Orders API¶
List all orders¶
GET /api/orders
OAuth AuthorizationRequired: order_read
schema
orders
: Arrayid
: UUIDstatus
:String<open,pending,awaiting_payment,processing,cancelled,failed,completed
project
: Objectid
: Integername
: String
created_at
: DateTimeupdated_at
: DateTime
Get a single order¶
GET /api/orders/{id}
OAuth AuthorizationRequired: order_read
schema
orders
: Objectid
: UUIDstatus
:String<open,pending,awaiting_payment,processing,cancelled,failed,completed
project
: Objectid
: Integername
: String
created_at
: DateTimeupdated_at
: DateTime
Create a new order¶
POST /api/orders
OAuth AuthorizationRequired: order_write
schema
order
: Objectproject_name
: Stringskip_ssh
: Booleanlocation_id
: Integerproject_id
: Integer | Only if adding to existing projectcontainers
: Arrayimage_id
: Integerdomains
:Array<String>
| provide an optional list of domains you want added after the order is provisioned.resources
: Objectpackage_id
: Integer
params
: Arraykey
: Stringvalue
: String
Last update: 2021-12-31