List API Packages

List API packages

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters API Packages in the response.

Show Child Parameters
sortstring

The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:created_at desc

Response

application/json

List of API Packages

ListApiPackagesResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
get/api-packages
 
application/json

Create API Package

Creates a package of APIs.
An API package is a collection of APIs that can be used to group related APIs together.

post

Body

application/json

API Package

* Additional properties are NOT allowed.
namestringrequired

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

>= 1 characters<= 255 characters

Example:MyAPIPackage

descriptionstring | null

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

slugstring | null

The unique slug for your API Package, It should be unique across all APIs and API Packages.

Match pattern:^[\w-]+$

Example:my-api-package-v1

versionstring | null

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

>= 1 characters<= 255 characters

rate_limiting_configobject | null

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

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"}

attributesobject

A set of attributes that describe the API

Default:{}

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

Response

application/json

API Package

API Package

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

The API Package identifier.

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

namestringrequired

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

>= 1 characters<= 255 characters

Example:MyAPIPackage

descriptionstring | null

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

slugstring | nullrequired

The unique slug for your API Package, It should be unique across all APIs and API Packages.

Match pattern:^[\w-]+$

Example:my-api-package-v1

versionstring | nullrequired

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

>= 1 characters<= 255 characters

rate_limiting_configobject | nullrequired

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* 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"}

attributesobjectrequired

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

imagesobject | nullread-only

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

* Additional properties are NOT allowed.
Show Child Parameters
post/api-packages

Body

{ "name": "MyAPIPackage" }
 
application/json

Get API Package

Get details of a specific API package.

get

Path Parameters

packageIdstring(uuid)required

The UUID API Package identifier

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

Response

application/json

API Package

API Package

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

The API Package identifier.

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

namestringrequired

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

>= 1 characters<= 255 characters

Example:MyAPIPackage

descriptionstring | null

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

slugstring | nullrequired

The unique slug for your API Package, It should be unique across all APIs and API Packages.

Match pattern:^[\w-]+$

Example:my-api-package-v1

versionstring | nullrequired

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

>= 1 characters<= 255 characters

rate_limiting_configobject | nullrequired

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* 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"}

attributesobjectrequired

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

imagesobject | nullread-only

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

* Additional properties are NOT allowed.
Show Child Parameters
get/api-packages/{packageId}
 
application/json

Patch API Package

Updates an existing API package.
You can modify the name, description and version of the API Package.

patch

Path Parameters

packageIdstring(uuid)required

The UUID API Package identifier

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

Body

application/json

API Package

* Additional properties are NOT allowed.
namestring

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

>= 1 characters<= 255 characters

Example:MyAPIPackage

descriptionstring | null

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

slugstring | null

The unique slug for your API Package, It should be unique across all APIs and API Packages.

Match pattern:^[\w-]+$

Example:my-api-package-v1

versionstring | null

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

>= 1 characters<= 255 characters

rate_limiting_configobject | null

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* Additional properties are NOT allowed.
Show Child Parameters
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 Package

API Package

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

The API Package identifier.

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

namestringrequired

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

>= 1 characters<= 255 characters

Example:MyAPIPackage

descriptionstring | null

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

slugstring | nullrequired

The unique slug for your API Package, It should be unique across all APIs and API Packages.

Match pattern:^[\w-]+$

Example:my-api-package-v1

versionstring | nullrequired

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

>= 1 characters<= 255 characters

rate_limiting_configobject | nullrequired

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* 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"}

attributesobjectrequired

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

imagesobject | nullread-only

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

* Additional properties are NOT allowed.
Show Child Parameters
patch/api-packages/{packageId}

Body

{}
 
application/json

Create API Version

Creates a version (OpenAPI or AsyncAPI) for an API.

post

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

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

Body

application/json

API Version

* Additional properties are NOT allowed.
versionstring

The version of the api.

Example:1.0.0

specobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

API version (OpenAPI or AsyncAPI)

API Version

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

The API version identifier.

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

versionstringrequired

The version of the api.

Example:1.0.0

specobject
* Additional properties are NOT allowed.
Show Child Parameters
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}/versions

Body

{ "version": "1.0.0", "spec": { "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}" } }
 
application/json