Targets

List all targets for a control plane

Changed on

Returns a collection of all targets for a control plane.

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

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/targets
  • 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.

Response

A paginated list response for a collection of targets.

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": [
    {
      "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
      "target": "203.0.113.42",
      "upstream": {
        "id": "5f1d7e76-2fed-4806-a6af-869984f025cb"
      },
      "weight": 100
    }
  ]
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status