ApiImplementationControlPlaneEntity

object

A control plane that implements an API

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

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

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

control_planeobject

A Control plane that implements an API

* Additional properties are NOT allowed.
Show Child Parameters
Example

API Attribute List Item

object

Entities that describe APIs

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

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

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

keystring(^[a-z0-9-_]{0,128}$)required

A unique key that can contain lowercase letters, numbers, hyphens, and underscores

<= 128 characters

Example:kind

valuesarray[object]required
Show Child Parameters
Example

API Attributes

object

A set of attributes that describe the API

Default:{}

Example

API Operation

object

An operation linked to an API

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

The API operation identifier.

Example:b42d905a-ed33-46a3-a093-d8f536af9a8a

methodstringrequiredread-only

The HTTP method of an API Operation.

Allowed values:GETPOSTPUTDELETEPATCHOPTIONSHEADCONNECTTRACE

pathstringrequired

The path of the operation.

Example:/users/*

implementation_statusobject

The implementation status of the operation.

* Additional properties are NOT allowed.
Show Child Parameters
Example

API Operation Implementation Status

object

The implementation status of the operation.

* Additional properties are NOT allowed.
matchedbooleanrequiredread-only

Whether the operation is matched by a Kong route in the control plane

routeobjectrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
serviceobjectrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
Example