Create a commitment.

post

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

Create a new commitment

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organizationId

string

required

Organization ID

Body Params

Input for creating a commitment.

name

string

required

Commitment name

cloud

string

enum

required

Cloud provider

Allowed:

region

string

required

Region where commitment is applicable

startTime

date-time

required

Start time of commitment

endTime

date-time

End time of commitment

type

string

enum

required

Commitment type

Allowed:

autoscalingStatus

string

enum

Controls whether the autoscaler can use this commitment

Allowed:

allowedUsage

float

Allowed usage (0.0-1.0). Defaults to 1.0 (100%).

prioritization

boolean

Prioritization: ignore resources used by lower priority clusters

scalingStrategy

string

enum

Scaling strategy for autoscaler

Allowed:

autoAssignment

boolean

Auto-assign to all matching clusters in the commitment's region

awsReservedInstancesDetails

object

AWS Reserved Instances details

azureReservationDetails

object

Azure Reservation details

gcpResourceCudDetails

object

GCP Resource CUD details

awsSavingsPlanDetails

object

AWS Savings Plan details

awsCapacityBlockDetails

object

AWS Capacity Block details

awsOdcrDetails

object

AWS On-Demand Capacity Reservation details

gcpFlexCudDetails

object

GCP Flex CUD details

azureSavingsPlanDetails

object

Azure Savings Plan details

gcpCapacityReservationDetails

object

GCP capacity reservation details

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