Update Existing Server

Update an existing server.

PUT /cabinet/admin/servers/{server_id}

Update Existing Server

cURL

curl --request PUT \
  --url https://api.example.com/cabinet/admin/servers/{server_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "description": "<string>",
  "country_code": "<string>",
  "is_available": true,
  "is_trial_eligible": true,
  "price_kopeks": 1,
  "max_users": 1,
  "sort_order": 1,
  "promo_group_ids": [
    123
  ]
}
'

200

{
  "id": 123,
  "squad_uuid": "<string>",
  "display_name": "<string>",
  "is_available": true,
  "is_trial_eligible": true,
  "price_kopeks": 123,
  "price_rubles": 123,
  "current_users": 123,
  "sort_order": 123,
  "is_full": true,
  "availability_status": "<string>",
  "promo_groups": [
    {
      "id": 123,
      "name": "<string>",
      "is_selected": false
    }
  ],
  "active_subscriptions": 123,
  "tariffs_using": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "original_name": "<string>",
  "country_code": "<string>",
  "description": "<string>",
  "max_users": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

server_id · integer · required

Body

application/json

Request to update a server.

display_name · string | null

Required string length: 1 - 255

description · string | null

country_code · string | null

Maximum string length: 5

is_available · boolean | null

is_trial_eligible · boolean | null

price_kopeks · integer | null

Required range: x >= 0

max_users · integer | null

Required range: x >= 0

sort_order · integer | null

Required range: x >= 0

promo_group_ids · integer[] | null

Response

200

application/json

Successful Response

Detailed server response.

id · integer · required

squad_uuid · string · required

display_name · string · required

is_available · boolean · required

is_trial_eligible · boolean · required

price_kopeks · integer · required

price_rubles · number · required

current_users · integer · required

sort_order · integer · required

is_full · boolean · required

availability_status · string · required

promo_groups · PromoGroupInfo · object[] · required

Show child attributes

active_subscriptions · integer · required

tariffs_using · string[] · required

created_at · string<date-time> · required

original_name · string | null

country_code · string | null

description · string | null

max_users · integer | null

updated_at · string<date-time> | null