Skip to main content
GET
List sprites

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

prefix
string

Filter sprites by name prefix

Example:

"dev-"

max_results
integer

Maximum number of results (1-500, default: 50)

Example:

50

continuation_token
string

Token from previous response for pagination

Example:

"eyJsYXN0IjoibXktc3ByaXRlIn0="

Response

Success

Paginated sprite list

cold
integer
required

Number of returned sprites currently cold.

Example:

3

has_more
boolean
required

Whether more results are available

Example:

true

name
string
required

Organization slug.

Example:

"my-org"

running
integer
required

Number of returned sprites currently running.

Example:

1

sprites
object[]
required

List of sprite resources

Example:
warm
integer
required

Number of returned sprites currently warm.

Example:

2

next_continuation_token
string

Token for fetching the next page of results

Example:

"eyJsYXN0IjoibXktZGV2LXNwcml0ZSJ9"

running_limit
integer

Organization-wide active sprite limit.

Example:

10

warm_limit
integer

Organization-wide warm sprite limit.

Example:

10