logo

Utility

Extra utility endpoints that aren't related to a specific resource.

Look up a resource identifier.

Given a (base64'd) resource identifier string (i.e. cluster:production/env:abc), returns the ID of the matching resource. If more than one resource matches the identifier, or no resource matches the identifier, this endpoint will return an error. Given identifiers are NOT unique, you may need to be more specific to target the exact identifier.

SecuritybearerAuth and hubAuth
Request
query Parameters
identifier
required
string

A base64 encoded resource identifier string.

Example: identifier=cltr:production/environment:654d4e848924c1c445c3635a/container:api
desired-component
required
string

The type of resource to lookup from the identifier string.

Enum: "cluster" "environment" "image-source" "stack" "server" "container"
Responses
200

Returns the ID of the requested resource from the identifier string.

default

General error response from the platform

get/v1/utils/resource/lookup
Response samples
application/json
{
  • "data": {
    }
}

Look up Cycle components (resources such as containers, servers, etc) based on their ID. Useful when the IDs are known ahead of time - all relevant items can be fetched in a single request.

SecuritybearerAuth and hubAuth
Request
Request Body schema: application/json

Accepts an array of component lookup objects. Consists of the type of resource to look up, and the ID.

required
Array of objects
Responses
200

Returns an array of the components requested.

default

General error response from the platform

post/v1/utils/components/lookup
Request samples
application/json
{
  • "components": [
    ]
}
Response samples
application/json
{
  • "data": {
    }
}