Sign in
Services

List all Services

List all Services

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

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

Changed in 5 of the 75 revisions of this API.624

  • c83332d134eb1See the full diff
    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

  • 581456e3279f2See the full diff
    • ○

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

      new-optional-request-parameter

    • ○

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

      new-optional-request-parameter

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3c0154b2053a47See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ○

      the response's property default value 60000 was added for the status

      response-property-default-value-added

    • ○

      the response's property default value true was added for the status

      response-property-default-value-added

    • ○

      the response's property default value 80 was added for the status

      response-property-default-value-added

    • ○

      the response's property default value http was added for the status

      response-property-default-value-added

    • ○

      the response's property default value 60000 was added for the status

      response-property-default-value-added

    • ○

      the response's property default value 5 was added for the status

      response-property-default-value-added

    • ○

      the response's property default value 60000 was added for the status

      response-property-default-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6333a0d3b0957See the full diff
    • ○

      the response's property default value 60000 was removed for the status

      response-property-default-value-removed

    • ○

      the response's property default value true was removed for the status

      response-property-default-value-removed

    • ○

      the response's property default value 80 was removed for the status

      response-property-default-value-removed

    • ○

      the response's property default value http was removed for the status

      response-property-default-value-removed

    • ○

      the response's property default value 60000 was removed for the status

      response-property-default-value-removed

    • ○

      the response's property default value 5 was removed for the status

      response-property-default-value-removed

    • ○

      the response's property default value 60000 was removed for the status

      response-property-default-value-removed

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76b0fefddb0d18See the full diff
    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      the response's property default value 60000 was added for the status

      response-property-default-value-added

    • ○

      the response's property default value true was added for the status

      response-property-default-value-added

    • ○

      the response's property default value 80 was added for the status

      response-property-default-value-added

    • ○

      the response's property default value http was added for the status

      response-property-default-value-added

    • ○

      the response's property default value 60000 was added for the status

      response-property-default-value-added

    • ○

      the response's property default value 5 was added for the status

      response-property-default-value-added

    • ○

      the response's property default value 60000 was added for the status

      response-property-default-value-added