Cloud Platform Projects and Resources API (v2.0.0)

Managing cloud platform resources: projects, project users, public IPs, SSH keys, and more. It does not allow you to create cloud platform resources. To do this, you can use the OpenStack API

Accounts

Get info about account

Authorizations:

X-Auth-Token

Responses

Response samples

200

Content type

application/json

{"account": {"enabled": true,
"locked": true,
"locks": [{"created_at": "string",
"reason": "string"
}
],
"name": "string",
"onboarding": true
}
}

DNS

Get info about DNS at hostname

Authorizations:

X-Auth-Token

path Parameters

hostname

required

string

Responses

Response samples

200

Content type

application/json

{"result": {"content": "string",
"delegated": true,
"ns_servers": ["string"
]
}
}

Floating IPs

Get list of floating IPs

Authorizations:

X-Auth-Token

query Parameters

detailed

string

Need extended info or not

Responses

Response samples

200

Content type

application/json

{"floatingips": [{"floating_ip_address": "string",
"id": "string",
"loadbalancer": {"id": "string",
"name": "string"
},
"project_id": "string",
"region": "string",
"servers": [{"id": "string",
"name": "string",
"status": "string",
"updated": "string"
}
],
"status": "string"
}
]
}

Delete floating IP from project

Authorizations:

X-Auth-Token

path Parameters

floatingip_id

required

string

Responses

Get floating IP by unique identifier

Authorizations:

X-Auth-Token

path Parameters

floatingip_id

required

string

Responses

Response samples

200

Content type

application/json

{"floatingip": {"fixed_ip_address": "string",
"floating_ip_address": "string",
"id": "string",
"loadbalancer": {"id": "string",
"name": "string"
},
"port_id": "string",
"project_id": "string",
"region": "string",
"servers": [{"id": "string",
"name": "string",
"status": "string",
"updated": "string"
}
],
"status": "string"
}
}

Add floating IP to project

Authorizations:

X-Auth-Token

path Parameters

project_id

required

string

Request Body schema: application/json

required

Array of objects (_CreateFloatingIPRequest)

Nested fields for floating IPs

Array

ips	string IP address for floating IP
quantity required	integer <int32> Quantity of floating IPs
region required	string Region name for floating IP

Responses

Request samples

Payload

Content type

application/json

{"floatingips": [{"ips": "string",
"quantity": 0,
"region": "string"
}
]
}

Response samples

200

Content type

application/json

{"floatingip": {"fixed_ip_address": "string",
"floating_ip_address": "string",
"id": "string",
"loadbalancer": {"id": "string",
"name": "string"
},
"port_id": "string",
"project_id": "string",
"region": "string",
"servers": [{"id": "string",
"name": "string",
"status": "string",
"updated": "string"
}
],
"status": "string"
}
}

Info

Get capabilities and restrictions for account

Authorizations:

X-Auth-Token

Responses

Response samples

200

Content type

application/json

{"capabilities": {"billing_stat_source": "string",
"logo": {"max_size_bytes": 0
},
"regions": [{"description": "string",
"is_available": true,
"is_default": true,
"name": "string",
"zones": [{"description": "string",
"enabled": true,
"is_default": true,
"is_private": true,
"name": "string"
}
]
}
],
"resources": [{"availability": ["string"
],
"closed_in": ["string"
],
"name": "string",
"preordered": true,
"quota_scope": "string",
"quotable": true,
"scope": "string",
"unbillable": true
}
],
"restrictions": {"flavor": {"max_ram_mb": 0,
"max_root_gb": 0,
"max_vcpus": 0
},
"image": {"max_size_bytes": 0
},
"qos": [{"cluster": "string",
"value": {"read_iops_sec": "string",
"total_bytes_sec": "string",
"write_iops_sec": "string"
},
"volume_type": "string",
"zone": "string"
}
]
}
}
}

Keypairs

Get list of all keypairs Deprecated

To manage keypairs (SSH keys), use the Nova API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

query Parameters

user_id

string

Keypair's user unique identifier

Responses

Response samples

200

Content type

application/json

{"keypairs": [{"name": "string",
"public_key": "string",
"regions": ["string"
],
"user_id": "string"
}
]
}

Add keypair Deprecated

To manage keypairs (SSH keys), use the Nova API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

Request Body schema: application/json

required

object

Nested fields for keypair

name required	string Keypair name
public_key required	string Public key of keypair
regions	Array of strings Regions where keypair is available
user_id required	string Keypair's user unique identifier

Responses

Request samples

Payload

Content type

application/json

{"keypair": {"name": "string",
"public_key": "string",
"regions": ["string"
],
"user_id": "string"
}
}

Response samples

200

Content type

application/json

{"keypair": [{"name": "string",
"public_key": "string",
"region": "string",
"user_id": "string"
}
]
}

Remove keypair Deprecated

To manage keypairs (SSH keys), use the Nova API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

name required	string
user_id required	string

Responses

Licenses

Get list of added Windows licenses Deprecated

License management will be removed in 2025.

Authorizations:

X-Auth-Token

query Parameters

detailed

boolean

Need extended info or not

Responses

Response samples

200

Content type

application/json

{"licenses": [{"id": 0,
"network_id": "string",
"port_id": "string",
"project_id": "string",
"region": "string",
"servers": [{"id": "string",
"name": "string",
"status": "string",
"updated": "string"
}
],
"status": "string",
"subnet_id": "string",
"type": "string"
}
]
}

Delete Windows license Deprecated

License management will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

license_id

required

string

Responses

Get info about Windows license Deprecated

License management will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

license_id

required

string

Responses

Response samples

200

Content type

application/json

{"license": {"id": 0,
"network_id": "string",
"port_id": "string",
"project_id": "string",
"region": "string",
"servers": [{"id": "string",
"name": "string",
"status": "string",
"updated": "string"
}
],
"status": "string",
"subnet_id": "string",
"type": "string"
}
}

Add Windows license to project Deprecated

License management will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

project_id

required

string

Request Body schema: application/json

required

Array of objects (_CreateLicenseRequest)

Nested fields for licenses

Array

quantity required	integer <int32> >= 1 Quantity of Windows licenses
region required	string Region name where license is available
type required	string License type

Responses

Request samples

Payload

Content type

application/json

{"licenses": [{"quantity": 1,
"region": "string",
"type": "string"
}
]
}

Response samples

200

Content type

application/json

{"licenses": [{"id": 0,
"network_id": "string",
"project_id": "string",
"region": "string",
"status": "string",
"subnet_id": "string",
"type": "string"
}
]
}

Projects

Get list of all account's projects

Authorizations:

X-Auth-Token

query Parameters

all	boolean Return all projects (requires iam_admin role)

Responses

Response samples

200

Content type

application/json

{"projects": [{"custom_url": "string",
"description": "string",
"enabled": true,
"id": "string",
"name": "string",
"url": "string"
}
]
}

Add project to account

Authorizations:

X-Auth-Token

Request Body schema: application/json

required

object

Nested fields for project

description	string [ 0 .. 255 ] characters Project description
name required	string [ 1 .. 64 ] characters Project name
skip_quotas_init	boolean Skip quotas initialization

Responses

Request samples

Payload

Content type

application/json

{"project": {"description": "string",
"name": "string",
"skip_quotas_init": true
}
}

Response samples

200

Content type

application/json

{"project": {"description": "string",
"id": "string",
"name": "string",
"url": "string"
}
}

Delete project from account

Authorizations:

X-Auth-Token

path Parameters

project_id

required

string

Responses

Get info about project

Authorizations:

X-Auth-Token

path Parameters

project_id

required

string

query Parameters

exclude_quotas

boolean

Default: false

Exclude project quotas from response.

Responses

Response samples

200

Content type

application/json

{"project": {"custom_url": "string",
"description": "string",
"enabled": true,
"id": "string",
"name": "string",
"quotas": {"property1": [{"region": "string",
"used": 0,
"value": 0,
"zone": "string"
}
],
"property2": [{"region": "string",
"used": 0,
"value": 0,
"zone": "string"
}
]
},
"theme": {"brand_color": "string",
"color": "string",
"logo": "string"
},
"url": "string"
}
}

Update project info

Authorizations:

X-Auth-Token

path Parameters

project_id

required

string

Request Body schema: application/json

required

object

Nested fields for project

custom_url	string or null Custom url for project
description	string [ 0 .. 255 ] characters Project description
name	string [ 1 .. 64 ] characters Project name
	object Nested fields for theme

Responses

Request samples

Payload

Content type

application/json

{"project": {"custom_url": "string",
"description": "string",
"name": "string",
"theme": {"brand_color": "string",
"color": "string",
"logo": "string"
}
}
}

Response samples

201

Content type

application/json

{"project": {"custom_url": "string",
"description": "string",
"enabled": true,
"id": "string",
"name": "string",
"theme": {"brand_color": "string",
"color": "string",
"logo": "string"
},
"url": "string"
}
}

Dissociate association for project

Authorizations:

X-Auth-Token

path Parameters

project_id

required

string

Responses

Response samples

200

Content type

application/json

{"association": {"domain_name": "string",
"project_id": "string",
"theme": {"brand_color": "string",
"color": "string",
"logo": "string"
},
"urls": [{"type": "string",
"url": "string"
}
]
}
}

Roles

Get list of roles Deprecated

To manage roles, use the new service: IAM API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

Responses

Response samples

200

Content type

application/json

{"roles": [{"project_id": "string",
"user_id": "string"
}
]
}

Add roles for projects Deprecated

To manage roles, use the new service: IAM API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

Request Body schema: application/json

required

Array of objects (_CreateRolesRequest)

Nested fields for roles

Array

project_id required	string Project unique identifier
user_id required	string User unique identifier

Responses

Request samples

Payload

Content type

application/json

{"roles": [{"project_id": "string",
"user_id": "string"
}
]
}

Response samples

200
207

Content type

application/json

{"roles": [{"project_id": "string",
"user_id": "string"
}
]
}

Get list of roles Deprecated

To manage roles, use the new service: IAM API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

project_id

required

string

Responses

Response samples

200

Content type

application/json

{"roles": [{"project_id": "string",
"user_id": "string"
}
]
}

Get list of roles Deprecated

To manage roles, use the new service: IAM API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Responses

Response samples

200

Content type

application/json

{"roles": [{"project_id": "string",
"user_id": "string"
}
]
}

Delete role from project Deprecated

To manage roles, use the new service: IAM API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

project_id required	string
user_id required	string

Responses

Add role for project Deprecated

To manage roles, use the new service: IAM API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

project_id required	string
user_id required	string

Responses

Response samples

200

Content type

application/json

{"role": {"project_id": "string",
"user_id": "string"
}
}

Subnets

Get list of subnets in account

Authorizations:

X-Auth-Token

query Parameters

detailed

boolean

Need extended info or not

Responses

Response samples

200

Content type

application/json

{"subnets": [{"cidr": "string",
"created_at": "string",
"gateway_ip": "string",
"id": 0,
"ip_version": 0,
"name": "string",
"network_id": "string",
"project_id": "string",
"region": "string",
"servers": [{"id": "string",
"name": "string",
"status": "string",
"updated": "string"
}
],
"status": "string",
"subnet_id": "string",
"updated_at": "string"
}
]
}

Delete subnet from project

Authorizations:

X-Auth-Token

path Parameters

subnet_id

required

string

Responses

Get info about subnet

Authorizations:

X-Auth-Token

path Parameters

subnet_id

required

string

Responses

Response samples

200

Content type

application/json

{"subnet": {"cidr": "string",
"created_at": "string",
"gateway_ip": "string",
"id": 0,
"ip_version": 0,
"name": "string",
"network_id": "string",
"project_id": "string",
"region": "string",
"servers": [{"id": "string",
"name": "string",
"status": "string",
"updated": "string"
}
],
"status": "string",
"subnet_id": "string",
"updated_at": "string"
}
}

Add subnet for project

Authorizations:

X-Auth-Token

path Parameters

project_id

required

string

Request Body schema: application/json

required

Array of objects (_CreateSubnetRequest)

Nested fields for subnets

Array

cidrs	Array of strings CIDR prefixes of subnet
prefix_length required	integer <int32> Subnet prefix length
quantity required	integer <int32> Quantity of subnets
region required	string Subnet region name
type required	string Subnet type

Responses

Request samples

Payload

Content type

application/json

{"subnets": [{"cidrs": ["string"
],
"prefix_length": 0,
"quantity": 0,
"region": "string",
"type": "string"
}
]
}

Response samples

200

Content type

application/json

{"subnet": {"cidr": "string",
"id": 0,
"network_id": "string",
"project_id": "string",
"region": "string",
"status": "string",
"subnet_id": "string"
}
}

Theme

Delete custom theme for project

Authorizations:

X-Auth-Token

Responses

Get custom theme for project

Authorizations:

X-Auth-Token

Responses

Response samples

200

Content type

application/json

{"theme": {"brand_color": "string",
"color": "string",
"logo": "string"
}
}

Set custom theme for project

Authorizations:

X-Auth-Token

Request Body schema: application/json

required

object

Nested fields for theme

brand_color	string or null Color for control panel
color	string or null Color code for top panel
logo	string or null Link to logo for panel

Responses

Request samples

Payload

Content type

application/json

{"theme": {"brand_color": "string",
"color": "string",
"logo": "string"
}
}

Response samples

200

Content type

application/json

{"theme": {"brand_color": "string",
"color": "string",
"logo": "string"
}
}

Delete custom theme for project

Authorizations:

X-Auth-Token

path Parameters

project_id

required

string

Responses

Get custom theme for project

Authorizations:

X-Auth-Token

path Parameters

project_id

required

string

Responses

Response samples

200

Content type

application/json

{"theme": {"brand_color": "string",
"color": "string",
"logo": "string"
}
}

Set custom theme for project

Authorizations:

X-Auth-Token

path Parameters

project_id

required

string

Request Body schema: application/json

required

object

Nested fields for theme

brand_color	string or null Color for control panel
color	string or null Color code for top panel
logo	string or null Link to logo for panel

Responses

Request samples

Payload

Content type

application/json

{"theme": {"brand_color": "string",
"color": "string",
"logo": "string"
}
}

Response samples

200

Content type

application/json

{"theme": {"brand_color": "string",
"color": "string",
"logo": "string"
}
}

Tokens

Create token for account Deprecated

To manage tokens, use the Keystone API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

Request Body schema: application/json

required

object

Nested fields for token

account_name	string Account name
domain_name	string Account name (deprecated, please use [account_name])
project_id	any Project unique identifier

Responses

Request samples

Payload

Content type

application/json

{"token": {"account_name": "string",
"domain_name": "string",
"project_id": null
}
}

Response samples

200

Content type

application/json

{"token": {"id": "string"
}
}

Revoke token Deprecated

To manage tokens, use the Keystone API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

token

required

string

Responses

Traffic

Get current account traffic usage

Authorizations:

X-Auth-Token

Responses

Response samples

200

Content type

application/json

{"traffic": {"domain": {"paid": {"start": "2019-08-24T14:15:22Z",
"stop": "2019-08-24T14:15:22Z",
"unit": "string",
"value": 0
},
"prepared": {"start": "2019-08-24T14:15:22Z",
"stop": "2019-08-24T14:15:22Z",
"unit": "string",
"value": 0
},
"used": {"start": "2019-08-24T14:15:22Z",
"stop": "2019-08-24T14:15:22Z",
"unit": "string",
"value": 0
}
}
}
}

Get account traffic report

Authorizations:

X-Auth-Token

query Parameters

start_date required	string <date> Start date of report
end_date required	string <date> End date of report

Responses

Users

Get list of users Deprecated

To manage users, use the new service: IAM API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

Responses

Response samples

200

Content type

application/json

{"users": [{"enabled": true,
"id": "string",
"name": "string"
}
]
}

Add user to account Deprecated

To manage users, use the new service: IAM API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

Request Body schema: application/json

required

object

Nested fields for user

enabled	boolean Enable user for use or not
name required	string [ 1 .. 250 ] characters User's name
password required	string non-empty User's password

Responses

Request samples

Payload

Content type

application/json

{"user": {"enabled": true,
"name": "string",
"password": "string"
}
}

Response samples

200

Content type

application/json

{"user": {"enabled": true,
"id": "string",
"name": "string"
}
}

Delete user from account and also delete user's keypairs Deprecated

To manage users, use the new service: IAM API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Responses

Get info about user Deprecated

To manage users, use the new service: IAM API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Responses

Response samples

200

Content type

application/json

{"user": {"enabled": true,
"id": "string",
"name": "string"
}
}

Update info about user Deprecated

To manage users, use the new service: IAM API. This endpoint will be removed in 2025.

Authorizations:

X-Auth-Token

path Parameters

user_id

required

string

Request Body schema: application/json

required

object

Nested fields for user

enabled	boolean Enable user for use or not
name	string [ 1 .. 250 ] characters User's name
password	string non-empty User's password

Responses

Request samples

Payload

Content type

application/json

{"user": {"enabled": true,
"name": "string",
"password": "string"
}
}

Response samples

200

Content type

application/json

{"user": {"enabled": true,
"id": "string",
"name": "string"
}
}