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

JSON Patch Operation

array

A JSON Patch operation to add or remove API Operations from a Package.

>= 1 items

opstringrequired

The operation to perform.

Allowed values:addremovereplace

pathstringrequired

The path to the API Operation in the Package, in the format “operations/”.

Match pattern:^operations/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

valueobject
* Additional properties are NOT allowed.
Show Child Parameters

APIPackageJSONPatchItem

object

A JSON Patch operation to add or remove an API Operation from a Package.

* Additional properties are NOT allowed.
opstringrequired

The operation to perform.

Allowed values:addremovereplace

pathstringrequired

The path to the API Operation in the Package, in the format “operations/”.

Match pattern:^operations/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

valueobject
* Additional properties are NOT allowed.
Show Child Parameters
Example