Перейти к основному содержимому
API docs by Redocly

Dedicated Servers API (1.177.3.dev13+dedicated.21180)

Managing dedicated servers: creating and configuring resources, billing management, power control, OS installation, network setup, and more.

Dashboard

Dashboard

Get api info

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get current maintenance status

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get current active tasks

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Locations

Locations namespace

List locations

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show location info

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Services

Services namespace

List services

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
is_hidden
boolean

hidden from view

sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

is_primary
boolean
state
string

billing state

model
string
Enum: "default" "colocation" "server" "serverchip" "custom" "rack" "network" "equipment" "firewall" "port" "network_equipment" "service" "software"

service model

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List colocation services

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
is_hidden
boolean

hidden from view

sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show colocation service

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Calculate Service billing

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
campaign_uuid
string = 36 characters
location_uuid
required
string = 36 characters
pay_currency
string
Enum: "bonus" "main" "vk_rub"
pay_day
integer [ 1 .. 28 ]
price_plan_uuid
required
string = 36 characters
quantity
integer >= 1
Default: 1

Responses

Request samples

Content type
application/json
{
  • "campaign_uuid": "00000000-0000-0000-A000-000000000000",
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_currency": "bonus",
  • "pay_day": 1,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List custom servers

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
is_hidden
boolean

hidden from view

sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show custom server details

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Calculate Service billing

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
campaign_uuid
string = 36 characters
location_uuid
required
string = 36 characters
pay_currency
string
Enum: "bonus" "main" "vk_rub"
pay_day
integer [ 1 .. 28 ]
price_plan_uuid
required
string = 36 characters
quantity
integer >= 1
Default: 1
Array of objects (ConfigCompactModel)
template_service_uuid
string = 36 characters

Responses

Request samples

Content type
application/json
{
  • "campaign_uuid": "00000000-0000-0000-A000-000000000000",
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_currency": "bonus",
  • "pay_day": 1,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1,
  • "config": [
    ],
  • "template_service_uuid": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Calculate Service resource upgrade billing

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
Array of objects (ConfigCompactModel)
resource_uuid
required
string = 36 characters

Responses

Request samples

Content type
application/json
{
  • "config": [
    ],
  • "resource_uuid": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List firewall services

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
is_hidden
boolean

hidden from view

sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show firewall service

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List network

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
is_hidden
boolean

hidden from view

state
string

billing state

sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show network details

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Calculate Service billing

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
campaign_uuid
string = 36 characters
location_uuid
required
string = 36 characters
pay_currency
string
Enum: "bonus" "main" "vk_rub"
pay_day
integer [ 1 .. 28 ]
price_plan_uuid
required
string = 36 characters
quantity
integer >= 1
Default: 1

Responses

Request samples

Content type
application/json
{
  • "campaign_uuid": "00000000-0000-0000-A000-000000000000",
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_currency": "bonus",
  • "pay_day": 1,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List network equipment services

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
is_hidden
boolean

hidden from view

sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show network equipment service

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List port services

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
is_hidden
boolean

hidden from view

sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show port service

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Calculate Service billing

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
campaign_uuid
string = 36 characters
location_uuid
required
string = 36 characters
pay_currency
string
Enum: "bonus" "main" "vk_rub"
pay_day
integer [ 1 .. 28 ]
price_plan_uuid
required
string = 36 characters
quantity
integer >= 1
Default: 1

Responses

Request samples

Content type
application/json
{
  • "campaign_uuid": "00000000-0000-0000-A000-000000000000",
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_currency": "bonus",
  • "pay_day": 1,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List servers

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
is_hidden
boolean

hidden from view

state
string

billing state

sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show server details

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Calculate Service billing

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
campaign_uuid
string = 36 characters
location_uuid
required
string = 36 characters
pay_currency
string
Enum: "bonus" "main" "vk_rub"
pay_day
integer [ 1 .. 28 ]
price_plan_uuid
required
string = 36 characters
quantity
integer >= 1
Default: 1

Responses

Request samples

Content type
application/json
{
  • "campaign_uuid": "00000000-0000-0000-A000-000000000000",
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_currency": "bonus",
  • "pay_day": 1,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List chipcore servers

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
is_hidden
boolean

hidden from view

sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show chipcore server details

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Calculate Service billing

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
campaign_uuid
string = 36 characters
location_uuid
required
string = 36 characters
pay_currency
string
Enum: "bonus" "main" "vk_rub"
pay_day
integer [ 1 .. 28 ]
price_plan_uuid
required
string = 36 characters
quantity
integer >= 1
Default: 1

Responses

Request samples

Content type
application/json
{
  • "campaign_uuid": "00000000-0000-0000-A000-000000000000",
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_currency": "bonus",
  • "pay_day": 1,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get service tag catalog list

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get tag from service tag catalog

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show service details

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Calculate Service resource billing

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
pay_day
integer [ 1 .. 28 ]
price_plan_uuid
required
string = 36 characters
resource_uuid
required
string = 36 characters

Responses

Request samples

Content type
application/json
{
  • "pay_day": 1,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "resource_uuid": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Calculate Service additional resource billing

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
quantity
integer >= 1
Default: 1
resource_uuid
required
string = 36 characters

Responses

Request samples

Content type
application/json
{
  • "quantity": 1,
  • "resource_uuid": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Price Plans

Price plan namespace

List price plans

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show price plan details

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Resources

Managing dedicated server resources: creating and ordering servers, billing operations, tagging for organization, resource information retrieval, upgrades, and more.

List resources

List resources.

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
blockstorage_local_connect_ready
boolean

If true, filters servers ready to connect to blockstorage by local network.

blockstorage_connect_ready
boolean

If true, filters servers ready to connect to blockstorage.

resource_tag_id
integer

Resource tag identifier.

limit
integer

Limit of results per pagination page.

page
integer

Pagination page number.

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get client billing information

Get client billing information.

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Cancel resource

Manage resource billing operations.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
immediately
required
boolean

If false, disable auto-renewal (resource runs until period end). If true, cancel at current month end with refund for unused days.

Responses

Request samples

Content type
application/json
{
  • "immediately": false
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": { },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Restore resource

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
next_price_plan_uuid
required
string = 36 characters

Next price plan identifier.

Responses

Request samples

Content type
application/json
{
  • "next_price_plan_uuid": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create colocation resource

Manage colocation resource billing.

Authorizations:
iam_token_account_scopediam_token_project_scoped
Request Body schema: application/json
required
location_uuid
required
string = 36 characters

Network pool identifier for the resource.

pay_day
integer [ 1 .. 28 ]

Payment day of month.

price_plan_uuid
required
string = 36 characters

Price plan identifier.

quantity
integer [ 1 .. 500 ]
Default: 1

Number of resource units.

service_uuid
required
string = 36 characters

Service identifier.

sync_key
string = 36 characters

Synchronization key.

user_desc
string

Custom name assigned to the resource by the user.

extra_period
integer >= 0
Default: 0

Prepayment for base plan period.

pay_currency
required
string
Enum: "bonus" "main" "vk_rub"

Billing account type for debiting funds.

ip_list
Array of strings[ items [ 6 .. 43 ] characters ]

IP list for servers.

limit_type
string
Enum: "speed" "traffic"

Network limit type.

sn
required
string

Serial number.

Responses

Request samples

Content type
application/json
{
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_day": 0,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1,
  • "service_uuid": "00000000-0000-0000-A000-000000000000",
  • "sync_key": "00000000-0000-0000-A000-000000000000",
  • "user_desc": "string",
  • "extra_period": 0,
  • "pay_currency": "bonus",
  • "ip_list": [
    ],
  • "limit_type": "speed",
  • "sn": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create server custom resource

Manage server custom resource billing.

Authorizations:
iam_token_account_scopediam_token_project_scoped
Request Body schema: application/json
required
location_uuid
required
string = 36 characters

Network pool identifier for the resource.

pay_day
integer [ 1 .. 28 ]

Payment day of month.

price_plan_uuid
required
string = 36 characters

Price plan identifier.

quantity
integer [ 1 .. 500 ]
Default: 1

Number of resource units.

service_uuid
required
string = 36 characters

Service identifier.

sync_key
string = 36 characters

Synchronization key.

user_desc
required
string

Custom name assigned to the resource by the user.

ipv4_address
string [ 6 .. 43 ] characters
ipv4_gateway
string [ 6 .. 43 ] characters
ipv4_netmask
string [ 6 .. 43 ] characters
local_ipv4_address
string [ 6 .. 43 ] characters
local_ipv4_gateway
string [ 6 .. 43 ] characters
local_ipv4_netmask
string [ 6 .. 43 ] characters
ipv6_address
string [ 6 .. 43 ] characters
ipv6_gateway
string [ 6 .. 43 ] characters
ipv6_netmask
string [ 6 .. 43 ] characters
local_ipv6_address
string [ 6 .. 43 ] characters
local_ipv6_gateway
string [ 6 .. 43 ] characters
local_ipv6_netmask
string [ 6 .. 43 ] characters
arch
required
string
cloud_init_meta_data
string or null
cloud_init_user_data
string or null
is_password_deleted
boolean or null
os_template
required
string
user_script
string or null
user_ssh_key
string
userhostname
required
string
version
required
string
Array of objects (PartitionUpdateModel)

List of partitions. Template version v1 only.

object

Full partitions configuration. Template version v2 only.

raid_type
string

Configuration type of disks. Template version v1 only.

password
string

Password for OS. Auto-generated if the field don't exists.

extra_period
integer >= 0
Default: 0

Prepayment for base plan period.

pay_currency
required
string
Enum: "bonus" "main" "vk_rub"

Billing account type for debiting funds.

campaign_uuid
string = 36 characters

Campaign identifier.

ip_list
Array of strings[ items [ 6 .. 43 ] characters ]

IP list for servers.

limit_type
string
Enum: "speed" "traffic"

Network limit type.

client_comment
string

Client comment.

Array of objects (ConfigCompactModel)

Hardware configuration.

raid_support_esxi
boolean

If true, install RAID controller compatible with ESXi.

reassembly_ram
boolean

If true, RAM reassembly is required.

template_service_uuid
string = 36 characters

Template service identifier.

Responses

Request samples

Content type
application/json
{
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_day": 0,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1,
  • "service_uuid": "00000000-0000-0000-A000-000000000000",
  • "sync_key": "00000000-0000-0000-A000-000000000000",
  • "user_desc": "string",
  • "ipv4_address": "10.0.0.0",
  • "ipv4_gateway": "10.0.0.0",
  • "ipv4_netmask": "255.255.255.248",
  • "local_ipv4_address": "10.0.0.0",
  • "local_ipv4_gateway": "10.0.0.0",
  • "local_ipv4_netmask": "255.255.255.248",
  • "ipv6_address": "fec0::0001",
  • "ipv6_gateway": "fec0::0001",
  • "ipv6_netmask": "ffff:ffff:ffff::",
  • "local_ipv6_address": "fec0::0001",
  • "local_ipv6_gateway": "fec0::0001",
  • "local_ipv6_netmask": "ffff:ffff:ffff::",
  • "arch": "x86_64",
  • "cloud_init_meta_data": "string",
  • "cloud_init_user_data": "string",
  • "is_password_deleted": true,
  • "os_template": "ubuntu",
  • "user_script": "string",
  • "user_ssh_key": "string",
  • "userhostname": "string",
  • "version": "16.04",
  • "partitions": [
    ],
  • "partitions_config": {
    },
  • "raid_type": "noraid",
  • "password": "string",
  • "extra_period": 0,
  • "pay_currency": "bonus",
  • "campaign_uuid": "00000000-0000-0000-A000-000000000000",
  • "ip_list": [
    ],
  • "limit_type": "speed",
  • "client_comment": "string",
  • "config": [
    ],
  • "raid_support_esxi": true,
  • "reassembly_ram": true,
  • "template_service_uuid": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create firewall resource

Manage firewall resource billing.

Authorizations:
iam_token_account_scopediam_token_project_scoped
Request Body schema: application/json
required
location_uuid
required
string = 36 characters

Network pool identifier for the resource.

pay_day
integer [ 1 .. 28 ]

Payment day of month.

price_plan_uuid
required
string = 36 characters

Price plan identifier.

quantity
integer [ 1 .. 500 ]
Default: 1

Number of resource units.

service_uuid
required
string = 36 characters

Service identifier.

sync_key
string = 36 characters

Synchronization key.

user_desc
string

Custom name assigned to the resource by the user.

extra_period
integer >= 0
Default: 0

Prepayment for base plan period.

pay_currency
required
string
Enum: "bonus" "main" "vk_rub"

Billing account type for debiting funds.

object

Additional firewall configuration.

limit_type
string
Enum: "speed" "traffic"

Network limit type.

Responses

Request samples

Content type
application/json
{
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_day": 0,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1,
  • "service_uuid": "00000000-0000-0000-A000-000000000000",
  • "sync_key": "00000000-0000-0000-A000-000000000000",
  • "user_desc": "string",
  • "extra_period": 0,
  • "pay_currency": "bonus",
  • "extra_content": {
    },
  • "limit_type": "speed"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List resource by rack layout

List resource by rack layout.

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create network resource

Manage network resource billing.

Authorizations:
iam_token_account_scopediam_token_project_scoped
Request Body schema: application/json
required
location_uuid
required
string = 36 characters

Network pool identifier for the resource.

pay_day
integer [ 1 .. 28 ]

Payment day of month.

price_plan_uuid
required
string = 36 characters

Price plan identifier.

quantity
integer [ 1 .. 500 ]
Default: 1

Number of resource units.

service_uuid
required
string = 36 characters

Service identifier.

sync_key
string = 36 characters

Synchronization key.

user_desc
string

Custom name assigned to the resource by the user.

extra_period
integer >= 0
Default: 0

Prepayment for base plan period.

pay_currency
required
string
Enum: "bonus" "main" "vk_rub"

Billing account type for debiting funds.

extra_context
object

Additional context data.

Responses

Request samples

Content type
application/json
{
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_day": 0,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1,
  • "service_uuid": "00000000-0000-0000-A000-000000000000",
  • "sync_key": "00000000-0000-0000-A000-000000000000",
  • "user_desc": "string",
  • "extra_period": 0,
  • "pay_currency": "bonus",
  • "extra_context": { }
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List orders by year

List orders by year.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
year
required
integer

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create port resource

Manage port resource billing.

Authorizations:
iam_token_account_scopediam_token_project_scoped
Request Body schema: application/json
required
location_uuid
required
string = 36 characters

Network pool identifier for the resource.

pay_day
integer [ 1 .. 28 ]

Payment day of month.

price_plan_uuid
required
string = 36 characters

Price plan identifier.

quantity
integer [ 1 .. 500 ]
Default: 1

Number of resource units.

service_uuid
required
string = 36 characters

Service identifier.

sync_key
string = 36 characters

Synchronization key.

user_desc
string

Custom name assigned to the resource by the user.

extra_period
integer >= 0
Default: 0

Prepayment for base plan period.

pay_currency
required
string
Enum: "bonus" "main" "vk_rub"

Billing account type for debiting funds.

extra_context
object

Additional context data.

Responses

Request samples

Content type
application/json
{
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_day": 0,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1,
  • "service_uuid": "00000000-0000-0000-A000-000000000000",
  • "sync_key": "00000000-0000-0000-A000-000000000000",
  • "user_desc": "string",
  • "extra_period": 0,
  • "pay_currency": "bonus",
  • "extra_context": { }
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create server resource

Manage server resource billing.

Authorizations:
iam_token_account_scopediam_token_project_scoped
Request Body schema: application/json
required
location_uuid
required
string = 36 characters

Network pool identifier for the resource.

pay_day
integer [ 1 .. 28 ]

Payment day of month.

price_plan_uuid
required
string = 36 characters

Price plan identifier.

quantity
integer [ 1 .. 500 ]
Default: 1

Number of resource units.

service_uuid
required
string = 36 characters

Service identifier.

sync_key
string = 36 characters

Synchronization key.

user_desc
required
string

Custom name assigned to the resource by the user.

ipv4_address
string [ 6 .. 43 ] characters
ipv4_gateway
string [ 6 .. 43 ] characters
ipv4_netmask
string [ 6 .. 43 ] characters
local_ipv4_address
string [ 6 .. 43 ] characters
local_ipv4_gateway
string [ 6 .. 43 ] characters
local_ipv4_netmask
string [ 6 .. 43 ] characters
ipv6_address
string [ 6 .. 43 ] characters
ipv6_gateway
string [ 6 .. 43 ] characters
ipv6_netmask
string [ 6 .. 43 ] characters
local_ipv6_address
string [ 6 .. 43 ] characters
local_ipv6_gateway
string [ 6 .. 43 ] characters
local_ipv6_netmask
string [ 6 .. 43 ] characters
arch
required
string
cloud_init_meta_data
string or null
cloud_init_user_data
string or null
is_password_deleted
boolean or null
os_template
required
string
user_script
string or null
user_ssh_key
string
userhostname
required
string
version
required
string
Array of objects (PartitionUpdateModel)

List of partitions. Template version v1 only.

object

Full partitions configuration. Template version v2 only.

raid_type
string

Configuration type of disks. Template version v1 only.

password
string

Password for OS. Auto-generated if the field don't exists.

extra_period
integer >= 0
Default: 0

Prepayment for base plan period.

pay_currency
required
string
Enum: "bonus" "main" "vk_rub"

Billing account type for debiting funds.

campaign_uuid
string = 36 characters

Campaign identifier.

ip_list
Array of strings[ items [ 6 .. 43 ] characters ]

IP list for servers.

limit_type
string
Enum: "speed" "traffic"

Network limit type.

local_ip_list
Array of strings[ items [ 6 .. 43 ] characters ]

Local IP list for servers.

local_subnet_uuid
string = 36 characters

Local subnet identifier.

Responses

Request samples

Content type
application/json
{
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_day": 0,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1,
  • "service_uuid": "00000000-0000-0000-A000-000000000000",
  • "sync_key": "00000000-0000-0000-A000-000000000000",
  • "user_desc": "string",
  • "ipv4_address": "10.0.0.0",
  • "ipv4_gateway": "10.0.0.0",
  • "ipv4_netmask": "255.255.255.248",
  • "local_ipv4_address": "10.0.0.0",
  • "local_ipv4_gateway": "10.0.0.0",
  • "local_ipv4_netmask": "255.255.255.248",
  • "ipv6_address": "fec0::0001",
  • "ipv6_gateway": "fec0::0001",
  • "ipv6_netmask": "ffff:ffff:ffff::",
  • "local_ipv6_address": "fec0::0001",
  • "local_ipv6_gateway": "fec0::0001",
  • "local_ipv6_netmask": "ffff:ffff:ffff::",
  • "arch": "x86_64",
  • "cloud_init_meta_data": "string",
  • "cloud_init_user_data": "string",
  • "is_password_deleted": true,
  • "os_template": "ubuntu",
  • "user_script": "string",
  • "user_ssh_key": "string",
  • "userhostname": "string",
  • "version": "16.04",
  • "partitions": [
    ],
  • "partitions_config": {
    },
  • "raid_type": "noraid",
  • "password": "string",
  • "extra_period": 0,
  • "pay_currency": "bonus",
  • "campaign_uuid": "00000000-0000-0000-A000-000000000000",
  • "ip_list": [
    ],
  • "limit_type": "speed",
  • "local_ip_list": [
    ],
  • "local_subnet_uuid": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create serverchip resource

Manage serverchip resource billing.

Authorizations:
iam_token_account_scopediam_token_project_scoped
Request Body schema: application/json
required
location_uuid
required
string = 36 characters

Network pool identifier for the resource.

pay_day
integer [ 1 .. 28 ]

Payment day of month.

price_plan_uuid
required
string = 36 characters

Price plan identifier.

quantity
integer [ 1 .. 500 ]
Default: 1

Number of resource units.

service_uuid
required
string = 36 characters

Service identifier.

sync_key
string = 36 characters

Synchronization key.

user_desc
required
string

Custom name assigned to the resource by the user.

ipv4_address
string [ 6 .. 43 ] characters
ipv4_gateway
string [ 6 .. 43 ] characters
ipv4_netmask
string [ 6 .. 43 ] characters
local_ipv4_address
string [ 6 .. 43 ] characters
local_ipv4_gateway
string [ 6 .. 43 ] characters
local_ipv4_netmask
string [ 6 .. 43 ] characters
ipv6_address
string [ 6 .. 43 ] characters
ipv6_gateway
string [ 6 .. 43 ] characters
ipv6_netmask
string [ 6 .. 43 ] characters
local_ipv6_address
string [ 6 .. 43 ] characters
local_ipv6_gateway
string [ 6 .. 43 ] characters
local_ipv6_netmask
string [ 6 .. 43 ] characters
arch
required
string
cloud_init_meta_data
string or null
cloud_init_user_data
string or null
is_password_deleted
boolean or null
os_template
required
string
user_script
string or null
user_ssh_key
string
userhostname
required
string
version
required
string
Array of objects (PartitionUpdateModel)

List of partitions. Template version v1 only.

object

Full partitions configuration. Template version v2 only.

raid_type
string

Configuration type of disks. Template version v1 only.

password
string

Password for OS. Auto-generated if the field don't exists.

extra_period
integer >= 0
Default: 0

Prepayment for base plan period.

pay_currency
required
string
Enum: "bonus" "main" "vk_rub"

Billing account type for debiting funds.

campaign_uuid
string = 36 characters

Campaign identifier.

ip_list
Array of strings[ items [ 6 .. 43 ] characters ]

IP list for servers.

limit_type
string
Enum: "speed" "traffic"

Network limit type.

Responses

Request samples

Content type
application/json
{
  • "location_uuid": "00000000-0000-0000-A000-000000000000",
  • "pay_day": 0,
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "quantity": 1,
  • "service_uuid": "00000000-0000-0000-A000-000000000000",
  • "sync_key": "00000000-0000-0000-A000-000000000000",
  • "user_desc": "string",
  • "ipv4_address": "10.0.0.0",
  • "ipv4_gateway": "10.0.0.0",
  • "ipv4_netmask": "255.255.255.248",
  • "local_ipv4_address": "10.0.0.0",
  • "local_ipv4_gateway": "10.0.0.0",
  • "local_ipv4_netmask": "255.255.255.248",
  • "ipv6_address": "fec0::0001",
  • "ipv6_gateway": "fec0::0001",
  • "ipv6_netmask": "ffff:ffff:ffff::",
  • "local_ipv6_address": "fec0::0001",
  • "local_ipv6_gateway": "fec0::0001",
  • "local_ipv6_netmask": "ffff:ffff:ffff::",
  • "arch": "x86_64",
  • "cloud_init_meta_data": "string",
  • "cloud_init_user_data": "string",
  • "is_password_deleted": true,
  • "os_template": "ubuntu",
  • "user_script": "string",
  • "user_ssh_key": "string",
  • "userhostname": "string",
  • "version": "16.04",
  • "partitions": [
    ],
  • "partitions_config": {
    },
  • "raid_type": "noraid",
  • "password": "string",
  • "extra_period": 0,
  • "pay_currency": "bonus",
  • "campaign_uuid": "00000000-0000-0000-A000-000000000000",
  • "ip_list": [
    ],
  • "limit_type": "speed"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List user tags

List user tags

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
limit
integer

Limit of results per pagination page.

page
integer

Pagination page number.

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create user tag

Authorizations:
iam_token_account_scopediam_token_project_scoped
Request Body schema: application/json
required
name
required
string <= 64 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Delete user tag

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Update user tag

Manage individual user tags.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
name
required
string <= 64 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Update resource project

Update resource project assignment.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string
Request Body schema: application/json
required
project_uuid
required
string

Responses

Request samples

Content type
application/json
{
  • "project_uuid": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create resource custom upgrade

Manage custom resource upgrades.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string
Request Body schema: application/json
required
auto_controller_links
boolean

If true, automatically configure disk connection links.

Array of objects (ConfigCompactModel)
pay_currency
required
string
Enum: "bonus" "main" "vk_rub"

Billing account type for debiting funds.

Responses

Request samples

Content type
application/json
{
  • "auto_controller_links": true,
  • "config": [
    ],
  • "pay_currency": "bonus"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create resource prebuilt upgrade

Manage prebuilt resource upgrades.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string
Request Body schema: application/json
required
resource_uuid
required
string = 36 characters
ticket_text
required
string

Responses

Request samples

Content type
application/json
{
  • "resource_uuid": "00000000-0000-0000-A000-000000000000",
  • "ticket_text": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get resource

Get resource.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Update resource

Update resource.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
price_plan_uuid
string = 36 characters

Price plan identifier.

user_desc
string

Custom name assigned to the resource by the user.

Responses

Request samples

Content type
application/json
{
  • "price_plan_uuid": "00000000-0000-0000-A000-000000000000",
  • "user_desc": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create additional resource

Manage additional resource billing.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
demo
boolean
Default: false

If true, demo mode.

pay_currency
required
string
Enum: "bonus" "main" "vk_rub"

Billing account type for debiting funds.

quantity
integer [ 1 .. 10000 ]
Default: 1

Number of units.

service_uuid
required
string = 36 characters

Service identifier.

sync_key
string = 36 characters

Synchronization key.

Responses

Request samples

Content type
application/json
{
  • "demo": false,
  • "pay_currency": "bonus",
  • "quantity": 1,
  • "service_uuid": "00000000-0000-0000-A000-000000000000",
  • "sync_key": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create additional resource list

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
extra_context
object

Additional context data.

pay_currency
required
string
Enum: "bonus" "main" "vk_rub"

Billing account type for debiting funds.

Array of objects (ResourceStartAdditionalNestedModel)

List of additional services.

sync_key
string = 36 characters

Synchronization key.

Responses

Request samples

Content type
application/json
{
  • "extra_context": { },
  • "pay_currency": "bonus",
  • "services": [
    ],
  • "sync_key": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List resource compensation

List resource compensation.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "comment": "string",
  • "is_applied": true,
  • "month": 0,
  • "start": 0,
  • "stop": 0,
  • "year": 0
}

Get colocation resource information

Get colocation resource information.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Update colocation resource information

Update colocation resource information.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
cpu
string
disk
string
ram
string

Responses

Request samples

Content type
application/json
{
  • "cpu": "string",
  • "disk": "string",
  • "ram": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get custom resource information

Get custom resource information.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get network equipment resource information

Get network equipment resource information.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get port resource information

Get port resource information.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get server resource information

Get server resource information.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get serverchip resource information

Get serverchip resource information.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Update resource tags

Manage resource tags.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
tags
Array of strings [ 0 .. 10 ] items [ items <= 64 characters ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Power Manager

Power Manager namespace

Show server power state

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Set server power state

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string
Request Body schema: application/json
required
power_state
required
boolean

Responses

Request samples

Content type
application/json
{
  • "power_state": true
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": { },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show server console

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Set server console resolution

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string
Request Body schema: application/json
required
height
number
width
number

Responses

Request samples

Content type
application/json
{
  • "height": 0,
  • "width": 0
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": { },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Reboot server

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string
Request Body schema: application/json
required
reboot
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "reboot": true
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": { },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Boot Manager

Resource Boot Manager

Show server boot details

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Set server boot template

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string
Request Body schema: application/json
required
ip_address_uuid
string = 36 characters
name
required
string
password
string
reboot
boolean

Responses

Request samples

Content type
application/json
{
  • "ip_address_uuid": "00000000-0000-0000-A000-000000000000",
  • "name": "string",
  • "password": "string",
  • "reboot": true
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show server OS details

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Reinstall OS from current configuration

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string
Request Body schema: application/json
required
reinstall
integer

Responses

Request samples

Content type
application/json
{
  • "reinstall": 0
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Install server new OS configuration

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string
Request Body schema: application/json
required
ipv4_address
string [ 6 .. 43 ] characters
ipv4_gateway
string [ 6 .. 43 ] characters
ipv4_netmask
string [ 6 .. 43 ] characters
local_ipv4_address
string [ 6 .. 43 ] characters
local_ipv4_gateway
string [ 6 .. 43 ] characters
local_ipv4_netmask
string [ 6 .. 43 ] characters
ipv6_address
string [ 6 .. 43 ] characters
ipv6_gateway
string [ 6 .. 43 ] characters
ipv6_netmask
string [ 6 .. 43 ] characters
local_ipv6_address
string [ 6 .. 43 ] characters
local_ipv6_gateway
string [ 6 .. 43 ] characters
local_ipv6_netmask
string [ 6 .. 43 ] characters
arch
required
string
cloud_init_meta_data
string or null
cloud_init_user_data
string or null
is_password_deleted
boolean or null
os_template
required
string
user_script
string or null
user_ssh_key
string
userhostname
required
string
version
required
string
Array of objects (PartitionUpdateModel)

List of partitions. Template version v1 only.

object

Full partitions configuration. Template version v2 only.

raid_type
string

Configuration type of disks. Template version v1 only.

password
string

Password for OS

reset_local_address
boolean

Responses

Request samples

Content type
application/json
{
  • "ipv4_address": "10.0.0.0",
  • "ipv4_gateway": "10.0.0.0",
  • "ipv4_netmask": "255.255.255.248",
  • "local_ipv4_address": "10.0.0.0",
  • "local_ipv4_gateway": "10.0.0.0",
  • "local_ipv4_netmask": "255.255.255.248",
  • "ipv6_address": "fec0::0001",
  • "ipv6_gateway": "fec0::0001",
  • "ipv6_netmask": "ffff:ffff:ffff::",
  • "local_ipv6_address": "fec0::0001",
  • "local_ipv6_gateway": "fec0::0001",
  • "local_ipv6_netmask": "ffff:ffff:ffff::",
  • "arch": "x86_64",
  • "cloud_init_meta_data": "string",
  • "cloud_init_user_data": "string",
  • "is_password_deleted": true,
  • "os_template": "ubuntu",
  • "user_script": "string",
  • "user_ssh_key": "string",
  • "userhostname": "string",
  • "version": "16.04",
  • "partitions": [
    ],
  • "partitions_config": {
    },
  • "raid_type": "noraid",
  • "password": "string",
  • "reset_local_address": true
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show server OS password

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Available local drives for partition configuration

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
service_uuid
string

UUID of a service

resource_uuid
string

UUID of a resource

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Available local drives for order custom server

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
service_uuid
string

UUID of a service

resource_uuid
string

UUID of a resource

Request Body schema: application/json
required
object (PartitionsCustomConfiguration)
resource_uuid
string
service_uuid
string

Responses

Request samples

Content type
application/json
{
  • "custom_config": {
    },
  • "resource_uuid": "string",
  • "service_uuid": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Validate partitions config for OS

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
service_uuid
string

UUID of the service

resource_uuid
string

UUID of the resource

Request Body schema: application/json
required
object

Configuration of custom hardware. Used when checking partitions.

os
string

Name of OS family

os_arch
string

Architecture of the operation system

os_version
string

Version of the operation system

required
object

Partitions config to validate

template_version
string^v\d+$

Version of the config. Only v2 supported

Responses

Request samples

Content type
application/json
{
  • "hardware_config": {
    },
  • "os": "Ubuntu",
  • "os_arch": "x86",
  • "os_version": "string",
  • "partitions_config": {
    },
  • "template_version": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List boot templates

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
service_uuid
string

Service is used to filter available device templates

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List OS configurations

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
location_uuid
string

Location is used to filter available os templates

service_uuid
string

Service is used to filter available os templates

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List OS configurations

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
location_uuid
string

Location is used to filter available os templates

service_uuid
string

Service is used to filter available os templates

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Events

Events namespace

List events

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
action_name
string

Action name

item_name
string

Item name

item_uuid
string

Items per page

request_uuid
string

Staff id

limit
integer

Items per page

page
integer

Page number

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Tasks

Tasks namespace

Show task details

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": { },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Network Management API

Managing networks, subnets, and IP addresses: creating and configuring networks, allocating and releasing IPs, managing local subnets and local IPs, configuring network limits, managing ports and basic firewall rules, and more.

List networks

Returns a list of networks with optional filtering by resource, location, or shared status.

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
is_shared
boolean

If true, filters shared networks.

location_uuid
string

Universally unique identifier (UUID) of the location to filter networks.

resource_uuid
string

Universally unique identifier (UUID) of the resource. Filters networks that have IP addresses allocated for the specified resource.

limit
integer

Limit of results per pagination page.

page
integer

Pagination page number.

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List IP addresses

Returns a list of IP addresses with optional filtering by location, subnet, network, owner, or shared status.

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
is_shared
boolean

If true, filters IP addresses only from shared networks, otherwise filters only from dedicated networks.

owner_id
integer

Owner identifier to filter IP addresses.

network_uuid
string

Universally unique identifier (UUID) of the network to filter IP addresses.

subnet_uuid
string

Universally unique identifier (UUID) of the subnet to filter IP addresses.

location_uuid
string

Universally unique identifier (UUID) of the location to filter IP addresses.

limit
integer

Limit of results per pagination page.

page
integer

Pagination page number.

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Release IP address

Releases the specified IP address from the subnet.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
resource_uuid
required
string = 36 characters

Resource identifier to release the IP address from.

Responses

Request samples

Content type
application/json
{
  • "resource_uuid": "00000000-0000-0000-A000-000000000000"
}

Get IP address

Returns information about the specified IP address.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List local IP addresses

Returns a list of local IP addresses with optional filtering by location, subnet, or network.

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
network_uuid
string

Universally unique identifier (UUID) of the network to filter local IP addresses.

subnet_uuid
string

Universally unique identifier (UUID) of the subnet to filter local IP addresses.

location_uuid
string

Universally unique identifier (UUID) of the location to filter local IP addresses.

limit
integer

Limit of results per pagination page.

page
integer

Pagination page number.

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "project_uuid": "00000000-0000-0000-A000-000000000000",
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Release local IP address

Releases the specified local IP address from the subnet.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
resource_uuid
required
string = 36 characters

Resource identifier to release the local IP address from.

Responses

Request samples

Content type
application/json
{
  • "resource_uuid": "00000000-0000-0000-A000-000000000000"
}

Get local IP address

Returns information about the specified local IP address.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List local subnets

Returns a list of local subnets.

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create local subnet

Creates a new local subnet.

Authorizations:
iam_token_account_scopediam_token_project_scoped
Request Body schema: application/json
required
network_uuid
required
string = 36 characters

Network identifier.

owner_id
integer

Owner identifier.

subnet_address
required
string [ 9 .. 18 ] characters

IPv4 subnet address in CIDR notation.

Responses

Request samples

Content type
application/json
{
  • "network_uuid": "00000000-0000-0000-A000-000000000000",
  • "owner_id": 0,
  • "subnet_address": "10.0.0.0/29"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List local IP addresses in subnet

Returns a list of local IP addresses in the specified subnet.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
subnet_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "project_uuid": "00000000-0000-0000-A000-000000000000",
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Allocate local IP address

Allocates a new local IP address in the specified subnet.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
subnet_uuid
required
string
Request Body schema: application/json
required
comment
string

Optional comment.

ip
string [ 6 .. 43 ] characters

Specific local IP address to allocate. If not specified, the next available IP will be allocated.

resource_uuid
string = 36 characters

Resource identifier to allocate the local IP address to.

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "ip": "10.0.64.11",
  • "resource_uuid": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Release local subnet

Releases the specified local subnet.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
object (LocalSubnetRemoveModel)

Responses

Request samples

Content type
application/json
{ }

Get local subnet

Returns information about the specified local subnet.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List master subnets

Returns a list of master subnets.

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List IP addresses in subnet

Returns a list of IP addresses in the specified subnet.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
subnet_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Allocate IP address

Allocates a new IP address in the specified subnet.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
subnet_uuid
required
string
Request Body schema: application/json
required
ip
string [ 6 .. 43 ] characters

Specific IP address to allocate. If not specified, the next available IP will be allocated.

resource_uuid
required
string = 36 characters

Resource identifier to allocate the IP address to.

Responses

Request samples

Content type
application/json
{
  • "ip": "10.0.64.11",
  • "resource_uuid": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get subnet

Returns information about the specified subnet.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Set reserved VRRP addresses

Sets reserved VRRP addresses for the specified subnet.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
reserved_vrrp_ip
Array of strings = 2 items unique [ items [ 6 .. 43 ] characters ]

Two IPv4 addresses reserved for VRRP (exactly 2 required).

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List network limit types

Returns a list of available network limit types.

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get network limit

Returns network limit information for the specified resource.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Update network limit

Updates network limit for the specified resource.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
next_limit_type
string

Network limit type to be applied asynchronously.

Responses

Request samples

Content type
application/json
{
  • "next_limit_type": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List ports

Returns a list of ports.

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List ports for hardware

Returns ports associated with the specified hardware.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
hw_uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get port

Returns information about the specified port.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Apply port configuration

Applies network configuration to the specified port.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
network_uuid
Array of strings[ items = 36 characters ]

List of network identifiers to apply to the port.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List networks for port

Returns networks associated with the specified port.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get network

Returns information about the specified network.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Update network

Updates the specified network configuration.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
user_desc
string

User-defined network description.

Responses

Request samples

Content type
application/json
{
  • "user_desc": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Remove all basic firewall rules from network

Removes all basic firewall rules from the specified network.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": { },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get network basic firewall rules

Returns basic firewall rules for the specified network.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Apply basic firewall rules to network

Applies basic firewall rules to the specified network.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
name
string <= 255 characters

Firewall configuration name.

required
Array of objects (RuleModel)

List of firewall rules to apply.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Remove subnet from network

Removes a subnet from the specified network.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
subnet_uuid
required
string = 36 characters

Subnet identifier.

Responses

Request samples

Content type
application/json
{
  • "subnet_uuid": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Add subnet to network

Adds a subnet to the specified network.

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
subnet_uuid
required
string = 36 characters

Subnet identifier.

Responses

Request samples

Content type
application/json
{
  • "subnet_uuid": "00000000-0000-0000-A000-000000000000"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Consumption

Consumption of speed and traffic

Get Resource speed points

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string
query Parameters
local
string
Default: "false"
Enum: "true" "false"

Switch which port type needs to be shown

interval
string
Default: "min5"
Enum: "min5" "hour"

Interval to group points by

till
integer
Default: 1765443950

Time from which speed points will end, Unix timestamp

from
integer
Default: 1765440350

Time from which speed points will start, Unix timestamp

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get traffic consumption

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
resource_uuid
required
string
query Parameters
month
integer
Default: 12
Enum: 1 2 3 4 5 6 7 8 9 10 11 12

Month to which traffic will be calculated, integer

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Miscellaneous

Miscellaneous data

Get name list

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
tags
Array of strings

tags

limit
integer
Default: 10
page
integer
Default: 1
sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get name data

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get list of name's tags

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get random name

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
get_user_name
boolean
Default: false

flag: need to return one of user's name

tags
Array of strings

tags

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get tag list

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
limit
integer
Default: 10
page
integer
Default: 1
sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get tag data

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get list of tag's names

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get user name list

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
limit
integer
Default: 10
page
integer
Default: 1
sort
string
Default: "created"
Enum: "created" "name"
order
string
Default: "asc"
Enum: "desc" "asc"

Order direction: ["desc", "asc"]

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Create new user name

Authorizations:
iam_token_account_scopediam_token_project_scoped
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Delete user name

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": { },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Get user name data

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Update user name data

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Discount campaign

Discount campaign namespace

List discount campaigns

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
limit
integer

Items limit

page
integer

Page number

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List finished discount campaigns

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
limit
integer

Items limit

page
integer

Page number

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": [
    ],
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Show discount campaign details

Authorizations:
iam_token_account_scopediam_token_project_scoped
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

List special offers

Authorizations:
iam_token_account_scopediam_token_project_scoped
query Parameters
sort
string
Default: "name"
Enum: "name" "discount" "created" "updated"

Sorting params list

service_uuid
string

UUID of a service

limit
integer

Items limit

page
integer

Page number

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}

Block storage Manager

Block storage Manager

Get block storage flag value

Authorizations:
iam_token_account_scopediam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "execution_time": 0,
  • "item_count": 0,
  • "limit": 0,
  • "page": 0,
  • "progress": 0,
  • "result": {
    },
  • "status": "string",
  • "task_id": "00000000-0000-0000-A000-000000000000"
}