clusters

Fetch cluster

Returns a cluster by its identifier.

get/api/v1/clusters/{id}

Path parameters

idstring uuid required
Example:01920000-0000-7000-8000-000000000000

Cluster identifier (UUID).

Response

Cluster found.

idstring required
codestring required
namestring required
descriptionstring nullable required
colorstring nullable required
activeboolean required
metadataobject nullable required
created_atstring required
updated_atstring required

Changes

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

    • added the required property active to the response with the 200 status

      response-required-property-added

    • added the required property code to the response with the 200 status

      response-required-property-added

    • added the required property color to the response with the 200 status

      response-required-property-added

    • added the required property created_at to the response with the 200 status

      response-required-property-added

    • added the required property description to the response with the 200 status

      response-required-property-added

    • added the required property id to the response with the 200 status

      response-required-property-added

    • added the required property metadata to the response with the 200 status

      response-required-property-added

    • added the required property name to the response with the 200 status

      response-required-property-added

    • added the required property 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 active from the response with the 200 status

      response-required-property-removed

    • removed the required property code from the response with the 200 status

      response-required-property-removed

    • removed the required property color from the response with the 200 status

      response-required-property-removed

    • removed the required property created_at from the response with the 200 status

      response-required-property-removed

    • removed the required property description from the response with the 200 status

      response-required-property-removed

    • removed the required property id from the response with the 200 status

      response-required-property-removed

    • removed the required property metadata from the response with the 200 status

      response-required-property-removed

    • removed the required property name from the response with the 200 status

      response-required-property-removed

    • removed the required property updated_at from the response with the 200 status

      response-required-property-removed

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