Cloud Services Documentation

https://docs.selectel.ru/
Admin
This project provides comprehensive documentation for various cloud infrastructure services,...
Tokens:540,542
Snippets:3,453
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install OpenStack CLI and optional clients on Windows

Source: https://docs.selectel.ru/cloud-servers/tools/openstack-cli/configure-openstack-cli.md

Install OpenStack CLI on Windows, verify the installation, and optionally install Octavia, Glance, and Manila clients. The version output example shows the expected response format.

```bash
pip3 install python-openstackclient
```

```bash
openstack --version
```

```bash
openstack 6.1.0
```

```bash
pip3 install python-octaviaclient
```

```bash
pip3 install python-glanceclient
```

```bash
pip3 install python-manilaclient==3.4.0
```

--------------------------------

### Launch spider.jnlp with Java Web Start (macOS)

Source: https://docs.selectel.ru/dedicated/manage/ip-kvm.md

Launch the downloaded spider.jnlp file using Java Web Start. Replace <java_directory> with the Java installation directory and <downloads_directory> with the directory containing spider.jnlp.

```bash
<java_directory>/bin/javaws <downloads_directory> spider.jnlp
```

--------------------------------

### Install open-vm-tools with dnf

Source: https://docs.selectel.ru/public-cloud/manage-public-cloud/vmware-tools.md

Installs the open-vm-tools package on a Red Hat-based system using the dnf package manager. Run this command with sudo privileges.

```bash
sudo dnf install open-vm-tools
```

--------------------------------

### Start macOS launch agent for GeeseFS

Source: https://docs.selectel.ru/s3/tools/geesefs.md

Loads and starts the launch agent for automatic GeeseFS mounting on macOS. The commands bootstrap, enable, and kickstart the agent using the current user ID.

```bash
launchctl bootstrap gui/$(id -u) "$HOME/Library/LaunchAgents/<agent_name>.plist"
launchctl enable gui/$(id -u)/<agent_name>
launchctl kickstart -k gui/$(id -u)/<agent_name>
```

--------------------------------

### Data source selectel_cloudbackup_checkpoint_v2 example

Source: https://docs.selectel.ru/terraform/selectel-provider-reference/data-sources/cloudbackup_checkpoint_v2.md

Use this data source to retrieve a list of backup checkpoints for Selectel Backups in the Cloud. The example filters checkpoints by backup plan name and volume name within a specified project and region.

```hcl
data "selectel_cloudbackup_checkpoint_v2" "checkpoint_1" {
  project_id = selectel_vpc_project_v2.project_1.id
  region     = "ru-3"
  filter {
    plan_name   = "my-backup-plan"
    volume_name = "my-volume"
  }
}
```

--------------------------------

### Get node response example

Source: https://docs.selectel.ru/api/managed-kubernetes-legacy.json

Example response for the get node operation, showing the node object with id, timestamps, hostname, IP, nodegroup_id, and os_server_id.

```json
{
    "node": {
        "id": "94838b31-9ae0-4a23-88ad-256e4f13d345",
        "created_at": "2019-11-05T15:08:23.672122Z",
        "updated_at": "2019-11-06T10:50:39.31144Z",
        "hostname": "first-node",
        "ip": "198.51.100.101",
        "nodegroup_id": "63ed5342-b22c-4c7a-9d41-c1fe4a142c13",
        "os_server_id": "1821e0ef-cd77-4fea-bd39-5b1f470368b5"
    }
}
```

--------------------------------

### Boot Instance, Create Volume, and Attach Volume as a Block Device

Source: https://docs.selectel.ru/terraform/openstack-provider-reference/compute-nova/resources/openstack_compute_instance_v2.md

Boots an instance from an image on local storage and creates a blank volume attached as a block device.

```hcl
resource "openstack_compute_instance_v2" "instance_1" {
  name            = "instance_1"
  image_id        = "<image-id>"
  flavor_id       = "1311"
  key_pair        = "<key-pair-name>"

  block_device {
    uuid                  = "<image-id>"
    source_type           = "image"
    destination_type      = "local"
    boot_index            = 0
    delete_on_termination = true
  }

  block_device {
    source_type           = "blank"
    destination_type      = "volume"
    volume_size           = 5
    boot_index            = 1
    delete_on_termination = true
  }
}
```

--------------------------------

### Boot Instance and Attach Existing Volume as a Block Device

Source: https://docs.selectel.ru/terraform/openstack-provider-reference/compute-nova/resources/openstack_compute_instance_v2.md

Boots an instance from an image on local storage and attaches an existing volume as a block device.

```hcl
resource "openstack_blockstorage_volume_v3" "volume_1" {
  name = "volume_1"
  size = 1
}

resource "openstack_compute_instance_v2" "instance_1" {
  name            = "instance_1"
  image_id        = "<image-id>"
  flavor_id       = "1311"
  key_pair        = "<key-pair-name>"

  block_device {
    uuid                  = "<image-id>"
    source_type           = "image"
    destination_type      = "local"
    boot_index            = 0
    delete_on_termination = true
  }

  block_device {
    uuid                  = openstack_blockstorage_volume_v3.volume_1.id
    source_type           = "volume"
    destination_type      = "volume"
    boot_index            = 1
    delete_on_termination = true
  }
}
```

--------------------------------

### POST /boot/os/{resource_uuid}

Source: https://docs.selectel.ru/api/dedicated.json

Installs a new operating system configuration on the server.

```APIDOC
## POST /boot/os/{resource_uuid}

### Description
Installs a new operating system configuration on the server.

### Method
POST

### Endpoint
/boot/os/{resource_uuid}

### Parameters
#### Path Parameters
- **resource_uuid** (string) - Required - The unique identifier of the server resource.

#### Request Body
- **payload** (OSConfigInput) - Required - The operating system configuration to install.

### Request Example
{
  "payload": {
    "$ref": "#/definitions/OSConfigInput"
  }
}

### Response
#### Success Response (200)
- Operating system configuration has been installed.

#### Response Example
{
  "schema": {
    "$ref": "#/definitions/ResponseOSConfig"
  }
}
```

--------------------------------

### Example response for GET /clusters/{cluster_id}/tasks/{task_id}

Source: https://docs.selectel.ru/api/managed-kubernetes-legacy.json

Example JSON response returned by the getTask operation. Shows a single task object with additional task_data fields such as location_name, service_uuid, and nodegroup_type.

```json
{
    "task": {
        "id": "aaa350dc-bbc2-442b-8d53-788d45b68728",
        "started_at": "2019-11-04T12:54:20.784887Z",
        "updated_at": "2019-11-04T13:00:08.782731Z",
        "cluster_id": "087f27de-8f9b-4368-9123-98f49161a69f",
        "status": "DONE",
        "type": "CREATE_CLUSTER",
        "error_details": {
            "code": 0,
            "name": "NO_ERROR",
            "details": ""
        },
         "task_data": {
             "location_name": "SPB-5",
             "service_uuid": "00353c1d-1e64-5ae1-a083-145dce6838b1",
             "nodegroup_type": "DEDICATED"
       }
    }
}
```

--------------------------------

### Example response for GET /clusters/{cluster_id}/tasks

Source: https://docs.selectel.ru/api/managed-kubernetes-legacy.json

Example JSON response returned by the listTasks operation. Shows a list of tasks with fields such as id, started_at, updated_at, cluster_id, status, type, and error_details.

```json
{
    "count": 2,
    "tasks": [
        {
            "id": "aaa350dc-bbc2-442b-8d53-788d45b68728",
            "started_at": "2019-11-04T12:54:20.784887Z",
            "updated_at": "2019-11-04T13:00:08.782731Z",
            "cluster_id": "087f27de-8f9b-4368-9123-98f49161a69f",
            "status": "DONE",
            "type": "CREATE_CLUSTER",
            "error_details": {
                "code": 0,
                "name": "NO_ERROR",
                "details": ""
            }
        },
        {
            "id": "a462e4ff-83e4-4aa4-b63b-731942a95644",
            "started_at": "2019-11-04T14:12:08.784887Z",
            "updated_at": "2019-11-04T14:12:54.782731Z",
            "cluster_id": "087f27de-8f9b-4368-9123-98f49161a69f",
            "status": "DONE",
            "type": "ROTATE_CERTS",
            "error_details": {
                "code": 0,
                "name": "NO_ERROR",
                "details": ""
            }
        }
    ]
}
```

--------------------------------

### Create a domain with selectel_domains_domain_v1

Source: https://docs.selectel.ru/terraform/selectel-provider-reference/resources/domains_domain_v1.md

Defines a domain resource named 'domain_1' with the domain name 'example.com'. The name is required and changing it creates a new domain.

```hcl
resource "selectel_domains_domain_v1" "domain_1" {
  name = "example.com"
}
```

--------------------------------

### GET /datastores/{datastore_id}/metrics

Source: https://docs.selectel.ru/api/managed-databases.json

Returns all metrics of the cluster. Supports filtering by start and end time.

```APIDOC
## GET /datastores/{datastore_id}/metrics

### Description
Returns all metrics of the cluster.

### Method
GET

### Endpoint
/datastores/{datastore_id}/metrics

### Parameters
#### Path Parameters
- **datastore_id** (string) - Required - Cluster identifier.

#### Query Parameters
- **start** (string) - Optional - Filter the list result by the `start`.
- **end** (string) - Optional - Filter the list result by the `end`.

### Response
#### Success Response (200)
- **description**: The cluster metrics have been returned.

#### Error Responses
- **400**: Bad request. Fix the request and try again.
- **401**: Bad or expired token. You can reissue the token and try again.
- **403**: Access is forbidden. Make sure you have the required rights.
- **404**: Cluster has not been found.
```

--------------------------------

### List clusters response example

Source: https://docs.selectel.ru/api/managed-kubernetes-legacy.json

Example response for the GET /clusters operation (listClusters). Shows two clusters with fields such as id, status, kube_version, region, and kubernetes_options including feature_gates, admission_controllers, audit_logs, and oidc settings.

```json
{
    "clusters": [
        {
            "id": "5803b490-2d6b-418a-8645-eacda0f003c5",
            "created_at": "2019-11-04T10:21:11.943917Z",
            "updated_at": "2019-11-04T10:29:22.652987Z",
            "name": "cluster1",
            "status": "ACTIVE",
            "project_id": "c1f35d51fbfc4ba595830d5416fea58a",
            "network_id": "f6e76442-d33d-4c35-9d73-b5391ca03653",
            "subnet_id": "a9881ca2-d481-4206-b39a-7f7e758672e3",
            "kube_api_ip": "203.0.113.101",
            "kube_version": "1.16.9",
            "region": "ru-3",
            "additional_software": null,
            "enable_autorepair": true,
            "enable_patch_version_auto_upgrade": true,
            "kubernetes_options": {
                "feature_gates": [
                    "CPUManager"
                 ],
                "admission_controllers": [
                    "PodSecurityPolicy"
                ],
                "audit_logs": {
                    "enabled": true,
                    "secret_name": "mks-audit-logs"
                },
                "oidc": {
                    "enabled": true,
                    "issuer_url": "https://example.com/",
                    "client_id": "kubernetes",
                    "username_claim": "email",
                    "groups_claim": "groups",
                    "provider_name": "keycloak"
                }
            },
            "zonal": false,
            "cluster_type": "HIGH_AVAILABILITY",
            "private_kube_api": false
        },
        {
            "id": "998e205c-b67c-4941-85cd-c31b09582a4a",
            "created_at": "2019-11-04T12:54:20.769125Z",
            "updated_at": "2019-11-04T13:08:08.785385Z",
            "name": "testing",
            "status": "ACTIVE",
            "project_id": "c1f35d51fbfc4ba595830d5416fea58a",
            "network_id": "b5e2e88d-d393-4b9d-b5e5-9cc89c7843cf",
            "subnet_id": "31c0a11c-cdb2-442a-a92b-0c5d12631b75",
            "kube_api_ip": "203.0.113.220",
            "kube_version": "1.17.6",
            "region": "ru-1",
            "additional_software": null,
            "enable_autorepair": true,
            "enable_patch_version_auto_upgrade": false,
            "kubernetes_options": {
                "feature_gates": [
                    "CPUManager"
                 ],
                "admission_controllers": [
                    "PodSecurityPolicy"
                ],
                "audit_logs": {
                    "enabled": true,
                    "secret_name": "mks-audit-logs"
                },
                "oidc": {
                    "enabled": true,
                    "issuer_url": "https://example.com/",
                    "client_id": "kubernetes",
                    "username_claim": "email",
                    "groups_claim": "groups",
                    "provider_name": "keycloak"
                }
            },
            "zonal": true,
            "cluster_type": "HIGH_AVAILABILITY",
            "private_kube_api": true
        }
    ]
}
```

--------------------------------

### POST /boot/device/{resource_uuid}

Source: https://docs.selectel.ru/api/dedicated.json

Sets the server boot template for a specified server.

```APIDOC
## POST /boot/device/{resource_uuid}

### Description
Sets the server boot template for a specified server.

### Method
POST

### Endpoint
/boot/device/{resource_uuid}

### Parameters
#### Path Parameters
- **resource_uuid** (string) - Required - The unique identifier of the server resource.

#### Request Body
- **payload** (DeviceSet) - Required - The boot template configuration to set.

### Request Example
{
  "payload": {
    "$ref": "#/definitions/DeviceSet"
  }
}

### Response
#### Success Response (200)
- Server boot template has been set.

#### Success Response (202)
- Task for setting boot device has been queued.

#### Response Example
{
  "schema": {
    "$ref": "#/definitions/ResponseDevice"
  }
}
```

--------------------------------

### Create server with boot and additional volumes

Source: https://docs.selectel.ru/terraform/examples/cloud-servers/create-custom-server-with-boot-network-volume.md

Creates an additional volume and attaches it to a server as a non-boot device (boot_index = -1) while the boot volume is attached with boot_index = 0. The server uses a port, keypair, and flavor from existing resources, and a floating IP is associated and output as public_ip_address. Requires the volume_1, port_1, flavor_1, and keypair_1 resources to be defined elsewhere.

```hcl
resource "openstack_blockstorage_volume_v3" "volume_2" {
  name                 = "additional-volume-for-server"
  size                 = "7"
  volume_type          = "universal.ru-9a"
  availability_zone    = "ru-9a"
  enable_online_resize = true
}

resource "openstack_compute_instance_v2" "server_1" {
  name              = "server"
  flavor_id         = openstack_compute_flavor_v2.flavor_1.id
  key_pair          = selectel_vpc_keypair_v2.keypair_1.name
  availability_zone = "ru-9a"

  network {
    port = openstack_networking_port_v2.port_1.id
  }

  lifecycle {
    ignore_changes = [image_id]
  }

  block_device {
    uuid             = openstack_blockstorage_volume_v3.volume_1.id
    source_type      = "volume"
    destination_type = "volume"
    boot_index       = 0
  }

  block_device {
    uuid             = openstack_blockstorage_volume_v3.volume_2.id
    source_type      = "volume"
    destination_type = "volume"
    boot_index       = -1
  }

  vendor_options {
    ignore_resize_confirmation = true
  }
}

resource "openstack_networking_floatingip_v2" "floatingip_1" {
  pool = "external-network"
}

resource "openstack_networking_floatingip_associate_v2" "association_1" {
  port_id     = openstack_networking_port_v2.port_1.id
  floating_ip = openstack_networking_floatingip_v2.floatingip_1.address
}

output "public_ip_address" {
  value = openstack_networking_floatingip_v2.floatingip_1.fixed_ip
}
```

--------------------------------

### GET /v2/traffic/report

Source: https://docs.selectel.ru/api/cloud-projects-and-resources.json

Generates a traffic report for a specified date range. Requires start and end dates as query parameters.

```APIDOC
## GET /v2/traffic/report

### Description
Get account traffic report.

### Method
GET

### Endpoint
/v2/traffic/report

### Parameters
#### Query Parameters
- **start_date** (string, date) - Required - Start date of report.
- **end_date** (string, date) - Required - End date of report.

### Request Example
GET /v2/traffic/report?start_date=2023-01-01&end_date=2023-01-31

### Response
#### Success Response (200)
- Returns a CSV file with the traffic report.

#### Response Example
CSV content

### Error Handling
- **400** - Missing or incorrect start_date or end_date.
```

--------------------------------

### Boot From Volume

Source: https://docs.selectel.ru/terraform/openstack-provider-reference/compute-nova/resources/openstack_compute_instance_v2.md

Boots an instance from a volume created from an image, with delete_on_termination set to true.

```hcl
resource "openstack_compute_instance_v2" "boot-from-volume" {
  name            = "boot-from-volume"
  flavor_id       = "1011"
  key_pair        = "<key-pair-name>"

  block_device {
    uuid                  = "<image-id>"
    source_type           = "image"
    volume_size           = 5
    boot_index            = 0
    destination_type      = "volume"
    delete_on_termination = true
  }

  network {
    name = "<network-name>"
  }
}
```

--------------------------------

### GET /v1/cloud_billing/statistic/balance

Source: https://docs.selectel.ru/api/balance-statistics.json

Retrieves balance statistics for a specified period. The response includes account ID, period start and end, total value, and item count.

```APIDOC
## GET /v1/cloud_billing/statistic/balance

### Description
Retrieves balance statistics for a specified period. The response includes account ID, period start and end, total value, and item count.

### Method
GET

### Endpoint
/v1/cloud_billing/statistic/balance

### Parameters
#### Query Parameters
- **provider_keys** (array of string) - Required - Service provider keys. Possible values: vpc, serverless, mks, dbaas, storage, cdn, vmware, craas, ones, mobfarm, ses.
- **start** (string, date-time) - Required - Start of statistics period.
- **end** (string, date-time) - Required - End of statistics period.
- **locale** (string) - Required - Localization language. Possible values: ru, en.
- **group_type** (string) - Required - Grouping type for returned data. Possible values: hour, day, week, month, year, all.
- **items_count_period_group_type** (string) - Required - Items count period grouping type for returned data. Possible values: hour, day, week, month, year, all.

### Response
#### Success Response (200)
- **status** (string) - Status of the response.
- **data** (array) - Array of balance statistics objects.
  - **account_id** (string) - Account identifier.
  - **period_start** (string) - Start of the period.
  - **period_end** (string) - End of the period.
  - **value** (integer) - Total value.
  - **items_count** (integer) - Number of items.

#### Response Example
{
  "status": "success",
  "data": [
    {
      "account_id": "5633235",
      "period_start": "2023-01-01T00:00:00",
      "period_end": "2023-01-31T23:59:59",
      "value": 29055134,
      "items_count": 1097
    }
  ]
}

#### Error Responses
- **401** - Unauthorized. Invalid X-Auth-Token or X-Token header value.
- **403** - Forbidden. The request is not allowed for the user.
- **500** - Internal Server Error.
```

--------------------------------

### Get flavors with selectel_dbaas_flavor_v1

Source: https://docs.selectel.ru/terraform/selectel-provider-reference/data-sources/dbaas_flavor_v1.md

Use this example to retrieve a list of flavors for a project and region. The project_id should reference a selectel_vpc_project_v2 resource, and region must be a valid pool such as 'ru-3'.

```hcl
data "selectel_dbaas_flavor_v1" "flavor" {
  project_id = selectel_vpc_project_v2.project_1.id
  region     = "ru-3"
}
```

--------------------------------

### Example Usage: Configure Selectel provider and create a project

Source: https://docs.selectel.ru/terraform/selectel-provider-reference/authentication.md

Configures the Selectel provider with required_providers and creates a project resource. The provider source is selectel/selectel and version is ~> 6.0.0.

```hcl
terraform {
  required_providers {
    selectel  = {
      source  = "selectel/selectel"
      version = "~> 6.0.0"
    }
  }
}

# Create a project
resource "selectel_vpc_project_v2" "project_1" {
  ...
}
```

--------------------------------

### Instance with User Data (cloud-init)

Source: https://docs.selectel.ru/terraform/openstack-provider-reference/compute-nova/resources/openstack_compute_instance_v2.md

Creates an instance with user_data for cloud-init configuration. The user_data can be provided inline, read from a file, or generated using the template_cloudinit_config resource.

```hcl
resource "openstack_compute_instance_v2" "instance_1" {
  name            = "basic"
  image_id        = "<image-id>"
  flavor_id       = "1311"
  key_pair        = "<key-pair-name>"
  user_data       = "#cloud-config\nhostname: instance_1.example.com\nfqdn: instance_1.example.com"

  network {
    name = "<network-name>"
  }
}
```

--------------------------------

### Simple port example

Source: https://docs.selectel.ru/terraform/openstack-provider-reference/networking-neutron/resources/openstack_networking_port_v2.md

Creates a network and a port attached to it. The port does not get an IP if the network has no subnet; use fixed_ip.subnet_id or depends_on to enforce subnet creation first.

```hcl
resource "openstack_networking_network_v2" "network_1" {
  name           = "network_1"
  admin_state_up = "true"
}

resource "openstack_networking_port_v2" "port_1" {
  name           = "port_1"
  network_id     = openstack_networking_network_v2.network_1.id
  admin_state_up = "true"
}
```

--------------------------------

### Get OpenStack image ID with openstack_images_image_v2

Source: https://docs.selectel.ru/terraform/openstack-provider-reference/images-glance/data-sources/openstack_images_image_v2.md

Use this data source to retrieve the ID of an available OpenStack image. The example filters by name and most_recent, and matches properties.

```hcl
data "openstack_images_image_v2" "ubuntu" {
  name        = "Ubuntu 16.04"
  most_recent = true

  properties = {
    key = "value"
  }
}
```

--------------------------------

### GET /datastores/{datastore_id}/logs

Source: https://docs.selectel.ru/api/managed-databases.json

Returns all cluster logs. This operation is applied only for MySQL clusters and supports filtering by job, start, end, limit, ips, and databases.

```APIDOC
## GET /datastores/{datastore_id}/logs

### Description
Returns all cluster logs. Applied only for MySQL clusters.

### Method
GET

### Endpoint
/datastores/{datastore_id}/logs

### Parameters
#### Path Parameters
- **datastore_id** (string) - Required - Cluster identifier.

#### Query Parameters
- **job** (string) - Optional - Filter the list result by the `job`.
- **start** (string) - Optional - Filter the list result by the `start`.
- **end** (string) - Optional - Filter the list result by the `end`.
- **limit** (string) - Optional - Filter the list result by the `limit`.
- **ips** (string) - Optional - Filter the list result by the `ips`.
- **databases** (string) - Optional - Filter the list result by the `databases`.

### Response
#### Success Response (200)
- **description**: The cluster logs have been returned.

#### Error Responses
- **400**: Bad request. Fix the request and try again.
- **401**: Bad or expired token. You can reissue the token and try again.
- **403**: Access is forbidden. Make sure you have the required rights.
- **404**: Cluster has not been found.
```

--------------------------------

### Instance with Boot Disk and Swap Disk

Source: https://docs.selectel.ru/terraform/openstack-provider-reference/compute-nova/resources/openstack_compute_instance_v2.md

Creates an instance with a boot disk and a swap disk using block_device blocks. Applicable only to Private Clouds. The first block_device is the boot disk, and the second is a swap disk with guest_format set to 'swap'.

```hcl
resource "openstack_compute_flavor_v2" "flavor-with-swap" {
  name  = "flavor-with-swap"
  ram   = "8096"
  vcpus = "2"
  disk  = "20"
  swap  = "4096"
}

resource "openstack_compute_instance_v2" "vm-swap" {
  name            = "vm_swap"
  flavor_id       = openstack_compute_flavor_v2.flavor-with-swap.id
  key_pair        = "<key-pair-name>"

  block_device {
    boot_index            = 0
    delete_on_termination = true
    destination_type      = "local"
    source_type           = "image"
    uuid                  = "<image-id>"
  }

  block_device {
    boot_index            = -1
    delete_on_termination = true
    destination_type      = "local"
    source_type           = "blank"
    guest_format          = "swap"
    volume_size           = 4
  }
}
```

--------------------------------

### Get OpenStack Load Balancer flavor by name

Source: https://docs.selectel.ru/terraform/openstack-provider-reference/lbaas-octavia/data-sources/lb_flavor_v2.md

Use this data source to retrieve the ID of an OpenStack Load Balancer flavor by its name. The example sets the name argument to "AMPH1.SNGL.2-1024". Exactly one of name or flavor_id must be set.

```hcl
data "openstack_loadbalancer_flavor_v2" "flavor_1" {
  name = "AMPH1.SNGL.2-1024"
}
```

--------------------------------

### GET /boot/os/{resource_uuid}

Source: https://docs.selectel.ru/api/dedicated.json

Returns the server operating system configuration details.

```APIDOC
## GET /boot/os/{resource_uuid}

### Description
Returns the server operating system configuration details.

### Method
GET

### Endpoint
/boot/os/{resource_uuid}

### Parameters
#### Path Parameters
- **resource_uuid** (string) - Required - The unique identifier of the server resource.

### Response
#### Success Response (200)
- Operating system configuration has been returned.

#### Response Example
{
  "schema": {
    "$ref": "#/definitions/ResponseOSConfig"
  }
}
```

--------------------------------

### GET /iam/v1/users

Source: https://docs.selectel.ru/api/users-and-roles.json

Get a list of users in the account. This endpoint returns all users associated with the account.

```APIDOC
## GET /iam/v1/users

### Description
Get list of users.

### Method
GET

### Endpoint
/iam/v1/users

### Authentication
Requires an account-scoped IAM token.

### Responses
- **200** (OK) - Successful response with user list
- **401** (Unauthorized) - Authentication failed

```

--------------------------------

### Example Usage: selectel_cloudbackup_plan_v2 data source

Source: https://docs.selectel.ru/terraform/selectel-provider-reference/data-sources/cloudbackup_plan_v2.md

Defines a data source to retrieve backup plans filtered by name, volume name, and status. Requires project_id and region.

```hcl
data "selectel_cloudbackup_plan_v2" "plan_1" {
  project_id = selectel_vpc_project_v2.project_1.id
  region     = "ru-3"
  filter {
    name        = "my-backup-plan"
    volume_name = "my-volume"
    status      = "started"
  }
}
```

--------------------------------

### Create SAML Federation with selectel_iam_saml_federation_v1

Source: https://docs.selectel.ru/terraform/selectel-provider-reference/resources/iam_saml_federation_v1.md

Defines a selectel_iam_saml_federation_v1 resource with required and optional attributes. The example sets name, description, issuer, sso_url, and session_max_age_hours. Use this to create a federation for Selectel IAM.

```hcl
resource "selectel_iam_saml_federation_v1" "federation_1" {
  name                  = "federation name"
  description           = "simple description"
  issuer                = "http://localhost:8080/realms/master"
  sso_url               = "http://localhost:8080/realms/master/protocol/saml"
  session_max_age_hours = 24
}
```

--------------------------------

### GET /v1/cloud_billing/statistic/summary_stats

Source: https://docs.selectel.ru/api/balance-statistics.json

Get summary billing statistics by provider keys, date range and grouping parameters.

```APIDOC
## GET /v1/cloud_billing/statistic/summary_stats

### Description
Get summary billing statistics by provider keys, date range and grouping parameters.

### Method
GET

### Endpoint
/v1/cloud_billing/statistic/summary_stats

### Parameters
#### Query Parameters
- **provider_keys** (array of string) - Required - Service Provider Key. Allowed values: vpc, serverless, mks, dbaas, storage, cdn, vmware, craas, ones, mobfarm, ses
- **start** (string, date-time) - Required - Start date for statistics range
- **end** (string, date-time) - Required - End date for statistics range
- **group_type** (string) - Required - Grouping type for returned data. Allowed values: project, object, metric, project_metric, region_metric
- **period_group_type** (string) - Required - Period grouping type for returned data. Allowed values: hour, day, week, month, year

### Response
#### Success Response (200)
- **status** (string) - Status of the response
- **data** (array) - Array of statistics data

#### Response Example
{
  "status": "success",
  "data": []
}

#### Error Responses
- **401** (Unauthorized) - Invalid X-Auth-Token or X-Token header value
- **403** (Forbidden) - The request is not allowed for the user
- **500** (Internal Server Error) - Internal server error
```

--------------------------------

### Example with content from file

Source: https://docs.selectel.ru/terraform/openstack-provider-reference/object-storage-swift/resources/openstack_objectstorage_object_v1.md

Creates an OpenStack object storage container and an object whose content is read from a local file. The object references the container name and sets metadata, content type, and source file path.

```hcl
resource "openstack_objectstorage_container_v1" "container_1" {
  region = "RegionOne"
  name   = "tf-test-container-1"

  metadata {
    test = "true"
  }

  content_type = "application/json"
}

resource "openstack_objectstorage_object_v1" "doc_1" {
  region         = "RegionOne"
  container_name = openstack_objectstorage_container_v1.container_1.name
  name           = "test/default.json"
  metadata {
    test = "true"
  }

  content_type = "application/json"
  source       = "./default.json"
}

```

--------------------------------

### GET /v1/registries/{id}

Source: https://docs.selectel.ru/api/craas.json

Returns information about the specified registry. Provide the unique identifier of the registry to get its details.

```APIDOC
## GET /v1/registries/{id}

### Description
Returns information about the specified registry.

### Method
GET

### Endpoint
/v1/registries/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique identifier of the registry.

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the registry.
- **name** (string) - Name of the registry.

#### Response Example
{
  "id": "registry-id",
  "name": "my-registry"
}

### Error Handling
- **404**: Registry has not been found.
- **500**: Server is not responding. Please try again later.
```

--------------------------------

### GET /iam/v1/users/{user_id}

Source: https://docs.selectel.ru/api/users-and-roles.json

Get information about a specific user by their ID. This endpoint returns user details including associated groups.

```APIDOC
## GET /iam/v1/users/{user_id}

### Description
Get info about user.

### Method
GET

### Endpoint
/iam/v1/users/{user_id}

### Authentication
Requires an account-scoped IAM token.

### Parameters
#### Path Parameters
- **user_id** (string) - Required - The ID of the user

### Responses
- **200** (OK) - Successful response with user details and groups
- **400** (Bad Request) - Invalid request
- **401** (Unauthorized) - Authentication failed

```

--------------------------------

### Pack and unpack a message in C++

Source: https://docs.selectel.ru/api/1c-cloud.json

Example 1 from the Any message documentation. Shows how to pack a Foo message into an Any and unpack it back.

```cpp
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}
```

--------------------------------

### Example Usage: openstack_networking_port_ids_v2

Source: https://docs.selectel.ru/terraform/openstack-provider-reference/networking-neutron/data-sources/openstack_networking_port_ids_v2.md

Retrieves a list of OpenStack port IDs matching the specified criteria. The example filters by name 'port'.

```hcl
data "openstack_networking_port_ids_v2" "ports" {
  name = "port"
}
```

--------------------------------

### GET /boot/template/os/new

Source: https://docs.selectel.ru/api/dedicated.json

Returns a list of available operating system templates. The list can be filtered by location UUID and service UUID.

```APIDOC
## GET /boot/template/os/new

### Description
Returns a list of available operating system templates. The list can be filtered by location UUID and service UUID.

### Method
GET

### Endpoint
/boot/template/os/new

### Parameters
#### Query Parameters
- **location_uuid** (string) - Optional - Location unique identifier (UUID) used to filter available operating system templates.
- **service_uuid** (string) - Optional - Service unique identifier (UUID) used to filter available operating system templates.

### Response
#### Success Response (200)
- **body** (object) - List of operating system templates. Schema: OSTemplateListNewResponse.

#### Response Example
{
  "body": {}
}
```
Tokens:
Raw