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

imagesobjectread-only

Example:{"icon":{"uri":"/apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw"}}

* Additional properties are NOT allowed.
Show Child Parameters
Example

Image Status

object
* Additional properties are NOT allowed.
errorstringrequiredread-only

An error related to the image invalid status.

statusstringrequiredread-only

The status of the image.

Allowed values:uploadingvalidatingvalidinvalid

Example:valid

api_idstring(uuid)requiredread-only

The API identifier which the image belongs to.

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

image_typestringrequiredread-only

The type of the image.

Allowed values:icon

Example:icon

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

ApiComputedSchema

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

The API identifier.

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

api_spec_validation_messages_countinteger

The number of validation messages for the API specification attached to the API. If there are no validation messages, the value will be 0, or if there are no API specifications, the value will be 0.

Example:1

Example

API Version

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

The API version identifier.

Example:7710d5c4-d902-410b-992f-18b814155b53

versionstring

The version of the api.

Example:1.0.0

specobject
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

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

Example

API Version Summary

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

The API version identifier.

Example:7710d5c4-d902-410b-992f-18b814155b53

versionstring

The version of this api spec.

specobject
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

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

Example