Skip to content
|

Konnect API Builder

v3.0.0OAS 3.0

The management API for building APIs for Konnect Dev Portals.

API Base URL
  • Server 1:https://us.api.konghq.com/v3[Konnect API Builder]

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v3[Konnect API Builder]

    Europe Production region

  • Server 3:https://au.api.konghq.com/v3[Konnect API Builder]

    Australia Production region

  • Server 4:https://me.api.konghq.com/v3[Konnect API Builder]

    Middle-East Production region

  • Server 5:https://in.api.konghq.com/v3[Konnect API Builder]

    India Production region

Security
konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.

personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

systemAccountAccessToken (http)

The system account access token is meant for automations and integrations that are not directly associated with a human identity.
You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.
The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'

Additional Information
Contact Kong

Create API

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Creates an API.

post

Body

application/json

API

idstring(uuid)

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

description[ "string", "null" ]

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

version[ "string", "null" ]

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

>= 1 characters<= 255 characters

deprecatedboolean

Marks this API as deprecated.

Default:false

slug[ "string", "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

portalsarray[object]unique-items

The list of portals which this API is published to.

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

public_labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

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

Example:{"category":"finance"}

created_atstring(date-time)

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)

An ISO-8601 timestamp representation of entity update date.

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

Response

application/json

API

API

idstring(uuid)required

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

description[ "string", "null" ]

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

version[ "string", "null" ]required

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

>= 1 characters<= 255 characters

deprecatedbooleanrequired

Marks this API as deprecated.

Default:false

slug[ "string", "null" ]required

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

Defaults to slugify(name + version)

Match pattern:^[\w-]+$

Example:my-api-v1

portalsarray[object]requiredunique-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"}

public_labelsobjectrequired

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

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

Example:{"category":"finance"}

created_atstring(date-time)required

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)required

An ISO-8601 timestamp representation of entity update date.

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

post/apis

Body

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