Get an API

Get an API.

get

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

Response

application/json

API

API

* 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 | null

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

versionstring | nullrequired

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

>= 1 characters<= 255 characters

current_version_summaryobject | nullrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
slugstring | nullrequired

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.

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_modestring | nullread-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

get/apis/{apiId}
 
application/json

Update API

Updates an API.

patch

Query Parameters

forcestring

If true, allows operations to be removed from the current version when using access control enforcement.
If false, operations removal will be rejected with a 409 error.
Omitting the value means true.

Allowed values:truefalse

Default:false

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

Body

application/json

API

* Additional properties are NOT allowed.
namestring

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

>= 1 characters<= 255 characters

Example:MyAPI

descriptionstring | null

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

versionstring | null

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

>= 1 characters<= 255 characters

slugstring | null

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

Defaults to slugify(name + version)

Match pattern:^[\w-]+$

Example:my-api-v1

labelsobject | null

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

Labels are intended to store INTERNAL metadata.

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

Example:{"env":"test"}

attributesobject

A set of attributes that describe the API

Default:{}

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

Response

application/json

API

API

* 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 | null

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

versionstring | nullrequired

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

>= 1 characters<= 255 characters

current_version_summaryobject | nullrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
slugstring | nullrequired

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.

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_modestring | nullread-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

patch/apis/{apiId}

Body

{ "name": "new API name" }
 
application/json

Delete API

Deletes an API.

delete

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

Response

API was deleted successfully.

delete/apis/{apiId}
 

API Documentation

Create API Document

Publish a new document attached to an API.

All configuration options may be provided in the frontmatter section of content. If you set values in both the POST request and in the frontmatter, the values in the POST request will take precedence.

post

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

Body

application/json

API Document

* Additional properties are NOT allowed.
contentstringrequired

Raw markdown content to display in your Portal

titlestring

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

Example:API Document

slugstring

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

Defaults to slugify(title)

Match pattern:^[\w-]+$

Example:api-document

statusstring

If status=published the document will be visible in your live portal

Allowed values:publishedunpublished

Default:unpublished

parent_document_idstring | null(uuid)

API Documents may be rendered as a tree of files.

Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.

Example:null

Response

application/json

API document

API Document

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

The API document identifier.

Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb

contentstringrequired

Raw markdown content to display in your Portal

titlestringrequired

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

Example:API Document

slugstringrequired

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

Defaults to slugify(title)

Match pattern:^[\w-]+$

Example:api-document

statusstringrequired

If status=published the document will be visible in your live portal

Allowed values:publishedunpublished

Default:unpublished

parent_document_idstring | null(uuid)required

API Documents may be rendered as a tree of files.

Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.

Example:null

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

post/apis/{apiId}/documents

Body

{ "slug": "api-document", "status": "published", "title": "API Document", "content": "# API Document Header" }
 
application/json