Yandex Cloud API

https://github.com/yandex-cloud/cloudapi
Admin
Yandex Cloud API provides interface definitions for accessing Yandex Cloud services via REST or gRPC...
Tokens:99,546
Snippets:557
Trust Score:7.9
License:MIT
Update:6 days ago
Show doc for...
Tokens:
Raw
### POST /compute/v1/instances/{instance_id}:start

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/compute.md

Starts the specified instance.

```APIDOC
## POST /compute/v1/instances/{instance_id}:start

### Description
Starts the specified instance.

### Method
POST

### Endpoint
/compute/v1/instances/{instance_id}:start

### Parameters
#### Path Parameters
- **instance_id** (string) - Required - The ID of the instance to start.

### Response
#### Success Response (200)
Returns an operation object.

```

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

### POST /compute/v1/instances/{instanceId}:start

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/compute.md

Starts a Compute instance. Returns an error if the instance is already running.

```APIDOC
## POST /compute/v1/instances/{instanceId}:start

### Description
Starts a Compute instance. If the instance is already running, the API returns a FAILED_PRECONDITION error.

### Method
POST

### Endpoint
/compute/v1/instances/{instanceId}:start

### Parameters
#### Path Parameters
- **instanceId** (string) - Required - The ID of the instance to start.

### Request Example
No request body is documented for this endpoint.

### Response
#### Success Response (200)
No response body is documented in the source.

#### Error Response (409 Conflict)
- **error** (object) - Error details.
  - **code** (integer) - Error code (9 for FAILED_PRECONDITION).
  - **message** (string) - Error message.
  - **details** (array) - Additional error details.
    - **@type** (string) - Type of the error detail.
    - **reason** (string) - Reason for the error.

#### Response Example
{
  "error": {
    "code": 9,
    "message": "instance is already running",
    "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "INVALID_STATE" } ]
  }
}
```

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

### Get operation example

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/operation.md

Shows a GET request to retrieve an operation and the JSON response with the operation details.

```json
GET /operations/c96p6m3e8jhd1b3e9k21
```

```json
{
  "id": "c96p6m3e8jhd1b3e9k21",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/yandex.cloud.compute.v1.Instance",
    "id": "epd1e1c2t3g0abcd1234",
    "status": "RUNNING"
  }
}
```

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

### Start an instance with error handling - REST API

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/compute.md

Sends a POST request to /compute/v1/instances/{instanceId}:start. If the instance is already RUNNING, the API returns a google.rpc.Status with code 9 (FAILED_PRECONDITION) and the shown error body. gRPC clients raise a status exception; REST clients get HTTP 409 Conflict.

```json
POST /compute/v1/instances/epd1e1c2t3g0abcd1234:start
```

```json
{
  "error": {
    "code": 9,
    "message": "instance is already running",
    "details": [ { "@type": "type.googleapis.com/google.rpc.ErrorInfo", "reason": "INVALID_STATE" } ]
  }
}
```

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

### Get RPC example: HTTP request and JSON response

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/endpoint.md

Shows a GET request to /endpoints/api and the corresponding JSON response with the endpoint details.

```http
GET /endpoints/api
```

```json
{ "id": "api", "address": "api.cloud.yandex.net" }
```

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

### POST /managed-kubernetes/v1/clusters/{cluster_id}:start

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/k8s.md

Starts a Kubernetes cluster. This is an asynchronous operation.

```APIDOC
## [POST] /managed-kubernetes/v1/clusters/{cluster_id}:start

### Description
Starts a Kubernetes cluster. This is an asynchronous operation.

### Method
POST

### Endpoint
/managed-kubernetes/v1/clusters/{cluster_id}:start

### Parameters
#### Path Parameters
- **cluster_id** (string) - Required - The ID of the Kubernetes cluster.

### Response
#### Success Response (200)
Returns an `operation.Operation` object.

#### Response Example
```json
{
  "operation": {}
}
```
```

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

### Start

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/compute.md

RPC to start a stopped instance. The request contains only the instance ID. Returns the updated Instance.

```APIDOC
## RPC Start

### Description
Starts a stopped Compute instance.

### Method
RPC

### Request Message
`StartInstanceRequest`

### Parameters

#### Request Body
- `instance_id` (string) - Required - The ID of the instance to start.

### Response

#### Response Message
`Instance`
```

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

### List RPC example: HTTP request and JSON response

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/endpoint.md

Shows a GET request to /endpoints and the JSON response containing a list of endpoints.

```http
GET /endpoints
```

```json
{
  "endpoints": [
    { "id": "api", "address": "api.cloud.yandex.net" },
    { "id": "iam", "address": "iam.api.cloud.yandex.net" }
  ]
}
```

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

### ClusterService.Start

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/endpoints.md

Starts the specified PostgreSQL cluster.

```APIDOC
## POST /managed-postgresql/v1/clusters/{cluster_id}:start

### Description
Starts the specified PostgreSQL cluster.

### Method
POST

### Endpoint
/managed-postgresql/v1/clusters/{cluster_id}:start

### Parameters
#### Path Parameters
- **cluster_id** (string) - Required - ID of the PostgreSQL cluster to start.

### Response
#### Success Response (200)
Returns the operation result.

```

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

### POST /managed-postgresql/v1/clusters/{cluster_id}:start

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/mdb-postgresql.md

Starts a previously stopped PostgreSQL cluster.

```APIDOC
## POST /managed-postgresql/v1/clusters/{cluster_id}:start

### Description
Starts the specified PostgreSQL cluster.

### Method
POST

### Endpoint
/managed-postgresql/v1/clusters/{cluster_id}:start

### Parameters
#### Path Parameters
- **cluster_id** (string) - Required - ID of the cluster to start.

### Response
#### Success Response (200)
Returns an operation.Operation object.

#### Response Example
{
  "id": "string",
  "done": true,
  "response": {}
}
```

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

### POST /managed-postgresql/v1/clusters/{cluster_id}:startFailover

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/mdb-postgresql.md

Starts a manual failover for a PostgreSQL cluster.

```APIDOC
## POST /managed-postgresql/v1/clusters/{cluster_id}:startFailover

### Description
Starts a manual failover for the specified PostgreSQL cluster.

### Method
POST

### Endpoint
/managed-postgresql/v1/clusters/{cluster_id}:startFailover

### Parameters
#### Path Parameters
- **cluster_id** (string) - Required - ID of the cluster.

#### Request Body
- **host_name** (string) - Optional - Name of the host to promote to master.

### Request Example
{
  "host_name": "string"
}

### Response
#### Success Response (200)
Returns an operation.Operation object.

#### Response Example
{
  "id": "string",
  "done": true,
  "response": {}
}
```

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

### GET /compute/v1/instances

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/compute.md

Lists instances in the specified folder.

```APIDOC
## GET /compute/v1/instances

### Description
Lists instances in the specified folder.

### Method
GET

### Endpoint
/compute/v1/instances

### Parameters
#### Query Parameters
- **folder_id** (string) - Required - The ID of the folder to list instances from.

### Response
#### Success Response (200)
Returns a list of instances.

```

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

### Create RPC example request and response

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/iam.md

Example HTTP request and response for the Create RPC. The request posts a Yandex passport OAuth token to /iam/v1/tokens. The response returns the IAM token and its expiration time.

```json
POST /iam/v1/tokens
{ "yandex_passport_oauth_token": "AQAAAABcdefgh..." }
```

```json
{
  "iamToken": "t1.9euelZrK...",
  "expiresAt": "2025-01-01T12:00:00Z"
}
```

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

### Presign two GET URLs (gRPC, Go)

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/storage.md

Uses the storageClient.Presign method to generate presigned GET URLs for two objects. The second object is set as an attachment. On error, the status code may be InvalidArgument or NotFound.

```go
resp, err := storageClient.Presign(ctx, &storage.PresignURLsRequest{
    BucketName: "my-app-assets",
    Objects: []*storage.PresignObjectRequest{
        {Name: "img/logo.png", Method: "GET", Expires: 3600},
        {Name: "data/report.pdf", Method: "GET", Expires: 3600, AsAttachment: true},
    },
})
if err != nil {
    // status.Code(err) == codes.InvalidArgument | codes.NotFound
}
// resp.Urls[0], resp.Urls[1] ...
```

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

### GET /compute/v1/instances/{resource_id}:listAccessBindings

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/compute.md

Lists access bindings for the specified instance.

```APIDOC
## GET /compute/v1/instances/{resource_id}:listAccessBindings

### Description
Lists access bindings for the specified instance.

### Method
GET

### Endpoint
/compute/v1/instances/{resource_id}:listAccessBindings

### Parameters
#### Path Parameters
- **resource_id** (string) - Required - The ID of the instance.

### Response
#### Success Response (200)
Returns a list of access bindings.

```

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

### POST /compute/v1/instances

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/compute.md

Creates a new Compute instance with specified resources, boot disk, and network interfaces.

```APIDOC
## POST /compute/v1/instances

### Description
Creates a new Compute instance with the specified configuration.

### Method
POST

### Endpoint
/compute/v1/instances

### Parameters
#### Request Body
- **folderId** (string) - Required - The ID of the folder where the instance will be created.
- **name** (string) - Optional - The name of the instance.
- **zoneId** (string) - Required - The availability zone where the instance will be placed.
- **platformId** (string) - Required - The platform identifier for the instance.
- **resourcesSpec** (object) - Required - Resource specification for the instance.
  - **memory** (integer) - Required - Memory size in bytes.
  - **cores** (integer) - Required - Number of CPU cores.
  - **coreFraction** (integer) - Required - Core fraction percentage.
- **bootDiskSpec** (object) - Required - Boot disk specification.
  - **diskSpec** (object) - Required - Disk specification.
    - **imageId** (string) - Required - ID of the image to use for the boot disk.
    - **size** (integer) - Required - Disk size in bytes.
    - **typeId** (string) - Required - Disk type identifier.
- **networkInterfaceSpecs** (array) - Required - List of network interface specifications.
  - **subnetId** (string) - Required - ID of the subnet to attach the interface to.

### Request Example
{
  "folderId": "b1g1234567890abcdefg",
  "name": "web-1",
  "zoneId": "ru-central1-a",
  "platformId": "standard-v3",
  "resourcesSpec": { "memory": 2147483648, "cores": 2, "coreFraction": 100 },
  "bootDiskSpec": {
    "diskSpec": { "imageId": "fd8abc...", "size": 10737418240, "typeId": "network-ssd" }
  },
  "networkInterfaceSpecs": [ { "subnetId": "e9b123..." } ]
}

### Response
#### Success Response (200)
No response body is documented in the source.

#### Response Example
No response example is provided in the source.
```

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

### Cancel operation example

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/operation.md

Shows a GET request to cancel an operation and the JSON response with the cancellation error.

```json
GET /operations/c96p6m3e8jhd1b3e9k21:cancel
```

```json
{
  "id": "c96p6m3e8jhd1b3e9k21",
  "done": true,
  "error": {
    "code": 1,
    "message": "The operation was cancelled"
  }
}
```

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

### package_options.proto stub file example

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/configuration.md

A stub file containing only the package and go_package declarations. Acts as a codegen build-unit marker so the Go client module can be compiled per package, independent of message/service files.

```proto
syntax = "proto3";

package yandex.cloud.iam.v1;

option go_package = "github.com/yandex-cloud/go-genproto/yandex/cloud/iam/v1;iam";
```

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

### POST /compute/v1/instances

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/compute.md

Creates an instance in the specified folder.

```APIDOC
## POST /compute/v1/instances

### Description
Creates an instance in the specified folder.

### Method
POST

### Endpoint
/compute/v1/instances

### Parameters
#### Request Body
- **folder_id** (string) - Required - The ID of the folder to create the instance in.
- **name** (string) - Optional - The name of the instance.
- **description** (string) - Optional - A description of the instance.
- **zone_id** (string) - Required - The ID of the availability zone.
- **platform_id** (string) - Required - The ID of the platform.
- **resources_spec** (object) - Required - The resources specification (cores, memory, etc.).
- **boot_disk_spec** (object) - Required - The boot disk specification.
- **network_interface_specs** (array) - Required - The network interface specifications.

### Response
#### Success Response (200)
Returns an operation object.

```

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

### GET /operations/{operation_id}:cancel

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/operation.md

Cancels a long-running operation by its ID. Note that not all services support cancellation; for example, Object Storage API does not currently support cancelling operations.

```APIDOC
## GET /operations/{operation_id}:cancel

### Description
Cancels a long-running operation by its ID. Note that not all services support cancellation; for example, Object Storage API does not currently support cancelling operations.

### Method
GET

### Endpoint
/operations/{operation_id}:cancel

### Parameters
#### Path Parameters
- **operation_id** (string) - Required - ID of the operation to cancel.

### Request Example
GET /operations/c96p6m3e8jhd1b3e9k21:cancel

### Response
#### Success Response (200)
- **id** (string) - Operation ID.
- **done** (boolean) - Indicates whether the operation is complete.
- **error** (object) - Error information if the operation was cancelled.

#### Response Example
{
  "id": "c96p6m3e8jhd1b3e9k21",
  "done": true,
  "error": {
    "code": 1,
    "message": "The operation was cancelled"
  }
}

### Errors
- **NOT_FOUND** - If the operation ID is unknown.
- **INVALID_ARGUMENT** - If validation fails.
```

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

### Create a cluster (excerpt) - POST /managed-kubernetes/v1/clusters

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/k8s.md

Example request to create a Kubernetes cluster. Specifies folder, name, network, release channel, master version and zone, and service accounts.

```json
POST /managed-kubernetes/v1/clusters
{
  "folderId": "b1g1234567890abcdefg",
  "name": "prod-cluster",
  "networkId": "enp123...",
  "releaseChannel": "REGULAR",
  "masterSpec": {
    "version": "1.30",
    "zonalMasterSpec": { "zoneId": "ru-central1-a" }
  },
  "serviceAccountId": "aje2c1d3...",
  "nodeServiceAccountId": "aje2c1d3..."
}
```

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

### Deploy a version

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/serverless-functions.md

Sends a POST request to /functions/v1/versions with functionId, runtime, entrypoint, resources, and package details.

```json
POST /functions/v1/versions
{
  "functionId": "d4e1abc2...",
  "runtime": "python312",
  "entrypoint": "index.handler",
  "resources": { "memory": 268435456 },
  "package": { "bucketName": "code-bucket", "objectName": "fn.zip", "sha256": "..." }
}
```

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

### Create an instance (basic) - REST API

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/compute.md

Sends a POST request to /compute/v1/instances with a JSON body specifying folder, name, zone, platform, resources, boot disk, and network interface. The example uses placeholder IDs like 'b1g1234567890abcdefg' and 'fd8abc...'.

```json
POST /compute/v1/instances
{
  "folderId": "b1g1234567890abcdefg",
  "name": "web-1",
  "zoneId": "ru-central1-a",
  "platformId": "standard-v3",
  "resourcesSpec": { "memory": 2147483648, "cores": 2, "coreFraction": 100 },
  "bootDiskSpec": {
    "diskSpec": { "imageId": "fd8abc...", "size": 10737418240, "typeId": "network-ssd" }
  },
  "networkInterfaceSpecs": [ { "subnetId": "e9b123..." } ]
}
```

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

### Create

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/compute.md

Asynchronous RPC to create a new Compute instance. Requires folder_id, zone_id, platform_id, resources_spec, boot_disk_spec, and network_interface_specs. Returns an Instance and operation metadata.

```APIDOC
## RPC Create

### Description
Asynchronously creates a new Compute instance with the specified configuration.

### Method
RPC

### Request Message
`CreateInstanceRequest`

### Parameters

#### Request Body
- `folder_id` (string) - Required - Target folder (≤50).
- `name` (string) - Optional - Regex `|[a-z]([-_a-z0-9]{0,61}[a-z0-9])?`.
- `description` (string) - Optional - ≤256.
- `labels` (map<string,string>) - Optional - ≤64; keys `[a-z][-_./\\@0-9a-z]*`.
- `zone_id` (string) - Required - Availability zone.
- `platform_id` (string) - Required - Hardware platform.
- `resources_spec` (ResourcesSpec) - Required - vCPU/memory/GPU spec.
- `metadata` (map<string,string>) - Optional - Total < 512 KB; values ≤ 256 KB.
- `boot_disk_spec` (AttachedDiskSpec) - Required - Boot disk.
- `secondary_disk_specs` (repeated AttachedDiskSpec) - Optional - ≤ 3 disks.
- `filesystem_specs` (repeated AttachedFilesystemSpec) - Optional - Same zone as instance.
- `local_disk_specs` (repeated AttachedLocalDiskSpec) - Optional - Local NVMe disks.
- `network_interface_specs` (repeated NetworkInterfaceSpec) - Required - NIC configuration.
- `hostname` (string) - Optional - Generates `fqdn`; regex `|[a-z]([-_a-z0-9]{0,61}[a-z0-9])?`.
- `scheduling_policy` (SchedulingPolicy) - Optional - Preemptibility.
- `service_account_id` (string) - Optional - For in-VM IAM auth.
- `network_settings` (NetworkSettings) - Optional - Network type.
- `placement_policy` (PlacementPolicy) - Optional - Placement group/affinity.
- `gpu_settings` (GpuSettings) - Optional - GPU cluster.
- `maintenance_policy` (MaintenancePolicy) - Optional - Maintenance behavior.
- `maintenance_grace_period` (Duration) - Optional - 1s-24h.
- `metadata_options` (MetadataOptions) - Optional - Metadata access.
- `serial_port_settings` (SerialPortSettings) - Optional - Serial console.
- `application` (Application) - Optional - App settings.
- `reserved_instance_pool_id` (string) - Optional - Use resources from a reserved pool.

### Response

#### Operation Metadata
`CreateInstanceMetadata { string instance_id; }`

#### Response Message
`Instance`

### Spec Messages

```proto
message ResourcesSpec {
  int64 memory = 1;       // required, <= 274877906944 bytes
  int64 cores = 2;        // required, 2..80 (even values incl. 36,40,44,48,52,56,60,64,68,72,76,80)
  int64 core_fraction = 3; // 0,5,20,50,100
  int64 gpus = 4;         // 0,1,2,4
}

message AttachedDiskSpec {
  enum Mode { MODE_UNSPECIFIED = 0; READ_ONLY = 1; READ_WRITE = 2; }
  message DiskSpec {
    string name = 1;
    string description = 2;
    string type_id = 3;             // <=50
    int64 size = 4;                 // required, 4194304..4398046511104
    int64 block_size = 8;           // default 4096
    DiskPlacementPolicy disk_placement_policy = 7;
    oneof source {
      string image_id = 5;          // <=50
      string snapshot_id = 6;       // <=50
    }
    string kms_key_id = 9;          // <=50
  }
  Mode mode = 1;
  string device_name = 2;           // [a-z][a-z0-9-_]{,19}
  bool auto_delete = 3;
  oneof disk {
    DiskSpec disk_spec = 4;         // create new disk
    string disk_id = 5;             // attach existing (<=50)
  }
}
```

`NetworkInterfaceSpec` (line 1099): `index` (server-generated), `subnet_id`
(required, ≤50), `primary_v4_address_spec`, `primary_v6_address_spec`
(both `PrimaryAddressSpec`), `security_group_ids`. `PrimaryAddressSpec` has
optional `address` (manual static IP) and `one_to_one_nat_spec`
(`OneToOneNatSpec`: `ip_version` or static `address`, plus `dns_record_specs`).
```

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

### GET /functions/v1/functions/{function_id}

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/serverless-functions.md

Retrieves a function by its ID. Corresponds to the Get RPC.

```APIDOC
## [GET] /functions/v1/functions/{function_id}

### Description
Retrieves a function by its ID.

### Method
GET

### Endpoint
/functions/v1/functions/{function_id}

### Parameters
#### Path Parameters
- **function_id** (string) - Required - The ID of the function to retrieve.

### Response
#### Success Response (200)
Returns a Function object.

```

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

### GET /iam/v1/roles/{role_id}

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/iam.md

Retrieves a role by its ID. This corresponds to the Get RPC of RoleService.

```APIDOC
## GET /iam/v1/roles/{role_id}

### Description
Retrieves a role by its unique identifier.

### Method
GET

### Endpoint
GET /iam/v1/roles/{role_id}

### Parameters
#### Path Parameters
- **role_id** (string) - Required - The unique identifier of the role to retrieve.

### Response
#### Success Response (200)
Returns a Role object.

#### Response Example
```json
{
  "role": {}
}
```
```

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

### Example HTTP request to create a network

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/vpc.md

Shows a POST request to /vpc/v1/networks with a JSON body containing folderId, name, and description. Poll the returned operation until done to obtain the created Network.

```json
POST /vpc/v1/networks
{
  "folderId": "b1g1234567890abcdefg",
  "name": "main",
  "description": "primary network"
}
```

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

### terraform.yaml example for compute service with field options

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/configuration.md

Shows a terraform.yaml configuration for the compute service, demonstrating options like memory, force_new, default, computed, and constant for various fields.

```yaml
options:
  yandex.cloud.compute.v1.Filesystem.size:
    memory: true
    force_new: true
    default: 150
  yandex.cloud.compute.v1.Filesystem.type_id:
    default: "network-hdd"
    force_new: true
  yandex.cloud.compute.v1.CreateFilesystemRequest.zone_id:
    computed: true
  yandex.cloud.compute.v1.DiskPlacementGroup.spread_placement_strategy:
    constant: "&compute.DiskSpreadPlacementStrategy{}"

```

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

### QuotaLimitService service definition

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/quotamanager.md

Defines the QuotaLimitService with three RPCs: Get, List, and ListServices, each with HTTP GET bindings.

```proto
service QuotaLimitService {
  rpc Get(GetQuotaLimitRequest) returns (QuotaLimit) {
    option (google.api.http) = {
      get: "/quota-manager/v1/quotaLimits/{quota_id}"
    };
  };

  rpc List(ListQuotaLimitsRequest) returns (ListQuotaLimitsResponse) {
    option (google.api.http) = {
      get: "/quota-manager/v1/quotaLimits"
    };
  };

  rpc ListServices(ListServicesRequest) returns (ListServicesResponse) {
    option (google.api.http) = {
      get: "/quota-manager/v1/quotaLimits/services"
    };
  };
}
```

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

### GetCloudRequest message for Get RPC

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/resourcemanager.md

Request for the Get RPC. The cloud_id field is required and must be at most 50 characters. Returns a Cloud or throws NOT_FOUND or INVALID_ARGUMENT.

```proto
message GetCloudRequest {
  string cloud_id = 1 [(length) = "<=50", (required) = true];
}
```

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

### Create a folder with POST /resource-manager/v1/folders

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/resourcemanager.md

Creates a folder in the specified cloud and shows the initial operation response. The operation is asynchronous, so you must poll GET /operations/{operation_id} until done is true; the final response will contain the created Folder.

```json
POST /resource-manager/v1/folders
{
  "cloud_id": "b1g1234567890abcdefg",
  "name": "prod",
  "description": "production folder"
}
```

```json
{
  "id": "b1g5a2b3c4d5e6f7g8h9",
  "done": false,
  "metadata": { "@type": "...FolderMetadata", "folder_id": "b1g5a2b3c4d5e6f7g8h9" }
}
```

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

### POST /compute/v1/instances/{instance_id}:attachFilesystem

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/compute.md

Attaches a filesystem to the specified instance.

```APIDOC
## POST /compute/v1/instances/{instance_id}:attachFilesystem

### Description
Attaches a filesystem to the specified instance.

### Method
POST

### Endpoint
/compute/v1/instances/{instance_id}:attachFilesystem

### Parameters
#### Path Parameters
- **instance_id** (string) - Required - The ID of the instance.

#### Request Body
- **attached_filesystem_spec** (object) - Required - The filesystem specification to attach.

### Response
#### Success Response (200)
Returns an operation object.

```

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

### GET /vpc/v1/networks

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/vpc.md

Lists networks in a folder.

```APIDOC
## GET /vpc/v1/networks

### Description
Lists networks in the specified folder. Supports pagination.

### Method
GET

### Endpoint
/vpc/v1/networks

### Parameters
#### Query Parameters
- **folder_id** (string) - Required - Folder ID to list networks from.
- **page_size** (int) - Optional - Maximum number of results per page.
- **page_token** (string) - Optional - Token for pagination.

### Response
#### Success Response (200)
Returns a ListNetworksResponse containing a list of Network objects and a next page token.

#### Response Example
{
  "networks": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "2023-01-01T00:00:00Z",
      "name": "string",
      "description": "string",
      "labels": {},
      "default_security_group_id": "string"
    }
  ],
  "next_page_token": "string"
}
```

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

### List quota limits for a cloud (GET request)

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/quotamanager.md

Sends a GET request to the Quota Manager API to list quota limits for a specified cloud resource. The response contains the resource and an array of quota limits with quotaId, limit, and usage.

```json
GET /quota-manager/v1/quotaLimits?resource.id=b1g1234567890abcdefg&resource.type=resource-manager.cloud&service=compute
```

```json
{
  "resource": { "id": "b1g1234567890abcdefg", "type": "resource-manager.cloud" },
  "quotaLimits": [
    { "quotaId": "compute.instances.count", "limit": 10, "usage": 3 },
    { "quotaId": "compute.gpus.count", "limit": 0, "usage": 0 }
  ]
}
```

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

### Create a bucket (JSON request)

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/storage.md

Sends a POST request to /storage/v1/buckets to create a bucket named 'my-app-assets' in the specified folder with the STANDARD storage class.

```json
POST /storage/v1/buckets
{
  "name": "my-app-assets",
  "folderId": "b1g1234567890abcdefg",
  "defaultStorageClass": "STANDARD"
}
```

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

### rpc Create(PresignURLsRequest) returns (PresignURLsResponse)

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/storage.md

Generates presigned URLs for one or more objects in a bucket. Accepts a list of per-object presign requests and returns a list of presigned URLs.

```APIDOC
## rpc Create(PresignURLsRequest) returns (PresignURLsResponse)

### Description
Generates presigned URLs for one or more objects in a bucket. Accepts a list of per-object presign requests and returns a list of presigned URLs.

### Method
Create

### Request
#### PresignURLsRequest
- **bucket_name** (string) - Required - Bucket whose objects are presigned.
- **presign_host** (string) - Optional - Custom presign host.
- **objects** (repeated PresignObjectRequest) - Required - Per-object presign requests.

#### PresignObjectRequest
- **expires** (int64) - Optional - URL lifetime in seconds.
- **name** (string) - Required - Object key.
- **method** (string) - Required - `GET`/`PUT`/`HEAD`.
- **headers** (map<string,string>) - Optional - Extra headers.
- **version_id** (string) - Optional - Object version.
- **as_attachment** (bool) - Optional - Content-Disposition attachment.

### Response
#### PresignURLsResponse
- **urls** (repeated string) - One presigned URL per requested object.

### Errors
- **INVALID_ARGUMENT** - Validation error.
- **NOT_FOUND** - Unknown bucket.
```

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

### GET /managed-kubernetes/v1/clusters

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/k8s.md

Lists Kubernetes clusters in the specified folder.

```APIDOC
## [GET] /managed-kubernetes/v1/clusters

### Description
Lists Kubernetes clusters in the specified folder.

### Method
GET

### Endpoint
/managed-kubernetes/v1/clusters

### Parameters
#### Query Parameters
- **folder_id** (string) - Required - The ID of the folder to list clusters from.

### Response
#### Success Response (200)
Returns a `ListClustersResponse` object.

#### Response Example
```json
{
  "clusters": []
}
```
```

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

### GET /vpc/v1/networks/{network_id}

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/vpc.md

Retrieves information about a specific network by its ID.

```APIDOC
## GET /vpc/v1/networks/{network_id}

### Description
Retrieves the details of a network, including its name, description, labels, and default security group ID.

### Method
GET

### Endpoint
/vpc/v1/networks/{network_id}

### Parameters
#### Path Parameters
- **network_id** (string) - Required - ID of the network to retrieve.

### Response
#### Success Response (200)
Returns a Network message with the following fields:
- **id** (string) - Network ID.
- **folder_id** (string) - Owning folder.
- **created_at** (Timestamp) - Creation time (RFC3339).
- **name** (string) - Unique within folder; regex `|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?`.
- **description** (string) - 0-256 chars.
- **labels** (map<string,string>) - ≤64; values `[-_0-9a-z]*`, keys `[a-z][-_0-9a-z]*`.
- **default_security_group_id** (string) - ID of the default security group.

#### Response Example
{
  "id": "string",
  "folder_id": "string",
  "created_at": "2023-01-01T00:00:00Z",
  "name": "string",
  "description": "string",
  "labels": {},
  "default_security_group_id": "string"
}
```

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

### Create

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/storage.md

Creates a new bucket. Requires a globally unique name and accepts various configuration fields.

```APIDOC
## [POST] /storage/v1/buckets

### Description
Creates a new bucket. Requires a globally unique name and accepts various configuration fields.

### Method
POST

### Endpoint
/storage/v1/buckets

### Parameters
#### Request Body
- **name** (string) - Required - Globally unique bucket name.
- **folder_id** (string) - Optional - Folder ID.
- **anonymous_access_flags** (object) - Optional - Anonymous access flags.
- **default_storage_class** (string) - Optional - Default storage class.
- **max_size** (int64) - Optional - Maximum size.
- **policy** (Struct) - Optional - Bucket policy.
- **acl** (object) - Optional - Access control list.
- **cors** (array) - Optional - CORS rules.
- **website_settings** (object) - Optional - Website settings.
- **lifecycle_rules** (array) - Optional - Lifecycle rules.
- **tags** (object) - Optional - Tags.
- **object_lock** (object) - Optional - Object lock settings.
- **encryption** (object) - Optional - Encryption settings.
- **allowed_private_endpoints** (array) - Optional - Allowed private endpoints.
- **disabled_statickey_auth** (bool) - Optional - Disabled static key auth.
- **logging** (object) - Optional - Logging settings.

### Request Example
{
  "name": "my-bucket",
  "folder_id": "folder-id",
  "anonymous_access_flags": {},
  "default_storage_class": "STANDARD",
  "max_size": 1000000,
  "policy": {},
  "acl": {},
  "cors": [],
  "website_settings": {},
  "lifecycle_rules": [],
  "tags": {},
  "object_lock": {},
  "encryption": {},
  "allowed_private_endpoints": [],
  "disabled_statickey_auth": false,
  "logging": {}
}

### Response
#### Success Response (200)
- **operation** (Operation) - Operation object.

#### Response Example
{
  "operation": {}
}
```

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

### ListInventoryConfigurations

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/storage.md

Lists inventory configurations for a bucket.

```APIDOC
## [GET] /storage/v1/buckets/{bucket}:listInventoryConfigurations

### Description
Lists inventory configurations for a bucket.

### Method
GET

### Endpoint
/storage/v1/buckets/{bucket}:listInventoryConfigurations

### Parameters
#### Path Parameters
- **bucket** (string) - Required - Bucket name.

### Response
#### Success Response (200)
- **inventory_configurations** (array) - List of inventory configurations.

#### Response Example
{
  "inventory_configurations": []
}
```

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

### GET /quota-manager/v1/quotaLimits/{quota_id}

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/endpoints.md

Retrieves a specific quota limit by its ID.

```APIDOC
## GET /quota-manager/v1/quotaLimits/{quota_id}

### Description
Retrieves a specific quota limit by its ID.

### Method
GET

### Endpoint
/quota-manager/v1/quotaLimits/{quota_id}

### Parameters
#### Path Parameters
- **quota_id** (string) - Required - The ID of the quota limit to retrieve.

```

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

### Get

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/storage.md

Retrieves a specific bucket by its name, including all heavy fields.

```APIDOC
## [GET] /storage/v1/buckets/{name}

### Description
Retrieves a specific bucket by its name, including all heavy fields.

### Method
GET

### Endpoint
/storage/v1/buckets/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - Name of the bucket.

### Response
#### Success Response (200)
- **name** (string) - Bucket name.
- **folder_id** (string) - Folder ID.
- **anonymous_access_flags** (object) - Anonymous access flags.
- **default_storage_class** (string) - Default storage class.
- **max_size** (int64) - Maximum size.
- **policy** (Struct) - Bucket policy.
- **acl** (object) - Access control list.
- **cors** (array) - CORS rules.
- **website_settings** (object) - Website settings.
- **lifecycle_rules** (array) - Lifecycle rules.
- **tags** (object) - Tags.
- **object_lock** (object) - Object lock settings.
- **encryption** (object) - Encryption settings.
- **allowed_private_endpoints** (array) - Allowed private endpoints.
- **disabled_statickey_auth** (bool) - Disabled static key auth.
- **logging** (object) - Logging settings.

#### Response Example
{
  "name": "my-bucket",
  "folder_id": "folder-id",
  "anonymous_access_flags": {},
  "default_storage_class": "STANDARD",
  "max_size": 1000000,
  "policy": {},
  "acl": {},
  "cors": [],
  "website_settings": {},
  "lifecycle_rules": [],
  "tags": {},
  "object_lock": {},
  "encryption": {},
  "allowed_private_endpoints": [],
  "disabled_statickey_auth": false,
  "logging": {}
}
```

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

### CreateInventoryConfiguration

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/storage.md

Creates an inventory configuration for a bucket.

```APIDOC
## [POST] /storage/v1/buckets/{bucket}/{id}:createInventoryConfiguration

### Description
Creates an inventory configuration for a bucket.

### Method
POST

### Endpoint
/storage/v1/buckets/{bucket}/{id}:createInventoryConfiguration

### Parameters
#### Path Parameters
- **bucket** (string) - Required - Bucket name.
- **id** (string) - Required - Inventory configuration ID.

#### Request Body
- **inventory_configuration** (object) - Required - Inventory configuration details.

### Request Example
{
  "inventory_configuration": {}
}

### Response
#### Success Response (200)
- **operation** (Operation) - Operation object.

#### Response Example
{
  "operation": {}
}
```

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

### GET /functions/v1/runtimes

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/serverless-functions.md

Lists available runtimes. Corresponds to the ListRuntimes RPC.

```APIDOC
## [GET] /functions/v1/runtimes

### Description
Lists available runtimes.

### Method
GET

### Endpoint
/functions/v1/runtimes

### Response
#### Success Response (200)
Returns a ListRuntimesResponse object.

```

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

### Go example: Write two log entries

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/logging.md

Shows how to call the Write method with a destination log group ID and two entries. The response uses a partial-failure model: iterate over resp.Errors to find failed entries by index; entries not in the map succeeded. Transport-level errors are returned as err.

```go
resp, err := ingClient.Write(ctx, &logging.WriteRequest{
    Destination: &logging.Destination{
        Destination: &logging.Destination_LogGroupId{LogGroupId: "e23abcd..."},
    },
    Entries: []*logging.IncomingLogEntry{
        {Message: "start", Level: logging.LogLevel_INFO, Timestamp: now},
        {Message: "request", Level: logging.LogLevel_DEBUG, Timestamp: now},
    },
})
if err != nil {
    // transport-level failure
}
for idx, status := range resp.Errors {
    // entry #idx failed with the given google.rpc.Status
}
```

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

### GET /functions/v1/versions

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/serverless-functions.md

Lists function versions. Corresponds to the ListVersions RPC.

```APIDOC
## [GET] /functions/v1/versions

### Description
Lists function versions.

### Method
GET

### Endpoint
/functions/v1/versions

### Response
#### Success Response (200)
Returns a Response object.

```

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

### GET /functions/v1/functions

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/serverless-functions.md

Lists functions in a folder. Corresponds to the List RPC.

```APIDOC
## [GET] /functions/v1/functions

### Description
Lists functions in a folder.

### Method
GET

### Endpoint
/functions/v1/functions

### Response
#### Success Response (200)
Returns a ListFunctionsResponse object.

```

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

### Compute MCP config with input-field exclusion and include_protos

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/configuration.md

Example YAML for compute service, using `include_protos` to expose a private proto and disabling the `metadata` input field for `InstanceService.Update`.

```yaml
include_protos:
  - yandex/cloud/priv/compute/v1/platform_service.proto

services:
  - name: InstanceService
    tools:
      - method: Update
        input:
        - field: metadata
          disabled: true

```

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

### GET /managed-postgresql/v1/clusters/{cluster_id}/hosts

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/mdb-postgresql.md

Lists hosts of a PostgreSQL cluster.

```APIDOC
## GET /managed-postgresql/v1/clusters/{cluster_id}/hosts

### Description
Returns a list of hosts for the specified PostgreSQL cluster.

### Method
GET

### Endpoint
/managed-postgresql/v1/clusters/{cluster_id}/hosts

### Parameters
#### Path Parameters
- **cluster_id** (string) - Required - ID of the cluster.

#### Query Parameters
- **page_size** (int32) - Optional - Maximum number of results per page.
- **page_token** (string) - Optional - Pagination token.

### Response
#### Success Response (200)
Returns a Response object.

#### Response Example
{
  "hosts": [
    {
      "name": "string",
      "zone_id": "string"
    }
  ],
  "next_page_token": "string"
}
```

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

### GET /managed-postgresql/v1/clusters/{cluster_id}/backups

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/api-reference/mdb-postgresql.md

Lists backups of a PostgreSQL cluster.

```APIDOC
## GET /managed-postgresql/v1/clusters/{cluster_id}/backups

### Description
Returns a list of backups for the specified PostgreSQL cluster.

### Method
GET

### Endpoint
/managed-postgresql/v1/clusters/{cluster_id}/backups

### Parameters
#### Path Parameters
- **cluster_id** (string) - Required - ID of the cluster.

#### Query Parameters
- **page_size** (int32) - Optional - Maximum number of results per page.
- **page_token** (string) - Optional - Pagination token.

### Response
#### Success Response (200)
Returns a Response object.

#### Response Example
{
  "backups": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "next_page_token": "string"
}
```

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

### DatabaseService.Create

Source: https://github.com/yandex-cloud/cloudapi/blob/master/_autodocs/endpoints.md

Creates a database in the specified PostgreSQL cluster.

```APIDOC
## POST /managed-postgresql/v1/clusters/{cluster_id}/databases

### Description
Creates a database in the specified PostgreSQL cluster.

### Method
POST

### Endpoint
/managed-postgresql/v1/clusters/{cluster_id}/databases

### Parameters
#### Path Parameters
- **cluster_id** (string) - Required - ID of the PostgreSQL cluster to create a database in.

#### Request Body
- **database_spec** (object) - Required - Specification of the database to create.

### Response
#### Success Response (200)
Returns the operation result.

```
Tokens:
Raw