Skip to main content
API docs by Redocly

Cloud Platform Projects and Resources API (v2)

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

Content type
application/json
{
  • "account": {
    }
}

Get info about account

Authorizations:
X-Auth-Token

Responses

Response samples

Content type
application/json
{
  • "account": {
    }
}

DNS

Get info about DNS at hostname

Authorizations:
X-Auth-Token
path Parameters
hostname
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get info about DNS at hostname

Authorizations:
X-Auth-Token
path Parameters
hostname
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Floating IPs

Get list of floating IPs

Authorizations:
X-Auth-Token
query Parameters
detailed
string

Need extended info or not

Responses

Response samples

Content type
application/json
{
  • "floatingips": [
    ]
}

Get list of floating IPs

Authorizations:
X-Auth-Token
query Parameters
detailed
string

Need extended info or not

Responses

Response samples

Content type
application/json
{
  • "floatingips": [
    ]
}

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

Content type
application/json
{
  • "floatingip": {
    }
}

Get floating IP by unique identifier

Authorizations:
X-Auth-Token
path Parameters
floatingip_id
required
string

Responses

Response samples

Content type
application/json
{
  • "floatingip": {
    }
}

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

Content type
application/json
{
  • "floatingips": [
    ]
}

Response samples

Content type
application/json
{
  • "floatingip": {
    }
}

Info

Get capabilities and restrictions for account

Authorizations:
X-Auth-Token

Responses

Response samples

Content type
application/json
{
  • "capabilities": {
    }
}

Get capabilities and restrictions for account

Authorizations:
X-Auth-Token

Responses

Response samples

Content type
application/json
{
  • "capabilities": {
    }
}

Keypairs

Get list of all keypairs

Authorizations:
X-Auth-Token
query Parameters
user_id
string

Keypair's user unique identifier

Responses

Response samples

Content type
application/json
{
  • "keypairs": [
    ]
}

Get list of all keypairs

Authorizations:
X-Auth-Token
query Parameters
user_id
string

Keypair's user unique identifier

Responses

Response samples

Content type
application/json
{
  • "keypairs": [
    ]
}

Add keypair

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

Content type
application/json
{
  • "keypair": {
    }
}

Response samples

Content type
application/json
{
  • "keypair": [
    ]
}

Remove keypair

Authorizations:
X-Auth-Token
path Parameters
name
required
string
user_id
required
string

Responses

Licenses

Get list of added Windows licenses

Authorizations:
X-Auth-Token
query Parameters
detailed
boolean

Need extended info or not

Responses

Response samples

Content type
application/json
{
  • "licenses": [
    ]
}

Get list of added Windows licenses

Authorizations:
X-Auth-Token
query Parameters
detailed
boolean

Need extended info or not

Responses

Response samples

Content type
application/json
{
  • "licenses": [
    ]
}

Delete Windows license

Authorizations:
X-Auth-Token
path Parameters
license_id
required
string

Responses

Get info about Windows license

Authorizations:
X-Auth-Token
path Parameters
license_id
required
string

Responses

Response samples

Content type
application/json
{
  • "license": {
    }
}

Get info about Windows license

Authorizations:
X-Auth-Token
path Parameters
license_id
required
string

Responses

Response samples

Content type
application/json
{
  • "license": {
    }
}

Add Windows license to project

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

Content type
application/json
{
  • "licenses": [
    ]
}

Response samples

Content type
application/json
{
  • "licenses": [
    ]
}

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

Content type
application/json
{
  • "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

Content type
application/json
{
  • "projects": [
    ]
}

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

Content type
application/json
{
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "project": {
    }
}

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

Content type
application/json
{
  • "project": {
    }
}

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

Content type
application/json
{
  • "project": {
    }
}

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

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

Content type
application/json
{
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "project": {
    }
}

Dissociate association for project

Authorizations:
X-Auth-Token
path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "association": {
    }
}

Roles

Get list of roles

Authorizations:
X-Auth-Token

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Get list of roles

Authorizations:
X-Auth-Token

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Add roles for projects

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

Content type
application/json
{
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Get list of roles

Authorizations:
X-Auth-Token
path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Get list of roles

Authorizations:
X-Auth-Token
path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Get list of roles

Authorizations:
X-Auth-Token
path Parameters
project_id
required
string
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Get list of roles

Authorizations:
X-Auth-Token
path Parameters
project_id
required
string
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Delete role from project

Authorizations:
X-Auth-Token
path Parameters
project_id
required
string
user_id
required
string

Responses

Add role for project

Authorizations:
X-Auth-Token
path Parameters
project_id
required
string
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "role": {
    }
}

Subnets

Get list of subnets in account

Authorizations:
X-Auth-Token
query Parameters
detailed
boolean

Need extended info or not

Responses

Response samples

Content type
application/json
{
  • "subnets": [
    ]
}

Get list of subnets in account

Authorizations:
X-Auth-Token
query Parameters
detailed
boolean

Need extended info or not

Responses

Response samples

Content type
application/json
{
  • "subnets": [
    ]
}

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

Content type
application/json
{
  • "subnet": {
    }
}

Get info about subnet

Authorizations:
X-Auth-Token
path Parameters
subnet_id
required
string

Responses

Response samples

Content type
application/json
{
  • "subnet": {
    }
}

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

Content type
application/json
{
  • "subnets": [
    ]
}

Response samples

Content type
application/json
{
  • "subnet": {
    }
}

Theme

Delete custom theme for project

Authorizations:
X-Auth-Token

Responses

Get custom theme for project

Authorizations:
X-Auth-Token

Responses

Response samples

Content type
application/json
{
  • "theme": {
    }
}

Get custom theme for project

Authorizations:
X-Auth-Token

Responses

Response samples

Content type
application/json
{
  • "theme": {
    }
}

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

Content type
application/json
{
  • "theme": {
    }
}

Response samples

Content type
application/json
{
  • "theme": {
    }
}

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

Content type
application/json
{
  • "theme": {
    }
}

Get custom theme for project

Authorizations:
X-Auth-Token
path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
{
  • "theme": {
    }
}

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

Content type
application/json
{
  • "theme": {
    }
}

Response samples

Content type
application/json
{
  • "theme": {
    }
}

Tokens

Create token for account

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

Content type
application/json
{
  • "token": {
    }
}

Response samples

Content type
application/json
{
  • "token": {
    }
}

Revoke token

Authorizations:
X-Auth-Token
path Parameters
token
required
string

Responses

Traffic

Get current account traffic usage

Authorizations:
X-Auth-Token

Responses

Response samples

Content type
application/json
{
  • "traffic": {
    }
}

Get current account traffic usage

Authorizations:
X-Auth-Token

Responses

Response samples

Content type
application/json
{
  • "traffic": {
    }
}

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

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

Authorizations:
X-Auth-Token

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Get list of users

Authorizations:
X-Auth-Token

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Add user to account

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

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "user": {
    }
}

Delete user from account and also delete user's keypairs

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

Responses

Get info about user

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

Get info about user

Authorizations:
X-Auth-Token
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

Update info about user

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

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "user": {
    }
}