Sign in
Context Interfaces

Create a Context Interface

Create a Context Interface in the Konnect Organization.

post/v1/context-interfaces

Request body

namestring required

The machine name of the Context Interface.

display_namestring required

The human-readable display name of the Context Interface.

descriptionstring required

A description of the Context Interface.

labelsLabels required

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 request

{
  "labels": {
    "env": "test"
  }
}

Response

A response to creating a Context Interface.

idstring uuid required

The unique identifier for the Context Interface.

namestring required

The machine name of the Context Interface.

display_namestring required

The human-readable display name of the Context Interface.

descriptionstring nullable required

A description of the Context Interface.

labelsLabels required

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 "_".

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "labels": {
    "env": "test"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 1 of the 83 revisions of this API.1