Skip to main content
POST
Reserve Capacity

Authorizations

Authorization
string
header
required

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

Body

application/json
accountId
string
required

AWS account ID

policyName
string
required

Name to assign to the reservation policy

instanceType
string
required

EC2 instance type to check (e.g., c5.large)

platform
string
default:Linux/UNIX
required

OS/platform for the offering (e.g., Linux/UNIX, Windows Server)

zoneId
string
required

Availability Zone identifier to search within (e.g., usw2-az1, aps1-az1)

quantity
integer
required

Number of instances to reserve (must be positive)

Required range: x >= 1
startDate
string
required

Reservation start date, format MM/dd/yyyy (e.g., 12/20/2024)

Pattern: ^\d{2}/\d{2}/\d{4}$
endDate
string
required

Reservation end date, format MM/dd/yyyy (e.g., 12/25/2024)

Pattern: ^\d{2}/\d{2}/\d{4}$
startTime
string
required

Reservation start time, format HH:mm (24-hour, e.g., 09:30)

Pattern: ^\d{2}:\d{2}$
endTime
string
required

Reservation end time, format HH:mm (24-hour, e.g., 23:15)

Pattern: ^\d{2}:\d{2}$
utcOffsetHours
string
required

Client UTC offset in hours (range -18 to 18)

autoRenewalEnabled
boolean
default:false

Enables auto-renewal for the policy

autoRenewalFrequency
enum<string>

Auto-renewal frequency (required when autoRenewalEnabled is true)

Available options:
one-day,
one-week,
one-month

Response

Success - Reservation was successful