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
Get list of floating IPs
Authorizations:
query Parameters
detailed | string Need extended info or not |
Responses
Response samples
- 200
{- "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"
}
]
}
Get list of floating IPs
Authorizations:
query Parameters
detailed | string Need extended info or not |
Responses
Response samples
- 200
{- "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"
}
]
}
Get floating IP by unique identifier
Authorizations:
path Parameters
floatingip_id required | string |
Responses
Response samples
- 200
{- "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"
}
}
Get floating IP by unique identifier
Authorizations:
path Parameters
floatingip_id required | string |
Responses
Response samples
- 200
{- "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:
path Parameters
project_id required | string |
Request Body schema: application/json
required | Array of objects (_CreateFloatingIPRequest) Nested fields for floating IPs | ||||||
Array
|
Responses
Request samples
- Payload
{- "floatingips": [
- {
- "ips": "string",
- "quantity": 0,
- "region": "string"
}
]
}
Response samples
- 200
{- "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"
}
}
Response samples
- 200
{- "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"
}
]
}
}
}
Response samples
- 200
{- "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"
}
]
}
}
}
Add keypair
Authorizations:
Request Body schema: application/json
required | object Nested fields for keypair | ||||||||
|
Responses
Request samples
- Payload
{- "keypair": {
- "name": "string",
- "public_key": "string",
- "regions": [
- "string"
], - "user_id": "string"
}
}
Response samples
- 200
{- "keypair": [
- {
- "name": "string",
- "public_key": "string",
- "region": "string",
- "user_id": "string"
}
]
}
Get list of added Windows licenses
Authorizations:
query Parameters
detailed | boolean Need extended info or not |
Responses
Response samples
- 200
{- "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"
}
]
}
Get list of added Windows licenses
Authorizations:
query Parameters
detailed | boolean Need extended info or not |
Responses
Response samples
- 200
{- "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"
}
]
}
Get info about Windows license
Authorizations:
path Parameters
license_id required | string |
Responses
Response samples
- 200
{- "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"
}
}
Get info about Windows license
Authorizations:
path Parameters
license_id required | string |
Responses
Response samples
- 200
{- "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
Authorizations:
path Parameters
project_id required | string |
Request Body schema: application/json
required | Array of objects (_CreateLicenseRequest) Nested fields for licenses | ||||||
Array
|
Responses
Request samples
- Payload
{- "licenses": [
- {
- "quantity": 1,
- "region": "string",
- "type": "string"
}
]
}
Response samples
- 200
{- "licenses": [
- {
- "id": 0,
- "network_id": "string",
- "project_id": "string",
- "region": "string",
- "status": "string",
- "subnet_id": "string",
- "type": "string"
}
]
}
Get list of all account's projects
Authorizations:
query Parameters
all | boolean Return all projects (requires iam_admin role) |
Responses
Response samples
- 200
{- "projects": [
- {
- "custom_url": "string",
- "description": "string",
- "enabled": true,
- "id": "string",
- "name": "string",
- "url": "string"
}
]
}
Get list of all account's projects
Authorizations:
query Parameters
all | boolean Return all projects (requires iam_admin role) |
Responses
Response samples
- 200
{- "projects": [
- {
- "custom_url": "string",
- "description": "string",
- "enabled": true,
- "id": "string",
- "name": "string",
- "url": "string"
}
]
}
Add project to account
Authorizations:
Request Body schema: application/json
required | object Nested fields for project | ||||||
|
Responses
Request samples
- Payload
{- "project": {
- "description": "string",
- "name": "string",
- "skip_quotas_init": true
}
}
Response samples
- 200
{- "project": {
- "description": "string",
- "id": "string",
- "name": "string",
- "url": "string"
}
}
Get info about project
Authorizations:
path Parameters
project_id required | string |
query Parameters
exclude_quotas | boolean Default: false Exclude project quotas from response. |
Responses
Response samples
- 200
{- "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"
}
}
Get info about project
Authorizations:
path Parameters
project_id required | string |
query Parameters
exclude_quotas | boolean Default: false Exclude project quotas from response. |
Responses
Response samples
- 200
{- "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:
path Parameters
project_id required | string |
Request Body schema: application/json
required | object Nested fields for project | ||||||||
|
Responses
Request samples
- Payload
{- "project": {
- "custom_url": "string",
- "description": "string",
- "name": "string",
- "theme": {
- "brand_color": "string",
- "color": "string",
- "logo": "string"
}
}
}
Response samples
- 201
{- "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:
path Parameters
project_id required | string |
Responses
Response samples
- 200
{- "association": {
- "domain_name": "string",
- "project_id": "string",
- "theme": {
- "brand_color": "string",
- "color": "string",
- "logo": "string"
}, - "urls": [
- {
- "type": "string",
- "url": "string"
}
]
}
}
Add roles for projects
Authorizations:
Request Body schema: application/json
required | Array of objects (_CreateRolesRequest) Nested fields for roles | ||||
Array
|
Responses
Request samples
- Payload
{- "roles": [
- {
- "project_id": "string",
- "user_id": "string"
}
]
}
Response samples
- 200
- 207
{- "roles": [
- {
- "project_id": "string",
- "user_id": "string"
}
]
}
Get list of subnets in account
Authorizations:
query Parameters
detailed | boolean Need extended info or not |
Responses
Response samples
- 200
{- "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"
}
]
}
Get list of subnets in account
Authorizations:
query Parameters
detailed | boolean Need extended info or not |
Responses
Response samples
- 200
{- "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"
}
]
}
Response samples
- 200
{- "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"
}
}
Response samples
- 200
{- "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:
path Parameters
project_id required | string |
Request Body schema: application/json
required | Array of objects (_CreateSubnetRequest) Nested fields for subnets | ||||||||||
Array
|
Responses
Request samples
- Payload
{- "subnets": [
- {
- "cidrs": [
- "string"
], - "prefix_length": 0,
- "quantity": 0,
- "region": "string",
- "type": "string"
}
]
}
Response samples
- 200
{- "subnet": {
- "cidr": "string",
- "id": 0,
- "network_id": "string",
- "project_id": "string",
- "region": "string",
- "status": "string",
- "subnet_id": "string"
}
}
Set custom theme for project
Authorizations:
Request Body schema: application/json
required | object Nested fields for theme | ||||||
|
Responses
Request samples
- Payload
{- "theme": {
- "brand_color": "string",
- "color": "string",
- "logo": "string"
}
}
Response samples
- 200
{- "theme": {
- "brand_color": "string",
- "color": "string",
- "logo": "string"
}
}
Set custom theme for project
Authorizations:
path Parameters
project_id required | string |
Request Body schema: application/json
required | object Nested fields for theme | ||||||
|
Responses
Request samples
- Payload
{- "theme": {
- "brand_color": "string",
- "color": "string",
- "logo": "string"
}
}
Response samples
- 200
{- "theme": {
- "brand_color": "string",
- "color": "string",
- "logo": "string"
}
}
Create token for account
Authorizations:
Request Body schema: application/json
required | object Nested fields for token | ||||||
|
Responses
Request samples
- Payload
{- "token": {
- "account_name": "string",
- "domain_name": "string",
- "project_id": null
}
}
Response samples
- 200
{- "token": {
- "id": "string"
}
}
Response samples
- 200
{- "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
}
}
}
}
Response samples
- 200
{- "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
}
}
}
}
Add user to account
Authorizations:
Request Body schema: application/json
required | object Nested fields for user | ||||||
|
Responses
Request samples
- Payload
{- "user": {
- "enabled": true,
- "name": "string",
- "password": "string"
}
}
Response samples
- 200
{- "user": {
- "enabled": true,
- "id": "string",
- "name": "string"
}
}
Update info about user
Authorizations:
path Parameters
user_id required | string |
Request Body schema: application/json
required | object Nested fields for user | ||||||
|
Responses
Request samples
- Payload
{- "user": {
- "enabled": true,
- "name": "string",
- "password": "string"
}
}
Response samples
- 200
{- "user": {
- "enabled": true,
- "id": "string",
- "name": "string"
}
}