Services

List all Services

Changed on

List all Services

get/v2/control-planes/{controlPlaneId}/core-entities/services

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

sizeinteger

Number of resources to be returned.

offsetstring

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

filter[name][contains]string

Filter routes by a substring of the name.

filter[name][eq]string

Filter routes by their name.

Response

A successful response listing Services

nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

Example response

{
  "data": [
    {
      "host": "example.internal",
      "id": "49fd316e-c457-481c-9fc7-8079153e4f3c",
      "name": "example-service",
      "path": "/",
      "port": 80,
      "protocol": "http"
    }
  ]
}

Changes

  • c83332d134ebRevision changes
    • breaking

      the response property // became nullable for the status

  • 581456e3279fRevision changes
    • info

      added the new optional query request parameter filter[name][contains]

    • info

      added the new optional query request parameter filter[name][eq]