コンテンツにスキップ
|

このページは翻訳されていません。

Konnect API Products

v2.0.0OAS 3.0

The API for Kong Konnect API Products.

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

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v2[Konnect API Products]

    Europe Production region

  • Server 3:https://au.api.konghq.com/v2[Konnect API Products]

    Australia Production region

  • Server 4:https://me.api.konghq.com/v2[Konnect API Products]

    Middle-East Production region

Security
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 Product

An API Product packages together associated APIs and their operations, backed by thorough documentation,
with the objective of making API consumption straightforward for developers.

post

Body

application/json

Create API Product Request

The request schema to create an API product.

namestringrequired

The name of the API product.

>= 1 characters<= 100 characters

Example:API Product

description[ "string", "null" ]

The description of the API product.

Default:null

Example:Text describing the API product

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

portal_idsarray[string](uuid)unique-items

The list of portal identifiers which this API product should be published to

>= 0 items

Example:25a2624c-49fc-4764-99e1-224ed819f200

Response

application/json

API product

API Product

idstring(uuid)required

The API product ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

The name of the API product

Example:My Name

description[ "string", "null" ]required

The description of the API product

Example:MyDescription

portal_idsarray[string](uuid)requiredunique-itemsDEPRECATED

The list of portal identifiers which this API product is published to.
This property is deprecated and will be removed in a future version. Use the portals property instead.

>= 0 items

Example:25a2624c-49fc-4764-99e1-224ed819f200

portalsarray[object]required

The list of portals which this API product is published to

>= 0 items

* Additional properties are NOT allowed.
Show Child Parameters
version_countnumberrequired

The number of product versions attached to this API product

Example:10

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

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

post/api-products

Body

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