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

Konnect Mesh Control Plane manager

v0.0.1OAS 3.0

Control Plane manager API

API Base URL
  • Server 1:https://us.api.konghq.com/v1[Konnect Mesh Control Plane manager]

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v1[Konnect Mesh Control Plane manager]

    Europe Production region

  • Server 3:https://au.api.konghq.com/v1[Konnect Mesh Control Plane manager]

    Australia Production region

  • Server 4:https://me.api.konghq.com/v1[Konnect Mesh Control Plane manager]

    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

Get a proxy XDS config on a CP

Returns the configuration of the proxy (xds configuration).

get

Query Parameters

shadowboolean

When computing XDS config the CP takes into account policies with ‘kuma.io/effect: shadow’ label

Default:false

includearray[string]

An array of extra fields to include in the response. When include=diff the server computes a diff in JSONPatch format
between the current proxy XDS config and the config returned in the ‘xds’ field.

Allowed values:diff

Path Parameters

meshstringrequired

The mesh of the DPP to get the diff for.

namestringrequired

The name of the DPP within the mesh to get the diff for.

cpIdstring(uuid)required

Id of the Konnect resource

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Response

application/json

Successfully retrieved proxy XDS config.

InspectDataplanesConfig

xdsobjectrequired

The raw XDS config as an inline JSON object

diffarray[object]

Contains a diff in a JSONPatch format between the XDS config returned in ‘xds’ and the current proxy XDS config.
By default, the field is empty. To include the diff in the response, use the include=diff query parameter.

Show Child Parameters
get/mesh/control-planes/{cpId}/meshes/{mesh}/dataplanes/{name}/_config
 
application/json