API
objectThe API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The name of your API. The name + version combination must be unique for each API you publish.
>= 1 characters<= 255 characters
Example:MyAPI
A description of your API. Will be visible on your live Portal.
An optional version for your API. Leave this empty if your API is unversioned.
>= 1 characters<= 255 characters
Show Child Parameters
The slug is used in generated URLs to provide human readable paths.
Defaults to slugify(name + version)
Match pattern:^[\w-]+$
Example:my-api-v1
The id of the API specification.
Example:123e4567-e89b-12d3-a456-426614174000
The list of portals which this API is published to.
Show Child Parameters
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"}
the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement
A set of attributes that describe the API
Default:{}
Example:{"env":["production"],"domains":["web","mobile"]}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
AuthStrategyApiSyncError
objectAllowed 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
Show Child Parameters
API Document ID
stringThe API document identifier.
API Document Content
stringRaw markdown content to display in your Portal
API Document Title
stringThe title of the document. Used to populate the <title> tag for the page