clusters

List clusters

Returns a paginated list of clusters scoped to the caller account.

get/api/v1/clusters

Query parameters

activeboolean
qstring
pagenumber
limitnumber
sortBystring
sortOrderstring

Response

Paginated list of clusters.

Example response

{
  "meta": {
    "total": 42,
    "pages": 3,
    "current_page": 1,
    "next_page": 2,
    "limit": 20
  }
}

Changes

Changed in 2 of the 9 revisions of this API.9615

    • added the new optional query request parameter active

      new-optional-request-parameter

    • added the new optional query request parameter limit

      new-optional-request-parameter

    • added the new optional query request parameter page

      new-optional-request-parameter

    • added the new optional query request parameter q

      new-optional-request-parameter

    • added the new optional query request parameter sortBy

      new-optional-request-parameter

    • added the new optional query request parameter sortOrder

      new-optional-request-parameter

    • added the required property data/items/active to the response with the 200 status

      response-required-property-added

    • added the required property data/items/code to the response with the 200 status

      response-required-property-added

    • added the required property data/items/color to the response with the 200 status

      response-required-property-added

    • added the required property data/items/created_at to the response with the 200 status

      response-required-property-added

    • added the required property data/items/description to the response with the 200 status

      response-required-property-added

    • added the required property data/items/id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/name to the response with the 200 status

      response-required-property-added

    • added the required property data/items/strategies_count to the response with the 200 status

      response-required-property-added

    • added the required property data/items/updated_at to the response with the 200 status

      response-required-property-added

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

    • removed the required property data/items/active from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/code from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/color from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/created_at from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/description from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/id from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/name from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/strategies_count from the response with the 200 status

      response-required-property-removed

    • removed the required property data/items/updated_at from the response with the 200 status

      response-required-property-removed

    • deleted the query request parameter active

      request-parameter-removed

    • deleted the query request parameter limit

      request-parameter-removed

    • deleted the query request parameter page

      request-parameter-removed

    • deleted the query request parameter q

      request-parameter-removed

    • deleted the query request parameter sortBy

      request-parameter-removed

    • deleted the query request parameter sortOrder

      request-parameter-removed

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