Catalog and prices

Locations (Netface region codes)

GET /locations

Responses

Status	Description
200	Locations open to the project
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
429	The key's allowance is used up

Response body

Field	Type	Required	Description
locations	array of Location	Yes

One location

GET /locations/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes

Responses

Status	Description
200	The location
401	No valid API key
404	No such resource in this project
429	The key's allowance is used up

Response body

Field	Type	Required	Description
location	Location	Yes

Server types

GET /server_types

Parameters

Name	In	Type	Required	Description
name	query	string	No	Exact name (maximum length 64)
location	query	string	No	Only what this location offers, by its id or its name (maximum length 64)

Responses

Status	Description
200	Server types offered at one location or more
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
429	The key's allowance is used up

Response body

Field	Type	Required	Description
server_types	array of ServerType	Yes

One server type

GET /server_types/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes

Responses

Status	Description
200	The server type
401	No valid API key
404	No such resource in this project
429	The key's allowance is used up

Response body

Field	Type	Required	Description
server_type	ServerType	Yes

System images

GET /images

Parameters

Name	In	Type	Required	Description
page	query	integer	No	(minimum 1, default 1)
per_page	query	integer	No	(minimum 1, maximum 100, default 25)
name	query	string	No	Exact name (maximum length 64)
location	query	string	No	Only what this location offers, by its id or its name (maximum length 64)
architecture	query	x86, arm	No

Responses

Status	Description
200	Images the project may start servers from
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
429	The key's allowance is used up

Response body

Field	Type	Required	Description
images	array of Image	Yes
meta	Meta	Yes

One image

GET /images/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes

Responses

Status	Description
200	The image
401	No valid API key
404	No such resource in this project
429	The key's allowance is used up

Response body

Field	Type	Required	Description
image	Image	Yes

Monthly unit prices of volumes, floating IPs and snapshots

GET /pricing

The prices in force per unit and month (billed per month, prorated per day; taxes excluded) and the organization's billing currency, the one to show prices in (ServerType.prices too). A resource without a price is not offered for creation. With currency the answer holds that currency's prices only and currency_source is requested. TRY prices are derived from the day's USD rate; before any rate is recorded their lists are empty, still a 200.

Parameters

Name	In	Type	Required	Description
currency	query	USD, TRY	No	The currency to answer in; without it the billing currency

Responses

Status	Description
200	The unit prices
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
429	The key's allowance is used up

Response body

Field	Type	Required	Description
pricing	object	Yes
pricing.currency	string	Yes	The currency asked for, else the billing profile's, or USD when the organization has no profile yet (pattern ^[A-Z]{3}$)
pricing.currency_source	billing_profile, canonical, requested	Yes
pricing.volume	UnitPricing	Yes
pricing.floating_ip	UnitPricing	Yes
pricing.snapshot	UnitPricing	Yes

The monthly list price of a server about to be created

GET /pricing/estimate

The list prices in force multiplied for one server type at one location, its extra volumes and its new floating IPs, in the currency asked for, else the organization's billing currency (GET /pricing). One month's amount (the proration of a part month is the invoice's), never a usage forecast. A line without a price makes the estimate priced: false with no total. A server type the location does not offer is 422 invalid_input not_offered_in_location; an unknown one unknown.

Parameters

Name	In	Type	Required	Description
server_type	query	string (uuid)	Yes
location	query	string	Yes	The location's id or name (maximum length 64)
volume_gb	query	array of integer	No	One extra volume each, in GB; repeat for several (at most 16) (at most items 16)
floating_ips	query	integer	No	New floating IPs (minimum 0, maximum 10, default 0)
currency	query	USD, TRY	No	The currency to answer in; without it the billing currency

Responses

Status	Description
200	The estimate
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
429	The key's allowance is used up

Response body

Field	Type	Required	Description
estimate	PriceEstimate	Yes