List all API Gateway Services

List all API Gateway Services

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter documents returned in the response.

Show Child Parameters

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200 application/json

List of API Gateway Services

* Additional properties are NOT allowed.
metaobjectrequired

Pagination metadata.

Show Child Parameters
dataarrayrequired
Show Child Parameters
get/api-gateways/{gatewayId}/services
 
200 application/json

Create a new API Gateway Service

Create a new API Gateway Service

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

The service to be created

BaseAPIGatewayService

namestringrequired

The unique name of the API Gateway Service.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the service.

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

Response

application/json

The created service.

APIGatewayService

namestringrequired

The unique name of the API Gateway Service.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the service.

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

idstring(uuid)required

The ID of the service.

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

post/api-gateways/{gatewayId}/services

Body

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

Get a service

Get service

get

Path Parameters

apiGatewayServiceIdstring(uuid)required

The ID of the API Gateway Service.

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

The requested service.

APIGatewayService

namestringrequired

The unique name of the API Gateway Service.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the service.

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

idstring(uuid)required

The ID of the service.

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

get/api-gateways/{gatewayId}/services/{apiGatewayServiceId}
 
application/json

Update a service

Update a service

put

Path Parameters

apiGatewayServiceIdstring(uuid)required

The ID of the API Gateway Service.

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

The service to be updated

BaseAPIGatewayService

namestringrequired

The unique name of the API Gateway Service.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the service.

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

Response

application/json

The updated service.

APIGatewayService

namestringrequired

The unique name of the API Gateway Service.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the service.

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

idstring(uuid)required

The ID of the service.

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

put/api-gateways/{gatewayId}/services/{apiGatewayServiceId}

Body

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

Delete a service

Delete a service

delete

Path Parameters

apiGatewayServiceIdstring(uuid)required

The ID of the API Gateway Service.

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

Success

delete/api-gateways/{gatewayId}/services/{apiGatewayServiceId}