API

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

namestringrequired

The name of your API. The name + version combination must be unique for each API you publish.

>= 1 characters<= 255 characters

Example:MyAPI

descriptionstring

A description of your API. Will be visible on your live Portal.

versionstringrequired

An optional version for your API. Leave this empty if your API is unversioned.

>= 1 characters<= 255 characters

current_version_summaryobjectrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
slugstringrequired

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

Match pattern:^[\w-]+$

Example:my-api-v1

api_spec_idsarray[string](uuid)requiredread-onlyDEPRECATED

The id of the API specification.

Example:123e4567-e89b-12d3-a456-426614174000

portalsarray[object]requiredread-onlyunique-items

The list of portals which this API is published to.

* Additional properties are NOT allowed.
Show Child Parameters
labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

implementation_modestringread-only

the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement

attributesobject

A set of attributes that describe the API

Default:{}

Example:{"env":["production"],"domains":["web","mobile"]}

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

AuthStrategyApiSyncError

object
* Additional properties are NOT allowed.
control_plane_errorstring

Allowed values:control_plane_error_no_responsecontrol_plane_error_invalid_responsecontrol_plane_error_unavailablecontrol_plane_error_internal_errorcontrol_plane_error_bad_requestcontrol_plane_error_plugin_conflictcontrol_plane_error_data_constraint_errorcontrol_plane_error_implementation_not_found

messagestringrequired
infoobject
* Additional properties are allowed.
Show Child Parameters
Example

API Document ID

string

The API document identifier.

Example

API Document Content

string

Raw markdown content to display in your Portal

API Document Title

string

The title of the document. Used to populate the <title> tag for the page

Example