List commitments.

get

https://api.cast.ai/pricing/v1beta/organizations/{organizationId}/commitments

List commitments with pagination, filtering, and sorting support.
Supersedes GetCommitments from the inventory API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organizationId

string

required

Organization ID

Query Params

page.limit

string

Defines the number of items that should be returned

page.cursor

string

Cursor that defines token indicating where to start the next page.
Empty value indicates to start from beginning of the dataset.

sort.field

string

The field name to order by. Nested fields can be specified by using a dot (e.g. user.name).

sort.order

string

enum

The order of returned items. Default is ASC.

Allowed:

types

array of strings

Filter by commitment types

types

Allowed:

clouds

array of strings

Filter by cloud providers

clouds

Allowed:

name

string

Filter by commitment name (case-insensitive, partial matching)

regions

array of strings

Filter by regions

regions

clusterId

string

Filter to commitments assigned to a specific cluster

states

array of strings

Filter by lifecycle states

states

Allowed:

includeTotalCount

boolean

Include total count of matching commitments in the response

unassigned

boolean

Filter to commitments that have no clusters assigned.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultDefault error response