{ "components": { "schemas": { "google.protobuf.Any": { "additionalProperties": {}, "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", "properties": { "@type": { "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", "type": "string" } }, "type": "object" }, "google.protobuf.NullValue": { "default": "NULL_VALUE", "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value.", "enum": [ "NULL_VALUE" ], "type": "string" }, "google.rpc.Code": { "default": "OK", "description": "The canonical error codes for gRPC APIs.\n\n\nSometimes multiple error codes may apply. Services should return\nthe most specific error code that applies. For example, prefer\n`OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply.\nSimilarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`.\n\n - OK: Not an error; returned on success.\n\nHTTP Mapping: 200 OK\n - CANCELLED: The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request\n - UNKNOWN: Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error\n - INVALID_ARGUMENT: The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request\n - DEADLINE_EXCEEDED: The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout\n - NOT_FOUND: Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented allowlist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found\n - ALREADY_EXISTS: The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict\n - PERMISSION_DENIED: The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden\n - UNAUTHENTICATED: The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized\n - RESOURCE_EXHAUSTED: Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests\n - FAILED_PRECONDITION: The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level. For\n example, when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence.\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. For example, if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request\n - ABORTED: The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict\n - OUT_OF_RANGE: The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request\n - UNIMPLEMENTED: The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented\n - INTERNAL: Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error\n - UNAVAILABLE: The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff. Note that it is not always safe to retry\nnon-idempotent operations.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable\n - DATA_LOSS: Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error", "enum": [ "OK", "CANCELLED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "UNAUTHENTICATED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS" ], "type": "string" }, "google.rpc.Status": { "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "code": { "description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code].", "format": "int32", "type": "integer" }, "details": { "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "items": { "$ref": "#/components/schemas/google.protobuf.Any" }, "type": "array" }, "message": { "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client.", "type": "string" } }, "type": "object" }, "nebius.ai.v1.CancelJobRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.ai.v1.CreateDevlabRequest": { "description": "A request to create a Devlab.", "properties": { "dryRun": { "description": "Validates the request without creating the Devlab.", "type": "boolean" }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "The metadata for the new Devlab." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec" } ], "description": "The configuration for the new Devlab." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.ai.v1.CreateEndpointRequest": { "properties": { "dryRun": { "description": "Dry run creation of the endpoint.", "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.ai.v1.CreateJobRequest": { "properties": { "dryRun": { "description": "Dry run creation of the job.", "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.ai.v1.Devlab": { "description": "Represents an interactive development environment backed by Serverless infrastructure.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "The metadata of the Devlab." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec" } ], "description": "The configuration of the Devlab." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabStatus" } ], "description": "The current status of the Devlab.", "readOnly": true } }, "type": "object" }, "nebius.ai.v1.DevlabInstanceStatus": { "description": "DevlabInstanceStatus represents the status of a Devlab runtime instance.", "properties": { "computeInstanceId": { "description": "ID of the compute instance running the Devlab.", "type": "string" }, "computeInstanceState": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.InstanceStatus.InstanceState" } ], "description": "The current state of the compute instance." }, "privateIp": { "description": "Private IP address of the instance.", "type": "string" }, "publicIp": { "description": "Public IP address of the instance.", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabInstanceStatus.State" } ], "description": "The current state of the Devlab's workload." } }, "type": "object" }, "nebius.ai.v1.DevlabInstanceStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Devlab instance state.\n\n - STATE_UNSPECIFIED: The service did not report the instance's state.\n - PROVISIONING: The Devlab is creating resources.\n - STARTING: The Devlab is being started.\n - RUNNING: The Devlab is running.\n - STOPPING: The Devlab is being stopped.\n - DELETING: The Devlab is being deleted.\n - STOPPED: The Devlab has been stopped.\n - FAILED: The Devlab has failed.\n - ERROR: The Devlab encountered an error.\n - IMAGE_PULLING: The Devlab is pulling an image (STARTING -\u003e IMAGE_PULLING -\u003e RUNNING).", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "STARTING", "RUNNING", "STOPPING", "DELETING", "STOPPED", "FAILED", "ERROR", "IMAGE_PULLING" ], "type": "string" }, "nebius.ai.v1.DevlabSpec": { "description": "DevlabSpec defines an interactive workload that will be run.", "properties": { "args": { "description": "The arguments to pass to the entrypoint command.", "type": "string" }, "authTokenMysteryboxSecret": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.MysteryBoxSecretRef" } ], "description": "The MysteryBox secret that contains the authentication token under the `AUTH_TOKEN` payload key.\nThis field enables an authentication proxy for the Devlab's HTTP ports.\nThe proxy rejects requests without an `Authorization: Bearer \u003ctoken\u003e` header that contains the matching token.\nIf absent, Serverless does not add this bearer-token check." }, "containerCommand": { "description": "The entrypoint command for the Devlab's container.", "type": "string" }, "disk": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.DiskSpec" } ], "description": "Disk spec for the main disk of the Devlab runtime VM." }, "environmentVariables": { "description": "Specifies the environment variables for the Devlab's container.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.EnvironmentVariable" }, "type": "array" }, "image": { "description": "The Docker image to use for the Devlab's container.\n\nRequired unless `template` is set: the template declares the image.", "type": "string" }, "injectedFiles": { "description": "Small config files injected into the container before the user process\nstarts. Intended for configs, not datasets. Read methods return target\npaths. File content is returned only by Get with view SECRET.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.FileInjection" }, "type": "array" }, "platform": { "description": "Compute platform that the Devlab will be run on.", "type": "string" }, "ports": { "description": "Specifies the ports that the Devlab exposes.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.Port" }, "type": "array" }, "preset": { "description": "Compute preset that the Devlab will be run on.", "type": "string" }, "primaryRoute": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.PrimaryRoute" } ], "description": "Primary web route exposed through the managed HTTPS endpoint.\n\nRequired unless `template` is set: the template declares the primary\nweb UI port." }, "publicIp": { "description": "Whether to assign a public IP to the Devlab runtime VM.", "type": "boolean" }, "registryCredentials": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.RegistryCredentials" } ], "description": "Registry credentials for private Docker registry." }, "shmSizeBytes": { "description": "Shared memory size in bytes for the Devlab's container.", "format": "int64", "type": "string" }, "sshAuthorizedKeys": { "description": "Public keys to be authorized for SSH access to the Devlab.", "items": { "type": "string" }, "type": "array" }, "subnetId": { "description": "Subnet ID where the Devlab will be deployed.\nIf omitted, the service uses the project's default subnet in the workload region.", "type": "string" }, "template": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.Template" } ], "description": "Template that defines the Devlab's container.\n\nWhen set, the template declares the container shape: image, entrypoint\ncommand, arguments, working directory, ports, optional shared memory size,\nthe primary web route, and the default workspace path. The spec must leave\nimage, container command, arguments, working directory, and primary route\nempty. Environment variables and ports extend the template-declared ones,\n`workspace.container_path` may override the template default, and\n`shm_size_bytes` may be set only when the template leaves it unset.\n\nThe template is consumed at creation time: read methods return the\nrendered container shape instead of the template reference." }, "volumes": { "description": "Extra volumes to be mounted into the Devlab container.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.VolumeMount" }, "type": "array" }, "workingDir": { "description": "The working directory for the Devlab's container.", "type": "string" }, "workspace": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.Workspace" } ], "description": "Primary workspace storage for user state." } }, "required": [ "disk", "workspace" ], "type": "object" }, "nebius.ai.v1.DevlabSpec.DiskSpec": { "properties": { "sizeBytes": { "description": "Disk size in bytes.", "format": "int64", "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.DiskSpec.DiskType" } ], "description": "Disk type." } }, "required": [ "type" ], "type": "object" }, "nebius.ai.v1.DevlabSpec.EnvironmentVariable": { "description": "EnvironmentVariable defines an environment variable for the Devlab's container.", "properties": { "mysteryboxSecret": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.MysteryBoxSecretRef" } ], "description": "Secret storing the environment variable value.\nThe value is read from the payload entry whose key matches the variable\nname, or the first entry when no such key exists." }, "name": { "description": "The name of the environment variable.", "type": "string" }, "value": { "description": "Environment variable value.\nThe unmasked value is returned only by Get with view SECRET.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "nebius.ai.v1.DevlabSpec.FileInjection": { "description": "FileInjection materializes a small file inside the container at launch.", "properties": { "containerPath": { "description": "Absolute path inside the container where the content is written.\n\nMust be a clean absolute path: root, trailing slashes, empty path\nsegments, \".\" and \"..\" are not allowed.", "type": "string" }, "content": { "description": "File content. On create, must contain between 1 byte and 64 KiB\n(one mystery box secret payload).\nReturned only by Get with view SECRET.", "format": "byte", "type": "string" } }, "required": [ "containerPath" ], "type": "object" }, "nebius.ai.v1.DevlabSpec.MysteryBoxSecretRef": { "description": "Reference to a MysteryBox secret.", "properties": { "secretId": { "description": "MysteryBox secret ID.", "type": "string" }, "versionId": { "description": "MysteryBox secret version ID.", "type": "string" } }, "type": "object" }, "nebius.ai.v1.DevlabSpec.Port": { "properties": { "containerPort": { "description": "Container port.", "format": "int32", "type": "integer" }, "hostPort": { "description": "Host port.\n\nSet to 0 to use the same value as container_port.", "format": "int32", "type": "integer" }, "protocol": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.Port.Protocol" } ], "description": "Port's protocol." } }, "required": [ "protocol" ], "type": "object" }, "nebius.ai.v1.DevlabSpec.Port.Protocol": { "default": "PROTOCOL_UNSPECIFIED", "description": "Represents protocol of the Devlab's port which will be exposed.\n\n - PROTOCOL_UNSPECIFIED: No protocol selected. Specify HTTP, TCP, or UDP.\n - HTTP: HTTP protocol.\n - TCP: TCP protocol.\n - UDP: UDP protocol.", "enum": [ "PROTOCOL_UNSPECIFIED", "HTTP", "TCP", "UDP" ], "type": "string" }, "nebius.ai.v1.DevlabSpec.PrimaryRoute": { "properties": { "containerPort": { "description": "Container port that serves the primary web UI.", "format": "int32", "type": "integer" } }, "type": "object" }, "nebius.ai.v1.DevlabSpec.RegistryCredentials": { "properties": { "mysteryboxSecretVersion": { "description": "Secret version storing the registry credentials.\nMust have keys \"REGISTRY_USERNAME\" and \"REGISTRY_PASSWORD\".", "type": "string" } }, "type": "object" }, "nebius.ai.v1.DevlabSpec.Template": { "description": "Reference to a VM app template the Devlab's container is rendered from.", "properties": { "id": { "description": "VM app template ID.", "type": "string" }, "inputFieldValues": { "additionalProperties": {}, "description": "The values for the template's input fields, keyed by each TemplateInputField.id.\nVmAppTemplateService.Get and List return these field definitions in VmAppTemplate.status.input_fields.\nEach value must match its field's type:\n- STRING: string_value. The value must satisfy the template's pattern, options, or unit format.\n- INTEGER: number_value with an integer value within the template's bounds.\n- BOOLEAN: bool_value.\n- MYSTERYBOX_SECRET_VERSION: string_value with the secret version ID.\nnull_value and absent entries both omit the input. Required inputs cannot be omitted.\nOptional inputs use the defaults from the template's input definition.\nExplicit false, 0, and empty strings are values, not omitted inputs. The template's validation still applies.\nObject and list values are not supported. Unknown field IDs have no effect.\nRead methods do not return this map.", "type": "object" } }, "required": [ "id" ], "type": "object" }, "nebius.ai.v1.DevlabSpec.VolumeMount": { "description": "VolumeMount represents an extra volume mount for the Devlab container.", "properties": { "containerPath": { "description": "Path inside the Devlab container where the volume is mounted.\n\nMust be a clean absolute path: root, trailing slashes, empty path\nsegments, \".\" and \"..\" are not allowed.", "type": "string" }, "mode": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.VolumeMount.Mode" } ], "description": "Mount mode." }, "s3Config": { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.VolumeMount.S3Config" }, "source": { "description": "Source of the volume mount.\n\nCan be a name or an ID of Nebius Storage bucket or filesystem,\nor an S3 URI (e.g. \"s3://bucket-name\") when using external S3 storage.", "type": "string" }, "sourcePath": { "description": "Path inside the source volume.\n\nOptional.", "type": "string" } }, "required": [ "source", "containerPath", "mode" ], "type": "object" }, "nebius.ai.v1.DevlabSpec.VolumeMount.Mode": { "default": "MODE_UNSPECIFIED", "description": "Mode that will be used to mount the volume.\n\n - MODE_UNSPECIFIED: No mount mode selected. Specify READ_WRITE or READ_ONLY.\n - READ_WRITE: Read-write mode.\n - READ_ONLY: Read-only mode.", "enum": [ "MODE_UNSPECIFIED", "READ_WRITE", "READ_ONLY" ], "type": "string" }, "nebius.ai.v1.DevlabSpec.VolumeMount.S3Config": { "description": "Config for accessing an external S3-compatible storage.\n\nThe bucket name is specified in the `source` field as an S3 URI.", "properties": { "endpoint": { "description": "S3-compatible endpoint URL (e.g. \"https://s3.amazonaws.com\").", "type": "string" }, "mysteryboxSecret": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabSpec.MysteryBoxSecretRef" } ], "description": "Reference to a MysteryBox secret containing S3 credentials." }, "region": { "description": "S3 region.", "type": "string" } }, "required": [ "endpoint", "region", "mysteryboxSecret" ], "type": "object" }, "nebius.ai.v1.DevlabSpec.Workspace": { "properties": { "containerPath": { "description": "Path inside the Devlab container where the workspace is mounted.\n\nMust be a clean absolute path: root, trailing slashes, empty path\nsegments, \".\" and \"..\" are not allowed.\n\nRequired unless the Devlab is created from a template: the template\ndeclares the default workspace path, and a non-empty value overrides it.", "type": "string" } }, "type": "object" }, "nebius.ai.v1.DevlabStateDetails": { "description": "Devlab state details.", "properties": { "code": { "description": "Short state description.", "type": "string" }, "message": { "description": "Detailed human-readable description.", "type": "string" }, "serviceError": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ServiceError" } ], "description": "Structured error details for the failure, if available." } }, "type": "object" }, "nebius.ai.v1.DevlabStatus": { "description": "DevlabStatus represents the status of a Devlab.", "properties": { "instances": { "description": "Status of individual Devlab runtime instances.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.DevlabInstanceStatus" }, "type": "array" }, "privateEndpoints": { "description": "Private endpoints to access the workload.", "items": { "type": "string" }, "type": "array" }, "publicEndpoints": { "description": "Managed HTTPS/TLS URLs the workload is reachable at, one per routable port.\n\nPopulated only while the Devlab is RUNNING and its managed tunnel is ready;\nempty otherwise. The URLs are not bearer secrets — Tunna/IAM authorizes\naccess on use — so they are returned to any caller that may read the Devlab.", "items": { "type": "string" }, "type": "array" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabStatus.State" } ], "description": "State of the Devlab." }, "stateDetails": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.DevlabStateDetails" } ], "description": "Details of the Devlab's state." } }, "type": "object" }, "nebius.ai.v1.DevlabStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Devlab state.\n\n - STATE_UNSPECIFIED: The service did not report the Devlab's state.\n - PROVISIONING: The Devlab is creating resources.\n - STARTING: The Devlab is being started.\n - RUNNING: The Devlab is running.\n - STOPPING: The Devlab is being stopped.\n - DELETING: The Devlab is being deleted.\n - STOPPED: The Devlab has been stopped.\n - FAILED: The Devlab has failed.\n - ERROR: The Devlab encountered an error.\n - IMAGE_PULLING: The Devlab is pulling an image (STARTING -\u003e IMAGE_PULLING -\u003e RUNNING).", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "STARTING", "RUNNING", "STOPPING", "DELETING", "STOPPED", "FAILED", "ERROR", "IMAGE_PULLING" ], "type": "string" }, "nebius.ai.v1.Endpoint": { "description": "Represents an endpoint with a specified workload.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.ai.v1.EndpointInstanceStatus": { "description": "EndpointInstanceStatus represents the status of a endpoint instance.", "properties": { "computeInstanceId": { "description": "ID of the compute instance running the endpoint.", "type": "string" }, "computeInstanceState": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.InstanceStatus.InstanceState" } ], "description": "The current state of the compute instance." }, "privateIp": { "description": "Private IP address of the instance.", "type": "string" }, "publicIp": { "description": "Public IP address of the instance.", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointInstanceStatus.State" } ], "description": "The current state of the endpoint's workload." } }, "type": "object" }, "nebius.ai.v1.EndpointInstanceStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Endpoint instance state.\n\n - PROVISIONING: The endpoint is creating resources.\n - STARTING: The endpoint is being started.\n - RUNNING: The endpoint is running.\n - STOPPING: The endpoint is being stopped.\n - DELETING: The endpoint is being deleted.\n - STOPPED: The endpoint has been stopped.\n - FAILED: The endpoint has failed.\n - ERROR: The endpoint encountered an error.\n - IMAGE_PULLING: The endpoint is pulling an image (STARTING -\u003e IMAGE_PULLING -\u003e RUNNING).", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "STARTING", "RUNNING", "STOPPING", "DELETING", "STOPPED", "FAILED", "ERROR", "IMAGE_PULLING" ], "type": "string" }, "nebius.ai.v1.EndpointSpec": { "description": "EndpointSpec defines a endpoint that will be run.", "properties": { "args": { "description": "The arguments to pass to the entrypoint command.", "type": "string" }, "authToken": { "description": "Authentication token needed to access the endpoint.\n\nAuthentication can only be enabled if the endpoint exposes one and only one HTTP port.\n\nMutually exclusive with `auth_token_mysterybox_secret`.\nIf not provided, authentication will be disabled.", "type": "string" }, "authTokenMysteryboxSecret": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.MysteryBoxSecretRef" } ], "description": "Secret storing the authentication token.\nMutually exclusive with `auth_token`.\nMust reference a secret payload containing `AUTH_TOKEN`." }, "containerCommand": { "description": "The entrypoint command for the endpoint's container.", "type": "string" }, "disk": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.DiskSpec" } ], "description": "Disk spec for the main disk of the endpoint." }, "environmentVariables": { "description": "Specifies the environment variables for the endpoint's container.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.EnvironmentVariable" }, "type": "array" }, "image": { "description": "The Docker image to use for the endpoint's container.", "type": "string" }, "injectedFiles": { "description": "Small config files injected into the container before the user process\nstarts. Intended for configs, not datasets. Read methods return target\npaths. File content is returned only by Get with view SECRET.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.FileInjection" }, "type": "array" }, "platform": { "description": "Compute platform that the endpoint will be run on.", "type": "string" }, "ports": { "description": "Specifies the ports that the endpoint exposes.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.Port" }, "type": "array" }, "preemptible": { "description": "Whether to use a preemptible VM for the endpoint.\nPreemptible VMs are cheaper but can be stopped by the platform at any time.", "type": "boolean" }, "preset": { "description": "Compute preset that the endpoint will be run on.", "type": "string" }, "pricingModel": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.PricingModelSpec" } ], "description": "Pricing model for the VM. Must match the preemptible flag.\nPreemptible VMs require follows_spot_price or spot_pricing_policy.\nRegular VMs use on_demand or omit this field." }, "publicIp": { "description": "Whether to assign a public IP to the endpoint.", "type": "boolean" }, "registryCredentials": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.RegistryCredentials" } ], "description": "Registry credentials for private Docker registry." }, "shmSizeBytes": { "description": "Shared memory size in bytes for the endpoint's container.", "format": "int64", "type": "string" }, "sshAuthorizedKeys": { "description": "Public keys to be authorized for SSH access to the job.", "items": { "type": "string" }, "type": "array" }, "subnetId": { "description": "Subnet ID where the endpoint will be deployed.\nIf omitted, the service uses the project's default subnet in the workload region.", "type": "string" }, "volumes": { "description": "Volumes to be mounted into the endpoint's container.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.VolumeMount" }, "type": "array" }, "workingDir": { "description": "The working directory for the endpoint's container.", "type": "string" } }, "required": [ "image", "disk" ], "type": "object" }, "nebius.ai.v1.EndpointSpec.DiskSpec": { "properties": { "sizeBytes": { "description": "Disk size in bytes.", "format": "int64", "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.DiskSpec.DiskType" } ], "description": "Disk type." } }, "required": [ "type" ], "type": "object" }, "nebius.ai.v1.EndpointSpec.EnvironmentVariable": { "description": "EnvironmentVariable defines an environment variable for the endpoint's container.", "properties": { "mysteryboxSecret": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.MysteryBoxSecretRef" } ], "description": "Secret storing the environment variable value.\nMutually exclusive with `value`.\nThe value is read from the payload entry whose key matches the variable\nname, or the first entry when no such key exists." }, "name": { "description": "The name of the environment variable.", "type": "string" }, "value": { "description": "Environment variable value.\nMutually exclusive with `mysterybox_secret`.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "nebius.ai.v1.EndpointSpec.FileInjection": { "description": "FileInjection materializes a small file inside the container at launch.", "properties": { "containerPath": { "description": "Absolute path inside the container where the content is written.\n\nMust be a clean absolute path: root, trailing slashes, empty path\nsegments, \".\" and \"..\" are not allowed.", "type": "string" }, "content": { "description": "File content. On create, must contain between 1 byte and 64 KiB\n(one mystery box secret payload).\nReturned only by Get with view SECRET.", "format": "byte", "type": "string" } }, "required": [ "containerPath" ], "type": "object" }, "nebius.ai.v1.EndpointSpec.MysteryBoxSecretRef": { "description": "Reference to a MysteryBox secret.", "properties": { "secretId": { "description": "MysteryBox secret ID.", "type": "string" }, "versionId": { "description": "MysteryBox secret version ID.", "type": "string" } }, "type": "object" }, "nebius.ai.v1.EndpointSpec.Port": { "properties": { "containerPort": { "description": "Container port.", "format": "int32", "type": "integer" }, "hostPort": { "description": "Host port.\n\nIf not specified, will be same as container_port.", "format": "int32", "type": "integer" }, "protocol": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.Port.Protocol" } ], "description": "Port's protocol." } }, "required": [ "protocol" ], "type": "object" }, "nebius.ai.v1.EndpointSpec.Port.Protocol": { "default": "PROTOCOL_UNSPECIFIED", "description": "Represents protocol of the endpoint's port which will be exposed.\n\n - HTTP: HTTP protocol.\n - TCP: TCP protocol.\n - UDP: UDP protocol.", "enum": [ "PROTOCOL_UNSPECIFIED", "HTTP", "TCP", "UDP" ], "type": "string" }, "nebius.ai.v1.EndpointSpec.RegistryCredentials": { "properties": { "mysteryboxSecretVersion": { "description": "Secret version storing the registry credentials.\nMust have keys \"REGISTRY_USERNAME\" and \"REGISTRY_PASSWORD\".", "type": "string" }, "password": { "description": "Registry password for private Docker registry.", "type": "string" }, "username": { "description": "Registry username for private Docker registry.", "type": "string" } }, "type": "object" }, "nebius.ai.v1.EndpointSpec.VolumeMount": { "description": "VolumeMount represents a volume mount for the endpoint's container.", "properties": { "containerPath": { "description": "Path inside the endpoint's container where the volume is mounted.\n\nMust be an absolute path.", "type": "string" }, "mode": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.VolumeMount.Mode" } ], "description": "Mount mode." }, "s3Config": { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.VolumeMount.S3Config" }, "source": { "description": "Source of the volume mount.\n\nCan be a name or an ID of Nebius Storage bucket or filesystem,\nor an S3 URI (e.g. \"s3://bucket-name\") when using external S3 storage.", "type": "string" }, "sourcePath": { "description": "Path inside the source volume.\n\nOptional.", "type": "string" } }, "required": [ "mode" ], "type": "object" }, "nebius.ai.v1.EndpointSpec.VolumeMount.Mode": { "default": "MODE_UNSPECIFIED", "description": "Mode that will be used to mount the volume.\n\n - READ_ONLY: Read-only mode.\n - READ_WRITE: Read-write mode.", "enum": [ "MODE_UNSPECIFIED", "READ_ONLY", "READ_WRITE" ], "type": "string" }, "nebius.ai.v1.EndpointSpec.VolumeMount.S3Config": { "description": "Config for accessing an external S3-compatible storage.\n\nThe bucket name is specified in the `source` field as an S3 URI.", "properties": { "credentials": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.VolumeMount.S3Config.S3Credentials" } ], "description": "Inline S3 credentials.\nUnmasked values are returned only by Get with view SECRET." }, "endpoint": { "description": "S3-compatible endpoint URL (e.g. \"https://s3.amazonaws.com\").", "type": "string" }, "mysteryboxSecret": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointSpec.VolumeMount.S3Config.MysteryBoxSecretRef" } ], "description": "Reference to a MysteryBox secret containing S3 credentials." }, "region": { "description": "S3 region.", "type": "string" } }, "required": [ "endpoint", "region" ], "type": "object" }, "nebius.ai.v1.EndpointSpec.VolumeMount.S3Config.MysteryBoxSecretRef": { "description": "Reference to a MysteryBox secret.", "properties": { "secretId": { "description": "MysteryBox secret ID.", "type": "string" }, "versionId": { "description": "MysteryBox secret version ID.", "type": "string" } }, "type": "object" }, "nebius.ai.v1.EndpointSpec.VolumeMount.S3Config.S3Credentials": { "description": "Inline S3 credentials.", "properties": { "accessKeyId": { "description": "Access key ID.", "type": "string" }, "secretAccessKey": { "description": "Secret access key.", "type": "string" }, "sessionToken": { "description": "Session token (optional, for temporary credentials).", "type": "string" } }, "required": [ "accessKeyId", "secretAccessKey" ], "type": "object" }, "nebius.ai.v1.EndpointStateDetails": { "description": "Endpoint state details.", "properties": { "code": { "description": "Short state description.", "type": "string" }, "message": { "description": "Detailed human-readable description.", "type": "string" }, "serviceError": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ServiceError" } ], "description": "Structured error details for the failure, if available.\nFor quota-related failures, `service_error.details.quota_failure`\nis populated with the quota violations." } }, "type": "object" }, "nebius.ai.v1.EndpointStatus": { "description": "EndpointStatus represents the status of a VM app.", "properties": { "instances": { "description": "Status of individual endpoint instances.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.EndpointInstanceStatus" }, "type": "array" }, "privateEndpoints": { "description": "Private endpoints to access the workload.", "items": { "type": "string" }, "type": "array" }, "publicEndpoints": { "description": "Public endpoints to access the workload.", "items": { "type": "string" }, "type": "array" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointStatus.State" } ], "description": "State of the endpoint." }, "stateDetails": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.EndpointStateDetails" } ], "description": "Details of the endpoint's state." } }, "type": "object" }, "nebius.ai.v1.EndpointStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Endpoint state.\n\n - PROVISIONING: The endpoint is creating resources.\n - STARTING: The endpoint is being started.\n - RUNNING: The endpoint is running.\n - STOPPING: The endpoint is being stopped.\n - DELETING: The endpoint is being deleted.\n - STOPPED: The endpoint has been stopped.\n - ERROR: The endpoint encountered an error.\n - IMAGE_PULLING: The endpoint is pulling an image (STARTING -\u003e IMAGE_PULLING -\u003e RUNNING).", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "STARTING", "RUNNING", "STOPPING", "DELETING", "STOPPED", "ERROR", "IMAGE_PULLING" ], "type": "string" }, "nebius.ai.v1.FollowsSpotPriceSpec": { "type": "object" }, "nebius.ai.v1.GetDevlabRequest.View": { "default": "VIEW_UNSPECIFIED", "description": "Controls which sensitive values the response includes.\n\n - VIEW_UNSPECIFIED: Masks environment-variable values and omits injected-file content.\n - SECRET: Includes unmasked environment-variable values and injected-file content.\nRequires the resource.devlab.getSensitiveData permission.", "enum": [ "VIEW_UNSPECIFIED", "SECRET" ], "type": "string" }, "nebius.ai.v1.GetEndpointRequest.View": { "default": "VIEW_UNSPECIFIED", "description": "Controls whether injected-file content and unmasked inline S3 credential values are included.", "enum": [ "VIEW_UNSPECIFIED", "SECRET" ], "type": "string" }, "nebius.ai.v1.GetJobRequest.View": { "default": "VIEW_UNSPECIFIED", "description": "Controls whether injected-file content and unmasked inline S3 credential values are included.", "enum": [ "VIEW_UNSPECIFIED", "SECRET" ], "type": "string" }, "nebius.ai.v1.Job": { "description": "Represents a job with a specified workload.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.JobStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.ai.v1.JobInstanceStatus": { "description": "JobInstanceStatus represents the status of a job instance.", "properties": { "computeInstanceId": { "description": "ID of the compute instance running the job.", "type": "string" }, "computeInstanceState": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.InstanceStatus.InstanceState" } ], "description": "The current state of the compute instance." }, "privateIp": { "description": "Private IP address of the instance.", "type": "string" }, "publicIp": { "description": "Public IP address of the instance.", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.JobInstanceStatus.State" } ], "description": "The current state of the job's workload." } }, "type": "object" }, "nebius.ai.v1.JobInstanceStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Job instance state.\n\n - PROVISIONING: The job is creating resources.\n - STARTING: The job is being started.\n - RUNNING: The job is running.\n - COMPLETING: The job is completing.\n - CANCELLING: The job is being cancelled.\n - DELETING: The job is being deleted.\n - COMPLETED: The job has successfully completed.\n - FAILED: The job has failed.\n - CANCELLED: The job has been cancelled.\n - ERROR: The job encountered an internal error.\n - IMAGE_PULLING: The job is pulling an image (STARTING -\u003e IMAGE_PULLING -\u003e RUNNING).", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "STARTING", "RUNNING", "COMPLETING", "CANCELLING", "DELETING", "COMPLETED", "FAILED", "CANCELLED", "ERROR", "IMAGE_PULLING" ], "type": "string" }, "nebius.ai.v1.JobSpec": { "description": "JobSpec defines a job that will be run.", "properties": { "args": { "description": "The arguments to pass to the entrypoint command.", "type": "string" }, "containerCommand": { "description": "The entrypoint command for the job's container.", "type": "string" }, "disk": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.DiskSpec" } ], "description": "Main disk for the job." }, "environmentVariables": { "description": "Specifies the environment variables for the job's container.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.EnvironmentVariable" }, "type": "array" }, "image": { "description": "The Docker image to use for the job's container.", "type": "string" }, "injectedFiles": { "description": "Small config files injected into the container before the user process\nstarts. Intended for configs, not datasets. Read methods return target\npaths. File content is returned only by Get with view SECRET.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.FileInjection" }, "type": "array" }, "platform": { "description": "Compute platform for the job.", "type": "string" }, "ports": { "description": "Specifies the ports that the job exposes.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.Port" }, "type": "array" }, "preemptible": { "description": "Whether to use a preemptible VM for the job.\nPreemptible VMs are cheaper but can be stopped by the platform at any time.", "type": "boolean" }, "preset": { "description": "Compute preset for the job.", "type": "string" }, "pricingModel": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.PricingModelSpec" } ], "description": "Pricing model for the VM. Must match the preemptible flag.\nPreemptible VMs require follows_spot_price or spot_pricing_policy.\nRegular VMs use on_demand or omit this field." }, "publicIp": { "description": "Whether to assign a public IP to the job.", "type": "boolean" }, "registryCredentials": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.RegistryCredentials" } ], "description": "Registry credentials for private Docker registry." }, "restartAttempts": { "description": "Restart attempts for the job.", "format": "int64", "type": "string" }, "shmSizeBytes": { "description": "Shared memory size in bytes for the job's container.", "format": "int64", "type": "string" }, "sshAuthorizedKeys": { "description": "Public keys to be authorized for SSH access to the job.", "items": { "type": "string" }, "type": "array" }, "subnetId": { "description": "Subnet ID where the job will be deployed.\nIf omitted, the service uses the project's default subnet in the workload region.", "type": "string" }, "timeout": { "description": "Job timeout.", "type": "string" }, "volumes": { "description": "Volumes to be mounted into the job's container.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.VolumeMount" }, "type": "array" }, "workingDir": { "description": "The working directory for the job's container.", "type": "string" } }, "required": [ "image" ], "type": "object" }, "nebius.ai.v1.JobSpec.DiskSpec": { "properties": { "sizeBytes": { "description": "Disk size in bytes.", "format": "int64", "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.DiskSpec.DiskType" } ], "description": "Disk type." } }, "required": [ "type" ], "type": "object" }, "nebius.ai.v1.JobSpec.EnvironmentVariable": { "description": "EnvironmentVariable defines an environment variable for the endpoint's container.", "properties": { "mysteryboxSecret": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.MysteryBoxSecretRef" } ], "description": "Secret storing the environment variable value.\nMutually exclusive with `value`.\nThe value is read from the payload entry whose key matches the variable\nname, or the first entry when no such key exists." }, "name": { "description": "The name of the environment variable.", "type": "string" }, "value": { "description": "Environment variable value.\nMutually exclusive with `mysterybox_secret`.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "nebius.ai.v1.JobSpec.FileInjection": { "description": "FileInjection materializes a small file inside the container at launch.", "properties": { "containerPath": { "description": "Absolute path inside the container where the content is written.\n\nMust be a clean absolute path: root, trailing slashes, empty path\nsegments, \".\" and \"..\" are not allowed.", "type": "string" }, "content": { "description": "File content. On create, must contain between 1 byte and 64 KiB\n(one mystery box secret payload).\nReturned only by Get with view SECRET.", "format": "byte", "type": "string" } }, "required": [ "containerPath" ], "type": "object" }, "nebius.ai.v1.JobSpec.MysteryBoxSecretRef": { "description": "Reference to a MysteryBox secret.", "properties": { "secretId": { "description": "MysteryBox secret ID.", "type": "string" }, "versionId": { "description": "MysteryBox secret version ID.", "type": "string" } }, "type": "object" }, "nebius.ai.v1.JobSpec.Port": { "properties": { "containerPort": { "description": "Container port.", "format": "int32", "type": "integer" }, "hostPort": { "description": "Host port.\n\nIf not specified, will be same as container_port.", "format": "int32", "type": "integer" }, "protocol": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.Port.Protocol" } ], "description": "Port's protocol." } }, "required": [ "protocol" ], "type": "object" }, "nebius.ai.v1.JobSpec.Port.Protocol": { "default": "PROTOCOL_UNSPECIFIED", "description": "Represents protocol of the job's port which will be exposed.\n\n - HTTP: HTTP protocol.\n - TCP: TCP protocol.\n - UDP: UDP protocol.", "enum": [ "PROTOCOL_UNSPECIFIED", "HTTP", "TCP", "UDP" ], "type": "string" }, "nebius.ai.v1.JobSpec.RegistryCredentials": { "properties": { "mysteryboxSecretVersion": { "description": "Secret version storing the registry credentials.\nMust have keys \"REGISTRY_USERNAME\" and \"REGISTRY_PASSWORD\".", "type": "string" }, "password": { "description": "Registry password for private Docker registry.", "type": "string" }, "username": { "description": "Registry username for private Docker registry.", "type": "string" } }, "type": "object" }, "nebius.ai.v1.JobSpec.VolumeMount": { "description": "VolumeMount represents a volume mount for the endpoint's container.", "properties": { "containerPath": { "description": "Path inside the endpoint's container where the volume is mounted.\n\nMust be an absolute path.", "type": "string" }, "mode": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.VolumeMount.Mode" } ], "description": "Mount mode." }, "s3Config": { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.VolumeMount.S3Config" }, "source": { "description": "Source of the volume mount.\n\nUse a Nebius Storage bucket ID or Compute filesystem ID for managed storage.\nUse an S3 URI (e.g. \"s3://bucket-name\") with s3_config for external S3 storage.", "type": "string" }, "sourcePath": { "description": "Path inside the source volume.\n\nOptional.", "type": "string" } }, "required": [ "mode" ], "type": "object" }, "nebius.ai.v1.JobSpec.VolumeMount.Mode": { "default": "MODE_UNSPECIFIED", "description": "Mode that will be used to mount the volume.\n\n - READ_WRITE: Read-write mode.\n - READ_ONLY: Read-only mode.", "enum": [ "MODE_UNSPECIFIED", "READ_WRITE", "READ_ONLY" ], "type": "string" }, "nebius.ai.v1.JobSpec.VolumeMount.S3Config": { "description": "Config for accessing an external S3-compatible storage.\n\nThe bucket name is specified in the `source` field as an S3 URI.", "properties": { "credentials": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.VolumeMount.S3Config.S3Credentials" } ], "description": "Inline S3 credentials.\nUnmasked values are returned only by Get with view SECRET." }, "endpoint": { "description": "S3-compatible endpoint URL (e.g. \"https://s3.amazonaws.com\").", "type": "string" }, "mysteryboxSecret": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.JobSpec.VolumeMount.S3Config.MysteryBoxSecretRef" } ], "description": "Reference to a MysteryBox secret containing S3 credentials." }, "region": { "description": "S3 region.", "type": "string" } }, "required": [ "endpoint", "region" ], "type": "object" }, "nebius.ai.v1.JobSpec.VolumeMount.S3Config.MysteryBoxSecretRef": { "description": "Reference to a MysteryBox secret.", "properties": { "secretId": { "description": "MysteryBox secret ID.", "type": "string" }, "versionId": { "description": "MysteryBox secret version ID.", "type": "string" } }, "type": "object" }, "nebius.ai.v1.JobSpec.VolumeMount.S3Config.S3Credentials": { "description": "Inline S3 credentials.", "properties": { "accessKeyId": { "description": "Access key ID.", "type": "string" }, "secretAccessKey": { "description": "Secret access key.", "type": "string" }, "sessionToken": { "description": "Session token (optional, for temporary credentials).", "type": "string" } }, "required": [ "accessKeyId", "secretAccessKey" ], "type": "object" }, "nebius.ai.v1.JobStateDetails": { "description": "Job state details.", "properties": { "code": { "description": "Short state description.", "type": "string" }, "message": { "description": "Detailed human-readable description.", "type": "string" }, "serviceError": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ServiceError" } ], "description": "Structured error details for the failure, if available.\nFor quota-related failures, `service_error.details.quota_failure`\nis populated with the quota violations." } }, "type": "object" }, "nebius.ai.v1.JobStatus": { "description": "JobStatus represents the status of a VM app.", "properties": { "finishedAt": { "description": "Time when the job workload finished.", "format": "date-time", "type": "string" }, "instances": { "description": "Status of individual job instances.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.JobInstanceStatus" }, "type": "array" }, "privateEndpoints": { "description": "Private endpoints to access the workload.", "items": { "type": "string" }, "type": "array" }, "publicEndpoints": { "description": "Public endpoints to access the workload.", "items": { "type": "string" }, "type": "array" }, "startedAt": { "description": "Time when the job workload started.", "format": "date-time", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.JobStatus.State" } ], "description": "State of the job." }, "stateDetails": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.JobStateDetails" } ], "description": "Details of the job's state." } }, "type": "object" }, "nebius.ai.v1.JobStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Job state.\n\n - PROVISIONING: The job is creating resources.\n - STARTING: The job is being started.\n - RUNNING: The job is running.\n - CANCELLING: The job is being cancelled.\n - DELETING: The job is being deleted.\n - COMPLETED: The job has successfully completed.\n - FAILED: The job has failed.\n - CANCELLED: The job has been cancelled.\n - ERROR: The job encountered an internal error.\n - IMAGE_PULLING: The job is pulling an image (STARTING -\u003e IMAGE_PULLING -\u003e RUNNING).", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "STARTING", "RUNNING", "CANCELLING", "DELETING", "COMPLETED", "FAILED", "CANCELLED", "ERROR", "IMAGE_PULLING" ], "type": "string" }, "nebius.ai.v1.ListDevlabsResponse": { "description": "A page of Devlabs from a project.", "properties": { "items": { "description": "The Devlabs in this page. The list can contain fewer items than page_size.", "items": { "$ref": "#/components/schemas/nebius.ai.v1.Devlab" }, "type": "array" }, "nextPageToken": { "description": "The token for the next page. An empty string indicates the end of the list.", "type": "string" } }, "type": "object" }, "nebius.ai.v1.ListEndpointsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.ai.v1.Endpoint" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.ai.v1.ListJobsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.ai.v1.Job" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.ai.v1.OnDemandSpec": { "type": "object" }, "nebius.ai.v1.PricingModelSpec": { "description": "PricingModelSpec defines how the workload's VM is priced.\nIt mirrors the pricing model of the Compute Instance API.", "properties": { "followsSpotPrice": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.FollowsSpotPriceSpec" } ], "description": "The preemptible VM accepts the current spot price." }, "onDemand": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.OnDemandSpec" } ], "description": "A regular, non-preemptible VM." }, "spotPricingPolicy": { "allOf": [ { "$ref": "#/components/schemas/nebius.ai.v1.SpotPricingPolicySpec" } ], "description": "The preemptible VM accepts the current spot price unless it exceeds the maximum price specified by the selected\npricing policy. When the spot price exceeds that maximum price, the VM is preempted." } }, "type": "object" }, "nebius.ai.v1.RestartDevlabRequest": { "description": "A request to restart a Devlab.", "properties": { "id": { "description": "The ID of the Devlab to restart.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.ai.v1.RestartEndpointRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.ai.v1.RestartJobRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.ai.v1.SpotPricingPolicySpec": { "properties": { "id": { "description": "PricingPolicy ID used as the maximum agreed price for the preemptible VM.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.ai.v1.StartEndpointRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.ai.v1.StopDevlabRequest": { "description": "A request to stop a Devlab.", "properties": { "id": { "description": "The ID of the Devlab to stop.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.ai.v1.StopEndpointRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.applications.v1alpha1.BootDisk": { "description": "BootDisk defines a boot disk path that will be mounted into the container.", "type": "object" }, "nebius.applications.v1alpha1.ContainerDefinition": { "description": "ContainerDefinition defines a container that will be run on the VM.", "properties": { "allGpus": { "description": "If true, all available GPUs will be allocated to the container.", "type": "boolean" }, "command": { "description": "The command for the container in shell-string format.\nIf not specified, the default entrypoint from the image will be used.", "type": "string" }, "entrypoint": { "description": "The entrypoint for the container.", "type": "string" }, "environmentVariables": { "description": "Specifies the environment variables for the container.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.EnvironmentVariable" }, "type": "array" }, "exportLogs": { "description": "Enables logs export to Nebius Observability.", "type": "boolean" }, "gpuCount": { "description": "The number of GPUs to allocate to the container.", "format": "int64", "type": "string" }, "hostIpc": { "description": "Enables host IPC namespace sharing.", "type": "boolean" }, "hostNetwork": { "description": "Enables host network namespace sharing.", "type": "boolean" }, "image": { "description": "The Docker image to use for the container.", "type": "string" }, "injectedFiles": { "description": "Small files materialized inside the container before it starts.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerDefinition.InjectedFile" }, "type": "array" }, "maxAttempts": { "description": "The maximum number of restart attempts for the ON_FAILURE restart policy.\nIf absent or zero, restarts have no limit. A positive value limits the number of restarts.\nOther restart policies ignore this field. Devlab templates must omit it.", "format": "int64", "type": "string" }, "name": { "description": "The name of the container. This name is should be unique within the VM app.\nIf not specified, it will be generated based on the image name.", "type": "string" }, "ports": { "description": "Specifies the ports that the container exposes.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerDefinition.Port" }, "type": "array" }, "privileged": { "description": "If true, the container will be run in privileged mode.", "type": "boolean" }, "registryPassword": { "description": "The docker registry password to configure for the container.", "type": "string" }, "registryUsername": { "description": "The docker registry username to configure for the container.", "type": "string" }, "restartPolicy": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerDefinition.RestartPolicy" } ], "description": "The restart policy for the container.\nIf not specified, the default policy is \"always\"." }, "runtimeUser": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerDefinition.User" } ], "description": "The user to run the container as." }, "shmSizeBytes": { "description": "Shared memory size in bytes.", "format": "int64", "type": "string" }, "volumes": { "description": "The volume to be mounted into the container.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerDefinition.Volume" }, "type": "array" }, "workingDir": { "description": "The working directory for the container.", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.ContainerDefinition.InjectedFile": { "description": "InjectedFile is a small file materialized inside the container at launch.", "properties": { "containerPath": { "description": "Absolute path inside the container where the content is written.", "type": "string" }, "content": { "description": "File content. Masked out of the stored definition by Sanitize(); the\nreal bytes live only in the mystery box data secret.", "format": "byte", "type": "string" }, "id": { "description": "Stable identifier within the container, used as the materialized\nfile's name under the agent state directory.", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.ContainerDefinition.Port": { "description": "Port defines a port that is exposed by the container.", "properties": { "endpointName": { "description": "The name of the endpoint for this port, which is used to identify the endpoint in the UI.", "type": "string" }, "hostPort": { "description": "The port on the host that the container port will be mapped to.\nIf not specified, the port will be mapped to the same port on the host.", "format": "int32", "type": "integer" }, "port": { "description": "The port number of the container that needs to be exposed.", "format": "int32", "type": "integer" }, "protocol": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerDefinition.Port.Protocol" } ], "description": "The protocol used by the exposed port, either TCP or UDP.\nIf not specified, it defaults to TCP." } }, "type": "object" }, "nebius.applications.v1alpha1.ContainerDefinition.Port.Protocol": { "default": "PROTOCOL_UNSPECIFIED", "description": "The transport protocol for the exposed port.\n\n - PROTOCOL_UNSPECIFIED: No protocol specified. Uses TCP.\n - TCP: The Transmission Control Protocol.\n - UDP: The User Datagram Protocol.", "enum": [ "PROTOCOL_UNSPECIFIED", "TCP", "UDP" ], "type": "string" }, "nebius.applications.v1alpha1.ContainerDefinition.RestartPolicy": { "default": "RESTART_POLICY_UNSPECIFIED", "description": " - RESTART_POLICY_UNSPECIFIED: No restart policy specified. Uses ALWAYS.\n - ALWAYS: Restart the container whenever it stops.\n - ON_FAILURE: Restart the container only when it exits with a non-zero exit code.\n - NEVER: Do not restart the container when it stops.", "enum": [ "RESTART_POLICY_UNSPECIFIED", "ALWAYS", "ON_FAILURE", "NEVER" ], "type": "string" }, "nebius.applications.v1alpha1.ContainerDefinition.User": { "properties": { "gid": { "description": "The group ID to run the container as.", "format": "int64", "type": "string" }, "uid": { "description": "The user ID to run the container as.", "format": "int64", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.ContainerDefinition.Volume": { "description": "Volume defines a volume that will be mounted into the container.", "properties": { "bootDisk": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.BootDisk" } ], "description": "Virtual machine boot disk." }, "description": { "description": "The description of the volume.", "type": "string" }, "disk": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.DiskMount" } ], "description": "Nebius Compute Disk." }, "externalS3": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ExternalS3Mount" } ], "description": "External S3-compatible bucket." }, "filesystem": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.FilesystemMount" } ], "description": "Nebius Filesystem." }, "id": { "description": "The unique identifier of the volume.\nIf not specified, an ID will be generated.", "type": "string" }, "mountPath": { "description": "The path in the container where the mounted volume will be available.", "type": "string" }, "storageBucket": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.StorageBucketMount" } ], "description": "Nebius Storage Bucket." } }, "type": "object" }, "nebius.applications.v1alpha1.ContainerTemplateDefinition": { "description": "ContainerTemplateDefinition defines a template for a VM app that consists of one or more containers.", "properties": { "containers": { "description": "The container definitions for the VM app.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerDefinition" }, "type": "array" }, "description": { "type": "string" }, "iconUrl": { "description": "The URL of the template icon.", "type": "string" }, "inputs": { "description": "The inputs that configure the template.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput" }, "type": "array" }, "substitutions": { "description": "The substitutions to apply when their conditions match.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerTemplateDefinition.Substitution" }, "type": "array" }, "supportedPlatforms": { "description": "The platforms that the VM app supports.\nAn empty list allows all platforms.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.SupportedPlatform" }, "type": "array" } }, "type": "object" }, "nebius.applications.v1alpha1.ContainerTemplateDefinition.Substitution": { "properties": { "conditions": { "description": "The conditions that permit this substitution. At least one condition must match.\nAn empty list applies the substitution unconditionally.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerTemplateDefinition.SubstitutionCondition" }, "type": "array" }, "containerName": { "description": "The name of the container to modify.", "type": "string" }, "operations": { "description": "The actions to apply in the listed order.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerTemplateDefinition.SubstitutionOperation" }, "type": "array" } }, "type": "object" }, "nebius.applications.v1alpha1.ContainerTemplateDefinition.SubstitutionCondition": { "description": "All specified constraints must match. Without constraints, the condition matches unconditionally before applying not.", "properties": { "environmentVariableKey": { "description": "The environment variable key that must exist. An empty value adds no environment variable constraint.", "type": "string" }, "environmentVariableValue": { "description": "The non-sensitive environment variable value to match. Requires environment_variable_key.\nIf absent, only the key must exist. An empty string requires an empty variable value.", "type": "string" }, "inputFieldId": { "description": "The input field ID that must exist. An empty value adds no input constraint.\nSet at most one input_field_value_* field to require a non-sensitive input value to match.", "type": "string" }, "inputFieldValueBool": { "description": "The Boolean value to match for input_field_id. Requires input_field_id.\nIf absent, this field adds no Boolean value constraint. If false, the input must equal false.", "type": "boolean" }, "inputFieldValueDouble": { "description": "The floating-point value to match for input_field_id. Requires input_field_id.\nIf absent, this field adds no floating-point value constraint. If zero, the input must equal zero.", "format": "double", "type": "number" }, "inputFieldValueInt64": { "description": "The integer value to match for input_field_id. Requires input_field_id.\nIf absent, this field adds no integer value constraint. If zero, the input must equal zero.", "format": "int64", "type": "string" }, "inputFieldValueString": { "description": "The string value to match for input_field_id. Requires input_field_id.\nIf absent, this field adds no string value constraint. An empty string requires an empty input string.", "type": "string" }, "not": { "description": "Whether to negate the condition after evaluating all constraints.", "type": "boolean" }, "platform": { "description": "The compute platform name to match. An empty value adds no platform constraint.", "type": "string" }, "preset": { "description": "The compute preset name to match. An empty value adds no preset constraint.", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.ContainerTemplateDefinition.SubstitutionOperation": { "properties": { "containerCommand": { "description": "The command to run in the container.\nAllowed values are: `set_from_input_field`, `set_to_string_value`, `remove`.", "type": "boolean" }, "containerUser": { "description": "The user to run the container as.\nAllowed values are: `set_user`, `remove`.", "type": "boolean" }, "environmentVariable": { "description": "The environment variable to set in the container.\nAllowed values are: `set_from_input_field`, `set_to_string_value`, `set_to_integer_value`, `remove`.", "type": "string" }, "image": { "description": "The image to use for the container.\nAllowed values are: `set_from_input_field`, `set_to_string_value`, `remove`.", "type": "boolean" }, "imageTag": { "description": "The image tag to use for the container. Replaces only the tag after the last colon.\nAllowed values are: `set_from_input_field`, `set_to_string_value`.", "type": "boolean" }, "remove": { "description": "Remove the target value.", "type": "boolean" }, "sensitiveEnvironmentVariable": { "description": "The sensitive environment variable to set in the container.\nAllowed actions are: `set_from_input_field`, `set_to_string_value`, `set_to_integer_value`, `remove`.", "type": "string" }, "setFromInputField": { "description": "The ID of the input field that supplies the value.", "type": "string" }, "setToIntegerValue": { "description": "The integer value to use.", "format": "int64", "type": "string" }, "setToStringValue": { "description": "The string value to use.", "type": "string" }, "setUser": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerDefinition.User" } ], "description": "The user to run the container as." }, "shmSizeBytes": { "description": "The shared memory size in bytes to set in the container.\nAllowed values are: `set_from_input_field`, `set_to_integer_value`, `remove`.", "type": "boolean" } }, "type": "object" }, "nebius.applications.v1alpha1.CreateK8sReleaseRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.K8sReleaseSpec" } }, "type": "object" }, "nebius.applications.v1alpha1.DiskMount": { "properties": { "id": { "description": "ID of the compute disk to be mounted", "type": "string" }, "mode": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.DiskMount.Mode" } ], "description": "Mount mode." } }, "type": "object" }, "nebius.applications.v1alpha1.DiskMount.Mode": { "default": "MODE_UNSPECIFIED", "description": "The access mode for the mounted disk.\n\n - MODE_UNSPECIFIED: No access mode specified. Specify READ_WRITE or READ_ONLY.\n - READ_WRITE: Allow reads and writes.\n - READ_ONLY: Allow reads only.", "enum": [ "MODE_UNSPECIFIED", "READ_WRITE", "READ_ONLY" ], "type": "string" }, "nebius.applications.v1alpha1.EnvironmentVariable": { "description": "EnvironmentVariable defines an environment variable for the container.", "properties": { "key": { "description": "The key of the environment variable.", "type": "string" }, "sensitiveValue": { "description": "Sensitive value", "type": "string" }, "value": { "description": "Plain text value", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.ExternalS3Mount": { "description": "ExternalS3Mount defines an external S3-compatible bucket that will be mounted into the container.", "properties": { "accessKeyId": { "description": "Access key ID.", "type": "string" }, "bucket": { "description": "Bucket name.", "type": "string" }, "endpoint": { "description": "S3-compatible endpoint URL.", "type": "string" }, "mode": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.StorageBucketMount.Mode" } ], "description": "Mount mode." }, "region": { "description": "S3 region.", "type": "string" }, "secretAccessKey": { "description": "Secret access key.", "type": "string" }, "sessionToken": { "description": "Session token (optional, for temporary credentials).", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.FilesystemMount": { "description": "FilesystemMount defines a filesystem that will be mounted into the container.", "properties": { "id": { "description": "ID of the filesystem to be mounted", "type": "string" }, "mode": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.FilesystemMount.Mode" } ], "description": "Mount mode." } }, "type": "object" }, "nebius.applications.v1alpha1.FilesystemMount.Mode": { "default": "MODE_UNSPECIFIED", "description": "The access mode for the mounted filesystem.\n\n - MODE_UNSPECIFIED: No access mode specified. Specify READ_WRITE or READ_ONLY.\n - READ_WRITE: Allow reads and writes.\n - READ_ONLY: Allow reads only.", "enum": [ "MODE_UNSPECIFIED", "READ_WRITE", "READ_ONLY" ], "type": "string" }, "nebius.applications.v1alpha1.K8sRelease": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.K8sReleaseSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.K8sReleaseStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.applications.v1alpha1.K8sReleaseSpec": { "properties": { "applicationName": { "type": "string" }, "clusterId": { "type": "string" }, "namespace": { "type": "string" }, "productSlug": { "type": "string" }, "set": { "additionalProperties": { "type": "string" }, "type": "object" }, "values": { "type": "string" } }, "required": [ "clusterId", "productSlug", "namespace", "applicationName" ], "type": "object" }, "nebius.applications.v1alpha1.K8sReleaseStatus": { "properties": { "errorMessage": { "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.K8sReleaseStatus.State" } }, "type": "object" }, "nebius.applications.v1alpha1.K8sReleaseStatus.State": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "CREATED", "RUNNING", "DEPLOYED", "FAILED", "INSTALLING" ], "type": "string" }, "nebius.applications.v1alpha1.ListK8sReleasesResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.K8sRelease" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.ListVmAppTemplatesResponse": { "description": "The templates that match the list request.", "properties": { "items": { "description": "All matching templates. The service currently returns the complete list without pagination.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.VmAppTemplate" }, "type": "array" }, "nextPageToken": { "description": "The token for the next page. Currently always empty because the service returns all matching templates.", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.StorageBucketMount": { "description": "StorageBucketMount defines a storage bucket that will be mounted into the container.", "properties": { "id": { "description": "ID of the storage bucket to be mounted", "type": "string" }, "mode": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.StorageBucketMount.Mode" } ], "description": "Mount mode." } }, "type": "object" }, "nebius.applications.v1alpha1.StorageBucketMount.Mode": { "default": "MODE_UNSPECIFIED", "description": "The access mode for the mounted storage bucket.\n\n - MODE_UNSPECIFIED: No access mode specified. Specify READ_WRITE or READ_ONLY.\n - READ_WRITE: Allow reads and writes.\n - READ_ONLY: Allow reads only.", "enum": [ "MODE_UNSPECIFIED", "READ_WRITE", "READ_ONLY" ], "type": "string" }, "nebius.applications.v1alpha1.SupportedPlatform": { "properties": { "id": { "description": "The compute platform ID.", "type": "string" }, "supportedPresets": { "description": "Presets of the platform that are supported by the VM app template.\nIf empty, all presets are supported.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput": { "properties": { "booleanInput": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.BooleanInput" } ], "description": "A Boolean input." }, "dockerRegistryCredentialsInput": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.DockerRegistryCredentialsInput" } ], "description": "A Docker registry credential input." }, "enumStringInput": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.EnumStringInput" } ], "description": "A string input with predefined options." }, "environmentVariablesInput": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.EnvironmentVariablesInput" } ], "description": "An environment variable input." }, "huggingFaceTokenInput": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.HuggingFaceTokenInput" } ], "description": "A Hugging Face token input." }, "id": { "description": "The input ID. Template input values use this ID as their key.", "type": "string" }, "integerInput": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.IntegerInput" } ], "description": "An integer input." }, "integerUnitInput": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.IntegerUnitInput" } ], "description": "An integer input with a unit suffix." }, "required": { "description": "Whether the template requires a value for this input.", "type": "boolean" }, "serviceAccountMirrorInput": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.ServiceAccountMirrorInput" } ], "description": "A service account selector." }, "stringInput": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.StringInput" } ], "description": "A string input." }, "textContentInput": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.TextContentInput" } ], "description": "A read-only text element." } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput.BooleanInput": { "description": "BooleanInput defines a Boolean field.", "properties": { "defaultValue": { "description": "The default input value.", "type": "boolean" }, "description": { "type": "string" }, "name": { "type": "string" }, "viewType": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.BooleanInput.ViewType" } ], "description": "The form control type for the input." } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput.BooleanInput.ViewType": { "default": "VIEW_TYPE_UNSPECIFIED", "description": " - VIEW_TYPE_UNSPECIFIED: No form control type specified. Specify CHECKBOX or SWITCH.\n - CHECKBOX: Display the Boolean input as a checkbox.\n - SWITCH: Display the Boolean input as a toggle switch.", "enum": [ "VIEW_TYPE_UNSPECIFIED", "CHECKBOX", "SWITCH" ], "type": "string" }, "nebius.applications.v1alpha1.TemplateInput.DockerRegistryCredentialsInput": { "description": "Docker Registry Credentials input\nWill be rendered as the form in UI.", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "sensitive": { "description": "Whether the credentials contain sensitive data.", "type": "boolean" }, "showInForm": { "description": "If set to true, the field will be shown in the form.", "type": "boolean" } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput.EnumStringInput": { "description": "EnumStringInput defines a string input with predefined options.\nWill be rendered as a dropdown in UI.", "properties": { "defaultValue": { "description": "The default option value.", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "options": { "description": "The available input options.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInput.EnumStringInput.Option" }, "type": "array" }, "placeholder": { "description": "The placeholder text for the input.", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput.EnumStringInput.Option": { "properties": { "label": { "description": "The label for the option. An empty label uses the option value.", "type": "string" }, "value": { "description": "The value of the option, which is used in the value of the input.", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput.EnvironmentVariablesInput": { "description": "Environment variables input\nWill be rendered as a list of key-value pairs in UI.\nCannot be optional.", "properties": { "description": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput.HuggingFaceTokenInput": { "description": "Hugging face token input\nWill be rendered as the form in UI.", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "sensitive": { "description": "Whether the token contains sensitive data.", "type": "boolean" }, "showInForm": { "description": "If set to true, the field will be shown in the form.", "type": "boolean" } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput.IntegerInput": { "description": "IntegerInput defines a simple integer field.\nThe form displays a text box.", "properties": { "defaultValue": { "description": "The default for an omitted, non-required input before multiplication.\nIf absent, the input uses min_value, or zero when min_value is absent.\nIf zero, the default is zero, regardless of min_value. The bounds still apply.", "format": "int64", "type": "string" }, "description": { "type": "string" }, "maxValue": { "description": "The maximum input value before multiplication.\nIf absent, no maximum applies. If zero, the input must be zero or less.", "format": "int64", "type": "string" }, "minValue": { "description": "The minimum input value before multiplication.\nIf absent, no minimum applies. If zero, the input must be zero or greater.", "format": "int64", "type": "string" }, "multiplyBy": { "description": "The multiplication factor. Zero uses a factor of one.", "format": "int64", "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput.IntegerUnitInput": { "description": "IntegerUnitInput defines an integer input with a unit, bounds, step, and default value.\nThe form displays a slider with the unit suffix.", "properties": { "defaultValue": { "description": "The default input value before multiplication.", "format": "int64", "type": "string" }, "description": { "type": "string" }, "maxValue": { "description": "The maximum input value before multiplication.", "format": "int64", "type": "string" }, "minValue": { "description": "The minimum input value before multiplication.", "format": "int64", "type": "string" }, "multiplyBy": { "description": "The multiplication factor. Values less than one use a factor of one.", "format": "int64", "type": "string" }, "name": { "type": "string" }, "step": { "description": "The increment between valid input values, starting at min_value.", "format": "int64", "type": "string" }, "unit": { "description": "The unit suffix for the input value.", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput.ServiceAccountMirrorInput": { "description": "Service Account Mirror input\nWill be rendered as a service account selector in UI.", "properties": { "description": { "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput.StringInput": { "properties": { "defaultValue": { "description": "The default input value.", "type": "string" }, "description": { "type": "string" }, "generate": { "description": "Whether the form offers password generation for this sensitive input.", "type": "boolean" }, "inputPrefix": { "description": "The prefix to display before the input.", "type": "string" }, "multiline": { "description": "Whether the form displays a multiline text input.", "type": "boolean" }, "name": { "type": "string" }, "pattern": { "description": "The regular expression that validates the input value.", "type": "string" }, "placeholder": { "description": "The placeholder text for the input.", "type": "string" }, "sensitive": { "description": "Whether the input contains sensitive data.", "type": "boolean" }, "tooltip": { "description": "The tooltip text for the input.", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInput.TextContentInput": { "description": "TextContentInput defines a read-only text content field.\nWill be rendered as a text block in UI.\nCannot be optional.", "properties": { "content": { "description": "The content to display.", "type": "string" }, "showInForm": { "description": "If set to true, the field will be shown in the form.", "type": "boolean" }, "showInOverview": { "description": "If set to true, the field will be shown in the overview page after the VM app is created.", "type": "boolean" } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInputField": { "properties": { "description": { "type": "string" }, "id": { "description": "The ID of the input field.", "type": "string" }, "name": { "type": "string" }, "required": { "description": "Whether the template requires a value for this input.", "type": "boolean" }, "sensitive": { "description": "Whether the input field contains sensitive data.", "type": "boolean" }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInputField.Type" } ], "description": "The type of value that the input field accepts." } }, "type": "object" }, "nebius.applications.v1alpha1.TemplateInputField.Type": { "default": "TYPE_UNSPECIFIED", "description": "The types of template input values.\n\n - TYPE_UNSPECIFIED: No input type specified.\n - STRING: A string value. Unit-based integers include their unit suffix in the string.\n - INTEGER: A numeric value with no fractional part.\n - BOOLEAN: A Boolean value.\n - LIST: A list value. Current templates do not support this type.\n - STRUCT: An object value. Current templates do not support this type.\n - MYSTERYBOX_SECRET_VERSION: A string that identifies a MysteryBox secret version.", "enum": [ "TYPE_UNSPECIFIED", "STRING", "INTEGER", "BOOLEAN", "LIST", "STRUCT", "MYSTERYBOX_SECRET_VERSION" ], "type": "string" }, "nebius.applications.v1alpha1.UpdateK8sReleaseRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.K8sReleaseSpec" } }, "type": "object" }, "nebius.applications.v1alpha1.VmAppTemplate": { "description": "Represents a reusable VM app template.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "The template metadata." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.VmAppTemplateSpec" } ], "description": "The template specification." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.VmAppTemplateStatus" } ], "description": "The template status and available inputs.", "readOnly": true } }, "type": "object" }, "nebius.applications.v1alpha1.VmAppTemplateSpec": { "properties": { "containerTemplate": { "allOf": [ { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ContainerTemplateDefinition" } ], "description": "The container template definition." }, "kind": { "description": "The template kind: \"covm\" or \"devlab\". The default is \"covm\".", "type": "string" } }, "type": "object" }, "nebius.applications.v1alpha1.VmAppTemplateStatus": { "properties": { "categories": { "description": "Categories that the template belongs to.", "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "iconUrl": { "description": "The URL of the template icon.", "type": "string" }, "inputFields": { "description": "The fields that accept values for this template.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.TemplateInputField" }, "type": "array" }, "supportedPlatforms": { "description": "Supported platforms for the VM app template.\nIf empty, the VM app template is supported on all platforms.", "items": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.SupportedPlatform" }, "type": "array" } }, "type": "object" }, "nebius.audit.v2.AccessToken": { "properties": { "maskedToken": { "description": "Token without signature.", "type": "string" } }, "type": "object" }, "nebius.audit.v2.AuditEvent": { "properties": { "action": { "description": "Indicates an action taken on the resource.", "type": "string" }, "authentication": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.Authentication" } ], "description": "Represents the subject of an API call." }, "authorization": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.Authorization" } ], "description": "Represents permissions that have been verified for the subject as part of the API call." }, "eventVersion": { "description": "Audit event version, in \"X.Y\" format, events within different Y's are backwards compatible, events with different X's are not.", "type": "string" }, "id": { "description": "Unique event id.", "type": "string" }, "request": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.Request" } ], "description": "Contains information about the request from the customer." }, "resource": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.Resource" } ], "description": "A resource that was read or modified as part of the operation. Can be empty if no resource accessed or changed." }, "response": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.Response" } ], "description": "Contains information about the response from the server." }, "service": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.Service" } ], "description": "Indicates the service that generated the event." }, "source": { "description": "Identifies the context in which an event happened. Presented in the form of URI.", "type": "string" }, "specVersion": { "description": "Version of CloudEvents spec. See https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#specversion", "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.Status" } ], "description": "The async operation status" }, "time": { "description": "Timestamp of when the occurrence happened.", "format": "date-time", "type": "string" }, "type": { "description": "The type of event related to the originating occurrence. Formed according to template:\n`ai.nebius.\u003cserviceName\u003e.\u003cresourceType\u003e.\u003caction\u003e`", "type": "string" } }, "type": "object" }, "nebius.audit.v2.AuditEventExport": { "description": "A resource representing information about previously created exports of audit events.\nEach record stores data about which filter was used and where the audit events were exported.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.audit.v2.AuditEventExportSpec" }, "status": { "$ref": "#/components/schemas/nebius.audit.v2.AuditEventExportStatus" } }, "type": "object" }, "nebius.audit.v2.AuditEventExportParams": { "properties": { "eventType": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.EventType" } ], "description": "Type of audit event to filter by." }, "filter": { "description": "Example:\nservice.name = 'iam' AND resource.hierarchy.id:'container-e0t' AND regex(resource.metadata.name, '^.*test.*$').\nSupported filters:\n\"=\" - equals\n\"!=\" - not equals\n\":\" - contains\nregex - regular expression\n\nFields that can be used for filtering:\naction\nauthentication.static_key_credential.id\nauthentication.subject.service_account_id\nauthentication.subject.tenant_user_id\nauthentication.token_credential.masked_token\nresource.hierarchy.id\nresource.hierarchy.name\nresource.metadata.id\nresource.metadata.name\nresource.metadata.type\nservice.name\ntype\nstatus", "type": "string" }, "from": { "description": "Returns results with a timestamp greater than or equal to this value.", "format": "date-time", "type": "string" }, "to": { "description": "Returns results with a timestamp lower than this value.", "format": "date-time", "type": "string" } }, "required": [ "from", "to", "eventType" ], "type": "object" }, "nebius.audit.v2.AuditEventExportSpec": { "properties": { "nebiusObjectStorage": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.NebiusObjectStorageDestination" } ], "description": "An object storage bucket that will be used as the destination for audit logs.\nYou must have `storage.upload` permission for successful execution." }, "params": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.AuditEventExportParams" } ], "description": "Filter based on which audit logs must be exported." } }, "required": [ "params" ], "type": "object" }, "nebius.audit.v2.AuditEventExportState": { "default": "AUDIT_EVENT_EXPORT_STATE_UNSPECIFIED", "description": " - AUDIT_EVENT_EXPORT_STATE_RUNNING: Export created and running.\n - AUDIT_EVENT_EXPORT_STATE_CANCELED: Export has been cancelled.\n - AUDIT_EVENT_EXPORT_STATE_DONE: Export successfully completed.\n - AUDIT_EVENT_EXPORT_STATE_FAILED: Export failed.", "enum": [ "AUDIT_EVENT_EXPORT_STATE_UNSPECIFIED", "AUDIT_EVENT_EXPORT_STATE_RUNNING", "AUDIT_EVENT_EXPORT_STATE_CANCELED", "AUDIT_EVENT_EXPORT_STATE_DONE", "AUDIT_EVENT_EXPORT_STATE_FAILED" ], "type": "string" }, "nebius.audit.v2.AuditEventExportStatus": { "properties": { "exportOperationId": { "description": "Identifier of the audit logs export operation.\nThis value is used as the final path prefix for exported files in the destination object storage bucket.", "type": "string" }, "finishedAt": { "description": "Timestamp indicating when the export was finished.", "format": "date-time", "type": "string" }, "message": { "description": "Error message in case of export failure.", "type": "string" }, "startedAt": { "description": "Timestamp indicating when the export was started.", "format": "date-time", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.AuditEventExportState" } ], "description": "Current state of audit logs export." } }, "type": "object" }, "nebius.audit.v2.Authentication": { "properties": { "authenticated": { "description": "Answers the question whether or not the subject has been successfully authenticated.", "type": "boolean" }, "authenticationType": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.AuthenticationType" } ], "description": "Describes the type of authentication." }, "federation": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.Federation" } ], "description": "Information on the federation within which the subject exists." }, "staticKeyCredential": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.StaticKey" } ], "description": "Information about static key." }, "subject": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.Subject" } ], "description": "Contains information about the subject of the call." }, "tokenCredential": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.AccessToken" } ], "description": "Information about token." } }, "type": "object" }, "nebius.audit.v2.AuthenticationType": { "default": "AUTHENTICATION_TYPE_UNSPECIFIED", "enum": [ "AUTHENTICATION_TYPE_UNSPECIFIED", "ACCESS_TOKEN", "STATIC_KEY" ], "type": "string" }, "nebius.audit.v2.Authorization": { "properties": { "authorized": { "description": "Field is required. We do not use `(buf.validate.field).required = true` here as false value\nconsidered as unset (validation violation)", "type": "boolean" } }, "type": "object" }, "nebius.audit.v2.BucketById": { "properties": { "id": { "description": "The id of the bucket in the tenant where the logs will be exported.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.audit.v2.CancelRequest": { "properties": { "id": { "description": "Id of the audit event export that needs to be cancelled.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.audit.v2.EventType": { "default": "EVENT_TYPE_UNSPECIFIED", "description": " - EVENT_TYPE_UNSPECIFIED: Unspecified event type.\n - CONTROL_PLANE: Control plane events.\n - DATA_PLANE: Data plane events (S3).", "enum": [ "EVENT_TYPE_UNSPECIFIED", "CONTROL_PLANE", "DATA_PLANE" ], "type": "string" }, "nebius.audit.v2.Federation": { "properties": { "id": { "description": "Unique identifier of the federation.", "type": "string" }, "name": { "description": "Human-readable name of the federation.", "type": "string" } }, "type": "object" }, "nebius.audit.v2.ListAuditEventExportResponse": { "properties": { "items": { "description": "List of audit event exports.", "items": { "$ref": "#/components/schemas/nebius.audit.v2.AuditEventExport" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.audit.v2.ListAuditEventResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.audit.v2.AuditEvent" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.audit.v2.NebiusObjectStorageDestination": { "properties": { "bucketById": { "$ref": "#/components/schemas/nebius.audit.v2.BucketById" }, "objectPrefix": { "description": "Prefix for export objects.\nDefault value is `auditlogs`.", "type": "string" } }, "type": "object" }, "nebius.audit.v2.Request": { "properties": { "clientIp": { "description": "Ip of the subject who initiated the RPC call.", "type": "string" }, "idempotencyId": { "description": "Unique key that the server uses to recognize subsequent retries of the same request.", "type": "string" }, "ja3Fingerprint": { "description": "Client Ja3 fingerprint", "type": "string" }, "parameters": { "description": "Parameters of the request.", "type": "object" }, "requestId": { "description": "Unique identifier of the request.", "type": "string" }, "traceId": { "description": "A unique identifier that allows you to link calls to different services within an operation.", "type": "string" }, "userAgent": { "description": "User agent of the subject who initiated operation.", "type": "string" } }, "type": "object" }, "nebius.audit.v2.Resource": { "properties": { "hierarchy": { "description": "Top-down resources hierarchy from tenant to resource.", "items": { "$ref": "#/components/schemas/nebius.audit.v2.ResourceMetadata" }, "type": "array" }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.ResourceMetadata" } ], "description": "Provides basic information about the resource." }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.ResourceState" } ], "description": "Gives an understanding of how the resource was changed in the call." } }, "type": "object" }, "nebius.audit.v2.ResourceMetadata": { "properties": { "id": { "description": "Unique identifier of the resource.", "type": "string" }, "name": { "description": "Name of the resource.", "type": "string" }, "type": { "description": "Type of the resource.", "type": "string" } }, "type": "object" }, "nebius.audit.v2.ResourceState": { "properties": { "current": { "description": "The state of the resource after the change in the call.", "type": "object" }, "previous": { "description": "The state of the resource before the change in the call.", "type": "object" } }, "type": "object" }, "nebius.audit.v2.Response": { "properties": { "errorMessage": { "description": "Error message if the call was not successful.", "type": "string" }, "payload": { "description": "The payload of the response.", "type": "object" }, "statusCode": { "allOf": [ { "$ref": "#/components/schemas/google.rpc.Code" } ], "description": "The status that the server returned to the client." } }, "type": "object" }, "nebius.audit.v2.Service": { "properties": { "name": { "type": "string" } }, "type": "object" }, "nebius.audit.v2.StartRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata associated with the new export." }, "region": { "description": "Region to retrieve audit logs (e.g. eu-north2, us-central1, eu-west1)\nSee https://docs.nebius.com/overview/regions", "type": "string" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.audit.v2.AuditEventExportSpec" } ], "description": "Specification for the new export." } }, "required": [ "region" ], "type": "object" }, "nebius.audit.v2.StaticKey": { "properties": { "id": { "description": "Unique identifier of static key.", "type": "string" } }, "type": "object" }, "nebius.audit.v2.Status": { "default": "RESPONSE_STATUS_UNSPECIFIED", "description": "- STARTED: Asynchronous action started\n - DONE: Action finished successfully\n - ERROR: Action finished with error", "enum": [ "RESPONSE_STATUS_UNSPECIFIED", "STARTED", "DONE", "ERROR" ], "type": "string" }, "nebius.audit.v2.Subject": { "properties": { "name": { "description": "Username of the subject.", "type": "string" }, "serviceAccountId": { "description": "This field is filled in if the call was made on behalf of a service account.", "type": "string" }, "tenantUserId": { "description": "This field is filled in if the call was made on behalf of a user.", "type": "string" } }, "type": "object" }, "nebius.billing.v1.AggregationUnit": { "properties": { "unit": { "description": "Resource unit value.", "type": "string" }, "unitType": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.AggregationUnit.UnitType" } ], "description": "Resource unit type." } }, "type": "object" }, "nebius.billing.v1.AggregationUnit.UnitType": { "default": "UNIT_TYPE_UNSPECIFIED", "description": "Aggregation unit type\nIf unit type is one of minute, hour, day, week, month, then it's time-based\nOtherwise it's usage-based", "enum": [ "UNIT_TYPE_UNSPECIFIED", "UNIT_TYPE_TIME_BASED", "UNIT_TYPE_USAGE_BASED" ], "type": "string" }, "nebius.billing.v1.AutoscaleResourceCost": { "description": "Autoscale resource cost.\nUsed for resources that can automatically scale.", "properties": { "maxCost": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.CostBreakdown" } ], "description": "Maximum possible cost when scaled to maximum instances." }, "maxInstances": { "description": "Maximum number of instances in the auto-scaling group.", "format": "int32", "type": "integer" }, "minCost": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.CostBreakdown" } ], "description": "Minimum possible cost when scaled to minimum instances." }, "minInstances": { "description": "Minimum number of instances in the auto-scaling group.", "format": "int32", "type": "integer" }, "perInstance": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.CostBreakdown" } ], "description": "Cost per individual instance.\nUsed to calculate costs at any scaling level between min and max." } }, "type": "object" }, "nebius.billing.v1.ComputeInstanceSpec": { "description": "Preemptible compute instances a pricing policy applies to.", "properties": { "v1": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.ComputeInstanceSpecV1" } ], "description": "First version of the compute instance specification." } }, "type": "object" }, "nebius.billing.v1.ComputeInstanceSpecV1": { "properties": { "platform": { "description": "Compute platform. Example: \"gpu-h100-sxm\".", "type": "string" } }, "required": [ "platform" ], "type": "object" }, "nebius.billing.v1.CostBreakdown": { "description": "Detailed cost breakdown showing individual SKU costs and totals.", "properties": { "cost": { "description": "Total cost as a decimal string.\nRepresents the sum of all SKU costs with full precision.\nExample: \"42.123456789\" for precise billing calculations.", "type": "string" }, "costRounded": { "description": "Total cost rounded up to 2 decimal places.\nExample: \"42.13\"", "type": "string" }, "skuCosts": { "description": "Individual costs for each SKU (Stock Keeping Unit) component.\nEach SKU represents a different billable component (e.g., CPU, memory, RAM, etc.).", "items": { "$ref": "#/components/schemas/nebius.billing.v1.SkuCost" }, "type": "array" } }, "type": "object" }, "nebius.billing.v1.CreatePricingPolicyRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.billing.v1.PricingPolicySpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.billing.v1.EstimateBatchRequest": { "properties": { "currency": { "description": "Currency for the cost estimate (e.g., \"usd\", \"ils\"). Defaults to \"usd\".", "type": "string" }, "filterAggregationUnit": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.FilterAggregationUnit" } ], "description": "Filters only time-based resource units, e.g. hour, day, month, etc.\nIf response contains other resource units like request, token, etc., it will always be presented in response." }, "offerTypes": { "description": "Type of offers to be applied to the cost estimate.", "items": { "$ref": "#/components/schemas/nebius.billing.v1.OfferType" }, "type": "array" }, "resourceSpecs": { "description": "List of resource specifications for cost estimation.\nEach resource will be priced individually and then aggregated into total costs.", "items": { "$ref": "#/components/schemas/nebius.billing.v1.ResourceSpec" }, "type": "array" } }, "type": "object" }, "nebius.billing.v1.EstimateBatchResponse": { "properties": { "currency": { "description": "Currency used for the estimate.", "type": "string" }, "resourceCosts": { "items": { "$ref": "#/components/schemas/nebius.billing.v1.ResourceCost" }, "type": "array" }, "totalCosts": { "description": "Total cost for all resource units.", "items": { "$ref": "#/components/schemas/nebius.billing.v1.TotalCost" }, "type": "array" } }, "type": "object" }, "nebius.billing.v1.FilterAggregationUnit": { "description": "Filters only time-based aggregation units, e.g. hour, day, month, etc.\nIf response contains other aggregation units like request, token, etc., it will always be presented in response.", "properties": { "filterAggregationUnitValues": { "description": "List of time aggregation unit values to filter by.\nOnly costs for these time units will be included in the response, but it doesn't filter not time-based units.", "items": { "$ref": "#/components/schemas/nebius.billing.v1.FilterAggregationUnit.FilterAggregationUnitValue" }, "type": "array" } }, "type": "object" }, "nebius.billing.v1.FilterAggregationUnit.FilterAggregationUnitValue": { "default": "FILTER_AGGREGATION_UNIT_UNSPECIFIED", "description": "List of time aggregation unit values to filter by.\nOnly costs for these time units will be included in the response, but it doesn't filter not time-based units.", "enum": [ "FILTER_AGGREGATION_UNIT_UNSPECIFIED", "FILTER_AGGREGATION_UNIT_MINUTE", "FILTER_AGGREGATION_UNIT_HOUR", "FILTER_AGGREGATION_UNIT_DAY", "FILTER_AGGREGATION_UNIT_WEEK", "FILTER_AGGREGATION_UNIT_MONTH" ], "type": "string" }, "nebius.billing.v1.FixedInstanceResourceCost": { "description": "Fixed instance resource cost.\nUsed for resources that have a fixed number of instances.", "properties": { "instanceCount": { "description": "Number of instances in the configuration.", "format": "int32", "type": "integer" }, "perInstance": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.CostBreakdown" } ], "description": "Cost per individual instance.\nMultiply by instance_count to get total cost." }, "total": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.CostBreakdown" } ], "description": "Total cost for all instances combined." } }, "type": "object" }, "nebius.billing.v1.GeneralResourceCost": { "description": "General resource cost for single-unit resources.\nUsed for resources like compute instances or disks where the unit count is not variable.", "properties": { "total": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.CostBreakdown" } ], "description": "Cost breakdown for the resource including all SKU costs and total cost." } }, "type": "object" }, "nebius.billing.v1.ListPricingPoliciesResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.billing.v1.PricingPolicy" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.billing.v1.MaxPriceV1": { "description": "Auction-bid pricing.", "properties": { "maxPrice": { "description": "Per-GPU hourly limit in USD, decimal string 3 digits precision. Example: \"3.515\".\nMust be within the allowed price range (OUT_OF_RANGE otherwise);\na value below the current market price is accepted but blocks scheduling.\nMutable only while `status.running_vm_count` is 0\n(FAILED_PRECONDITION otherwise); the policy reports STATE_UPDATING and\nblocks scheduling while the change is applied.", "type": "string" } }, "required": [ "maxPrice" ], "type": "object" }, "nebius.billing.v1.OfferType": { "default": "OFFER_TYPE_UNSPECIFIED", "description": "OfferType is a enum that specifies the type of offer.\n\n - OFFER_TYPE_CONTRACT_PRICE: Contract price is a special price for SKU.", "enum": [ "OFFER_TYPE_UNSPECIFIED", "OFFER_TYPE_CONTRACT_PRICE" ], "type": "string" }, "nebius.billing.v1.PricingMethod": { "description": "How the price of a pricing policy is set.", "properties": { "maxPriceV1": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.MaxPriceV1" } ], "description": "Auction bid: the per-GPU `max_price` ranks the policy's VMs for\nscheduling and preemption." } }, "type": "object" }, "nebius.billing.v1.PricingPolicy": { "description": "How preemptible VMs are priced: a standing per-GPU bid for one (region, platform).\nOne policy backs any number of VMs, referenced by id from the preemptible spec.\nA VM without a policy is a price-taker and pays the market price.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Parent is a project, immutable. Only VMs in that scope may\nreference the policy. Name is unique within the parent, renamable any time." }, "spec": { "$ref": "#/components/schemas/nebius.billing.v1.PricingPolicySpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.PricingPolicyStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.billing.v1.PricingPolicySpec": { "properties": { "computeInstanceSpec": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.ComputeInstanceSpec" } ], "description": "Preemptible compute instances the policy prices." }, "pricing": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.PricingMethod" } ], "description": "How the price is set." } }, "required": [ "computeInstanceSpec", "pricing" ], "type": "object" }, "nebius.billing.v1.PricingPolicyStatus": { "description": "Observed state of a pricing policy.", "properties": { "currency": { "description": "ISO 4217 currency code of max_price, e.g. \"USD\".", "type": "string" }, "runningVmCount": { "description": "Number of VMs currently running under this policy. Nonzero blocks resource\nchanges and deletion.", "format": "int64", "type": "string" }, "schedulingState": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.PricingPolicyStatus.SchedulingState" } ], "description": "Whether new VMs may currently start under this policy." }, "skuId": { "description": "SKU resolved from the spec.", "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.billing.v1.PricingPolicyStatus.State" } }, "type": "object" }, "nebius.billing.v1.PricingPolicyStatus.SchedulingState": { "default": "SCHEDULING_STATE_UNSPECIFIED", "description": " - SCHEDULING_STATE_ALLOWED: New VMs may start.\n - SCHEDULING_STATE_BLOCKED: The max_price limit is below the market price in force or below a market price\nthat is being applied; VM creation succeeds once the price falls to it.", "enum": [ "SCHEDULING_STATE_UNSPECIFIED", "SCHEDULING_STATE_ALLOWED", "SCHEDULING_STATE_BLOCKED" ], "type": "string" }, "nebius.billing.v1.PricingPolicyStatus.State": { "default": "STATE_UNSPECIFIED", "description": " - STATE_CREATING: Not ready yet; a VM referencing the policy gets a retryable error.\nThe state can last while a market price change is applied to the segment.\n - STATE_ACTIVE: Ready; whether VMs may start is `scheduling_state`.\n - STATE_DELETING: Being deleted; does not accept new VMs.\n - STATE_UPDATING: The bid is being changed; scheduling is blocked until the change lands.\nThe state can last while a market price change is applied to the segment.", "enum": [ "STATE_UNSPECIFIED", "STATE_CREATING", "STATE_ACTIVE", "STATE_DELETING", "STATE_UPDATING" ], "type": "string" }, "nebius.billing.v1.RangeTotalCost": { "description": "Range-based total cost with minimum and maximum bounds.\nUsed for resources with variable pricing based on usage or scaling.", "properties": { "max": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.CostBreakdown" } ], "description": "Maximum possible cost for the resource group.\nRepresents the cost when resources are at their maximum configuration." }, "min": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.CostBreakdown" } ], "description": "Minimum possible cost for the resource group.\nRepresents the cost when resources are at their minimum configuration." } }, "type": "object" }, "nebius.billing.v1.ResourceCost": { "description": "Cost information for a single resource.\nContains metadata about the resource and its cost.", "properties": { "aggregationUnit": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.AggregationUnit" } ], "description": "Unit of the SKU measurement within a resource, e.g. \"hour\", \"day\", \"month\", etc." }, "autoscale": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.AutoscaleResourceCost" } ], "description": "Autoscale cost for resources with variable instance count.\nUsed for resources that can automatically scale up or down." }, "fixedInstance": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.FixedInstanceResourceCost" } ], "description": "Fixed instance cost for resources with instances.\nUsed for resources that have a fixed number of instances." }, "general": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.GeneralResourceCost" } ], "description": "General cost for single-unit resources.\nUsed for resources like compute instances or disks where the unit count is not variable." }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Resource metadata." }, "overrideMetadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Optional field to override the resource metadata." } }, "type": "object" }, "nebius.billing.v1.ResourceSpec": { "description": "Resource specification for cost estimation.\nContains the specifications for creating and updating different types of resources.", "properties": { "spec": { "allOf": [ { "$ref": "#/components/schemas/google.protobuf.Any" } ], "description": "Resource specification for cost estimation. Payload must include billing routing annotations. Must contain\neither a create-request or an update-request message for the target resource type. Examples:\ntype.googleapis.com/nebius.compute.v1.CreateInstanceRequest, type.googleapis.com/nebius.compute.v1.UpdateInstanceRequest and so on" } }, "type": "object" }, "nebius.billing.v1.SkuCost": { "description": "Cost information for a specific SKU (Stock Keeping Unit).\nRepresents a single billable component within a resource.", "properties": { "cost": { "description": "Cost for this SKU as a decimal string.\nCalculated as quantity * unit_price with full precision.\nExample: \"15.6789012345\" for precise billing calculations.", "type": "string" }, "costRounded": { "description": "Cost for this SKU rounded up to 2 decimal places.\nExample: \"15.68\"", "type": "string" }, "quantity": { "description": "Quantity of the SKU being used as a decimal string.\nExample: \"2.123\"", "type": "string" }, "quantityRounded": { "description": "Quantity rounded up to 2 decimal places.\nExample: \"2.13\"", "type": "string" }, "skuId": { "description": "Unique identifier for the SKU.", "type": "string" } }, "type": "object" }, "nebius.billing.v1.TotalCost": { "description": "Total cost for a single resource unit.", "properties": { "aggregationUnit": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.AggregationUnit" } ], "description": "Aggregation unit." }, "general": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.GeneralResourceCost" } ], "description": "General total cost for single-unit resources.\nUsed for resources like compute instances or disks where the unit count is not variable." }, "range": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1.RangeTotalCost" } ], "description": "Range-based total cost with minimum and maximum bounds.\nUsed for resources with variable pricing based on usage or scaling." } }, "type": "object" }, "nebius.billing.v1.UpdatePricingPolicyRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.billing.v1.PricingPolicySpec" } }, "required": [ "metadata" ], "type": "object" }, "nebius.billing.v1alpha1.CostBreakdown": { "description": "Detailed cost breakdown showing individual SKU costs and totals.", "properties": { "cost": { "description": "Total cost as a decimal string.\nRepresents the sum of all SKU costs with full precision.\nExample: \"42.123456789\" for precise billing calculations.", "type": "string" }, "costRounded": { "description": "Total cost rounded up to 2 decimal places.\nExample: \"42.13\"", "type": "string" } }, "type": "object" }, "nebius.billing.v1alpha1.CreateOneTimeExportRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Resource metadata including parent contract ID." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.OneTimeExportSpec" } ], "description": "Export configuration specification." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.billing.v1alpha1.EstimateBatchRequest": { "properties": { "offerTypes": { "description": "Type of offers to be applied to the cost estimate.", "items": { "$ref": "#/components/schemas/nebius.billing.v1alpha1.OfferType" }, "type": "array" }, "resourceSpecs": { "description": "List of resource specifications for cost estimation.\nEach resource will be priced individually and then aggregated into total costs.", "items": { "$ref": "#/components/schemas/nebius.billing.v1alpha1.ResourceSpec" }, "type": "array" } }, "type": "object" }, "nebius.billing.v1alpha1.EstimateBatchResponse": { "properties": { "hourlyCost": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.ResourceGroupCost" } ], "description": "Estimated hourly cost for all resources in the batch." }, "monthlyCost": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.ResourceGroupCost" } ], "description": "Estimated monthly cost for all resources in the batch.\nCalculated as hourly_cost * 24 * 30 (720 hours) for resources running continuously." } }, "type": "object" }, "nebius.billing.v1alpha1.EstimateRequest": { "properties": { "offerTypes": { "description": "Type of offers to be applied to the cost estimate.", "items": { "$ref": "#/components/schemas/nebius.billing.v1alpha1.OfferType" }, "type": "array" }, "resourceSpec": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.ResourceSpec" } ], "description": "Resource specification for cost estimation.\nMust contain exactly one resource type." } }, "required": [ "resourceSpec" ], "type": "object" }, "nebius.billing.v1alpha1.EstimateResponse": { "properties": { "hourlyCost": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.ResourceGroupCost" } ], "description": "Estimated hourly cost for the resource." }, "monthlyCost": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.ResourceGroupCost" } ], "description": "Estimated monthly cost for the resource.\nCalculated as hourly_cost * 24 * 30 (720 hours) for resources running continuously." } }, "type": "object" }, "nebius.billing.v1alpha1.ExportFormat": { "default": "EXPORT_FORMAT_UNSPECIFIED", "description": "Supported export formats for billing reports.\n\n - EXPORT_FORMAT_FOCUS_1_2_CSV: FOCUS (FinOps Open Cost and Usage Specification) v1.2 CSV format.\nSee: https://focus.finops.org/focus-specification/v1-2/\n - EXPORT_FORMAT_CONSUMPTION_BREAKDOWN_PDF: Consumption Breakdown PDF format.\nSingle-period human-readable cost breakdown report exported as a PDF file.", "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "EXPORT_FORMAT_FOCUS_1_2_CSV", "EXPORT_FORMAT_CONSUMPTION_BREAKDOWN_PDF" ], "type": "string" }, "nebius.billing.v1alpha1.GeneralTotalCost": { "description": "General total cost with a single fixed amount.\nUsed for resources with predictable, non-variable pricing.", "properties": { "total": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.CostBreakdown" } ], "description": "Cost breakdown including all SKUs and their individual costs." } }, "type": "object" }, "nebius.billing.v1alpha1.ListOneTimeExportsResponse": { "properties": { "items": { "description": "List of one-time exports for the specified contract.", "items": { "$ref": "#/components/schemas/nebius.billing.v1alpha1.OneTimeExport" }, "type": "array" }, "nextPageToken": { "description": "Token for retrieving the next page of results. Empty if no more pages.", "type": "string" } }, "type": "object" }, "nebius.billing.v1alpha1.OfferType": { "default": "OFFER_TYPE_UNSPECIFIED", "description": "OfferType is a enum that specifies the type of offer.\n\n - OFFER_TYPE_CONTRACT_PRICE: Contract price is a special price for SKU.", "enum": [ "OFFER_TYPE_UNSPECIFIED", "OFFER_TYPE_CONTRACT_PRICE" ], "type": "string" }, "nebius.billing.v1alpha1.OneTimeExport": { "description": "One-time export of billing reports as a downloadable archive.\nCreates a .tar.gz archive of FOCUS billing data for the requested period\nand provides a presigned download URL.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Parent is Contract ID." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.OneTimeExportSpec" } ], "description": "Export configuration specification." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.OneTimeExportStatus" } ], "description": "Current status of the one-time export.", "readOnly": true } }, "type": "object" }, "nebius.billing.v1alpha1.OneTimeExportSpec": { "description": "Specification for one-time billing report export.", "properties": { "endPeriod": { "description": "The last billing period to include in the export (inclusive).\nExample: \"2025-06\".", "type": "string" }, "format": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.ExportFormat" } ], "description": "Format of the exported billing reports." }, "startPeriod": { "description": "The first billing period to include in the export (inclusive).\nExample: \"2025-04\".", "type": "string" } }, "required": [ "format", "startPeriod", "endPeriod" ], "type": "object" }, "nebius.billing.v1alpha1.OneTimeExportState": { "default": "ONE_TIME_EXPORT_STATE_UNSPECIFIED", "description": "Lifecycle states for one-time export.\n\n - ONE_TIME_EXPORT_STATE_SCHEDULED: Export has been created and is scheduled for processing.\n - ONE_TIME_EXPORT_STATE_RUNNING: Export is in progress.\n - ONE_TIME_EXPORT_STATE_SUCCESS: Export completed successfully. Download URL is available.\n - ONE_TIME_EXPORT_STATE_FAILED: Export failed. See error field for details.\n - ONE_TIME_EXPORT_STATE_ARCHIVED: Export has been archived and the archive is no longer available for download.", "enum": [ "ONE_TIME_EXPORT_STATE_UNSPECIFIED", "ONE_TIME_EXPORT_STATE_SCHEDULED", "ONE_TIME_EXPORT_STATE_RUNNING", "ONE_TIME_EXPORT_STATE_SUCCESS", "ONE_TIME_EXPORT_STATE_FAILED", "ONE_TIME_EXPORT_STATE_ARCHIVED" ], "type": "string" }, "nebius.billing.v1alpha1.OneTimeExportStateDetails": { "description": "Additional details about the current state of the export.", "properties": { "error": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ServiceError" } ], "description": "Error encountered during export.\nPopulated only when state is FAILED." } }, "type": "object" }, "nebius.billing.v1alpha1.OneTimeExportStatus": { "description": "Status information for one-time export.", "properties": { "downloadUrl": { "description": "Presigned download URL for the archive.\nPopulated only when state is DONE. Each Get request generates a fresh URL.", "type": "string" }, "expiresAt": { "description": "Timestamp when this export expires.", "format": "date-time", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.OneTimeExportState" } ], "description": "Current state of the export." }, "stateDetails": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.OneTimeExportStateDetails" } ], "description": "Additional details about the current state." } }, "type": "object" }, "nebius.billing.v1alpha1.ResourceGroupCost": { "description": "Cost information for a group of resources.", "properties": { "general": { "allOf": [ { "$ref": "#/components/schemas/nebius.billing.v1alpha1.GeneralTotalCost" } ], "description": "Fixed total cost calculation.\nUsed when the total cost is deterministic and doesn't vary." } }, "type": "object" }, "nebius.billing.v1alpha1.ResourceSpec": { "description": "Resource specification for cost estimation.\nContains the specifications for creating and updating different types of resources.", "properties": { "computeDiskSpec": { "$ref": "#/components/schemas/nebius.compute.v1.CreateDiskRequest" }, "computeDiskUpdateSpec": { "$ref": "#/components/schemas/nebius.compute.v1.UpdateDiskRequest" }, "computeFilesystemSpec": { "$ref": "#/components/schemas/nebius.compute.v1.CreateFilesystemRequest" }, "computeFilesystemUpdateSpec": { "$ref": "#/components/schemas/nebius.compute.v1.UpdateFilesystemRequest" }, "computeInstanceSpec": { "$ref": "#/components/schemas/nebius.compute.v1.CreateInstanceRequest" }, "computeInstanceUpdateSpec": { "$ref": "#/components/schemas/nebius.compute.v1.UpdateInstanceRequest" } }, "type": "object" }, "nebius.capacity.v1.CapacityAllowance": { "description": "Resource that restricts Capacity Block Group quota by project.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Standard metadata. parent_id is the User's Project NID." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityAllowanceSpec" } ], "description": "Identifiers for the limit and technical configuration." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityAllowanceStatus" } ], "description": "Current status of the Capacity Allowance.", "readOnly": true } }, "type": "object" }, "nebius.capacity.v1.CapacityAllowanceSpec": { "description": "Capacity Allowance specification.", "properties": { "capacityBlockGroupId": { "description": "Capacity Block Group NID.", "type": "string" }, "limit": { "description": "Total amount of resources allocated.\nOptional is used to define an unlimited Capacity Allowance.", "format": "uint64", "type": "string" } }, "required": [ "capacityBlockGroupId" ], "type": "object" }, "nebius.capacity.v1.CapacityAllowanceStatus": { "description": "Capacity Allowance status.", "properties": { "reconciling": { "description": "Shows that changes are in flight.", "type": "boolean" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityAllowanceStatus.State" } ], "description": "Current state of the capacity allowance." }, "unit": { "description": "Capacity Allowance unit.\nExample: \"GPU\".", "type": "string" }, "usage": { "description": "Current capacity allowance usage.", "format": "uint64", "type": "string" }, "usagePercentage": { "description": "Capacity allowance usage percentage.", "type": "string" }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityAllowanceStatus.UsageState" } ], "description": "Current state of the capacity allowance usage." } }, "type": "object" }, "nebius.capacity.v1.CapacityAllowanceStatus.State": { "default": "STATE_UNSPECIFIED", "description": " - STATE_PROVISIONING: Capacity Allowance is being allocated; the process can take up to several minutes.\n - STATE_ACTIVE: Capacity Allowance is allocated and can be used.\n - STATE_CONTAINER_DELETED: The container of the Capacity Allowance is deleted. Capacity Allowance cannot be changed.", "enum": [ "STATE_UNSPECIFIED", "STATE_PROVISIONING", "STATE_ACTIVE", "STATE_CONTAINER_DELETED" ], "type": "string" }, "nebius.capacity.v1.CapacityAllowanceStatus.UsageState": { "default": "USAGE_STATE_UNSPECIFIED", "description": " - USAGE_STATE_USED: Capacity allowance is actively in use.\n - USAGE_STATE_NOT_USED: Capacity allowance is not currently in use.\n - USAGE_STATE_UNKNOWN: Capacity allowance region is unreachable, the current usage is therefore unknown.\nPlease, retry the request later.", "enum": [ "USAGE_STATE_UNSPECIFIED", "USAGE_STATE_USED", "USAGE_STATE_NOT_USED", "USAGE_STATE_UNKNOWN" ], "type": "string" }, "nebius.capacity.v1.CapacityBlockGroup": { "description": "Capacity Block Group is a parent resource for Capacity Intervals.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityBlockGroupSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityBlockGroupStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.capacity.v1.CapacityBlockGroupSpec": { "description": "Capacity Block Group specification.", "type": "object" }, "nebius.capacity.v1.CapacityBlockGroupStatus": { "description": "Capacity Block Group status.", "properties": { "currentContinuousInterval": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.CurrentContinuousInterval" } ], "description": "Current concatenation of non-zero Capacity Intervals that overlap or follow each other without a break.\nIf all Capacity Intervals are in the past, returns the last Continuous Interval.\nIf all Capacity Intervals are in the future, returns the first Continuous Interval scheduled." }, "currentLimit": { "description": "Capacity Block Group current quota limit.", "format": "uint64", "type": "string" }, "nextChangeAt": { "description": "Time of the next Capacity Block Group quota change.", "format": "date-time", "type": "string" }, "nextChangeTo": { "description": "The next expected change of the Capacity Block Group quota limit.\nthe quota limit change that is currently performed.", "format": "uint64", "type": "string" }, "reconciling": { "description": "Shows that changes are in flight.", "type": "boolean" }, "region": { "description": "Name of the region where the Capacity Block Group is allocated.\nExample: \"eu-north1\".", "type": "string" }, "resourceAffinity": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ResourceAffinity" } ], "description": "Specification of the Capacity Block Group." }, "service": { "description": "Service for which the Capacity Block Group is allocated.\nDerived from the resource_affinity variant (compute_v1 -\u003e \"compute\", tokenfactory_v1 -\u003e \"tokenfactory\").", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityBlockGroupStatus.State" } ], "description": "Capacity Block Group state with respect to quota allocation." }, "usage": { "description": "Capacity Block Group quota usage.", "format": "uint64", "type": "string" }, "usagePercentage": { "description": "Capacity Block Group quota usage percentage.", "type": "string" }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityBlockGroupStatus.UsageState" } ], "description": "Capacity Block Group quota usage state." } }, "type": "object" }, "nebius.capacity.v1.CapacityBlockGroupStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Shows the state of a Capacity Block Group with respect to its quota.\n\n - STATE_UNSPECIFIED: Shouldn't happen.\n - STATE_ALLOCATING: Capacity Block Group quota is being allocated as one or more capacity intervals have started.\n - STATE_ACTIVE: Capacity Block Group quota is already allocated and active as one or more capacity intervals are active.\n - STATE_SHUTTING: Capacity Block Group is being shut down due to absence of active intervals at the time.\n - STATE_INACTIVE: Capacity Block Group is inactive due to absence of active intervals at the time.", "enum": [ "STATE_UNSPECIFIED", "STATE_ALLOCATING", "STATE_ACTIVE", "STATE_SHUTTING", "STATE_INACTIVE" ], "type": "string" }, "nebius.capacity.v1.CapacityBlockGroupStatus.UsageState": { "default": "USAGE_STATE_UNSPECIFIED", "description": "Shows the usage state if a Capacity Block Group quota.\n\n - USAGE_STATE_UNSPECIFIED: Shouldn't happen.\n - USAGE_STATE_USED: Capacity Block Group quota is actively in use.\n - USAGE_STATE_NOT_USED: Capacity Block Group quota is not currently in use.\n - USAGE_STATE_UNKNOWN: Capacity Block Group region is unreachable, the current usage is therefore unknown.\nPlease, retry the request later.", "enum": [ "USAGE_STATE_UNSPECIFIED", "USAGE_STATE_USED", "USAGE_STATE_NOT_USED", "USAGE_STATE_UNKNOWN" ], "type": "string" }, "nebius.capacity.v1.CapacityInterval": { "description": "Capacity Intervals represents a timeframe during which the specified resources can be used.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityIntervalSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityIntervalStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.capacity.v1.CapacityIntervalSpec": { "description": "Capacity Interval specification.", "type": "object" }, "nebius.capacity.v1.CapacityIntervalStatus": { "description": "Capacity Interval status data.", "properties": { "containerId": { "description": "Tenant ID for which the Capacity Interval is created.", "type": "string" }, "endTime": { "description": "End time of the Capacity Interval.", "format": "date-time", "type": "string" }, "quantity": { "description": "Resource quantity of the Capacity Interval.", "format": "uint64", "type": "string" }, "reconciling": { "description": "Shows that changes are in flight.", "type": "boolean" }, "region": { "description": "Name of the region where the Capacity Interval is created.\nExample: \"eu-north1\".", "type": "string" }, "resourceAffinity": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ResourceAffinity" } ], "description": "Specification of the Capacity Interval." }, "service": { "description": "Service for which the Capacity Interval is created.", "type": "string" }, "startTime": { "description": "Start time of the Capacity Interval.", "format": "date-time", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityIntervalStatus.State" } ], "description": "State of the Capacity Interval." } }, "type": "object" }, "nebius.capacity.v1.CapacityIntervalStatus.State": { "default": "STATE_UNSPECIFIED", "description": " - STATE_UNSPECIFIED: Shouldn't happen.\n - STATE_SCHEDULED: Capacity Interval is fully in the future (now \u003c start_time).\n - STATE_ACTIVE: Capacity Interval is currently active (start_time \u003c= now \u003c end_time).\n - STATE_EXPIRED: Capacity Interval is fully in the past (end_time \u003c= now).", "enum": [ "STATE_UNSPECIFIED", "STATE_SCHEDULED", "STATE_ACTIVE", "STATE_EXPIRED" ], "type": "string" }, "nebius.capacity.v1.ComputeInstanceDetails": { "description": "Details for Compute/GPU capacity.", "properties": { "gpuMemoryGigabytes": { "description": "GPU memory size.", "format": "int32", "type": "integer" }, "platform": { "description": "Specific platform. Example: \"gpu-h200-sxm\".", "type": "string" }, "preset": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ComputeInstanceDetails.Preset" } ], "description": "The specific VM preset this advice applies to." } }, "type": "object" }, "nebius.capacity.v1.ComputeInstanceDetails.Preset": { "description": "Preset details.", "properties": { "name": { "description": "Name of the preset (e.g., \"8gpu-128vcpu-1600gb\").", "type": "string" }, "resources": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ComputeInstanceDetails.Preset.Resources" } ], "description": "Resources for the specified preset." } }, "type": "object" }, "nebius.capacity.v1.ComputeInstanceDetails.Preset.Resources": { "description": "All resources existing in a preset.", "properties": { "gpuCount": { "description": "Number of GPU cores.", "format": "int32", "type": "integer" }, "memoryGibibytes": { "description": "Memory size.", "format": "int32", "type": "integer" }, "vcpuCount": { "description": "Number of vCPUs.", "format": "int32", "type": "integer" } }, "type": "object" }, "nebius.capacity.v1.CreateCapacityAllowanceRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityAllowanceSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.capacity.v1.CurrentContinuousInterval": { "description": "Current, last or future concatenation of Capacity Intervals in a Capacity Block Group.", "properties": { "endTime": { "description": "End time of the last interval(s) in Continuous Interval.", "format": "date-time", "type": "string" }, "quantity": { "description": "Quota quantity that is currently set, was set or will be set in the Continuous Interval depending on it's\nstart_time and end_time.\nIf the Continuous Interval is currently active, quantity is the sum of quantities of the currently active\nnon-zero intervals.\nIf the Continuous Interval is in the past, quantity is the sum of quantities of the last non-zero active\nintervals.\nIf the Continuous Interval is in the future, quantity is the sum of the quantities of the first scheduled\nnon-zero active intervals.", "format": "uint64", "type": "string" }, "startTime": { "description": "Start time of the first interval(s) in Continuous Interval.", "format": "date-time", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.CurrentContinuousInterval.State" } ], "description": "Continuous Interval state." } }, "type": "object" }, "nebius.capacity.v1.CurrentContinuousInterval.State": { "default": "STATE_UNSPECIFIED", "description": "Shows a state of a Continuous Interval.\n\n - STATE_UNSPECIFIED: Shouldn't happen.\n - STATE_SCHEDULED: Continuous Interval is in the future.\n - STATE_ACTIVE: Continuous Interval is active.\n - STATE_EXPIRED: Continuous Interval is in the past.", "enum": [ "STATE_UNSPECIFIED", "STATE_SCHEDULED", "STATE_ACTIVE", "STATE_EXPIRED" ], "type": "string" }, "nebius.capacity.v1.ListCapacityAllowancesResponse": { "properties": { "items": { "description": "List of Capacity Allowances on this result page.", "items": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityAllowance" }, "type": "array" }, "nextPageToken": { "description": "Listing continuation token for the next page of results.", "type": "string" } }, "type": "object" }, "nebius.capacity.v1.ListCapacityBlockGroupResourcesResponse": { "description": "All VM instances' IDs that occupy the Capacity Block Group.", "properties": { "resourceIds": { "description": "List of instances' IDs.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.capacity.v1.ListCapacityBlockGroupsResponse": { "description": "All existing Capacity Block Groups in a Tenant.", "properties": { "items": { "description": "List of Capacity Block Groups on this result page.", "items": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityBlockGroup" }, "type": "array" }, "nextPageToken": { "description": "Listing continuation token for the next page of results.", "type": "string" } }, "type": "object" }, "nebius.capacity.v1.ListCapacityIntervalsResponse": { "description": "All existing Capacity Intervals in a Capacity Block Group.", "properties": { "items": { "description": "List of Capacity Intervals on this result page.", "items": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityInterval" }, "type": "array" }, "nextPageToken": { "description": "Listing continuation token for the next page of results.", "type": "string" } }, "type": "object" }, "nebius.capacity.v1.ListResourceAdviceResponse": { "properties": { "items": { "description": "List of resource advice items matching the request.\nEach item represents a unique combination of Resource Type + Tier/Preset.", "items": { "$ref": "#/components/schemas/nebius.capacity.v1.ResourceAdvice" }, "type": "array" }, "nextPageToken": { "description": "Token for retrieving the next page of results.", "type": "string" } }, "type": "object" }, "nebius.capacity.v1.ResourceAdvice": { "description": "ResourceAdvice is a virtual resource representing the availability\nof a specific technical configuration in a specific scope.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Standard metadata. parent_id is the User's Tenant NID." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ResourceAdviceSpec" } ], "description": "Identifiers for the capacity scope and technical configuration." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ResourceAdviceStatus" } ], "description": "The current state of availability, including quotas and data freshness.", "readOnly": true } }, "type": "object" }, "nebius.capacity.v1.ResourceAdviceSpec": { "description": "Resource Advice specification.", "properties": { "computeInstance": { "$ref": "#/components/schemas/nebius.capacity.v1.ComputeInstanceDetails" }, "fabric": { "description": "Data center fabric or cluster identifier.", "type": "string" }, "region": { "description": "Geographical region identifier.", "type": "string" } }, "type": "object" }, "nebius.capacity.v1.ResourceAdviceStatus": { "description": "Resource Advice status.", "properties": { "onDemand": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ResourceAdviceStatus.Availability" } ], "description": "Capacity for regular on-demand resources." }, "preemptible": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ResourceAdviceStatus.Availability" } ], "description": "Capacity for preemptible/spot resources." }, "reserved": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ResourceAdviceStatus.Availability" } ], "description": "Capacity for reserved/guaranteed resources through Capacity Blocks." } }, "type": "object" }, "nebius.capacity.v1.ResourceAdviceStatus.Availability": { "description": "Shows the available resources.", "properties": { "availabilityLevel": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ResourceAdviceStatus.Availability.AvailabilityLevel" } ], "description": "Categorical indicator for resources availability." }, "available": { "description": "Current units that can be allocated immediately (clipped by quota).", "format": "int64", "type": "integer" }, "dataState": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ResourceAdviceStatus.Availability.DataState" } ], "description": "Reflects relevance of the data." }, "effectiveAt": { "description": "The timestamp of the actual infrastructure measurement.", "format": "date-time", "type": "string" }, "limit": { "description": "The user's maximum quota limit for this resource type.", "format": "int64", "type": "integer" } }, "type": "object" }, "nebius.capacity.v1.ResourceAdviceStatus.Availability.AvailabilityLevel": { "default": "AVAILABILITY_LEVEL_UNSPECIFIED", "description": "Indicates the likelihood of a successful allocation.\n\n - AVAILABILITY_LEVEL_UNSPECIFIED: Shouldn't ever happen.\n - AVAILABILITY_LEVEL_HIGH: Plenty of room for large requests.\n - AVAILABILITY_LEVEL_MEDIUM: Room for medium requests.\n - AVAILABILITY_LEVEL_LOW: High risk of Not Enough Resources (NER).\n - AVAILABILITY_LEVEL_LIMIT_REACHED: Not enough quota or capacity block on the customer's side.\n - AVAILABILITY_LEVEL_UNKNOWN: Failed to retrieve data.", "enum": [ "AVAILABILITY_LEVEL_UNSPECIFIED", "AVAILABILITY_LEVEL_HIGH", "AVAILABILITY_LEVEL_MEDIUM", "AVAILABILITY_LEVEL_LOW", "AVAILABILITY_LEVEL_LIMIT_REACHED", "AVAILABILITY_LEVEL_UNKNOWN" ], "type": "string" }, "nebius.capacity.v1.ResourceAdviceStatus.Availability.DataState": { "default": "DATA_STATE_UNSPECIFIED", "description": "Shows if data could be trusted.\n\n - DATA_STATE_UNSPECIFIED: Shouldn't ever happen.\n - DATA_STATE_FRESH: Data is relevant and reflects current state of the system.\n - DATA_STATE_STALE: Data is not relevant anymore as it was fetched long time ago.\n - DATA_STATE_UNKNOWN: Failed to retrieve data.", "enum": [ "DATA_STATE_UNSPECIFIED", "DATA_STATE_FRESH", "DATA_STATE_STALE", "DATA_STATE_UNKNOWN" ], "type": "string" }, "nebius.capacity.v1.ResourceAffinity": { "description": "Specification of the Capacity Block Group.", "properties": { "computeV1": { "allOf": [ { "$ref": "#/components/schemas/nebius.capacity.v1.ResourceAffinityComputeV1" } ], "description": "First version of the compute Resource Affinity." } }, "type": "object" }, "nebius.capacity.v1.ResourceAffinityComputeV1": { "description": "First version of Compute service resource affinity", "properties": { "fabric": { "description": "The fabric where the Capacity Block Group is allocated.", "type": "string" }, "platform": { "description": "The platform for which the Capacity Block Group is allocated.", "type": "string" } }, "required": [ "platform" ], "type": "object" }, "nebius.capacity.v1.UpdateCapacityAllowanceRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityAllowanceSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.common.v1.BadRequest": { "description": "The request is invalid.", "properties": { "violations": { "description": "Describes all violations.", "items": { "$ref": "#/components/schemas/nebius.common.v1.BadRequest.Violation" }, "type": "array" } }, "type": "object" }, "nebius.common.v1.BadRequest.Violation": { "properties": { "field": { "description": "What field value is invalid.", "type": "string" }, "message": { "description": "Description why the value is invalid, in English.", "type": "string" }, "relatedFields": { "description": "Other fields whose values contribute to this violation.\nDoes not include the primary field.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.common.v1.BadResourceState": { "description": "The resource we are trying to use, create, change or delete is in a bad state and cannot be used.", "properties": { "message": { "description": "The reason why this state is bad and cannot be used.", "type": "string" }, "resourceId": { "description": "ID of the resource which is bad.", "type": "string" } }, "type": "object" }, "nebius.common.v1.InternalError": { "description": "Generic internal error.", "properties": { "requestId": { "description": "Error request ID.", "type": "string" }, "traceId": { "description": "Trace ID for the failing request.", "type": "string" } }, "type": "object" }, "nebius.common.v1.ListOperationsResponse": { "properties": { "nextPageToken": { "type": "string" }, "operations": { "items": { "$ref": "#/components/schemas/nebius.common.v1.Operation" }, "type": "array" } }, "type": "object" }, "nebius.common.v1.NotEnoughResources": { "description": "Indicates that there are not enough resources available to perform the requested action.", "properties": { "violations": { "description": "Describes all resource violations.", "items": { "$ref": "#/components/schemas/nebius.common.v1.NotEnoughResources.Violation" }, "type": "array" } }, "type": "object" }, "nebius.common.v1.NotEnoughResources.Violation": { "properties": { "message": { "description": "A description of how the resource is insufficient.", "type": "string" }, "requested": { "description": "Requested value.", "type": "string" }, "resourceType": { "description": "The type of resource that is insufficient.\nThis field is populated when it is possible to determine the lacking resource type.\n**Not for programmatic use.**", "type": "string" } }, "type": "object" }, "nebius.common.v1.Operation": { "properties": { "createdAt": { "description": "Creation timestamp.", "format": "date-time", "type": "string" }, "createdBy": { "description": "ID of the user or service account who initiated the operation.", "type": "string" }, "description": { "description": "Human-readable description of the operation. 0-256 characters long.", "type": "string" }, "finishedAt": { "description": "The time when the operation has finished.", "format": "date-time", "type": "string" }, "id": { "description": "ID of the operation.", "type": "string" }, "progressData": { "allOf": [ { "$ref": "#/components/schemas/google.protobuf.Any" } ], "description": "Extra information about this operation's progress. MAY be absent while the operation is running, MUST be absent after the operation has\ncompleted.\n\nType of message that's stored inside [progress_data] is service-dependent." }, "progressTracker": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ProgressTracker" } ], "description": "Information about this operation's progress, if this operation tracks its progress.\nIf the operation tracks its progress, `progress_tracker` MUST be present both while\nthe operation is running and after it has been completed." }, "request": { "allOf": [ { "$ref": "#/components/schemas/google.protobuf.Any" } ], "description": "The request that generated this operation." }, "requestHeaders": { "additionalProperties": { "$ref": "#/components/schemas/nebius.common.v1.Operation.RequestHeader" }, "description": "The request headers that are essential for the request that generated the operation.\nFor instance, `x-resetmask`. Without these headers the request might have been processed\ndifferently if repeated.\nAll the header names *must* be converted to lower case.\nValidator is based on:\nhttps://httpwg.org/specs/rfc9110.html#considerations.for.new.field.names", "type": "object" }, "resourceId": { "description": "ID of the resource that this operation creates, updates, deletes or otherwise changes.\n\nIf the operation affects multiple resources or does not affect any API resources at all\n(e.g. a routine maintenance operation visible to the user), the [resource_id] must be empty.", "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/google.rpc.Status" } ], "description": "The status of this operation. Set when this operation is completed.\nSee https://github.com/grpc/grpc/blob/master/src/proto/grpc/status/status.proto.\n\n[status.code] is https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto:\n- If [status.code] == OK, the operation has completed successfully.\n- If [status.code] != OK, the operation has failed or has been cancelled.\n - [status.message] will contain a user-readable and actionable error message.\n - [status.details] will contain additional diagnostic information in the form of [ServiceError] from nebius/common/v1/error.proto\n- [status.code] must belong to an Operation-compatible subset of GRPC codes:\n OK, CANCELLED, PERMISSION_DENIED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, INTERNAL" } }, "type": "object" }, "nebius.common.v1.Operation.RequestHeader": { "description": "Request header is a container for all the values of a particular header of a request because there is no such thing as\n`map\u003cstring, repeated string\u003e`", "properties": { "values": { "description": "The values of a particular header from a request", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.common.v1.OperationAborted": { "description": "Operation on the resource has been aborted by a subsequent operation.", "properties": { "abortedByOperationId": { "description": "ID of the subsequent operation.", "type": "string" }, "operationId": { "description": "ID of the aborted operation.", "type": "string" }, "resourceId": { "description": "Resource ID corresponding to both of the operations.", "type": "string" } }, "type": "object" }, "nebius.common.v1.OperationConflict": { "description": "Operation cannot be started because a conflicting operation is already running on the same resource.\nWait until the conflicting operation finishes, then you can retry starting your operation.", "properties": { "conflictingOperationId": { "description": "ID of the conflicting operation (the one that's running).", "type": "string" }, "resourceId": { "description": "Resource ID corresponding to the conflicting operation.", "type": "string" } }, "type": "object" }, "nebius.common.v1.OutOfRange": { "description": "Indicates that element with requested parameters is exceeding the particular range.", "properties": { "limit": { "description": "Available limit.", "type": "string" }, "requested": { "description": "Requested value.", "type": "string" } }, "type": "object" }, "nebius.common.v1.PermissionDenied": { "description": "Indicates that the action cannot be performed because there are insufficient access rights to a resource.", "properties": { "resourceId": { "description": "ID of the resource that cannot be accessed.", "type": "string" } }, "type": "object" }, "nebius.common.v1.PreflightCheckContext": { "description": "Context supplied by a caller when requesting a server-side preflight check.", "properties": { "action": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.PreflightCheckContext.Action" } ], "description": "Operation evaluated by the preflight check." }, "pathsRequireRecreate": { "description": "Additive Nebius mask of fields that require resource recreation when changed.\nFor RECREATE, the calling tool fills this mask with the paths that caused it to recreate the resource.\nIf a field at one of these paths changes, the calling tool must delete the existing resource\nand create a new resource with the requested values.\nEmpty means that the caller has not identified any such fields.", "type": "string" }, "tool": { "description": "Lower-case name of the calling tool, such as \"terraform\", \"cli\", or \"console\".\nEmpty means that no tool-specific behavior is requested.", "type": "string" }, "unknownPaths": { "description": "Nebius mask identifying values in the proposed request that are unknown.\nAn unknown value is not available to the caller when it sends the preflight request.\nThe caller expects the actual value to be available when the create or update operation runs.\nThe mask is rooted at the request's metadata and spec fields. Empty means all supplied values are known;\n\"*\" means the complete proposed request is unknown.", "type": "string" } }, "type": "object" }, "nebius.common.v1.PreflightCheckContext.Action": { "default": "UNSPECIFIED", "description": "Operation evaluated by the preflight check.\n\n - UNSPECIFIED: Infer UPDATE when the request metadata contains a resource ID; otherwise infer CREATE.\n - CREATE: Evaluate resource creation.\n - UPDATE: Evaluate a resource update.\n - DELETE: Evaluate resource deletion. Reserved until delete preflight requests are supported.\n - RECREATE: Evaluate resource recreation. This is the same as CREATE, but assumes that the resource\nwith the requested ID is deleted immediately before it is created.", "enum": [ "UNSPECIFIED", "CREATE", "UPDATE", "DELETE", "RECREATE" ], "type": "string" }, "nebius.common.v1.PreflightCheckDiagnostic": { "description": "A user-facing diagnostic produced by a preflight check.", "properties": { "details": { "description": "Optional plain-text consequence and remediation details.", "type": "string" }, "path": { "description": "Optional Nebius field path rooted at metadata or spec.\nEmpty means that the diagnostic applies to the resource or operation as a whole.", "type": "string" }, "severity": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.PreflightCheckDiagnostic.Severity" } ], "description": "Effect of the diagnostic on the proposed operation. Must not be UNSPECIFIED." }, "summary": { "description": "Required single-line, plain-text user-facing explanation.", "type": "string" } }, "type": "object" }, "nebius.common.v1.PreflightCheckDiagnostic.Severity": { "default": "UNSPECIFIED", "description": "Effect of the diagnostic on the proposed operation.\n\n - UNSPECIFIED: Invalid for a returned diagnostic.\n - ERROR: The proposed operation cannot proceed.\n - WARNING: The proposed operation can proceed, subject to requires_user_approval.", "enum": [ "UNSPECIFIED", "ERROR", "WARNING" ], "type": "string" }, "nebius.common.v1.ProgressTracker": { "description": "Information for tracking the progress of a task (e.g., an API operation or background maintenance action).\nThis serves as a UI contract and may be directly reflected in CLI, Console, and other tools.", "properties": { "description": { "description": "Human-readable description of the currently executing task, e.g., \"Downloading dat-groot-llm.tar.xz\".\nRelates to the overall task, not individual steps.\nSHOULD match the Operation's `description` field when this ProgressTracker tracks an API Operation's progress.\nMAY provide more detailed overall information.\n\nMUST be suitable for display to public users.\nEven if the task is internal, this description may be shown to end users in overall task step descriptions.\n\nFor individual step descriptions, use `Step.description`.", "type": "string" }, "estimatedFinishedAt": { "description": "Estimated completion timestamp for the task.\nMUST be absent if the task is completed (i.e., finished_at is set).\nMAY be absent if the estimate is unknown.\nMAY be updated as the progress estimate changes.", "format": "date-time", "type": "string" }, "finishedAt": { "description": "Completion timestamp of the task.\nMUST be absent for running tasks; MUST be present for completed tasks.\nMUST match the operation's finished_at timestamp when tracking an API Operation's progress.", "format": "date-time", "type": "string" }, "startedAt": { "description": "Timestamp when the overall task started.\nMUST match the operation's created_at timestamp when tracking an API Operation's progress.", "format": "date-time", "type": "string" }, "steps": { "description": "Detailed information about the task steps that are currently running or have been finished.\n- For a completed task, the step list MUST either be empty or contain finished steps only.\n- For a running task, the step list MAY be empty if the task consists of a single step or no detailed information is available.\n A non-empty step list MUST include all currently running steps and MAY include some or all finished steps.\n- Service SHOULD provide both running and finished steps if the task has around 10-20 steps, and provide only running steps otherwise.\n Service MUST consistently choose either the \"running steps only\" or the \"running + finished steps\" behavior.\n- The UI, CLI etc. MAY choose not to display all steps provided by the service.", "items": { "$ref": "#/components/schemas/nebius.common.v1.ProgressTracker.Step" }, "type": "array" }, "workDone": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ProgressTracker.WorkDone" } ], "description": "Overall work progress details.\nMAY be absent if unknown." } }, "type": "object" }, "nebius.common.v1.ProgressTracker.Step": { "description": "Represents a basic step in the task.\nFields are binary-compatible with ProgressTracker for easier processing.", "properties": { "description": { "description": "Human-readable description of the step, e.g., \"Connecting to localhost:8080\".\nMUST be suitable for display to public users.\nPrivate descriptions must be filtered server-side based on the use case.", "type": "string" }, "finishedAt": { "description": "Timestamp when the step finished.\nMUST be absent for running steps; MUST be present for completed steps.", "format": "date-time", "type": "string" }, "startedAt": { "description": "Timestamp when the step started.", "format": "date-time", "type": "string" }, "workDone": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ProgressTracker.WorkDone" } ], "description": "Details on the work to be done for this step and progress made.\nMAY be absent if unknown." } }, "type": "object" }, "nebius.common.v1.ProgressTracker.WorkDone": { "description": "Information about the work done by the task or its step, expressed in ticks (abstract work units).\nEach tick may represent a real measurement (e.g., VMs created, KiB uploaded), number of substeps or a percentage of work completed.", "properties": { "doneTickCount": { "description": "Number of ticks completed so far. MUST be between 0 and total_tick_count, inclusive.\nMUST equal total_tick_count if the task or step is finished.", "format": "int64", "type": "string" }, "totalTickCount": { "description": "Total number of ticks (work units) to be completed. MUST be greater than 0.", "format": "int64", "type": "string" } }, "type": "object" }, "nebius.common.v1.QuotaFailure": { "description": "Indicates a failure due to exceeding specified limits or allocations in a system or service.", "properties": { "violations": { "description": "Describes all quota violations.", "items": { "$ref": "#/components/schemas/nebius.common.v1.QuotaFailure.Violation" }, "type": "array" } }, "type": "object" }, "nebius.common.v1.QuotaFailure.Violation": { "properties": { "limit": { "description": "Maximum permissible value.", "type": "string" }, "message": { "description": "A description of how the quota check failed.", "type": "string" }, "quota": { "description": "Which quota check failed.", "type": "string" }, "requested": { "description": "Requested value.", "type": "string" } }, "type": "object" }, "nebius.common.v1.RecurrentResourceEvent": { "description": "A resource event that has occurred (more or less in the same way) multiple times across a service-defined aggregation interval", "properties": { "firstOccurredAt": { "description": "Time of the first occurrence of a recurrent event", "format": "date-time", "type": "string" }, "lastOccurrence": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceEvent" } ], "description": "Last occurrence of a recurrent event" }, "occurrenceCount": { "description": "The number of times this event has occurred between `first_occurred_at` and `last_occurrence.occurred_at`. Must be \u003e 0", "format": "int64", "type": "string" } }, "type": "object" }, "nebius.common.v1.ResourceAlreadyExists": { "description": "Resource we are trying to create already exists.", "properties": { "resourceId": { "description": "ID of the existing resource.", "type": "string" } }, "type": "object" }, "nebius.common.v1.ResourceConflict": { "description": "There is a difference between the actual resource state and the expected one.", "properties": { "message": { "description": "Detailed info about conflict.", "type": "string" }, "resourceId": { "description": "ID of conflicting resource.", "type": "string" } }, "type": "object" }, "nebius.common.v1.ResourceEvent": { "description": "Represents an API Resource-related event which is potentially important to the end-user. What exactly constitutes an *event* to be\nreported is service-dependent", "properties": { "code": { "description": "Event code (unique within the API service), in UpperCamelCase, e.g. `\"DiskAttached\"`", "type": "string" }, "error": { "allOf": [ { "$ref": "#/components/schemas/google.rpc.Status" } ], "description": "Describes a GRPC error status associated with an `ERROR` or `WARN` level event, if known. The `error` **must** have a standard GRPC\n`code` (which **must not** be `OK` (0)) and a human-readable `message`. A standard `common.v1.ServiceError` **should** also be\nincluded in `details`" }, "level": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceEvent.Level" } ], "description": "Severity level for the event" }, "message": { "description": "A human-readable message describing what has happened\n(and suggested actions for the user, if this is a `WARN` or `ERROR` level event)", "type": "string" }, "occurredAt": { "description": "Time at which the event has occurred", "format": "date-time", "type": "string" } }, "type": "object" }, "nebius.common.v1.ResourceEvent.Level": { "default": "UNSPECIFIED", "description": "- UNSPECIFIED: Unspecified event severity level\n - DEBUG: A debug event providing detailed insight. Such events are used to debug problems with specific resource(s) and process(es)\n - INFO: A normal event or state change. Informs what is happening with the API resource. Does not require user attention or interaction\n - WARN: Warning event. Indicates a potential or minor problem with the API resource and/or the corresponding processes. Needs user attention,\nbut requires no immediate action (yet)\n - ERROR: Error event. Indicates a serious problem with the API resource and/or the corresponding processes. Requires immediate user action", "enum": [ "UNSPECIFIED", "DEBUG", "INFO", "WARN", "ERROR" ], "type": "string" }, "nebius.common.v1.ResourceMetadata": { "description": "Common resource metadata.", "properties": { "createdAt": { "description": "Timestamp indicating when the resource was created.", "format": "date-time", "readOnly": true, "type": "string" }, "id": { "description": "Identifier for the resource, unique for its resource type.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels associated with the resource.", "type": "object" }, "name": { "description": "Human readable name for the resource.", "type": "string" }, "parentId": { "description": "Identifier of the parent resource to which the resource belongs.", "type": "string" }, "resourceVersion": { "description": "Version of the resource for safe concurrent modifications and consistent reads.\nPositive and monotonically increases on each resource spec change (but *not* on each change of the\nresource's container(s) or status).\nService allows zero value or current.", "format": "int64", "type": "string" }, "updatedAt": { "description": "Timestamp indicating when the resource was last updated.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "parentId" ], "type": "object" }, "nebius.common.v1.ResourceNotFound": { "description": "Resource we are trying to interact with does not exist.", "properties": { "resourceId": { "description": "ID of the requested resource.", "type": "string" } }, "type": "object" }, "nebius.common.v1.ServiceError": { "properties": { "badRequest": { "$ref": "#/components/schemas/nebius.common.v1.BadRequest" }, "badResourceState": { "$ref": "#/components/schemas/nebius.common.v1.BadResourceState" }, "code": { "description": "Detailed error code, service-specific. E.g. \"DnsZoneNotEmpty\".\nName of the exception, without Exception suffix if not set.\nExample: for PermissionDeniedException -\u003e code == PermissionDenied.", "type": "string" }, "internalError": { "$ref": "#/components/schemas/nebius.common.v1.InternalError" }, "notEnoughResources": { "$ref": "#/components/schemas/nebius.common.v1.NotEnoughResources" }, "operationAborted": { "$ref": "#/components/schemas/nebius.common.v1.OperationAborted" }, "operationConflict": { "$ref": "#/components/schemas/nebius.common.v1.OperationConflict" }, "outOfRange": { "$ref": "#/components/schemas/nebius.common.v1.OutOfRange" }, "permissionDenied": { "$ref": "#/components/schemas/nebius.common.v1.PermissionDenied" }, "quotaFailure": { "$ref": "#/components/schemas/nebius.common.v1.QuotaFailure" }, "resourceAlreadyExists": { "$ref": "#/components/schemas/nebius.common.v1.ResourceAlreadyExists" }, "resourceConflict": { "$ref": "#/components/schemas/nebius.common.v1.ResourceConflict" }, "resourceNotFound": { "$ref": "#/components/schemas/nebius.common.v1.ResourceNotFound" }, "retryType": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ServiceError.RetryType" } ], "description": "Retry type tells how to provide retry, e.g.: just a single call or the whole logic before it." }, "service": { "description": "ID of Service which the error originated in. E.g. \"dns\".", "type": "string" }, "tooManyRequests": { "$ref": "#/components/schemas/nebius.common.v1.TooManyRequests" } }, "type": "object" }, "nebius.common.v1.ServiceError.RetryType": { "default": "UNSPECIFIED", "description": " - CALL: Just retry the failed call.\n - UNIT_OF_WORK: Retry whole logic before call and make a new one.\n - NOTHING: Do not retry, this is a fatal error.", "enum": [ "UNSPECIFIED", "CALL", "UNIT_OF_WORK", "NOTHING" ], "type": "string" }, "nebius.common.v1.TooManyRequests": { "description": "You initiated too many requests to the service at once. Enhance your calm.", "properties": { "violation": { "description": "What request limit is exceeded (service-dependent).", "type": "string" } }, "type": "object" }, "nebius.common.v1alpha1.ListOperationsResponse": { "properties": { "nextPageToken": { "description": "Listing continuation token for the next page of results.", "type": "string" }, "operations": { "description": "List of operations on this result page.", "items": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" }, "type": "array" } }, "type": "object" }, "nebius.common.v1alpha1.Operation": { "properties": { "createdAt": { "description": "Creation timestamp.", "format": "date-time", "type": "string" }, "createdBy": { "description": "ID of the user or service account who initiated the operation.", "type": "string" }, "description": { "description": "Human readable description of the operation. 0-256 characters long.", "type": "string" }, "finishedAt": { "description": "The time when the operation finished.", "format": "date-time", "type": "string" }, "id": { "description": "ID of the operation.", "type": "string" }, "progressData": { "allOf": [ { "$ref": "#/components/schemas/google.protobuf.Any" } ], "description": "Additional information about the progress of an operation, e.g., a progress percentage.\nMAY be absent while the operation is running, MUST be absent after the operation has completed.\n\nFormat of message inside [progress_data] is service-dependent and MUST be documented by the\nservice, IF it is used." }, "request": { "allOf": [ { "$ref": "#/components/schemas/google.protobuf.Any" } ], "description": "The request that generated this operation." }, "requestHeaders": { "additionalProperties": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation.request_header" }, "description": "The request headers that are essential for the request that generated the operation.\nFor instance, `x-resetmask`. Without these headers the request might have been processed\ndifferently if repeated.\nAll the header names *must* be converted to lower case.\nValidator is based on:\nhttps://httpwg.org/specs/rfc9110.html#considerations.for.new.field.names", "type": "object" }, "resource": { "allOf": [ { "$ref": "#/components/schemas/google.protobuf.Any" } ], "description": "Snapshot of the resource at the moment this operation started.\n- [resource.spec] and [resource.metadata] reflect the desired resource state at the moment\n this operation started.\n E.g., in an Update operation it will be the *updated* resource spec and metadata,\n in a Create operation it will be the spec and metadata *of the resource being created*,\n and so on.\n- [resource.status] reflects the status of the resource at the moment this operation started.\n This is a snapshot, call the `\u003cResource\u003eService/Get` to get current status of the resource.\n\nThe [resource] field MUST never be updated *after* this operation has started.\n\nIn a Delete operation, an operation affecting multiple resources or an operation that doesn't\naffect any API resources at all (e.g. a routine maintenance operation visible to the user),\nthe [resource] inside MUST be a [google.protobuf.Empty]." }, "resourceId": { "description": "ID of the resource that this operation creates, updates, deletes or otherwise changes.\n\nIf the operation affects multiple resources or does not affect any API resources at all\n(e.g. a routine maintenance operation visible to the user), the [resource_id] must be empty.", "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/google.rpc.Status" } ], "description": "The status of this operation. Set when this operation is completed.\nSee https://github.com/grpc/grpc/blob/master/src/proto/grpc/status/status.proto.\n\n[status.code] is https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto:\n- If [status.code] == OK, the operation has completed successfully.\n- If [status.code] != OK, the operation has failed or has been cancelled.\n - [status.message] will contain a user-readable and actionable error message.\n - [status.details] will contain additional diagnostic information in the form of\n [ServiceError] from ../error/v1alpha1/error.proto\n- [status.code] must belong to an Operation-compatible subset of GRPC codes:\n OK, CANCELLED, PERMISSION_DENIED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, INTERNAL" } }, "type": "object" }, "nebius.common.v1alpha1.Operation.request_header": { "description": "Request header is a container for all the values of a particular header of a request\nas there is no such thing as map\u003cstring, repeated string\u003e", "properties": { "values": { "description": "The values of a particular header from a request", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.compute.v1.AttachedDiskSpec": { "properties": { "attachMode": { "$ref": "#/components/schemas/nebius.compute.v1.AttachedDiskSpec.AttachMode" }, "deviceId": { "description": "Specifies the user-defined device identifier.\nUse `/dev/disk/by-id/virtio-{device_id}` as the device path in a mount command.", "type": "string" }, "existingDisk": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.ExistingDisk" } ], "description": "Attach an existing disk.\n\nLifecycle:\n- The disk is preserved when the instance is deleted (it will be detached).\n\nSwitching to a managed disk:\n- To delete the disk together with the instance, switch to ManagedDisk in the instance spec.\n- For the switch, `ManagedDisk.name` MUST match the current disk `name`\n (see DiskService.Get for the disk referenced by `ExistingDisk.id`).\n- When converting an ExistingDisk to a ManagedDisk, you must provide `ManagedDisk.name` and `ManagedDisk.spec`\n exactly as they are currently defined in the disk resource.\n Obtain the current values via `DiskService.Get` and copy them verbatim.\n If `ManagedDisk.spec` differs from the current disk spec, the instance update will fail." }, "managedDisk": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.ManagedDisk" } ], "description": "Attach a managed disk.\n\nLifecycle:\n- The disk is deleted when the instance is deleted.\n\nSemantics:\n- Specifying a ManagedDisk expresses an intent to have that managed disk attached.\n- If this intent cannot be satisfied, the entire operation fails.\n- You can check the intent status in `instance.status.disk_attachments`.\n\nUpdates and matching:\n- Managed disks can be updated only via instance spec updates. Updates via DiskService are not allowed.\n- During updates, disks are matched by `name`.\n\nRenaming and data loss:\n- Changing the disk `name` triggers disk replacement (create a new disk and delete the old one),\n which causes data loss.\n- To rename a managed disk safely:\n 1) switch it to ExistingDisk in the instance spec, and\n 2) update/rename it via DiskService.\n\nConflicts:\n- Instance create/update fails if there is already a disk with the same `name`.\n as requested by any ManagedDisk.\n\nFinding the disk ID:\n- The disk ID is available in `instance.status.disk_attachments` after it is created.\n Use `DiskAttachmentStatus.name` to find the desired disk which matches `name`.\n\nSwitching to an existing (non-managed) disk:\n- To preserve the disk after instance deletion, switch it to ExistingDisk in the instance spec,\n use the disk ID from `instance.status.disk_attachments`.\n\nDeletion protection:\n- Switching ExistingDisk to ManagedDisk fails if `Disk.spec.deletion_protection` is enabled.\n- Deleting an instance that has a ManagedDisk fails if `Disk.spec.deletion_protection` is enabled." } }, "required": [ "attachMode" ], "type": "object" }, "nebius.compute.v1.AttachedDiskSpec.AttachMode": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "READ_ONLY", "READ_WRITE" ], "type": "string" }, "nebius.compute.v1.AttachedFilesystemSpec": { "properties": { "attachMode": { "$ref": "#/components/schemas/nebius.compute.v1.AttachedFilesystemSpec.AttachMode" }, "existingFilesystem": { "$ref": "#/components/schemas/nebius.compute.v1.ExistingFilesystem" }, "mountTag": { "description": "Specifies the user-defined identifier, allowing to use it as a device in mount command.", "type": "string" } }, "required": [ "attachMode", "mountTag" ], "type": "object" }, "nebius.compute.v1.AttachedFilesystemSpec.AttachMode": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "READ_ONLY", "READ_WRITE" ], "type": "string" }, "nebius.compute.v1.BatchGetResponse": { "properties": { "items": { "additionalProperties": { "$ref": "#/components/schemas/nebius.compute.v1.BatchGetResponse.BatchGetResult" }, "description": "Map where key is instance id from original request array.", "type": "object" } }, "type": "object" }, "nebius.compute.v1.BatchGetResponse.BatchGetResult": { "properties": { "error": { "allOf": [ { "$ref": "#/components/schemas/google.rpc.Status" } ], "description": "Will be set if any error happened during instance info fetch (not found, permission denied)." }, "instance": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.Instance" } ], "description": "Will be set if we successfully fetched instance info." } }, "type": "object" }, "nebius.compute.v1.CreateDiskRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSpec" } }, "type": "object" }, "nebius.compute.v1.CreateDiskSnapshotRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSnapshotSpec" } }, "type": "object" }, "nebius.compute.v1.CreateFilesystemRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.FilesystemSpec" } }, "type": "object" }, "nebius.compute.v1.CreateGpuClusterRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.GpuClusterSpec" } }, "type": "object" }, "nebius.compute.v1.CreateImageRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.ImageSpec" } }, "type": "object" }, "nebius.compute.v1.CreateInstanceRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.InstanceSpec" } }, "type": "object" }, "nebius.compute.v1.CreateNVLInstanceGroupRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.NVLInstanceGroupSpec" } }, "type": "object" }, "nebius.compute.v1.Disk": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSpec" }, "status": { "$ref": "#/components/schemas/nebius.compute.v1.DiskStatus" } }, "type": "object" }, "nebius.compute.v1.DiskAttachmentStatus": { "properties": { "id": { "description": "Disk ID.\n- For ExistingDisk, this is the referenced disk ID.\n- For ManagedDisk, may be empty while the attachment intent is still pending.", "type": "string" }, "isManaged": { "description": "Indicates whether this attachment is managed by the instance lifecycle.\nIf true, the disk is expected to be deleted when the instance is deleted.\nIf false, the disk is preserved and only detached on instance deletion.", "type": "boolean" }, "name": { "description": "Disk name used to match this status entry with the desired attachment\nfrom the instance specification.\n\nConsistency:\n- For ManagedDisk, this value is derived from the instance spec (ManagedDisk.name).\n- For ExistingDisk, this value is derived from the disk resource name and may lag behind\n in case of renaming. It is updated asynchronously and is eventually consistent.", "type": "string" } }, "type": "object" }, "nebius.compute.v1.DiskEncryption": { "properties": { "type": { "$ref": "#/components/schemas/nebius.compute.v1.DiskEncryption.DiskEncryptionType" } }, "type": "object" }, "nebius.compute.v1.DiskEncryption.DiskEncryptionType": { "default": "DISK_ENCRYPTION_UNSPECIFIED", "description": " - DISK_ENCRYPTION_UNSPECIFIED: No encryption is applied unless explicitly specified.\n - DISK_ENCRYPTION_MANAGED: Enables encryption using the platform's default root key from KMS.\nAvailable for disks with NETWORK_SSD_NON_REPLICATED and NETWORK_SSD_IO_M3 types only.", "enum": [ "DISK_ENCRYPTION_UNSPECIFIED", "DISK_ENCRYPTION_MANAGED" ], "type": "string" }, "nebius.compute.v1.DiskSnapshot": { "description": "DiskSnapshot resource", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSnapshotSpec" }, "status": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSnapshotStatus" } }, "type": "object" }, "nebius.compute.v1.DiskSnapshotSpec": { "properties": { "description": { "description": "Arbitrary information about this snapshot provided by user.", "type": "string" }, "sourceDiskId": { "description": "Identifier of the source disk. May become stale if the disk is deleted.", "type": "string" } }, "required": [ "sourceDiskId" ], "type": "object" }, "nebius.compute.v1.DiskSnapshotStatus": { "properties": { "contentSizeBytes": { "description": "Logical size of the snapshot content.\nThis is the size of a disk that would be created from this snapshot.", "format": "int64", "type": "string" }, "lockState": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.DiskSnapshotStatus.LockState" } ], "description": "Indicates which resources prevent the disk snapshot from being deleted." }, "sourceCpuArchitecture": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.DiskSnapshotStatus.CPUArchitecture" } ], "description": "CPU architecture associated with the source disk.\nNot set if the architecture is unknown." }, "state": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSnapshotStatus.State" }, "storageSizeBytes": { "description": "Physical storage used by this snapshot in the snapshot backend.\nThis value is used for billing and quota and may change over time as the snapshot chain evolves\n(e.g., when earlier snapshots are deleted and data gets re-attributed).\nCurrently is equal to content_size_bytes, as incremental snapshots are not supported yet.", "format": "int64", "type": "string" } }, "type": "object" }, "nebius.compute.v1.DiskSnapshotStatus.CPUArchitecture": { "default": "UNDEFINED", "description": "Right now UNDEFINED is an alias for AMD64, but that might change in the future", "enum": [ "UNDEFINED", "AMD64", "ARM64" ], "type": "string" }, "nebius.compute.v1.DiskSnapshotStatus.LockState": { "properties": { "disks": { "description": "The snapshot is locked for deletion while disk is being created from this snapshot.\nHere is the list of these disks.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.compute.v1.DiskSnapshotStatus.State": { "default": "UNSPECIFIED", "description": "All possible states for DiskSnapshot resource", "enum": [ "UNSPECIFIED", "CREATING", "READY", "DELETING", "ERROR" ], "type": "string" }, "nebius.compute.v1.DiskSpec": { "properties": { "blockSizeBytes": { "description": "Block size in bytes.\nThe block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB).\nThe default value is 4096 bytes (4 KiB).", "format": "int64", "type": "string" }, "diskEncryption": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.DiskEncryption" } ], "description": "Defines how data on the disk is encrypted. By default, no encryption is applied." }, "forbidDeletion": { "description": "Prevents deletion whilst set", "type": "boolean" }, "sizeBytes": { "format": "int64", "type": "string" }, "sizeGibibytes": { "format": "int64", "type": "string" }, "sizeKibibytes": { "format": "int64", "type": "string" }, "sizeMebibytes": { "format": "int64", "type": "string" }, "sourceImageFamily": { "$ref": "#/components/schemas/nebius.compute.v1.SourceImageFamily" }, "sourceImageId": { "type": "string" }, "sourceSnapshotId": { "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.DiskSpec.DiskType" } ], "description": "The type of disk defines the performance and reliability characteristics of the block device.\nFor details, see https://docs.nebius.com/compute/storage/types#disks-types" } }, "required": [ "type" ], "type": "object" }, "nebius.compute.v1.DiskSpec.DiskType": { "default": "UNSPECIFIED", "description": "the list of available types will be clarified later, it is not final version", "enum": [ "UNSPECIFIED", "NETWORK_SSD", "NETWORK_HDD", "NETWORK_SSD_NON_REPLICATED", "NETWORK_SSD_IO_M3" ], "type": "string" }, "nebius.compute.v1.DiskStatus": { "properties": { "blockSizeBytes": { "format": "int64", "type": "string" }, "lockState": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.DiskStatus.LockState" } ], "description": "Indicates resources that prevent the disk from being attached as read-write." }, "managedBy": { "description": "Indicates whether the disk is deleted along with an instance.\nSet only for disks declared in the instance spec.\nIf set, the value is the instance ID that manages this disk's lifecycle (the disk is deleted when that instance is deleted).\nTo change this value, update the instance specification (see AttachedDiskSpec.type).", "type": "string" }, "readOnlyAttachments": { "items": { "type": "string" }, "type": "array" }, "readWriteAttachment": { "description": "Current read-write owner (instance ID).\nMay refer to an instance in any state, including stopped\n(this semantics is preserved for backward compatibility).\nReassigned on disk detach, instance deletion, or ownership transfer.\nOwnership transfer occurs when this disk is explicitly attached to another instance\nor when a VM with this disk attached starts while the current owner is stopped.", "type": "string" }, "reconciling": { "description": "Indicates whether there is an ongoing operation", "type": "boolean" }, "sizeBytes": { "format": "int64", "type": "string" }, "sourceImageCpuArchitecture": { "$ref": "#/components/schemas/nebius.compute.v1.DiskStatus.SourceImageCPUArchitecture" }, "sourceImageId": { "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.compute.v1.DiskStatus.State" }, "stateDescription": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.DiskStatus.LockState": { "properties": { "images": { "description": "Disk is locked for deletion and for read-write operations while image is being created.\nHere is the list of these images.", "items": { "type": "string" }, "type": "array" }, "snapshots": { "description": "Disk is locked only for deletion while snapshot is being created.\nHere is the list of these snapshots.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.compute.v1.DiskStatus.SourceImageCPUArchitecture": { "default": "SOURCE_IMAGE_CPU_UNSPECIFIED", "enum": [ "SOURCE_IMAGE_CPU_UNSPECIFIED", "AMD64", "ARM64" ], "type": "string" }, "nebius.compute.v1.DiskStatus.State": { "default": "UNSPECIFIED", "description": " - ERROR: Indicates that error happened during disk creation, and the disk cannot be recovered.\n - BROKEN: Indicates that an error has occurred during the disk's life cycle, and the disk is broken or unhealthy, but can still be recovered.", "enum": [ "UNSPECIFIED", "CREATING", "READY", "UPDATING", "DELETING", "ERROR", "BROKEN" ], "type": "string" }, "nebius.compute.v1.ExistingDisk": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.compute.v1.ExistingFilesystem": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.compute.v1.Filesystem": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.FilesystemSpec" }, "status": { "$ref": "#/components/schemas/nebius.compute.v1.FilesystemStatus" } }, "type": "object" }, "nebius.compute.v1.FilesystemSpec": { "properties": { "blockSizeBytes": { "description": "Block size in bytes.\nThe block size must be a power of two between 4096 bytes (4 KiB) and 131072 bytes (128 KiB).\nThe default value is 4096 bytes (4 KiB).", "format": "int64", "type": "string" }, "forbidDeletion": { "description": "Prevents deletion whilst set", "type": "boolean" }, "sizeBytes": { "format": "int64", "type": "string" }, "sizeGibibytes": { "format": "int64", "type": "string" }, "sizeKibibytes": { "format": "int64", "type": "string" }, "sizeMebibytes": { "format": "int64", "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.FilesystemSpec.FilesystemType" } ], "description": "The Shared Filesystem type determines its limits and performance characteristics.\nFor details, see https://docs.nebius.com/compute/storage/types#filesystems-types" } }, "required": [ "type" ], "type": "object" }, "nebius.compute.v1.FilesystemSpec.FilesystemType": { "default": "UNSPECIFIED", "description": "- NETWORK_SSD: the list of available types will be clarified later, it is not final version", "enum": [ "UNSPECIFIED", "NETWORK_SSD", "NETWORK_HDD", "WEKA", "VAST" ], "type": "string" }, "nebius.compute.v1.FilesystemStatus": { "properties": { "blockSizeBytes": { "format": "int64", "type": "string" }, "readOnlyAttachments": { "items": { "type": "string" }, "type": "array" }, "readWriteAttachments": { "items": { "type": "string" }, "type": "array" }, "reconciling": { "description": "Indicates whether there is an ongoing operation", "type": "boolean" }, "sizeBytes": { "format": "int64", "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.compute.v1.FilesystemStatus.State" }, "stateDescription": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.FilesystemStatus.State": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "CREATING", "READY", "UPDATING", "DELETING", "ERROR" ], "type": "string" }, "nebius.compute.v1.FollowsSpotPriceSpec": { "type": "object" }, "nebius.compute.v1.GpuCluster": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.GpuClusterSpec" }, "status": { "$ref": "#/components/schemas/nebius.compute.v1.GpuClusterStatus" } }, "type": "object" }, "nebius.compute.v1.GpuClusterSpec": { "properties": { "infinibandFabric": { "description": "The identifier of the physical InfiniBand fabric to connect GPU instances to.\nFor details, see https://docs.nebius.com/compute/clusters/gpu#fabrics", "type": "string" } }, "required": [ "infinibandFabric" ], "type": "object" }, "nebius.compute.v1.GpuClusterStatus": { "properties": { "infinibandTopologyPath": { "$ref": "#/components/schemas/nebius.compute.v1.GpuClusterStatusInfinibandTopologyPath" }, "instances": { "description": "IDs of Compute instances that belong to this GPU cluster.", "items": { "type": "string" }, "type": "array" }, "reconciling": { "description": "Indicates whether there is an ongoing operation", "type": "boolean" } }, "type": "object" }, "nebius.compute.v1.GpuClusterStatusInfinibandTopologyPath": { "properties": { "instances": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.GpuClusterStatusInfinibandTopologyPathInstance" }, "type": "array" } }, "type": "object" }, "nebius.compute.v1.GpuClusterStatusInfinibandTopologyPathInstance": { "properties": { "instanceId": { "type": "string" }, "path": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.compute.v1.IPAddress": { "description": "Describes an IPv4 address.", "properties": { "allocationId": { "description": "Allocation identifier if it was created before.", "type": "string" } }, "type": "object" }, "nebius.compute.v1.IPAddressStatus": { "properties": { "address": { "description": "Effective private IPv4 address assigned to the interface.", "type": "string" }, "allocationId": { "description": "Allocation identifier.", "type": "string" } }, "type": "object" }, "nebius.compute.v1.IPAlias": { "properties": { "allocationId": { "description": "ID of allocation", "type": "string" } }, "required": [ "allocationId" ], "type": "object" }, "nebius.compute.v1.IPAliasesStatus": { "properties": { "cidrs": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.compute.v1.Image": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.ImageSpec" }, "status": { "$ref": "#/components/schemas/nebius.compute.v1.ImageStatus" } }, "type": "object" }, "nebius.compute.v1.ImageSpec": { "properties": { "cpuArchitecture": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.ImageSpec.CPUArchitecture" } ], "description": "CPU architecture supported by the image" }, "description": { "type": "string" }, "imageFamily": { "type": "string" }, "imageFamilyHumanReadable": { "description": "human readable name for image family", "type": "string" }, "recommendedPlatforms": { "description": "list of platforms where this image is recommended to use", "items": { "type": "string" }, "type": "array" }, "sourceDiskId": { "description": "ID of the disk to create the image from", "type": "string" }, "sourceDiskSnapshotId": { "description": "Identifier of the disk snapshot to create the image from.", "type": "string" }, "sourceStorage": { "$ref": "#/components/schemas/nebius.compute.v1.ImageSpec.SourceStorage" }, "unsupportedPlatforms": { "additionalProperties": { "type": "string" }, "description": "list of platforms where this image is not supported with explanation", "type": "object" }, "unsupportedPresets": { "description": "Platform presets that cannot use this image. Each item includes the reason.", "items": { "$ref": "#/components/schemas/nebius.compute.v1.ImageSpec.UnsupportedPreset" }, "type": "array" }, "version": { "description": "part of identifier into the image family", "type": "string" } }, "type": "object" }, "nebius.compute.v1.ImageSpec.CPUArchitecture": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "AMD64", "ARM64" ], "type": "string" }, "nebius.compute.v1.ImageSpec.SourceStorage": { "properties": { "bucketName": { "type": "string" }, "objectName": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ImageSpec.UnsupportedPreset": { "properties": { "platform": { "type": "string" }, "preset": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ImageStatus": { "properties": { "imageFamilyDeprecation": { "$ref": "#/components/schemas/nebius.compute.v1.ImageStatus.ImageFamilyDeprecationStatus" }, "minDiskSizeBytes": { "format": "int64", "type": "string" }, "reconciling": { "description": "Indicates whether there is an ongoing operation", "type": "boolean" }, "state": { "$ref": "#/components/schemas/nebius.compute.v1.ImageStatus.State" }, "stateDescription": { "type": "string" }, "storageSizeBytes": { "format": "int64", "type": "string" } }, "type": "object" }, "nebius.compute.v1.ImageStatus.ImageFamilyDeprecationStatus": { "description": "Impossible create a disk using image family after the deprecation time, but still possible to create disk using image id.", "properties": { "deprecatedAt": { "format": "date-time", "type": "string" }, "message": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ImageStatus.State": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "CREATING", "READY", "UPDATING", "DELETING", "ERROR" ], "type": "string" }, "nebius.compute.v1.Instance": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.InstanceSpec" }, "status": { "$ref": "#/components/schemas/nebius.compute.v1.InstanceStatus" } }, "type": "object" }, "nebius.compute.v1.InstanceGpuClusterSpec": { "properties": { "id": { "description": "If you want to interconnect several instances in a GPU cluster via NVIDIA InfiniBand,\nset the ID of an existing GPU cluster.\nYou can only add the VM to the cluster when creating the VM.\nFor details, see https://docs.nebius.com/compute/clusters/gpu", "type": "string" } }, "type": "object" }, "nebius.compute.v1.InstanceRecoveryPolicy": { "default": "RECOVER", "enum": [ "RECOVER", "FAIL", "ALWAYS" ], "type": "string" }, "nebius.compute.v1.InstanceSpec": { "properties": { "bootDisk": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.AttachedDiskSpec" } ], "description": "Specified boot disk attached to the instance." }, "cloudInitUserData": { "description": "Data in cloud-init format for customizing instance initialization.\nFor details, see https://docs.nebius.com/compute/virtual-machines/manage#user-data", "type": "string" }, "filesystems": { "description": "List of Shared Filesystems attached to the instance.", "items": { "$ref": "#/components/schemas/nebius.compute.v1.AttachedFilesystemSpec" }, "type": "array" }, "followsSpotPrice": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.FollowsSpotPriceSpec" } ], "description": "The preemptible VM accepts the current spot price." }, "gpuCluster": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.InstanceGpuClusterSpec" } ], "description": "If you want to interconnect several instances in a GPU cluster via NVIDIA InfiniBand,\nset the ID of an existing GPU cluster.\nYou can only add the VM to the cluster when creating the VM.\nFor details, see https://docs.nebius.com/compute/clusters/gpu" }, "hostname": { "description": "Instance's hostname. Used to generate default DNS record in format `\u003chostname\u003e.\u003cnetwork_id\u003e.compute.internal.`\nor `\u003cinstance_id\u003e.\u003cnetwork_id\u003e.compute.internal.` if hostname is not specified.", "type": "string" }, "localDisks": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.LocalDisksSpec" } ], "description": "Local disks are meaningfully different from regular (remote) disks:\nthey are provided by the underlying host and are tied to a particular VM run.\nLocal disk data is not preserved across Stop-Start initiated via Compute API.\nLocal disks are not provided by default. To get them, explicitly request them via this field.\nAvailability depends on the selected platform, preset and region.\nChanging this field will result in disks change and content loss, but only after stop and start the instance." }, "networkInterfaces": { "description": "List of network interfaces attached to the instance.", "items": { "$ref": "#/components/schemas/nebius.compute.v1.NetworkInterfaceSpec" }, "type": "array" }, "nvlInstanceGroupId": { "description": "NVLink Instance Group ID associated with the VM", "type": "string" }, "onDemand": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.OnDemandSpec" } ], "description": "A regular, non-preemptible VM." }, "preemptible": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.PreemptibleSpec" } ], "description": "Set this field to create a preemptible VM, or omit it to create a regular VM.\nFor details, see https://docs.nebius.com/compute/virtual-machines/preemptible\nA preemptible VM cannot be converted to a regular VM or vice versa. Once set, this field cannot be removed; if the\nVM was created without it, the field cannot be added later." }, "recoveryPolicy": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.InstanceRecoveryPolicy" } ], "description": "Recovery policy defines how the instance will be treated in case of a failure.\nCommon source of failure is a host failure, but it can be any other failure.\nInstance undergoing a guest shutdown (poweroff, etc.) will be subject to recovery policy, meaning that it could\nbe restarted and billed accordingly. Stop instance via API or UI to stop it to avoid recovering.\n- If set to RECOVER, instance will be restarted, if possible. It could be restarted on the same host or on another host.\n- If set to FAIL, instance will be stopped and not restarted.\n- If set to ALWAYS, keep retrying recovery indefinitely until the instance is recovered. Available only for instances in\n nvlinstancegroup" }, "reservationPolicy": { "$ref": "#/components/schemas/nebius.compute.v1.ReservationPolicy" }, "resources": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.ResourcesSpec" } ], "description": "Specification of compute resources allocated to the instance.\nFor details, see https://docs.nebius.com/compute/virtual-machines/types" }, "secondaryDisks": { "description": "List of additional data disks attached to the instance beyond the boot disk.", "items": { "$ref": "#/components/schemas/nebius.compute.v1.AttachedDiskSpec" }, "type": "array" }, "serviceAccountId": { "description": "Unique identifier of the service account associated with this instance.\nFor details, see https://docs.nebius.com/iam/service-accounts/manage", "type": "string" }, "spotPricingPolicy": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.SpotPricingPolicySpec" } ], "description": "The preemptible VM accepts the current spot price unless it exceeds the maximum price specified by the selected\npricing policy. When the spot price exceeds that maximum price, the VM is preempted." }, "stopped": { "description": "Indicates whether the instance should be stopped.", "type": "boolean" } }, "required": [ "resources", "bootDisk" ], "type": "object" }, "nebius.compute.v1.InstanceStatus": { "properties": { "diskAttachments": { "description": "Status of the requested disk attachments.", "items": { "$ref": "#/components/schemas/nebius.compute.v1.DiskAttachmentStatus" }, "type": "array" }, "infinibandTopologyPath": { "$ref": "#/components/schemas/nebius.compute.v1.InstanceStatusInfinibandTopologyPath" }, "maintenanceEventId": { "description": "Identifier of the maintenance event associated with the instance, if any.", "type": "string" }, "networkInterfaces": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.NetworkInterfaceStatus" }, "type": "array" }, "reconciling": { "description": "Indicates whether there is an ongoing operation", "type": "boolean" }, "reservationId": { "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.compute.v1.InstanceStatus.InstanceState" } }, "type": "object" }, "nebius.compute.v1.InstanceStatus.InstanceState": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "CREATING", "UPDATING", "STARTING", "RUNNING", "STOPPING", "STOPPED", "DELETING", "ERROR" ], "type": "string" }, "nebius.compute.v1.InstanceStatusInfinibandTopologyPath": { "properties": { "path": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.compute.v1.ListDiskSnapshotsByDiskResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSnapshot" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ListDiskSnapshotsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSnapshot" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ListDisksResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.Disk" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ListFilesystemsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.Filesystem" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ListGpuClustersResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.GpuCluster" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ListImagesResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.Image" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ListInstancesResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.Instance" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ListMaintenanceEventsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.MaintenanceEvent" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ListNVLInstanceGroupsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.NVLInstanceGroup" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.ListPlatformsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.Platform" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.LocalDisksSpec": { "properties": { "passthroughGroup": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.PassthroughGroupRequest" } ], "description": "Requests passthrough local disks from the host.\nTopology of the provided disks is preserved during stop and start\nfor every instance of a specific platform and preset in the region." } }, "type": "object" }, "nebius.compute.v1.MaintenanceEvent": { "properties": { "id": { "type": "string" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.MaintenanceEventSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.MaintenanceEventStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.compute.v1.MaintenanceEventSpec": { "properties": { "isPlanned": { "description": "If the maintenance event is planned or not", "type": "boolean" } }, "type": "object" }, "nebius.compute.v1.MaintenanceEventStatus": { "properties": { "createdAt": { "description": "Time when the maintenance event is created", "format": "date-time", "type": "string" }, "finishedAt": { "description": "Time when the maintenance event is finished", "format": "date-time", "type": "string" }, "maintenanceId": { "description": "ID of the maintenance event.", "type": "string" }, "maintenanceReason": { "description": "Reason of the maintenance", "type": "string" }, "slaDeadlineTs": { "description": "Time when the instance will be force stopped", "format": "date-time", "type": "string" }, "supportCenterTicketId": { "description": "Ticket key, can be transformed into url where support is talking with the client", "type": "string" } }, "type": "object" }, "nebius.compute.v1.ManagedDisk": { "properties": { "labels": { "additionalProperties": { "type": "string" }, "description": "Labels associated with disk resource.", "type": "object" }, "name": { "description": "Name of a dependent disk.\nUse it to convert an ExistingDisk to a dependent disk.\nChanging the name will replace the disk and cause data loss.", "type": "string" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.DiskSpec" } ], "description": "Specification of a dependent disk to be created." } }, "required": [ "name", "spec" ], "type": "object" }, "nebius.compute.v1.NVLInstanceGroup": { "description": "Represents an NVLink InstanceGroup.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.NVLInstanceGroupSpec" }, "status": { "$ref": "#/components/schemas/nebius.compute.v1.NVLInstanceGroupStatus" } }, "type": "object" }, "nebius.compute.v1.NVLInstanceGroupSpec": { "properties": { "size": { "description": "Maximum number of instances in the NVLink InstanceGroup", "format": "int64", "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.NVLInstanceGroupSpec.NVLInstanceGroupType" } ], "description": "Type of the NVLink InstanceGroup (corresponds to the Compute platform)" } }, "required": [ "size" ], "type": "object" }, "nebius.compute.v1.NVLInstanceGroupSpec.NVLInstanceGroupType": { "default": "UNSPECIFIED", "description": "Type of the NVLink InstanceGroup.", "enum": [ "UNSPECIFIED", "GB200", "GB300" ], "type": "string" }, "nebius.compute.v1.NVLInstanceGroupStatus": { "properties": { "instances": { "additionalProperties": { "$ref": "#/components/schemas/nebius.compute.v1.NVLInstanceGroupStatus.InstanceInfo" }, "description": "Instances that are associated with this NVLink InstanceGroup", "type": "object" }, "reconciling": { "description": "Indicates whether there is an ongoing operation with any VM in the InstanceGroup", "type": "boolean" } }, "type": "object" }, "nebius.compute.v1.NVLInstanceGroupStatus.InstanceInfo": { "properties": { "instanceState": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.InstanceStatus.InstanceState" } ], "description": "Current state of the instance." } }, "type": "object" }, "nebius.compute.v1.NetworkInterfaceSpec": { "description": "Describes the specification of a network interface.", "properties": { "aliases": { "description": "Assign ranges of IP addresses as aliases", "items": { "$ref": "#/components/schemas/nebius.compute.v1.IPAlias" }, "type": "array" }, "ipAddress": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.IPAddress" } ], "description": "Private IPv4 address associated with the interface." }, "name": { "description": "Interface name\nValue of this field configures the name of the network interface inside VM's OS.\nLonger values will persist in the specification but will be truncated to 15 symbols before being passed to VM configuration.", "type": "string" }, "publicIpAddress": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.PublicIPAddress" } ], "description": "Public IPv4 address associated with the interface." }, "securityGroups": { "description": "Security groups associated with the network interface.\nIf an empty list is provided, the default security group for the network will be used.\nEffective security groups can be seen in the status.", "items": { "$ref": "#/components/schemas/nebius.compute.v1.SecurityGroup" }, "type": "array" }, "subnetId": { "description": "Subnet ID", "type": "string" } }, "required": [ "subnetId", "name", "ipAddress" ], "type": "object" }, "nebius.compute.v1.NetworkInterfaceStatus": { "description": "Describes the status of a network interface.", "properties": { "aliases": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.IPAliasesStatus" } ], "description": "Effective IP Aliases" }, "fqdn": { "description": "FQDN of the interface", "type": "string" }, "index": { "description": "The index of the network interface", "format": "int32", "type": "integer" }, "ipAddress": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.IPAddressStatus" } ], "description": "Effective Private IPv4 address" }, "macAddress": { "description": "MAC address", "type": "string" }, "name": { "description": "Name for interface.\nUnique within instance's network interfaces", "type": "string" }, "publicIpAddress": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.PublicIPAddressStatus" } ], "description": "Effective Public IPv4 address" }, "securityGroups": { "description": "Effective security groups associated with the network interface.", "items": { "$ref": "#/components/schemas/nebius.compute.v1.SecurityGroupStatus" }, "type": "array" } }, "type": "object" }, "nebius.compute.v1.NodeSetUnhealthyRequest": { "properties": { "dryRun": { "description": "If set to true, the call performs the authorization and limit checks, but does not mark node unhealthy.\nFalse by default", "type": "boolean" }, "healthCheckInfo": { "$ref": "#/components/schemas/nebius.compute.v1.NodeSetUnhealthyRequest.HealthCheckInfo" }, "instanceId": { "type": "string" } }, "required": [ "instanceId", "healthCheckInfo" ], "type": "object" }, "nebius.compute.v1.NodeSetUnhealthyRequest.HealthCheckInfo": { "properties": { "checkId": { "description": "Identifies specific GPU check that failed in soperator (key for observability)", "type": "string" }, "description": { "description": "Human-readable description of the error for further investigation", "type": "string" }, "observedAt": { "description": "Time when the unhealthy node was observed", "format": "date-time", "type": "string" } }, "required": [ "observedAt", "checkId", "description" ], "type": "object" }, "nebius.compute.v1.NodeSetUnhealthyResponse": { "type": "object" }, "nebius.compute.v1.OnDemandSpec": { "type": "object" }, "nebius.compute.v1.PassthroughGroupRequest": { "properties": { "requested": { "description": "Passthrough local disks from the underlying host.\n\nDevices are expected to appear in the guest as NVMe devices (nvme0, nvme1, ...),\nbut the exact number depends on the preset.\nEnabled only when this field is explicitly set.", "type": "boolean" } }, "type": "object" }, "nebius.compute.v1.Platform": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.PlatformSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.PlatformStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.compute.v1.PlatformSpec": { "properties": { "allowPresetChange": { "type": "boolean" }, "gpuCountQuotaType": { "type": "string" }, "gpuMemoryGibibytes": { "format": "int32", "type": "integer" }, "gpuMemoryGigabytes": { "format": "int32", "type": "integer" }, "humanReadableName": { "type": "string" }, "presets": { "items": { "$ref": "#/components/schemas/nebius.compute.v1.Preset" }, "type": "array" }, "shortHumanReadableName": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.PlatformStatus": { "properties": { "allowedForPreemptibles": { "type": "boolean" } }, "type": "object" }, "nebius.compute.v1.PreemptibleSpec": { "properties": { "onPreemption": { "allOf": [ { "$ref": "#/components/schemas/nebius.compute.v1.PreemptibleSpec.PreemptionPolicy" } ], "description": "Specifies what happens when the VM is preempted. The only supported value is STOP:\nCompute stops the VM without deleting or restarting it." }, "priority": { "format": "int32", "type": "integer" } }, "required": [ "onPreemption" ], "type": "object" }, "nebius.compute.v1.PreemptibleSpec.PreemptionPolicy": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "STOP" ], "type": "string" }, "nebius.compute.v1.Preset": { "properties": { "allowGpuClustering": { "type": "boolean" }, "name": { "type": "string" }, "resources": { "$ref": "#/components/schemas/nebius.compute.v1.PresetResources" } }, "type": "object" }, "nebius.compute.v1.PresetResources": { "properties": { "gpuCount": { "format": "int32", "type": "integer" }, "gpuMemoryGibibytes": { "format": "int32", "type": "integer" }, "memoryGibibytes": { "format": "int32", "type": "integer" }, "vcpuCount": { "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "nebius.compute.v1.PublicIPAddress": { "description": "Describes a public IP address.", "properties": { "allocationId": { "description": "Allocation identifier if it was created before.", "type": "string" }, "static": { "description": "If false - Allocation will be created/deleted during NetworkInterface.Allocate/NetworkInterface.Deallocate\nIf true - Allocation will be created/deleted during NetworkInterface.Create/NetworkInterface.Delete\nFalse by default", "type": "boolean" } }, "type": "object" }, "nebius.compute.v1.PublicIPAddressStatus": { "properties": { "address": { "description": "Effective public IPv4 address assigned to the interface.", "type": "string" }, "allocationId": { "description": "Allocation identifier.", "type": "string" }, "static": { "description": "If false - Allocation will be created/deleted during NetworkInterface.Allocate/NetworkInterface.Deallocate\nIf true - Allocation will be created/deleted during NetworkInterface.Create/NetworkInterface.Delete\nFalse by default", "type": "boolean" } }, "type": "object" }, "nebius.compute.v1.ReservationPolicy": { "properties": { "policy": { "$ref": "#/components/schemas/nebius.compute.v1.ReservationPolicy.Policy" }, "reservationIds": { "description": "Capacity block groups, order matters", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.compute.v1.ReservationPolicy.Policy": { "default": "AUTO", "description": " - AUTO: 1) Will try to launch instance in any reservation_ids if provided.\n2) Will try to launch instance in any of the available capacity block.\n3) Will try to launch instance in PAYG if 1 \u0026 2 are not satisfied.\n - FORBID: The instance is launched only using on-demand (PAYG) capacity.\nNo attempt is made to find or use a Capacity Block.\nIt's an error to provide reservation_ids with policy = FORBID\n - STRICT: 1) Will try to launch the instance in Capacity Blocks from reservation_ids if provided.\n2) If reservation_ids are not provided will try to launch instance in suitable \u0026 available Capacity Block.\n3) Fail otherwise.", "enum": [ "AUTO", "FORBID", "STRICT" ], "type": "string" }, "nebius.compute.v1.ResourcesSpec": { "properties": { "platform": { "type": "string" }, "preset": { "type": "string" } }, "required": [ "platform" ], "type": "object" }, "nebius.compute.v1.SecurityGroup": { "properties": { "id": { "description": "Security group identifier", "type": "string" } }, "type": "object" }, "nebius.compute.v1.SecurityGroupStatus": { "properties": { "id": { "description": "Security group identifier", "type": "string" } }, "type": "object" }, "nebius.compute.v1.SourceImageFamily": { "properties": { "imageFamily": { "type": "string" }, "parentId": { "type": "string" } }, "required": [ "imageFamily" ], "type": "object" }, "nebius.compute.v1.SpotPricingPolicySpec": { "properties": { "id": { "description": "PricingPolicy ID used as the maximum agreed price for the preemptible VM.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.compute.v1.StartInstanceRequest": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.StopInstanceRequest": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.compute.v1.UpdateDiskRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSpec" } }, "type": "object" }, "nebius.compute.v1.UpdateDiskSnapshotRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSnapshotSpec" } }, "type": "object" }, "nebius.compute.v1.UpdateFilesystemRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.FilesystemSpec" } }, "type": "object" }, "nebius.compute.v1.UpdateGpuClusterRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.GpuClusterSpec" } }, "type": "object" }, "nebius.compute.v1.UpdateImageRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.ImageSpec" } }, "type": "object" }, "nebius.compute.v1.UpdateInstanceRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.InstanceSpec" } }, "type": "object" }, "nebius.compute.v1.UpdateNVLInstanceGroupRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.compute.v1.NVLInstanceGroupSpec" } }, "type": "object" }, "nebius.dns.v1.CreateRecordRequest": { "description": "Request to create a DNS record", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the DNS record to create\nThe only required field is `metadata.parent_id`, which must be set to the ID of this record's parent DNS zone" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.dns.v1.RecordSpec" } ], "description": "Specification for the DNS record to create" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.dns.v1.CreateZoneRequest": { "description": "Request to create a DNS zone", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the DNS zone to create\nThe only required field is `metadata.parent_id`, which must be set to the ID of this zone's parent IAM container" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.dns.v1.ZoneSpec" } ], "description": "Specification for the DNS zone to create" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.dns.v1.ListRecordsResponse": { "description": "Response with a single page of DNS record listing results", "properties": { "items": { "description": "This page's items", "items": { "$ref": "#/components/schemas/nebius.dns.v1.Record" }, "type": "array" }, "nextPageToken": { "description": "An opaque listing continuation token that can be used to return the next page of listing results\nIf `next_page_token` is empty, this is the last result page", "type": "string" } }, "type": "object" }, "nebius.dns.v1.ListZonesResponse": { "description": "Response with a single page of DNS zone listing results", "properties": { "items": { "description": "This page's items", "items": { "$ref": "#/components/schemas/nebius.dns.v1.Zone" }, "type": "array" }, "nextPageToken": { "description": "An opaque listing continuation token that can be used to return the next page of listing results\nIf `next_page_token` is empty, this is the last result page", "type": "string" } }, "type": "object" }, "nebius.dns.v1.Record": { "description": "API Resource: DNS *Resource Record* (RR), an information entry about a specific domain.\nEach record is contained within a DNS zone, which is a container for DNS data of a specific domain, and, possibly, its subdomains\nDNS zones are represented in this API by the `Zone` API Resource which is managed by the `ZoneService`", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "DNS record metadata\n`metadata.parent_id` must be a DNS zone ID" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.dns.v1.RecordSpec" } ], "description": "DNS record specification, including its relative name, type, data and TTL" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.dns.v1.RecordStatus" } ], "description": "DNS record status, including e.g. its effective FQDN (fully-qualified domain name)" } }, "type": "object" }, "nebius.dns.v1.RecordSpec": { "description": "DNS record specification", "properties": { "data": { "description": "Record data in text format.\nThis should be the RDATA part of this Resource Record's\n[presentation (zonefile) format](https://datatracker.ietf.org/doc/html/rfc9499#name-resource-records).\nE.g., `10 xyz.tuv` for a `@ 600 IN MX 10 xyz.tuv.` resource record in a zonefile", "type": "string" }, "deletionProtection": { "description": "Mark this record as delete-protected\nDelete-protected records can *only* be deleted by explicitly calling `RecordService/Delete` API with `force` flag set to `true`", "type": "boolean" }, "relativeName": { "description": "Zone-relative name of this record (e.g., `www` for `www.\u003cparent zone's domain name\u003e`)\nUse `@` for records in zone apex (that is, records that have the same domain name as the zone itself)\nTo see the resolved absolute domain name, see `Record.status.effective_fqdn`", "type": "string" }, "ttl": { "description": "Record TTL. If absent or negative, will be assumed to be the default value (`600`)", "format": "int64", "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.dns.v1.RecordSpec.RecordType" } ], "description": "Record type" } }, "required": [ "relativeName", "type", "data" ], "type": "object" }, "nebius.dns.v1.RecordSpec.RecordType": { "default": "RECORD_TYPE_UNSPECIFIED", "description": "DNS Record type.\n- RECORD_TYPE_UNSPECIFIED: Record type is not specified\n - A: `A` record: IPv4 address\n - AAAA: `AAAA` record: IPv6 address\n - PTR: `PTR` record: mapping from IP address to a domain name\n - CNAME: `CNAME` record: an alias for a *canonical domain name*\n - MX: `MX` record: mail server information (domain name, priority)\n - TXT: `TXT` record: text data, typically used to verify e-mail addresses, websites and TLS certificates\n - SRV: `SRV` record: information about a network service (domain name, port, weight)\n - NS: `NS` record: domain name of an authoritative nameserver for this DNS zone, or one of its subzones\n - SOA: `SOA` record: administrative information about this DNS zone\n - CAA: `CAA` record: certificate issuance settings for this DNS zone and its subzones\n - SVCB: `SVCB` record: service binding. See [RFC 9460, section 2.3](https://www.rfc-editor.org/rfc/rfc9460.html#section-2.3)\n - HTTPS: `HTTPS` record: service binding with HTTPS protocol configuration.\nSee [RFC 9460, section 9.1](https://www.rfc-editor.org/rfc/rfc9460.html#section-9.1)", "enum": [ "RECORD_TYPE_UNSPECIFIED", "A", "AAAA", "PTR", "CNAME", "MX", "TXT", "SRV", "NS", "SOA", "CAA", "SVCB", "HTTPS" ], "type": "string" }, "nebius.dns.v1.RecordStatus": { "description": "DNS record status", "properties": { "effectiveFqdn": { "description": "Fully-qualified domain name of this record including `.` at the end, e.g. `www.example.com.`", "type": "string" }, "reconciling": { "description": "Indicates whether there is a running Operation for this Record", "type": "boolean" }, "zoneDomainName": { "description": "Domain name of this record's parent zone including `.` at the end, e.g. `example.com.`", "type": "string" } }, "type": "object" }, "nebius.dns.v1.SoaSpec": { "description": "Custom SOA (Start of Authority) record specification for the zone", "properties": { "negativeTtl": { "description": "Specifies TTL, in seconds, for caching `NXDOMAIN` (\"record not found\") DNS responses from this zone (*negative caching*)\nSet this TTL to a low value if you frequently delete and recreate records instead of updating them\n*Note:* Values of less than `5` will be ignored, and a default negative caching TTL will be used instead", "format": "int64", "type": "string" } }, "type": "object" }, "nebius.dns.v1.UpdateRecordRequest": { "description": "Request to update the DNS record by its ID", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the DNS record being updated\n- The only required field is `metadata.id`, which must be set to the ID of the DNS record being updated\n- You may also set the expected DNS record version (`metadata.resource_version`), which ensures that only the requested version is\n updated (and a `FAILED_PRECONDITION` error is returned on version mismatch)" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.dns.v1.RecordSpec" } ], "description": "New specification for the DNS record" } }, "type": "object" }, "nebius.dns.v1.UpdateZoneRequest": { "description": "Request to update the DNS zone by its ID", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the DNS zone being updated\n- The only required field is `metadata.id`, which must be set to the ID of the DNS zone being updated\n- You may also set the expected DNS zone version (`metadata.resource_version`), which ensures that only the requested version is\n updated (and a `FAILED_PRECONDITION` error is returned on version mismatch)" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.dns.v1.ZoneSpec" } ], "description": "New specification for the DNS zone" } }, "type": "object" }, "nebius.dns.v1.VpcZoneScope": { "description": "VPC zone scope specification", "properties": { "primaryNetworkId": { "description": "ID of the virtual network that this zone's records will be visible from\nThis value cannot be changed after creating the zone", "type": "string" } }, "required": [ "primaryNetworkId" ], "type": "object" }, "nebius.dns.v1.Zone": { "description": "API Resource: *DNS zone*, a container for DNS data.\nEach DNS zone starts at a particular domain within the hierarchical DNS namespace tree,\ne.g., `example.com.`, and is also responsible for its subdomains (e.g., `sales.example.com.`)\nunless there are explicit DNS zones defined for them.\n\nDNS zones contain *Resource Records* (RRs), which are individual information entries about the domain(s),\ne.g., a domain's IP address.\nEach Resource Record is represented in this API by the `Record` API Resource which is managed by the `RecordService`.\n\nSee the [graphical explanation of DNS zones and Resource Records on\nWikipedia](https://en.wikipedia.org/wiki/Domain_Name_System#/media/File:Domain_name_space.svg)", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "DNS zone metadata\n`metadata.parent_id` must be an IAM Container ID" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.dns.v1.ZoneSpec" } ], "description": "DNS zone specification, including its domain name and scope" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.dns.v1.ZoneStatus" } ], "description": "DNS zone status, including e.g. the number of records in the zone" } }, "type": "object" }, "nebius.dns.v1.ZoneSpec": { "description": "DNS Zone specification", "properties": { "domainName": { "description": "Fully qualified domain name of this zone, including `.` at the end\nCannot be changed after creating the zone", "type": "string" }, "soaSpec": { "allOf": [ { "$ref": "#/components/schemas/nebius.dns.v1.SoaSpec" } ], "description": "Custom SOA (Start of Authority) record specification for the zone" }, "vpc": { "allOf": [ { "$ref": "#/components/schemas/nebius.dns.v1.VpcZoneScope" } ], "description": "A VPC zone, which is only visible from a virtual network (VPC)" } }, "required": [ "domainName" ], "type": "object" }, "nebius.dns.v1.ZoneStatus": { "description": "DNS zone status", "properties": { "reconciling": { "description": "Indicates whether there is a running Operation for this Zone", "type": "boolean" }, "recordCount": { "description": "Number of records in this zone. May be 0 if not calculated (e.g., in listings)", "format": "int64", "type": "string" } }, "type": "object" }, "nebius.iam.v1.AccessKey": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.AccessKeySpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.AccessKeyStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v1.AccessKeySpec": { "properties": { "account": { "$ref": "#/components/schemas/nebius.iam.v1.Account" }, "description": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "nebius.iam.v1.AccessKeyStatus": { "properties": { "algorithm": { "type": "string" }, "awsAccessKeyId": { "type": "string" }, "fingerprint": { "type": "string" }, "keySize": { "format": "int32", "type": "integer" }, "secret": { "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.iam.v1.AccessKeyStatus.State" } }, "type": "object" }, "nebius.iam.v1.AccessKeyStatus.State": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "EXPIRED", "DELETING", "DELETED" ], "type": "string" }, "nebius.iam.v1.AccessPermit": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.AccessPermitSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.AccessPermitStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v1.AccessPermitSpec": { "properties": { "resourceId": { "description": "Resource for granting access permit.", "type": "string" }, "role": { "description": "Role for granting access permit.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.AccessPermitStatus": { "type": "object" }, "nebius.iam.v1.Account": { "properties": { "anonymousAccount": { "$ref": "#/components/schemas/nebius.iam.v1.Account.AnonymousAccount" }, "serviceAccount": { "$ref": "#/components/schemas/nebius.iam.v1.Account.ServiceAccount" }, "userAccount": { "$ref": "#/components/schemas/nebius.iam.v1.Account.UserAccount" } }, "type": "object" }, "nebius.iam.v1.Account.AnonymousAccount": { "type": "object" }, "nebius.iam.v1.Account.ServiceAccount": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.Account.UserAccount": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.ActivateAccessKeyRequest": { "properties": { "id": { "$ref": "#/components/schemas/nebius.iam.v1.KeyIdentity" } }, "type": "object" }, "nebius.iam.v1.ActivateAuthPublicKeyRequest": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.ActivateFederationRequest": { "properties": { "federationId": { "description": "Target federation ID.", "type": "string" } }, "required": [ "federationId" ], "type": "object" }, "nebius.iam.v1.AnonymousAccount": { "type": "object" }, "nebius.iam.v1.AuthPublicKey": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.AuthPublicKeySpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.AuthPublicKeyStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v1.AuthPublicKeySpec": { "properties": { "account": { "$ref": "#/components/schemas/nebius.iam.v1.Account" }, "data": { "type": "string" }, "description": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "nebius.iam.v1.AuthPublicKeyStatus": { "properties": { "algorithm": { "type": "string" }, "fingerprint": { "type": "string" }, "keySize": { "format": "int32", "type": "integer" }, "state": { "$ref": "#/components/schemas/nebius.iam.v1.AuthPublicKeyStatus.State" } }, "type": "object" }, "nebius.iam.v1.AuthPublicKeyStatus.State": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "EXPIRED", "DELETING", "DELETED" ], "type": "string" }, "nebius.iam.v1.BlockTenantUserAccountRequest": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.Container": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.ContainerSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.ContainerStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v1.ContainerSpec": { "properties": { "region": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.ContainerStatus": { "properties": { "containerState": { "$ref": "#/components/schemas/nebius.iam.v1.State" }, "region": { "type": "string" }, "suspensionState": { "$ref": "#/components/schemas/nebius.iam.v1.SuspensionState" } }, "type": "object" }, "nebius.iam.v1.CreateAccessKeyRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.AccessKeySpec" } }, "type": "object" }, "nebius.iam.v1.CreateAccessPermitRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.AccessPermitSpec" } }, "type": "object" }, "nebius.iam.v1.CreateAuthPublicKeyRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.AuthPublicKeySpec" } }, "type": "object" }, "nebius.iam.v1.CreateFederatedCredentialsRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Federated credentials resource metadata." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.FederatedCredentialsSpec" } ], "description": "Federated credentials resource specification." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.iam.v1.CreateFederationCertificateRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.FederationCertificateSpec" } }, "type": "object" }, "nebius.iam.v1.CreateFederationRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Federation resource metadata." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.FederationSpec" } ], "description": "Federation resource specification." } }, "type": "object" }, "nebius.iam.v1.CreateGroupMembershipRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "revokeAfterHours": { "format": "int64", "type": "string" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.GroupMembershipSpec" } }, "required": [ "metadata" ], "type": "object" }, "nebius.iam.v1.CreateGroupRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.GroupSpec" } }, "type": "object" }, "nebius.iam.v1.CreateInvitationRequest": { "description": "Request to create an invitation.", "properties": { "expiresIn": { "description": "Duration for which the invitation remains valid after creation.\nIf omitted, the service's default value is used.", "type": "string" }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Invitation metadata." }, "noSend": { "description": "If set, no immediate sending is attempted (it is assumed that a Resend method will be called later).\n\nif set, no sending is attempted (it's supposed that later a Resend method is called)", "type": "boolean" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.InvitationSpec" } ], "description": "Invitation specification." } }, "type": "object" }, "nebius.iam.v1.CreateProjectRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.ContainerSpec" } }, "type": "object" }, "nebius.iam.v1.CreateServiceAccountRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.ServiceAccountSpec" } }, "type": "object" }, "nebius.iam.v1.DeactivateAccessKeyRequest": { "properties": { "id": { "$ref": "#/components/schemas/nebius.iam.v1.KeyIdentity" } }, "type": "object" }, "nebius.iam.v1.DeactivateAuthPublicKeyRequest": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.DeactivateFederationRequest": { "properties": { "federationId": { "description": "Target federation ID.", "type": "string" } }, "required": [ "federationId" ], "type": "object" }, "nebius.iam.v1.Error": { "properties": { "message": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.FederatedCredentials": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Federated credentials resource metadata." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.FederatedCredentialsSpec" } ], "description": "Federated credentials resource specification." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.FederatedCredentialsStatus" } ], "description": "Federated credentials resource status.", "readOnly": true } }, "type": "object" }, "nebius.iam.v1.FederatedCredentialsSpec": { "properties": { "federatedSubjectId": { "description": "Federated subject ID. For oidc_provider, the subject is calculated from the\n\"sub\" claim of the federated JWT token.", "type": "string" }, "oidcProvider": { "$ref": "#/components/schemas/nebius.iam.v1.OidcCredentialsProvider" }, "subjectId": { "description": "IAM subject (service account) that the federated subject impersonates.", "type": "string" } }, "required": [ "subjectId" ], "type": "object" }, "nebius.iam.v1.FederatedCredentialsStatus": { "type": "object" }, "nebius.iam.v1.Federation": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Federation resource metadata." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.FederationSpec" } ], "description": "Federation resource specification." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.FederationStatus" } ], "description": "Federation resource status.", "readOnly": true } }, "type": "object" }, "nebius.iam.v1.FederationCertificate": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.FederationCertificateSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.FederationCertificateStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v1.FederationCertificateSpec": { "properties": { "data": { "type": "string" }, "description": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.FederationCertificateStatus": { "properties": { "algorithm": { "type": "string" }, "fingerprint": { "type": "string" }, "keySize": { "format": "int64", "type": "string" }, "notAfter": { "format": "date-time", "type": "string" }, "notBefore": { "format": "date-time", "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.iam.v1.FederationCertificateStatus.State" } }, "type": "object" }, "nebius.iam.v1.FederationCertificateStatus.State": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "EXPIRED" ], "type": "string" }, "nebius.iam.v1.FederationSpec": { "properties": { "active": { "description": "Specifies if the federation in active state", "type": "boolean" }, "samlSettings": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.SamlSettings" } ], "description": "SAML federation settings." }, "userAccountAutoCreation": { "description": "If false, users with access to the federation cannot sign in automatically\nand user accounts for them must be pre-created by a federation administrator.", "type": "boolean" } }, "type": "object" }, "nebius.iam.v1.FederationStatus": { "properties": { "certificatesCount": { "description": "Number of certificates attached to the SAML federation for verifying SAML responses.", "format": "int32", "type": "integer" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.FederationStatus.State" } ], "description": "Federation state." }, "usersCount": { "description": "Number of users registered in the IAM federation. This value may differ from the number of users in the identity provider.", "format": "int32", "type": "integer" } }, "type": "object" }, "nebius.iam.v1.FederationStatus.State": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "ACTIVE", "INACTIVE" ], "type": "string" }, "nebius.iam.v1.FindStaticKeyRequest": { "properties": { "token": { "description": "the method accepts a static key token with and without signature as an input", "type": "string" } }, "type": "object" }, "nebius.iam.v1.FindStaticKeyResponse": { "properties": { "staticKey": { "$ref": "#/components/schemas/nebius.iam.v1.StaticKey" } }, "type": "object" }, "nebius.iam.v1.GetAccessKeySecretOnceResponse": { "properties": { "secret": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.GetProfileResponse": { "properties": { "anonymousProfile": { "$ref": "#/components/schemas/nebius.iam.v1.AnonymousAccount" }, "serviceAccountProfile": { "$ref": "#/components/schemas/nebius.iam.v1.ServiceAccountProfile" }, "userProfile": { "$ref": "#/components/schemas/nebius.iam.v1.UserProfile" } }, "type": "object" }, "nebius.iam.v1.Group": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.GroupSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.GroupStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v1.GroupMemberKind": { "properties": { "kind": { "$ref": "#/components/schemas/nebius.iam.v1.GroupMemberKind.Kind" } }, "type": "object" }, "nebius.iam.v1.GroupMemberKind.Kind": { "default": "KIND_UNSPECIFIED", "enum": [ "KIND_UNSPECIFIED", "ORDINARY_TENANT_USER_ACCOUNT", "INVITED_TENANT_USER_ACCOUNT", "SERVICE_ACCOUNT" ], "type": "string" }, "nebius.iam.v1.GroupMembership": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "revokeAt": { "format": "date-time", "readOnly": true, "type": "string" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.GroupMembershipSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.GroupMembershipStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v1.GroupMembershipSpec": { "properties": { "memberId": { "description": "Member of the group. Can be tenant user account id or service account id.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.GroupMembershipStatus": { "properties": { "groupMemberMetadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "serviceAccountStatus": { "$ref": "#/components/schemas/nebius.iam.v1.ServiceAccountStatus" }, "tenantUserAccountStatus": { "$ref": "#/components/schemas/nebius.iam.v1.TenantUserAccountStatus" } }, "type": "object" }, "nebius.iam.v1.GroupMembershipWithAttributes": { "description": "see also nebius/iam/v1/tenant_user_account.proto/TenantUserAccountWithAttributes", "properties": { "error": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.Error" } ], "description": "in a case of issues of getting attributes from pds service, we can still return some data from cpl" }, "groupMemberKind": { "$ref": "#/components/schemas/nebius.iam.v1.GroupMemberKind" }, "groupMembership": { "$ref": "#/components/schemas/nebius.iam.v1.GroupMembership" }, "serviceAccountAttributes": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.ServiceAccountAttributes" } ], "description": "filled with known data for members corresponding to service accounts\nleft unset for any kind of tenant user accounts" }, "userAttributes": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.UserAttributes" } ], "description": "filled with known data for members corresponding to tenant user accounts and provisional tenant user accounts (invitees)\nleft unset for service accounts" } }, "type": "object" }, "nebius.iam.v1.GroupSpec": { "type": "object" }, "nebius.iam.v1.GroupStatus": { "properties": { "membersCount": { "format": "int32", "type": "integer" }, "serviceAccountsCount": { "format": "int32", "type": "integer" }, "state": { "$ref": "#/components/schemas/nebius.iam.v1.GroupStatus.State" }, "tenantUserAccountsCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "nebius.iam.v1.GroupStatus.State": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "ACTIVE" ], "type": "string" }, "nebius.iam.v1.Invitation": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.InvitationSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.InvitationStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v1.InvitationSpec": { "properties": { "description": { "type": "string" }, "email": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.InvitationStatus": { "properties": { "expiresAt": { "format": "date-time", "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.iam.v1.InvitationStatus.State" }, "tenantUserAccountId": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.InvitationStatus.State": { "default": "UNSPECIFIED", "description": "- CREATING: contacts data is not stored in pds yet. probably will GC it later\n - CREATED: notification is not sent yet\n - PENDING: notification is sent, we are waiting for the user to approve the notification\n - EXPIRED: notification is expired, accept is no longer possible\n - ACCEPTED: notification is accepted", "enum": [ "UNSPECIFIED", "CREATING", "CREATED", "PENDING", "EXPIRED", "ACCEPTED" ], "type": "string" }, "nebius.iam.v1.IssueStaticKeyRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.StaticKeySpec" } }, "type": "object" }, "nebius.iam.v1.IssueStaticKeyResponse": { "properties": { "operation": { "$ref": "#/components/schemas/nebius.common.v1.Operation" }, "token": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.KeyIdentity": { "properties": { "awsAccessKeyId": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListAccessKeysResponse": { "properties": { "items": { "description": "List of access keys returned in the response. The field should be named as `items` for consistency.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.AccessKey" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListAccessPermitResponse": { "properties": { "items": { "description": "List of access bindings returned in the response. The field should be named as `items` for consistency.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.AccessPermit" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListAuthPublicKeyResponse": { "properties": { "items": { "description": "List of auth public keys returned in the response. The field should be named as `items` for consistency.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.AuthPublicKey" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListFederatedCredentialsResponse": { "properties": { "items": { "description": "List of federated credentials returned in the response.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.FederatedCredentials" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, allowing the retrieval of the next set of results.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListFederationCertificateResponse": { "properties": { "items": { "description": "List of public keys returned in the response. The field should be named as `items` for consistency.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.FederationCertificate" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListFederationsResponse": { "properties": { "items": { "description": "List of federations returned in the response.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.Federation" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, allowing the retrieval of the next set of results.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListGroupMembershipsResponse": { "properties": { "memberships": { "description": "Members of the group. Can be tenant user account ids or service account ids.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.GroupMembership" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListGroupMembershipsWithAttributesResponse": { "properties": { "memberships": { "description": "Members of the group with their attributes if supported by member type.\nCan be tenant user accounts (regular or provisional/invited) or service accounts.\nRegular tenant user accounts may have a full set of attributes, provisional may have contacts only,\nservice accounts", "items": { "$ref": "#/components/schemas/nebius.iam.v1.GroupMembershipWithAttributes" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListGroupsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.iam.v1.Group" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListInvitationsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.iam.v1.Invitation" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListMemberOfResponse": { "properties": { "items": { "description": "Groups that requested entity is a member of", "items": { "$ref": "#/components/schemas/nebius.iam.v1.Group" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListProjectsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.iam.v1.Container" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListServiceAccountResponse": { "properties": { "items": { "description": "List of service accounts returned in the response. The field should be named as `items` for consistency.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.ServiceAccount" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListStaticKeysResponse": { "properties": { "items": { "description": "List of static keys returned in the response. The field should be named as `items` for consistency.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.StaticKey" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListTenantUserAccountsResponse": { "properties": { "items": { "description": "List of service accounts returned in the response. The field should be named as `items` for consistency.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.TenantUserAccount" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListTenantUserAccountsWithAttributesResponse": { "properties": { "items": { "description": "List of user accounts returned in the response. The field should be named as `items` for consistency.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.TenantUserAccountWithAttributes" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ListTenantsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.iam.v1.Container" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.OidcCredentialsProvider": { "description": "The OIDC provider does not have to be a full OIDC provider, but it must expose\nOIDC discovery metadata at the \"/.well-known/openid-configuration\" endpoint.\nThe discovery metadata must contain \"jwks_uri\", which points to the JSON Web\nKey Set (JWKS). The JWKS contains public keys used to verify JSON\nWeb Tokens (JWTs) issued by the identity provider.", "properties": { "issuerUrl": { "description": "OIDC-compatible JWT issuer URL.", "type": "string" }, "jwkSetJson": { "description": "JSON representation of a JSON Web Key Set (JWKS) with public keys used for\nJWT signature verification.\nIf set, the token service uses this JWKS to verify token signatures.", "type": "string" } }, "required": [ "issuerUrl" ], "type": "object" }, "nebius.iam.v1.ResendInvitationRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.iam.v1.RevokeSessionRequest": { "properties": { "allMyActive": { "description": "Revoke all active sessions and access tokens for the current user.", "type": "boolean" }, "serviceAccountId": { "description": "Revoke all tokens for a service account.", "type": "string" }, "tenantUserAccountId": { "description": "Revoke all active sessions and tokens for a tenant user.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.RevokeSessionResponse": { "type": "object" }, "nebius.iam.v1.RevokeStaticKeyRequest": { "properties": { "token": { "description": "the method accepts a static key token with and without signature as an input", "type": "string" } }, "type": "object" }, "nebius.iam.v1.SamlSettings": { "properties": { "forceAuthn": { "description": "If true, the SAML AuthnRequest asks the identity provider to authenticate the user instead of reusing an existing IdP session. (See\nSAML Core 2.0, section 3.4.1, ForceAuthn: https://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf) Limitations: the SAML\nresponse does not let verify whether the identity provider honored this request; support depends on the identity provider.", "type": "boolean" }, "idpIssuer": { "description": "The unique identifier of the SAML Identity Provider. It usually matches the entityID from the IdP metadata.", "type": "string" }, "ssoUrl": { "description": "Identity Provider’s Single Sign-On endpoint. This is the URL where the user is redirected to start SAML login.", "type": "string" } }, "type": "object" }, "nebius.iam.v1.ServiceAccount": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.ServiceAccountSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.ServiceAccountStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v1.ServiceAccountAttributes": { "description": "see also nebius/iam/v1/tenant_user_account.proto/UserAttributes", "properties": { "description": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.ServiceAccountProfile": { "properties": { "info": { "$ref": "#/components/schemas/nebius.iam.v1.ServiceAccount" } }, "type": "object" }, "nebius.iam.v1.ServiceAccountSpec": { "properties": { "description": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.ServiceAccountStatus": { "properties": { "active": { "type": "boolean" } }, "type": "object" }, "nebius.iam.v1.State": { "default": "STATE_UNSPECIFIED", "description": "- CREATING: DRAFT = 1000;", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "SCHEDULING_FOR_DELETION", "SCHEDULED_FOR_DELETION", "SCHEDULING_FOR_DELETION_BY_PARENT", "SCHEDULED_FOR_DELETION_BY_PARENT", "UNDELETING", "PURGING", "PURGED", "CREATED", "ACTIVATING", "PARKING", "PARKED", "CREATING" ], "type": "string" }, "nebius.iam.v1.StaticKey": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.StaticKeySpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.StaticKeyStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v1.StaticKeySpec": { "properties": { "account": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.Account" } ], "description": "account of the static key. only service accounts are supported for now" }, "expiresAt": { "description": "when will the static key expire", "format": "date-time", "type": "string" }, "service": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.StaticKeySpec.ClientService" } ], "description": "service static key is to be used for" } }, "required": [ "service" ], "type": "object" }, "nebius.iam.v1.StaticKeySpec.ClientService": { "default": "CLIENT_SERVICE_UNSPECIFIED", "enum": [ "CLIENT_SERVICE_UNSPECIFIED", "OBSERVABILITY", "CONTAINER_REGISTRY", "AI_STUDIO", "TRACTO", "LINUX_IDENTITY" ], "type": "string" }, "nebius.iam.v1.StaticKeyStatus": { "properties": { "active": { "type": "boolean" } }, "type": "object" }, "nebius.iam.v1.SuspensionState": { "default": "SUSPENSION_STATE_UNSPECIFIED", "enum": [ "SUSPENSION_STATE_UNSPECIFIED", "NONE", "SUSPENDING", "SUSPENDED", "RESUMING" ], "type": "string" }, "nebius.iam.v1.TenantUserAccount": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.TenantUserAccountSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.TenantUserAccountStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v1.TenantUserAccountSpec": { "properties": { "visibleAttributes": { "$ref": "#/components/schemas/nebius.iam.v1.TenantUserAccountSpec.VisibleAttributes" } }, "type": "object" }, "nebius.iam.v1.TenantUserAccountSpec.VisibleAttributes": { "description": "when a global user account is projected to a specific tenant\nthey can give consent for that tenant's owner to view specific personal data\nby listing explicitly visible PDS attributes\ncomplete list of PDS attributes is described in ../../pds/inner/v1alpha1/iam_identifier.proto", "properties": { "attribute": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.iam.v1.TenantUserAccountStatus": { "properties": { "federationId": { "description": "the federation id of the linked user account. Could be empty in a case of a tenant user account belongs to an invitation which wasn't\naccepted.", "type": "string" }, "invitationId": { "description": "if a tenant user account is created during invitation it gets a reference to the invitation resource\nonce invitation is accepted it looses this reference (and internally gets a reference to their global federated user account)", "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.iam.v1.TenantUserAccountStatus.State" }, "userAccountState": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.UserAccountStatus.State" } ], "description": "user account state can help distinguish case when account is blocked globally" } }, "type": "object" }, "nebius.iam.v1.TenantUserAccountStatus.State": { "default": "STATE_UNSPECIFIED", "description": "- ACTIVE: - in case of ordinary tenant user account a corresponding user can log into the system and use granted tenant resources\n- in case of invited tenant user account once the invitation is accepted a corresponding user can start using granted resources\n immediately\n - INACTIVE: unused\n - BLOCKED: - in case of ordinary tenant user account a corresponding user can log into the system but cannot be authorized to use tenant\n resources\n- in case of invited tenant user account once the invitation is accepted a corresponding user cannot start using granted resources\n until is unblocked", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "BLOCKED" ], "type": "string" }, "nebius.iam.v1.TenantUserAccountWithAttributes": { "properties": { "attributes": { "$ref": "#/components/schemas/nebius.iam.v1.UserAttributes" }, "error": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.Error" } ], "description": "in a case of issues of getting attributes from pds service, we can still return some data from cpl" }, "tenantUserAccount": { "$ref": "#/components/schemas/nebius.iam.v1.TenantUserAccount" } }, "type": "object" }, "nebius.iam.v1.UnblockTenantUserAccountRequest": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.UpdateAccessKeyRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.AccessKeySpec" } }, "type": "object" }, "nebius.iam.v1.UpdateAuthPublicKeyRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.AuthPublicKeySpec" } }, "type": "object" }, "nebius.iam.v1.UpdateBulkFederationCertificateRequest": { "properties": { "federationId": { "description": "Represents the parent federation ID. All certificates in update should have identical parent id.", "type": "string" }, "updates": { "description": "If target certificate contains id - the existing one will be updates, otherwise the new one will be created.", "items": { "$ref": "#/components/schemas/nebius.iam.v1.UpdateFederationCertificateRequest" }, "type": "array" } }, "type": "object" }, "nebius.iam.v1.UpdateFederatedCredentialsRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Federated credentials resource metadata." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.FederatedCredentialsSpec" } ], "description": "Federated credentials resource specification." } }, "type": "object" }, "nebius.iam.v1.UpdateFederationCertificateRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.FederationCertificateSpec" } }, "type": "object" }, "nebius.iam.v1.UpdateFederationRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Federation resource metadata." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v1.FederationSpec" } ], "description": "Federation resource specification." }, "status": { "$ref": "#/components/schemas/nebius.iam.v1.FederationStatus" } }, "type": "object" }, "nebius.iam.v1.UpdateGroupRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.GroupSpec" } }, "type": "object" }, "nebius.iam.v1.UpdateInvitationRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.InvitationSpec" } }, "type": "object" }, "nebius.iam.v1.UpdateProjectRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.ContainerSpec" } }, "type": "object" }, "nebius.iam.v1.UpdateServiceAccountRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v1.ServiceAccountSpec" } }, "type": "object" }, "nebius.iam.v1.UserAccountExternalId": { "properties": { "federationId": { "type": "string" }, "federationUserAccountId": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.UserAccountStatus.State": { "default": "STATE_UNSPECIFIED", "description": "- ACTIVE: usual state when federated user can log into the system and view/manage granted resources in one or more tenants\n - INACTIVE: federated user can be blocked (manually or by any specific automated process), in this state user cannot log into the system\n - DELETING: federated user can be deleted/forgot, in this state user cannot log into the system and various internal removal interactions are in\nprogress", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "DELETING" ], "type": "string" }, "nebius.iam.v1.UserAttributes": { "properties": { "email": { "type": "string" }, "emailVerified": { "type": "boolean" }, "familyName": { "type": "string" }, "givenName": { "type": "string" }, "locale": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "phoneNumberVerified": { "type": "boolean" }, "picture": { "type": "string" }, "preferredUsername": { "type": "string" }, "sub": { "type": "string" }, "zoneinfo": { "type": "string" } }, "type": "object" }, "nebius.iam.v1.UserProfile": { "properties": { "attributes": { "$ref": "#/components/schemas/nebius.iam.v1.UserAttributes" }, "federationInfo": { "$ref": "#/components/schemas/nebius.iam.v1.UserAccountExternalId" }, "id": { "type": "string" }, "retrievingError": { "$ref": "#/components/schemas/nebius.iam.v1.Error" }, "tenants": { "items": { "$ref": "#/components/schemas/nebius.iam.v1.UserTenantInfo" }, "type": "array" }, "userAccountState": { "$ref": "#/components/schemas/nebius.iam.v1.UserAccountStatus.State" } }, "type": "object" }, "nebius.iam.v1.UserTenantInfo": { "properties": { "tenantId": { "type": "string" }, "tenantUserAccountId": { "type": "string" }, "tenantUserAccountState": { "$ref": "#/components/schemas/nebius.iam.v1.TenantUserAccountStatus.State" } }, "type": "object" }, "nebius.iam.v2.AccessKey": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v2.AccessKeySpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v2.AccessKeyStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v2.AccessKeySpec": { "properties": { "account": { "$ref": "#/components/schemas/nebius.iam.v1.Account" }, "description": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "secretDeliveryMode": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v2.SecretDeliveryMode" } ], "description": "Specifies how the secret will be delivered upon creation. This field is immutable — it cannot be changed after the resource is\ncreated." } }, "type": "object" }, "nebius.iam.v2.AccessKeyStatus": { "properties": { "algorithm": { "type": "string" }, "awsAccessKeyId": { "type": "string" }, "fingerprint": { "type": "string" }, "keySize": { "format": "int32", "type": "integer" }, "secret": { "type": "string" }, "secretReferenceId": { "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.iam.v2.AccessKeyStatus.State" } }, "type": "object" }, "nebius.iam.v2.AccessKeyStatus.State": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "EXPIRED", "DELETING", "DELETED" ], "type": "string" }, "nebius.iam.v2.ActivateAccessKeyByAwsIdRequest": { "properties": { "awsAccessKeyId": { "type": "string" } }, "type": "object" }, "nebius.iam.v2.ActivateAccessKeyRequest": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.iam.v2.CreateAccessKeyRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v2.AccessKeySpec" } }, "type": "object" }, "nebius.iam.v2.CreateProjectRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v2.ProjectSpec" } }, "type": "object" }, "nebius.iam.v2.DeactivateAccessKeyByAwsIdRequest": { "properties": { "awsAccessKeyId": { "type": "string" } }, "type": "object" }, "nebius.iam.v2.DeactivateAccessKeyRequest": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.iam.v2.DeleteAccessKeyByAwsIdRequest": { "properties": { "awsAccessKeyId": { "type": "string" } }, "type": "object" }, "nebius.iam.v2.GetAccessKeySecretResponse": { "properties": { "awsAccessKeyId": { "type": "string" }, "secret": { "type": "string" } }, "type": "object" }, "nebius.iam.v2.ListAccessKeysResponse": { "properties": { "items": { "description": "List of access keys returned in the response. The field should be named as `items` for consistency.", "items": { "$ref": "#/components/schemas/nebius.iam.v2.AccessKey" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v2.ListProjectsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.iam.v2.Project" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v2.ListTenantsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.iam.v2.Tenant" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.iam.v2.Project": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v2.ProjectSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v2.ProjectStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v2.ProjectSpec": { "properties": { "region": { "description": "Name of the region where project resources will be created.\nExample: \"eu-north1\".", "type": "string" } }, "type": "object" }, "nebius.iam.v2.ProjectStatus": { "properties": { "projectState": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v2.ProjectStatus.ProjectState" } ], "description": "Current state of the project." } }, "type": "object" }, "nebius.iam.v2.ProjectStatus.ProjectState": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "PURGING", "CREATED", "ACTIVATING", "PARKING", "PARKED" ], "type": "string" }, "nebius.iam.v2.SecretDeliveryMode": { "default": "UNSPECIFIED", "description": "- UNSPECIFIED: If not specified, the default behaviour will be applied. Currently it's INLINE, later will be EXPLICIT.\n - INLINE: The secret value will be returned directly in the API response\n - MYSTERY_BOX: The secret will be delivered via a MysteryBox secret, in case of terraform it is recommended to use that enum\n - EXPLICIT: The secret value will be accessible via a separate method GetSecret", "enum": [ "UNSPECIFIED", "INLINE", "MYSTERY_BOX", "EXPLICIT" ], "type": "string" }, "nebius.iam.v2.Tenant": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v2.TenantSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.iam.v2.TenantStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.iam.v2.TenantSpec": { "type": "object" }, "nebius.iam.v2.TenantStatus": { "properties": { "tenantState": { "$ref": "#/components/schemas/nebius.iam.v2.TenantStatus.TenantState" } }, "type": "object" }, "nebius.iam.v2.TenantStatus.TenantState": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "CREATED", "ACTIVATING", "PARKING", "PARKED" ], "type": "string" }, "nebius.iam.v2.UpdateAccessKeyRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v2.AccessKeySpec" } }, "type": "object" }, "nebius.iam.v2.UpdateProjectRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v2.ProjectSpec" } }, "type": "object" }, "nebius.iam.v2.UpdateTenantRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "namePrefix": { "description": "Tenant name prefix. A few random characters will be added to this prefix.", "type": "string" }, "spec": { "$ref": "#/components/schemas/nebius.iam.v2.TenantSpec" } }, "type": "object" }, "nebius.kms.v1.AsymmetricAlgorithm": { "default": "ASYMMETRIC_ALGORITHM_UNSPECIFIED", "description": "Supported asymmetric algorithms.\n\n - ECDSA_NIST_P256_SHA_256: ECDSA signature with NIST P-256 curve and SHA-256\n - ECDSA_NIST_P384_SHA_384: ECDSA signature with NIST P-384 curve and SHA-384\n - RSA_4096_ENC_OAEP_SHA_256: RSA encryption with RSA-4096 key, OAEP padding and SHA-256.", "enum": [ "ASYMMETRIC_ALGORITHM_UNSPECIFIED", "ECDSA_NIST_P256_SHA_256", "ECDSA_NIST_P384_SHA_384", "RSA_4096_ENC_OAEP_SHA_256" ], "type": "string" }, "nebius.kms.v1.AsymmetricDecryptRequest": { "properties": { "ciphertext": { "description": "cipher text to be decrypted.", "format": "byte", "type": "string" }, "keyId": { "description": "ID of the asymmetric KMS key.", "type": "string" } }, "required": [ "keyId", "ciphertext" ], "type": "object" }, "nebius.kms.v1.AsymmetricDecryptResponse": { "properties": { "keyId": { "description": "ID of the asymmetric KMS key that was used for decryption.", "type": "string" }, "plaintext": { "description": "Decrypted plaintext.", "format": "byte", "type": "string" } }, "type": "object" }, "nebius.kms.v1.AsymmetricGetPublicKeyResponse": { "properties": { "keyId": { "description": "ID of the asymmetric KMS key whose public key was returned.", "type": "string" }, "publicKey": { "description": "Public key value.\nThe value is a PEM-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280.", "type": "string" } }, "type": "object" }, "nebius.kms.v1.AsymmetricKey": { "description": "An asymmetric KMS key that may contain several versions of the cryptographic material.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricKeySpec" } ], "description": "The specifications of the asymmetric key." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricKeyStatus" } ], "description": "The current status of the asymmetric key." } }, "type": "object" }, "nebius.kms.v1.AsymmetricKeySpec": { "properties": { "algorithm": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricAlgorithm" } ], "description": "Cryptographic algorithm that should be used with the key.\nMust be specified only during create operations. Cannot be updated." }, "description": { "description": "Description of the key.", "type": "string" } }, "required": [ "algorithm" ], "type": "object" }, "nebius.kms.v1.AsymmetricKeyStatus": { "properties": { "deletedAt": { "description": "Time when the key was scheduled for deletion.", "format": "date-time", "type": "string" }, "purgeAt": { "description": "Time when the key will be permanently deleted.", "format": "date-time", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.KeyState" } ], "description": "State (ACTIVE, SCHEDULED_FOR_DELETION)" } }, "type": "object" }, "nebius.kms.v1.AsymmetricSignHashRequest": { "properties": { "hash": { "description": "Hash to sign.", "format": "byte", "type": "string" }, "keyId": { "description": "ID of the asymmetric KMS key to use for signing the hash.", "type": "string" } }, "required": [ "keyId", "hash" ], "type": "object" }, "nebius.kms.v1.AsymmetricSignHashResponse": { "properties": { "keyId": { "description": "ID of the asymmetric KMS key used to produce the signature.", "type": "string" }, "signature": { "description": "Value of signature.", "format": "byte", "type": "string" } }, "type": "object" }, "nebius.kms.v1.CreateAsymmetricKeyRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "The metadata for the resource." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricKeySpec" } ], "description": "The specifications for creating an asymmetric key." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.kms.v1.CreateSymmetricKeyRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricKeySpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.kms.v1.GenerateDataKeyRequest": { "properties": { "aadContext": { "description": "Additional authenticated data (AAD context), optional.\nIf specified, this data will be required for decryption with the [SymmetricDecryptRequest].\nShould be encoded with base64.", "format": "byte", "type": "string" }, "dataKeySpec": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricAlgorithm" } ], "description": "Encryption algorithm and key length for the generated data key." }, "keyId": { "description": "ID of the symmetric KMS key that the generated data key should be encrypted with.", "type": "string" }, "skipPlaintext": { "description": "If `true`, the method won't return the data key as plaintext.\nDefault value is `false`.", "type": "boolean" } }, "required": [ "keyId", "dataKeySpec" ], "type": "object" }, "nebius.kms.v1.GenerateDataKeyResponse": { "properties": { "dataKeyCiphertext": { "description": "The encrypted data key.", "format": "byte", "type": "string" }, "dataKeyPlaintext": { "description": "Generated data key as plaintext.\nThe field is empty, if the [GenerateDataKeyRequest.skip_plaintext] parameter\nwas set to `true`.", "format": "byte", "type": "string" }, "keyId": { "description": "ID of the symmetric KMS key that was used to encrypt the generated data key.", "type": "string" } }, "type": "object" }, "nebius.kms.v1.KeyState": { "default": "KEY_STATE_UNSPECIFIED", "description": "Key state.\n- ACTIVE: Key is active, ready for use\n - SCHEDULED_FOR_DELETION: Key is scheduled for deletion.", "enum": [ "KEY_STATE_UNSPECIFIED", "ACTIVE", "SCHEDULED_FOR_DELETION" ], "type": "string" }, "nebius.kms.v1.ListAsymmetricKeysResponse": { "properties": { "items": { "description": "List of asymmetric KMS keys in the specified container.", "items": { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricKey" }, "type": "array" }, "nextPageToken": { "description": "This token allows you to get the next page of results for list requests. If the number\nof results is greater than the specified [ListAsymmetricKeysRequest.page_size], use\nthe [next_page_token] as the value for the [ListAsymmetricKeysRequest.page_token] query parameter\nin the next list request. Each subsequent list request will have its own\n[next_page_token] to continue paging through the results.", "type": "string" } }, "type": "object" }, "nebius.kms.v1.ListSymmetricKeysResponse": { "properties": { "items": { "description": "List of symmetric KMS keys in the specified container.", "items": { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricKey" }, "type": "array" }, "nextPageToken": { "description": "This token allows you to get the next page of results for list requests. If the number\nof results is greater than the specified [ListSymmetricKeysRequest.page_size], use\nthe [next_page_token] as the value for the [ListSymmetricKeysRequest.page_token] query parameter\nin the next list request. Each subsequent list request will have its own\n[next_page_token] to continue paging through the results.", "type": "string" } }, "type": "object" }, "nebius.kms.v1.RotateSymmetricKeyRequest": { "properties": { "id": { "description": "ID of the key to be rotated.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.kms.v1.SymmetricAlgorithm": { "default": "SYMMETRIC_ALGORITHM_UNSPECIFIED", "description": "Supported symmetric encryption algorithms.\n\n - AES_128: Deprecated. It is impossible to create new keys with this algorithm.\nAES algorithm with 128-bit keys.\n - AES_256: AES algorithm with 256-bit keys.", "enum": [ "SYMMETRIC_ALGORITHM_UNSPECIFIED", "AES_128", "AES_256" ], "type": "string" }, "nebius.kms.v1.SymmetricDecryptRequest": { "properties": { "aadContext": { "description": "Additional authenticated data, must be the same as was provided\nin the corresponding [SymmetricEncryptRequest].\nShould be encoded with base64.", "format": "byte", "type": "string" }, "ciphertext": { "description": "Ciphertext to be decrypted.\nShould be encoded with base64.", "format": "byte", "type": "string" }, "keyId": { "description": "ID of the symmetric KMS key to use for decryption.", "type": "string" } }, "required": [ "keyId" ], "type": "object" }, "nebius.kms.v1.SymmetricDecryptResponse": { "properties": { "keyId": { "description": "ID of the symmetric KMS key that was used for decryption.", "type": "string" }, "plaintext": { "description": "Decrypted plaintext.", "format": "byte", "type": "string" } }, "type": "object" }, "nebius.kms.v1.SymmetricEncryptRequest": { "properties": { "aadContext": { "description": "Additional authenticated data (AAD context), optional.\nIf specified, this data will be required for decryption with the [SymmetricDecryptRequest].\nShould be encoded with base64.", "format": "byte", "type": "string" }, "keyId": { "description": "ID of the symmetric KMS key to use for encryption.", "type": "string" }, "plaintext": { "description": "Plaintext to be encrypted.\nShould be encoded with base64.", "format": "byte", "type": "string" } }, "required": [ "keyId" ], "type": "object" }, "nebius.kms.v1.SymmetricEncryptResponse": { "properties": { "ciphertext": { "description": "Resulting ciphertext.", "format": "byte", "type": "string" }, "keyId": { "description": "ID of the symmetric KMS key that was used for encryption.", "type": "string" } }, "type": "object" }, "nebius.kms.v1.SymmetricKey": { "description": "A symmetric KMS key.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricKeySpec" } ], "description": "The specifications of the symmetric key." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricKeyStatus" } ], "description": "The current status of the symmetric key." } }, "type": "object" }, "nebius.kms.v1.SymmetricKeySpec": { "properties": { "algorithm": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricAlgorithm" } ], "description": "Encryption algorithm that should be used when using the key to encrypt plaintext.\nMust be specified only during create operations. Cannot be updated." }, "description": { "description": "Description of the key.", "type": "string" }, "rotationPeriod": { "description": "Key rotation period.", "type": "string" } }, "required": [ "algorithm" ], "type": "object" }, "nebius.kms.v1.SymmetricKeyStatus": { "properties": { "deletedAt": { "description": "Time when the key was scheduled for deletion.", "format": "date-time", "type": "string" }, "purgeAt": { "description": "Time when the key will be permanently deleted.", "format": "date-time", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.KeyState" } ], "description": "State (ACTIVE, SCHEDULED_FOR_DELETION)." } }, "type": "object" }, "nebius.kms.v1.UndeleteAsymmetricKeyRequest": { "properties": { "id": { "description": "ID of the asymmetric KMS key to restore.", "type": "string" }, "name": { "description": "A new name in case the current one is already in use.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.kms.v1.UndeleteSymmetricKeyRequest": { "properties": { "id": { "description": "ID of the symmetric KMS key to restore.", "type": "string" }, "name": { "description": "A new name in case the current one is already in use.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.kms.v1.UpdateAsymmetricKeyDeletionDelayRequest": { "properties": { "deletionDelay": { "description": "Deletion delay applied from the update timestamp.\nExample: \"86400s\" (1 day). Valid range: 86400s (1 day) to 2592000s (30 days).", "type": "string" }, "id": { "description": "ID of the asymmetric KMS key scheduled for deletion.", "type": "string" } }, "required": [ "id", "deletionDelay" ], "type": "object" }, "nebius.kms.v1.UpdateAsymmetricKeyRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "The metadata for the resource." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricKeySpec" } ], "description": "The specifications for updating an asymmetric key." } }, "required": [ "metadata" ], "type": "object" }, "nebius.kms.v1.UpdateSymmetricKeyDeletionDelayRequest": { "properties": { "deletionDelay": { "description": "Deletion delay applied from the update timestamp.\nExample: \"86400s\" (1 day). Valid range: 86400s (1 day) to 2592000s (30 days).", "type": "string" }, "id": { "description": "ID of the symmetric KMS key scheduled for deletion.", "type": "string" } }, "required": [ "id", "deletionDelay" ], "type": "object" }, "nebius.kms.v1.UpdateSymmetricKeyRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "The metadata for the resource." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricKeySpec" } ], "description": "The specifications for updating a symmetric key." } }, "required": [ "metadata" ], "type": "object" }, "nebius.logging.agentmanager.v1.Action": { "default": "ACTION_UNDEFINED", "description": "Action to be taken by the agent based on version check.\n\n - ACTION_UNDEFINED: Default undefined action.\n - NOP: No operation needed.\n - UPDATE: Update to new version required.\n - RESTART: Agent restart required.", "enum": [ "ACTION_UNDEFINED", "NOP", "UPDATE", "RESTART" ], "type": "string" }, "nebius.logging.agentmanager.v1.AgentState": { "default": "STATE_UNDEFINED", "description": "Current operational state of the agent.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" }, "nebius.logging.agentmanager.v1.AgentType": { "default": "AGENT_UNDEFINED", "description": "Type of the agent in the system.\n\n - AGENT_UNDEFINED: Default undefined state.\n - O11Y_AGENT: Observability agent type.", "enum": [ "AGENT_UNDEFINED", "O11Y_AGENT" ], "type": "string" }, "nebius.logging.agentmanager.v1.GetVersionResponse": { "description": "Response message for GetVersion RPC containing required action for the agent.", "properties": { "action": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.Action" } ], "description": "Required action for the agent to take." }, "configVersion": { "description": "Version of the rollout state this response was built from. Agent echoes\nit back as last_seen_config_version on the next request.", "format": "uint64", "type": "string" }, "featureFlags": { "additionalProperties": { "type": "string" }, "description": "Feature flags for the agent. Keys are UPPER_CASE flag names, values are flag values (typically \"true\"/\"false\").\nWhen feature_flags_unavailable is true the agent must ignore this field and\nkeep its current flag set unchanged.", "type": "object" }, "featureFlagsUnavailable": { "description": "True when the server could not load feature-flag state. The agent must\nkeep its current flag set instead of treating an empty feature_flags map\nas \"clear all\". The default value of false means feature_flags is\nauthoritative — including legitimately empty.", "type": "boolean" }, "nop": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.NopActionParams" } ], "description": "Parameters for no-operation action." }, "restart": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.RestartActionParams" } ], "description": "Parameters for restart action." }, "update": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.UpdateActionParams" } ], "description": "Parameters for update action." } }, "type": "object" }, "nebius.logging.agentmanager.v1.HealthCheckLogs": { "description": "Health check logs information for monitoring disk usage.", "properties": { "directorySizeBytes": { "description": "Size of the healthcheck directory in bytes.", "format": "int64", "type": "string" }, "mountpointTotalBytes": { "description": "Total size of the healthcheck mountpoint in bytes.", "format": "int64", "type": "string" } }, "type": "object" }, "nebius.logging.agentmanager.v1.ModuleHealth": { "description": "Health status information for an individual module.", "properties": { "messages": { "description": "Status messages describing the module's state.", "items": { "type": "string" }, "type": "array" }, "parameters": { "description": "Current parameters of the module.", "items": { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.Parameter" }, "type": "array" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.AgentState" } ], "description": "Current operational state of the module." } }, "type": "object" }, "nebius.logging.agentmanager.v1.ModulesHealth": { "description": "Health status information for all agent modules.", "properties": { "ciliumPipeline": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.ModuleHealth" } ], "description": "Health status of the Cilium pipeline module." }, "commonServiceLogsPipeline": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.ModuleHealth" } ], "description": "Health status of the common service logs pipeline module." }, "computeGpuLogsPipeline": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.ModuleHealth" } ], "description": "Health status of the compute GPU logs pipeline module." }, "cpuPipeline": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.ModuleHealth" } ], "description": "Health status of the CPU pipeline module." }, "gpuPipeline": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.ModuleHealth" } ], "description": "Health status of the GPU pipeline module." }, "journaldPipeline": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.ModuleHealth" } ], "description": "Health status of the journald pipeline module." }, "ncclMetricsPipeline": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.ModuleHealth" } ], "description": "Health status of the NCCL metrics pipeline module." }, "process": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.ModuleHealth" } ], "description": "Health status of the process module." }, "vmServiceLogsPipeline": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.ModuleHealth" } ], "description": "Health status of the vm service logs pipeline module." }, "vmappsPipeline": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.ModuleHealth" } ], "description": "Health status of the VM applications pipeline module." } }, "type": "object" }, "nebius.logging.agentmanager.v1.NopActionParams": { "description": "Parameters when no operation is required.", "type": "object" }, "nebius.logging.agentmanager.v1.OSInfo": { "description": "Operating system information for the instance.", "properties": { "architecture": { "description": "System architecture.", "type": "string" }, "name": { "description": "Operating system name and version.\nExample: \"Ubuntu 22.04.4 LTS\"", "type": "string" }, "uname": { "description": "Detailed system information from uname command.\n\nExample:\n```\nLinux computeimage-abcdef 6.5.0-44-generic #44~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Tue Jun 18 14:36:16 UTC 2 x86_64 x86_64 x86_64 GNU/Linux\n```", "type": "string" } }, "type": "object" }, "nebius.logging.agentmanager.v1.Parameter": { "description": "Key-value parameter for module configuration.", "properties": { "name": { "description": "Name of the parameter.", "type": "string" }, "value": { "description": "Value of the parameter.", "type": "string" } }, "type": "object" }, "nebius.logging.agentmanager.v1.RestartActionParams": { "description": "Parameters for agent restart action.", "type": "object" }, "nebius.logging.agentmanager.v1.UpdateActionParams": { "description": "Parameters for agent update action.", "properties": { "repoUrl": { "description": "URL of the repository containing the update.", "type": "string" }, "version": { "description": "Target version for the update.", "type": "string" } }, "type": "object" }, "nebius.logging.v1.CancelExportLogsRequest": { "properties": { "exportOperationId": { "description": "ID of the export operation to cancel, as returned by `create` or shown by `list`.", "type": "string" } }, "required": [ "exportOperationId" ], "type": "object" }, "nebius.logging.v1.ExportFilter": { "properties": { "from": { "description": "Start of the time range to export, ISO 8601 (e.g. `2025-12-21T20:00:00Z`).", "format": "date-time", "type": "string" }, "matchExpression": { "description": "LogQL match expression selecting log entries to export.", "type": "string" }, "to": { "description": "End of the time range to export, ISO 8601 (e.g. `2025-12-22T00:00:00Z`).", "format": "date-time", "type": "string" } }, "required": [ "from", "to" ], "type": "object" }, "nebius.logging.v1.ExportLogsRequest": { "properties": { "params": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.v1.ExportParams" } ], "description": "What to export and where to write it." }, "parentId": { "description": "Project ID whose logs are exported. Also used as the default owner of the destination bucket when the bucket is\nresolved by name and `--bucket-parent-id` is not set.", "type": "string" } }, "required": [ "params", "parentId" ], "type": "object" }, "nebius.logging.v1.ExportParams": { "properties": { "log": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.v1.LogsExport" } ], "description": "Export log entries selected by a LogQL match expression." }, "nebiusObjectStorage": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.v1.NebiusObjectStorageDestination" } ], "description": "Write the export to a Nebius Object Storage bucket.\n\nNebiusObjectStorageDestinationRegistered nebius_object_storage_registered = 5; // to be added later\n ObjectStorage object_storage = 6; // to be added later" } }, "type": "object" }, "nebius.logging.v1.ExportStatus": { "properties": { "operation": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.Operation" } ], "description": "Long-running operation backing the export." }, "resultPath": { "description": "Path to the resulting objects in the destination bucket, as an ordered\nsequence of segments (join with `/` to get the full path). Individual objects\nappear below this prefix under `\u003ctimestamp\u003e/\u003csegment\u003e.\u003cext\u003e` (e.g.\n`logs/oplogexport-.../2025-12-21-20:00:00/0.parquet`).", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.logging.v1.ListExportsResponse": { "properties": { "exports": { "description": "List of export operations on this result page.", "items": { "$ref": "#/components/schemas/nebius.logging.v1.ExportStatus" }, "type": "array" }, "nextPageToken": { "description": "Listing continuation token for the next page of results.", "type": "string" } }, "type": "object" }, "nebius.logging.v1.LogsExport": { "properties": { "exportLabels": { "description": "Label names to include as columns in the exported data. Empty means export all labels.", "items": { "type": "string" }, "type": "array" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.v1.ExportFilter" } ], "description": "Time range and LogQL match expression selecting log entries to export." }, "format": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.v1.LogsExportFormat" } ], "description": "Output file format." } }, "required": [ "filter", "format" ], "type": "object" }, "nebius.logging.v1.LogsExportFormat": { "default": "EXPORT_FORMAT_UNSUPPORTED", "description": "Output file format for exported log data, chosen via `--log-format`.\n\n - JSON_GZIP: JSON lines (one JSON object per line) compressed with gzip. Written as `.json.gz`.\n - PARQUET: Apache Parquet. Written as `.parquet`.", "enum": [ "EXPORT_FORMAT_UNSUPPORTED", "JSON_GZIP", "PARQUET" ], "type": "string" }, "nebius.logging.v1.NebiusObjectStorageBucketByName": { "properties": { "name": { "description": "Name of the destination Object Storage bucket.", "type": "string" }, "parentId": { "description": "Project ID that owns the bucket. Required only when the bucket lives in a different project than `--parent-id`;\ndefaults to `--parent-id` otherwise.", "type": "string" } }, "required": [ "name" ], "type": "object" }, "nebius.logging.v1.NebiusObjectStorageDestination": { "properties": { "byName": { "allOf": [ { "$ref": "#/components/schemas/nebius.logging.v1.NebiusObjectStorageBucketByName" } ], "description": "Destination bucket." }, "id": { "description": "ID of the destination Object Storage bucket.", "type": "string" }, "objectPrefix": { "description": "Key prefix under which exported objects are written. Defaults to `logs/`.", "type": "string" } }, "type": "object" }, "nebius.logging.v1.OrderBy": { "default": "ORDER_BY_UNSPECIFIED", "description": "Sort order for `list` output, applied to export operations by creation time.", "enum": [ "ORDER_BY_UNSPECIFIED", "ORDER_BY_ASC", "ORDER_BY_DESC" ], "type": "string" }, "nebius.maintenance.v1alpha1.ListMaintenancesResponse": { "properties": { "items": { "description": "List of maintenance operations.", "items": { "$ref": "#/components/schemas/nebius.maintenance.v1alpha1.Maintenance" }, "type": "array" } }, "type": "object" }, "nebius.maintenance.v1alpha1.Maintenance": { "description": "Maintenance operations are initiated by Nebius Cloud infrastructure.\nThey are used to perform scheduled or urgent operations on Nebius Cloud resources,\nsuch as Managed Services or Standalone Applications, that are necessary for\nmaintaining the service in an operable state. These operations run automatically,\nwithout user intervention.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "The metadata for the maintenance operation resource." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.maintenance.v1alpha1.MaintenanceSpec" } ], "description": "Specifications for the maintenance operation." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.maintenance.v1alpha1.MaintenanceStatus" } ], "description": "Current status of the maintenance operation." } }, "type": "object" }, "nebius.maintenance.v1alpha1.MaintenanceSpec": { "properties": { "scheduledAt": { "description": "Timestamp indicating when the maintenance operation is scheduled to run.", "format": "date-time", "type": "string" } }, "required": [ "scheduledAt" ], "type": "object" }, "nebius.maintenance.v1alpha1.MaintenanceStatus": { "properties": { "affectedResources": { "description": "List of resources that are affected by this maintenance operation.", "items": { "$ref": "#/components/schemas/nebius.maintenance.v1alpha1.Resource" }, "type": "array" }, "finishedAt": { "description": "Timestamp indicating when the maintenance operation finished.", "format": "date-time", "type": "string" }, "reschedulable": { "description": "Indicates whether the maintenance operation's scheduled_at time can be changed.", "type": "boolean" }, "startedAt": { "description": "Timestamp indicating when the maintenance operation started.", "format": "date-time", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.maintenance.v1alpha1.State" } ], "description": "Current state of the maintenance operation." } }, "type": "object" }, "nebius.maintenance.v1alpha1.Resource": { "properties": { "id": { "description": "Unique identifier for the resource.", "type": "string" }, "parentId": { "description": "IAM container of the resource.", "type": "string" } }, "type": "object" }, "nebius.maintenance.v1alpha1.State": { "default": "STATE_UNSPECIFIED", "description": " - STATE_SCHEDULED: Maintenance operation is scheduled to be run in the future.\n - STATE_IN_PROGRESS: Maintenance operation is currently in progress.\n - STATE_FINISHED: Maintenance operation has been successfully completed.\n - STATE_ERROR: Maintenance operation has encountered an error and could not be completed.\n - STATE_CANCELLED: Maintenance operation has been cancelled by the system.", "enum": [ "STATE_UNSPECIFIED", "STATE_SCHEDULED", "STATE_IN_PROGRESS", "STATE_FINISHED", "STATE_ERROR", "STATE_CANCELLED" ], "type": "string" }, "nebius.maintenance.v1alpha1.UpdateMaintenanceRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata associated with the maintenance operation.\nMust include ID of the maintenance operation to update." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.maintenance.v1alpha1.MaintenanceSpec" } ], "description": "Updated specification for the maintenance operation." } }, "required": [ "metadata" ], "type": "object" }, "nebius.maintenance.v1alpha1.UpdateMaintenanceResponse": { "properties": { "maintenance": { "allOf": [ { "$ref": "#/components/schemas/nebius.maintenance.v1alpha1.Maintenance" } ], "description": "Updated maintenance operation." } }, "type": "object" }, "nebius.mk8s.v1.AttachedFilesystemSpec": { "properties": { "attachMode": { "$ref": "#/components/schemas/nebius.mk8s.v1.AttachedFilesystemSpec.AttachMode" }, "existingFilesystem": { "$ref": "#/components/schemas/nebius.mk8s.v1.ExistingFilesystem" }, "mountTag": { "description": "Specifies the user-defined identifier, allowing to use it as a device in mount command.", "type": "string" } }, "required": [ "attachMode", "mountTag" ], "type": "object" }, "nebius.mk8s.v1.AttachedFilesystemSpec.AttachMode": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "READ_ONLY", "READ_WRITE" ], "type": "string" }, "nebius.mk8s.v1.AuditLogsSpec": { "type": "object" }, "nebius.mk8s.v1.Cluster": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mk8s.v1.ClusterSpec" }, "status": { "$ref": "#/components/schemas/nebius.mk8s.v1.ClusterStatus" } }, "type": "object" }, "nebius.mk8s.v1.ClusterControlPlaneVersion": { "properties": { "deprecated": { "description": "Deprecated marks version to be soon deleted from API.\nCreation of clusters with this version is forbidden.", "type": "boolean" }, "endOfLife": { "description": "EndOfLife determines when the version will be forced out of use.", "format": "date-time", "type": "string" }, "restricted": { "description": "Restricted shows versions available only for internal Nebius use, mostly those about to get released to public.\nTo use such versions - a feature restricted_k8s_versions should be enabled on a cluster.", "type": "boolean" }, "version": { "description": "Format of the version includes only MAJOR.MINOR, the same as can be passed to cluster creation API. For example \"1.31\".", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.ClusterSpec": { "properties": { "controlPlane": { "$ref": "#/components/schemas/nebius.mk8s.v1.ControlPlaneSpec" }, "kubeNetwork": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.KubeNetworkSpec" } ], "description": "Defines kubernetes network configuration, like IP allocation." } }, "required": [ "controlPlane" ], "type": "object" }, "nebius.mk8s.v1.ClusterStatus": { "properties": { "controlPlane": { "$ref": "#/components/schemas/nebius.mk8s.v1.ControlPlaneStatus" }, "events": { "items": { "$ref": "#/components/schemas/nebius.common.v1.RecurrentResourceEvent" }, "type": "array" }, "reconciling": { "description": "Show that changes are in flight", "type": "boolean" }, "state": { "$ref": "#/components/schemas/nebius.mk8s.v1.ClusterStatus.State" } }, "type": "object" }, "nebius.mk8s.v1.ClusterStatus.State": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "DELETING" ], "type": "string" }, "nebius.mk8s.v1.ConditionStatus": { "default": "CONDITION_STATUS_UNSPECIFIED", "enum": [ "CONDITION_STATUS_UNSPECIFIED", "TRUE", "FALSE", "UNKNOWN" ], "type": "string" }, "nebius.mk8s.v1.ControlPlaneEndpointsSpec": { "properties": { "publicEndpoint": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.PublicEndpointSpec" } ], "description": "Public endpoint specification. When set, a public endpoint is created." } }, "type": "object" }, "nebius.mk8s.v1.ControlPlaneSpec": { "properties": { "auditLogs": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.AuditLogsSpec" } ], "description": "Specify configuration of the pushing k8s audit logs into service logs and show it in the UI.\nBy default cluster will be created without it." }, "endpoints": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.ControlPlaneEndpointsSpec" } ], "description": "Specification of endpoints of cluster control plane." }, "etcdClusterSize": { "description": "Number of instances in etcd cluster.\n3 by default.\nControl plane with `etcd_cluster_size: 3` called \"Highly Available\" (\"HA\"), because it's Kubernetes API\nwill be available despite a failure of one control plane instance.", "format": "int64", "type": "string" }, "karpenter": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.Karpenter" } ], "description": "Enables installation of the Karpenter inside a cluster.\nKarpenter will be installed as a helm chart inside cluster\nso it requires creation of at least one CPU public node group.\n\nPlease note that there is no feature parity between Karpenter node pools and\npublic node groups.\nBy default cluster will be created without it." }, "subnetId": { "description": "Nebius VPC Subnet ID where control plane instances will be located.\nAlso will be default NodeGroup subnet.", "type": "string" }, "version": { "description": "Desired Kubernetes version of the cluster. May be lower than the actual cluster version\nif the desired version is no longer supported and the cluster has been automatically updated.\nFor now only acceptable format is `\u003cmajor\u003e.\u003cminor\u003e` like \"1.31\".\nOption for patch version update will be added later.", "type": "string" } }, "required": [ "subnetId" ], "type": "object" }, "nebius.mk8s.v1.ControlPlaneStatus": { "properties": { "auth": { "$ref": "#/components/schemas/nebius.mk8s.v1.ControlPlaneStatusAuth" }, "endpoints": { "$ref": "#/components/schemas/nebius.mk8s.v1.ControlPlaneStatusEndpoints" }, "etcdClusterSize": { "description": "Number of instances in etcd cluster.", "format": "int64", "type": "string" }, "version": { "description": "Actual Kubernetes and configuration version.\nVersion has format `\u003cmajor\u003e.\u003cminor\u003e.\u003cpatch\u003e-nebius-cp.\u003cinfra_version\u003e` like\n\"1.30.0-nebius-cp.3\", where `\u003cmajor\u003e.\u003cminor\u003e.\u003cpatch\u003e` is Kubernetes version and `\u003cinfra_version\u003e` is version of control plane\ninfrastructure and configuration, updating of which may include bug fixes, security updates and new features of components running on\ncontrol plane, like CCM or Cluster Autoscaler.", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.ControlPlaneStatusAuth": { "properties": { "clusterCaCertificate": { "description": "PEM with the Cluster Certificate Authority, that must be used for TLS connection to Kubernetes API.", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.ControlPlaneStatusEndpoints": { "description": "Endpoints of Kubernetes control plane. Kubernetes API can be accessed at `https://endpoint/`.", "properties": { "privateEndpoint": { "description": "DNS name or IP address accessible from the user VPC.", "type": "string" }, "publicEndpoint": { "description": "DNS name or IP address accessible from the Internet.", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.CreateClusterRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mk8s.v1.ClusterSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.mk8s.v1.CreateNodeGroupRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.mk8s.v1.DiskEncryption": { "properties": { "type": { "$ref": "#/components/schemas/nebius.mk8s.v1.DiskEncryption.DiskEncryptionType" } }, "type": "object" }, "nebius.mk8s.v1.DiskEncryption.DiskEncryptionType": { "default": "DISK_ENCRYPTION_UNSPECIFIED", "enum": [ "DISK_ENCRYPTION_UNSPECIFIED", "DISK_ENCRYPTION_MANAGED" ], "type": "string" }, "nebius.mk8s.v1.DiskSpec": { "properties": { "blockSizeBytes": { "format": "int64", "type": "string" }, "diskEncryption": { "$ref": "#/components/schemas/nebius.mk8s.v1.DiskEncryption" }, "sizeBytes": { "format": "int64", "type": "string" }, "sizeGibibytes": { "format": "int64", "type": "string" }, "sizeKibibytes": { "format": "int64", "type": "string" }, "sizeMebibytes": { "format": "int64", "type": "string" }, "type": { "$ref": "#/components/schemas/nebius.mk8s.v1.DiskSpec.DiskType" } }, "type": "object" }, "nebius.mk8s.v1.DiskSpec.DiskType": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "NETWORK_SSD", "NETWORK_HDD", "NETWORK_SSD_IO_M3", "NETWORK_SSD_NON_REPLICATED" ], "type": "string" }, "nebius.mk8s.v1.ExistingFilesystem": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.mk8s.v1.FollowsSpotPriceSpec": { "type": "object" }, "nebius.mk8s.v1.GpuClusterSpec": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.GpuSettings": { "description": "GPU-related settings.", "properties": { "dra": { "description": "Enables Dynamic Resource Allocation for this GPU node group.\nFor nodes whose image contains preinstalled NVIDIA drivers, disables the legacy NVIDIA device plugin.\nFor GPU nodes attached to a Compute GPU cluster, advertises RDMA capability through the managed DRANet DaemonSet.", "type": "boolean" }, "driversPreset": { "description": "Identifier of the predefined set of drivers included in the ComputeImage deployed on ComputeInstances that are part of the NodeGroup.\nSupported presets depend on the platform and Kubernetes version.\nTo get the up-to-date list of supported presets for a given Kubernetes version and platform, run:\nnebius mk8s node-group get-compatibility-matrix --cluster-kubernetes-version VERSION --platform PLATFORM\nLeave empty for GPU nodes that do not have preinstalled drivers, including DRA-enabled node groups.", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.InstanceMetadataTemplate": { "properties": { "labels": { "additionalProperties": { "type": "string" }, "description": "Labels propagated into Compute Instance metadata.\nProvider-managed labels take precedence over user-provided instance labels.", "type": "object" } }, "type": "object" }, "nebius.mk8s.v1.Karpenter": { "type": "object" }, "nebius.mk8s.v1.KubeNetworkSpec": { "properties": { "serviceCidrs": { "description": "CIDR blocks for Service ClusterIP allocation.\nFor now, only one value is supported.\nMust be a valid CIDR block or prefix length.\nIn case of prefix length, certain CIDR is auto allocated.\nSpecified CIDR blocks will be reserved in Cluster.spec.control_plane.subnet_id to prevent address duplication.\nAllowed prefix length is from \"/12\" to \"/28\".\nEmpty value treated as [\"/16\"].", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.mk8s.v1.ListClusterControlPlaneVersionsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.mk8s.v1.ClusterControlPlaneVersion" }, "type": "array" } }, "type": "object" }, "nebius.mk8s.v1.ListClustersResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.mk8s.v1.Cluster" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.ListNodeGroupsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroup" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.LocalDisksSpec": { "properties": { "config": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.LocalDisksSpecConfig" } ], "description": "config defines actions that managed Kubernetes service performs on mounted local disks\nto provide them inside Kubernetes cluster with a convenient interface.\n\nWhen omitted, a default value is generated." }, "passthroughGroup": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.PassthroughGroupRequest" } ], "description": "Requests passthrough local disks from the host.\nTopology of the provided disks is preserved during stop and start\nfor every instance of a specific platform and preset in the region." } }, "type": "object" }, "nebius.mk8s.v1.LocalDisksSpecConfig": { "description": "LocalDisksSpecConfig defines actions that managed Kubernetes service performs on mounted local disks\nto provide them inside Kubernetes cluster with a convenient interface.", "properties": { "kubeletEphemeral": { "description": "kubelet_ephemeral: combine all local disks into a single storage volume and use it as kubelet's local ephemeral storage on the node\nSee also https://kubernetes.io/docs/concepts/storage/ephemeral-storage/.\nThe default when LocalDisksSpecConfig is not set.", "type": "boolean" }, "none": { "description": "none: \"do nothing\" - local disks will be provisioned as on a regular compute instance.", "type": "boolean" } }, "type": "object" }, "nebius.mk8s.v1.NVLinkSpec": { "properties": { "nvlInstanceGroupId": { "description": "Existing NVLInstanceGroup ID to use.", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.NetworkInterfaceTemplate": { "properties": { "publicIpAddress": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.PublicIPAddress" } ], "description": "Parameters for Public IPv4 address associated with the interface.\nSet to empty value, to enable it." }, "securityGroups": { "description": "User provided VPC Security Groups which will be assigned to all nodes of this NodeGroup.", "items": { "$ref": "#/components/schemas/nebius.mk8s.v1.SecurityGroup" }, "type": "array" }, "subnetId": { "description": "Nebius VPC Subnet ID that will be attached to a node cloud instance network interface.\nBy default Cluster control plane subnet_id used.\nSubnet should be located in the same network with control plane.", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.NodeAutoRepairCondition": { "properties": { "disabled": { "description": "When true, disables the default auto-repair condition rules.", "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.ConditionStatus" } ], "description": "Node condition status." }, "timeout": { "description": "The duration after which the node is automatically repaired if the condition remains in the specified status.", "type": "string" }, "type": { "description": "Node condition type.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "nebius.mk8s.v1.NodeGroup": { "description": "NodeGroup represents Kubernetes node pool - set of worker machines having the same configuration.\nA Node is a Nebius Compute Instance created in Cluster.metadata.parent_id container, running kubelet\nthat registers in Kubernetes API and a Node object created.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupSpec" }, "status": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupStatus" } }, "type": "object" }, "nebius.mk8s.v1.NodeGroupAutoRepairSpec": { "properties": { "conditions": { "description": "Conditions that determine whether a node should be auto repaired.", "items": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeAutoRepairCondition" }, "type": "array" } }, "type": "object" }, "nebius.mk8s.v1.NodeGroupAutoscalingSpec": { "properties": { "maxNodeCount": { "format": "int64", "type": "string" }, "minNodeCount": { "format": "int64", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.NodeGroupCompatibilityMatrix": { "properties": { "versions": { "description": "List of available versions.", "items": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupCompatibilityVersion" }, "type": "array" } }, "type": "object" }, "nebius.mk8s.v1.NodeGroupCompatibilityVersion": { "properties": { "items": { "description": "List of available images.", "items": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupCompatibilityVersionItem" }, "type": "array" }, "kubernetesVersion": { "description": "Kubernetes version.", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.NodeGroupCompatibilityVersionItem": { "properties": { "compatiblePlatforms": { "description": "Hardware platforms.", "items": { "type": "string" }, "type": "array" }, "driversPreset": { "description": "Drivers preset name.", "type": "string" }, "os": { "description": "Operating system.", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.NodeGroupDeploymentStrategy": { "properties": { "drainTimeout": { "description": "Maximum amount of time that the service will spend attempting to gracefully drain a node\n(evicting its pods) before falling back to pod deletion.\nA value of 0 means no timeout: the node can be drained for an unlimited time.\nImportant consequence of that is if PodDisruptionBudget doesn't allow evicting a pod,\nthen NodeGroup update with node re-creation will hang on that pod eviction.\nNote that this is different from `kubectl drain --timeout`, which gives up and returns an error.\n\nOn 2026-08-01, defaults to 0.\nIMPORTANT: starting from Q3 2026 new default is 10m;\nfor new clusters it will default to 10m,\nnode groups in existing clusters will be gradually migrated during Q3 to the default of 10m as well.\nTo get the actual value for your node group, please see 'strategy' in its status.", "type": "string" }, "maxSurge": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.PercentOrCount" } ], "description": "The maximum number of additional nodes that can be provisioned above the desired number of nodes during the update process.\n\nThis value can be specified either as an absolute number (for example 3) or as a percentage of the desired\nnumber of nodes (for example 5%).\n\nWhen specified as a percentage, the actual number is calculated by rounding up to the nearest whole number.\nThis value cannot be 0 if `max_unavailable` is also set to 0.\n\nOn 2026-08-01, defaults to 1.\nIMPORTANT: starting from Q3 2026 new default is 0;\nfor new clusters it will default to 0,\nnode groups in existing clusters will be gradually migrated during Q3 to the default of 0 as well.\nTo get the actual value for your node group, please see 'strategy' in its status.\n\nExample: If set to 25%, the node group can scale up by an additional 25% during the update,\nallowing new nodes to be added before old nodes are removed, which helps minimize workload disruption.\n\nNOTE:\n\nit is user responsibility to ensure that there are enough quota for provision nodes above the desired number.\nAvailable quota effectively limits `max_surge`.\nIn case of not enough quota even for one extra node, update operation will hung because of quota exhausted error.\nSuch error will be visible in Operation.progress_data." }, "maxUnavailable": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.PercentOrCount" } ], "description": "The maximum number of nodes that can be simultaneously unavailable during the update process.\n\nThis value can be specified either as an absolute number (for example 3) or as a percentage of the desired\nnumber of nodes (for example 5%).\n\nWhen specified as a percentage, the actual number is calculated by rounding down to the nearest whole number.\nThis value cannot be 0 if `max_surge` is also set to 0.\n\nOn 2026-08-01, defaults to 0.\nIMPORTANT: starting from Q3 2026 new default is 1;\nfor new clusters it will default to 1,\nnode groups in existing clusters will be gradually migrated during Q3 to the default of 1 as well.\nTo get the actual value for your node group, please see 'strategy' in its status.\n\nExample: If set to 20%, up to 20% of the nodes can be taken offline at once during the update,\nensuring that at least 80% of the desired nodes remain operational." } }, "type": "object" }, "nebius.mk8s.v1.NodeGroupSpec": { "properties": { "autoRepair": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupAutoRepairSpec" } ], "description": "Parameters for nodes auto repair." }, "autoscaling": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupAutoscalingSpec" } ], "description": "Enables [Kubernetes Cluster Autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler)\nfor that NodeGroup, and defines autoscaling parameters." }, "fixedNodeCount": { "description": "Number of nodes in the group. Can be changed manually at any time, except for a node group with NVLink.", "format": "int64", "type": "string" }, "strategy": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupDeploymentStrategy" } ], "description": "Defines deployment - roll-out, or nodes re-creation during configuration change.\nAllows to setup compromise in roll-out speed, extra resources consumption and workloads disruption." }, "template": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeTemplate" } ], "description": "Parameters for Kubernetes Node object and Nebius Compute Instance\nIf not written opposite a NodeTemplate field update will cause NodeGroup roll-out according NodeGroupDeploymentStrategy." }, "version": { "description": "Version is desired Kubernetes version of the cluster. For now only acceptable format is\n`\u003cmajor\u003e.\u003cminor\u003e` like \"1.31\". Option for patch version update will be added later.\nBy default the cluster control plane `\u003cmajor\u003e.\u003cminor\u003e` version will be used.", "type": "string" } }, "required": [ "template" ], "type": "object" }, "nebius.mk8s.v1.NodeGroupStatus": { "properties": { "events": { "items": { "$ref": "#/components/schemas/nebius.common.v1.RecurrentResourceEvent" }, "type": "array" }, "nodeCount": { "description": "Total number of nodes that are currently in the node group.\nBoth ready and not ready nodes are counted.", "format": "int64", "type": "string" }, "outdatedNodeCount": { "description": "Total number of nodes that has outdated node configuration.\nThese nodes will be replaced by new nodes with up-to-date configuration.", "format": "int64", "type": "string" }, "readyNodeCount": { "description": "Total number of nodes that successfully joined the cluster and are ready to serve workloads.\nBoth outdated and up-to-date nodes are counted.", "format": "int64", "type": "string" }, "reconciling": { "description": "Show that there are changes are in flight.", "type": "boolean" }, "state": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupStatus.State" }, "strategy": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupDeploymentStrategy" } ], "description": "Deployment strategy used by the service for node group rollouts and node deletions.\nIt includes default values applied by the service. A drain_timeout value of 0 means\nthat node draining is not time-limited." }, "targetNodeCount": { "description": "Desired total number of nodes that should be in the node group.\nIt is either `NodeGroupSpec.fixed_node_count` or arbitrary number between\n`NodeGroupAutoscalingSpec.min_node_count` and `NodeGroupAutoscalingSpec.max_node_count` decided by autoscaler.", "format": "int64", "type": "string" }, "version": { "description": "Actual version of NodeGroup. Have format `\u003cmajor\u003e.\u003cminor\u003e.\u003cpatch\u003e-nebius-node.\u003cinfra_version\u003e` like \"1.30.0-nebius-node.10\".\nWhere `\u003cmajor\u003e.\u003cminor\u003e.\u003cpatch\u003e` is Kubernetes version and `\u003cinfra_version\u003e` is version of Node infrastructure and configuration,\nwhich update may include bug fixes, security updates and new features depending on worker node configuration.", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.NodeGroupStatus.State": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "DELETING" ], "type": "string" }, "nebius.mk8s.v1.NodeMetadataTemplate": { "properties": { "labels": { "additionalProperties": { "type": "string" }, "description": "Kubernetes Node labels.\n\nKeys and values must follow Kubernetes label syntax:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/\n\nFor now change will not be propagated to existing nodes, so will be applied only to Kubernetes Nodes created after the field change.\nThat behavior may change later.\nSo, for now you will need to manually set them to existing nodes, if that is needed.\n\nSystem labels containing \"kubernetes.io\" and \"k8s.io\" will be ignored.\nField change will NOT trigger NodeGroup roll out.", "type": "object" } }, "type": "object" }, "nebius.mk8s.v1.NodeTaint": { "description": "See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/", "properties": { "effect": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeTaint.Effect" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value", "effect" ], "type": "object" }, "nebius.mk8s.v1.NodeTaint.Effect": { "default": "EFFECT_UNSPECIFIED", "enum": [ "EFFECT_UNSPECIFIED", "NO_EXECUTE", "NO_SCHEDULE", "PREFER_NO_SCHEDULE" ], "type": "string" }, "nebius.mk8s.v1.NodeTemplate": { "properties": { "bootDisk": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.DiskSpec" } ], "description": "Parameters of a Node Nebius Compute Instance boot disk." }, "cloudInitUserData": { "description": "cloud-init user-data\nShould contain at least one SSH key.", "type": "string" }, "filesystems": { "description": "Static attachments of Compute Filesystem.\nCan be used as a workaround, until CSI for Compute Disk and Filesystem will be available.", "items": { "$ref": "#/components/schemas/nebius.mk8s.v1.AttachedFilesystemSpec" }, "type": "array" }, "followsSpotPrice": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.FollowsSpotPriceSpec" } ], "description": "The preemptible VM accepts the current spot price." }, "gpuCluster": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.GpuClusterSpec" } ], "description": "Nebius Compute GPUCluster ID that will be attached to node." }, "gpuSettings": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.GpuSettings" } ], "description": "GPU-related settings." }, "instanceMetadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.InstanceMetadataTemplate" } ], "description": "Metadata propagated to the Compute Instances in the NodeGroup." }, "localDisks": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.LocalDisksSpec" } ], "description": "local_disks enables the provisioning of fast local drives.\nThis type of storage is strictly ephemeral: on node restart, all data is erased, similar to RAM." }, "maxPods": { "description": "The maximum number of Pods per node for your cluster. If omitted, MK8S assigns the default value of 110. When you\nconfigure the maximum number of Pods per node for the cluster, MK8S uses this value to allocate a CIDR range for every node\nin group. The node CIDR prefix is calculated as `32 - ceil(log2(2 * max_pods))`, i.e. the smallest IPv4 subnet whose total address\ncount is at least `2 * max_pods`. Not all IPs are usable for workload Pods because some of them are consumed by system Pods.", "format": "int64", "type": "string" }, "metadata": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeMetadataTemplate" }, "networkInterfaces": { "items": { "$ref": "#/components/schemas/nebius.mk8s.v1.NetworkInterfaceTemplate" }, "type": "array" }, "nvlink": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.NVLinkSpec" } ], "description": "NVLinkSpec configures NVLink settings for the NodeGroup." }, "onDemand": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.OnDemandSpec" } ], "description": "A regular, non-preemptible VM." }, "os": { "description": "OS version that will be used to create the boot disk of Compute Instances in the NodeGroup.\nSupported OS depend on the platform and Kubernetes version.\nTo get the up-to-date list of supported OS for a given Kubernetes version and platform, run:\nnebius mk8s node-group get-compatibility-matrix --cluster-kubernetes-version VERSION --platform PLATFORM", "type": "string" }, "preemptible": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.PreemptibleSpec" } ], "description": "Configures whether the nodes in the group are preemptible.\nSet to empty value to enable preemptible nodes." }, "reservationPolicy": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.ReservationPolicy" } ], "description": "reservation_policy is an interface of the \"capacity block\" (or \"capacity block group\") mechanism of Nebius Compute." }, "resources": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.ResourcesSpec" } ], "description": "Resources that will have Nebius Compute Instance where Node kubelet will run." }, "serviceAccountId": { "description": "the Nebius service account whose credentials will be available on the nodes of the group.\nWith these credentials, it is possible to make `nebius` CLI or public API requests from the nodes\nwithout the need for extra authentication.\nThis service account is also used to make requests to container registry.\n\n`resource.serviceaccount.issueAccessToken` permission is required to use this field.", "type": "string" }, "spotPricingPolicy": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.SpotPricingPolicySpec" } ], "description": "The preemptible VM accepts the current spot price unless it exceeds the maximum price specified by the selected\npricing policy. When the spot price exceeds that maximum price, the VM is preempted." }, "taints": { "description": "Kubernetes Node taints.\nFor now change will not be propagated to existing nodes, so will be applied only to Kubernetes Nodes created after the field change.\nThat behaviour may change later.\nSo, for now you will need to manually set them to existing nodes, if that is needed.\nField change will NOT trigger NodeGroup roll out.", "items": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeTaint" }, "type": "array" } }, "required": [ "resources" ], "type": "object" }, "nebius.mk8s.v1.OnDemandSpec": { "type": "object" }, "nebius.mk8s.v1.PassthroughGroupRequest": { "properties": { "requested": { "description": "Passthrough local disks from the underlying host.\n\nDevices are expected to appear in the guest as NVMe devices (nvme0, nvme1, ...),\nbut the exact number depends on the preset.\nEnabled only when this field is explicitly set.", "type": "boolean" } }, "type": "object" }, "nebius.mk8s.v1.PercentOrCount": { "properties": { "count": { "format": "int64", "type": "string" }, "percent": { "format": "int64", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.PreemptibleSpec": { "type": "object" }, "nebius.mk8s.v1.PreflightCheckNodeGroupRequest": { "properties": { "context": { "$ref": "#/components/schemas/nebius.common.v1.PreflightCheckContext" }, "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupSpec" } }, "type": "object" }, "nebius.mk8s.v1.PreflightCheckNodeGroupResponse": { "properties": { "diagnostics": { "items": { "$ref": "#/components/schemas/nebius.common.v1.PreflightCheckDiagnostic" }, "type": "array" }, "pathsRequireRecreate": { "type": "string" }, "requiresUserApproval": { "type": "boolean" } }, "type": "object" }, "nebius.mk8s.v1.PublicEndpointSpec": { "properties": { "allowedCidrs": { "description": "List of CIDR blocks from which access to public endpoint is allowed.\nIf field is not set, or list is empty, it means that access is not restricted at all.\nYou can specify a maximum of 8 CIDRs.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.mk8s.v1.PublicIPAddress": { "description": "Describes a public IP address.", "type": "object" }, "nebius.mk8s.v1.ReservationPolicy": { "description": "ReservationPolicy is copied as-is from NebiusAPI `compute/v1/instance.proto`.", "properties": { "policy": { "$ref": "#/components/schemas/nebius.mk8s.v1.ReservationPolicy.Policy" }, "reservationIds": { "description": "Capacity block groups, order matters", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.mk8s.v1.ReservationPolicy.Policy": { "default": "AUTO", "description": " - AUTO: 1) Will try to launch instance in any reservation_ids if provided.\n2) Will try to launch instance in any of the available capacity block.\n3) Will try to launch instance in PAYG if 1 \u0026 2 are not satisfied.\n - FORBID: The instance is launched only using on-demand (PAYG) capacity.\nNo attempt is made to find or use a Capacity Block.\nIt's an error to provide reservation_ids with policy = FORBID\n - STRICT: 1) Will try to launch the instance in Capacity Blocks from reservation_ids if provided.\n2) If reservation_ids are not provided will try to launch instance in suitable \u0026 available Capacity Block.\n3) Fail otherwise.", "enum": [ "AUTO", "FORBID", "STRICT" ], "type": "string" }, "nebius.mk8s.v1.ResourcesSpec": { "properties": { "platform": { "type": "string" }, "preset": { "type": "string" } }, "required": [ "platform" ], "type": "object" }, "nebius.mk8s.v1.SecurityGroup": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.mk8s.v1.SpotPricingPolicySpec": { "properties": { "id": { "description": "PricingPolicy ID used as the maximum agreed price for the preemptible VM.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.mk8s.v1.UpdateClusterRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata associated with the instance.\nIncludes ID of the instance to update." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1.ClusterSpec" } ], "description": "Updated specifications for the instance." } }, "required": [ "metadata" ], "type": "object" }, "nebius.mk8s.v1.UpdateNodeGroupRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupSpec" } }, "required": [ "metadata" ], "type": "object" }, "nebius.mk8s.v1.UpgradeNodeGroupRequest": { "properties": { "id": { "type": "string" }, "latestInfraVersion": { "description": "Upgrades to the latest infra version, which includes latest supported kubernetes patch version. Kubernetes minor version remain the\nsame.", "type": "object" } }, "required": [ "id" ], "type": "object" }, "nebius.mk8s.v1alpha1.AttachedFilesystemSpec": { "properties": { "attachMode": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.AttachedFilesystemSpec.AttachMode" }, "deviceName": { "type": "string" }, "existingFilesystem": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ExistingFilesystem" } }, "required": [ "attachMode", "deviceName" ], "type": "object" }, "nebius.mk8s.v1alpha1.AttachedFilesystemSpec.AttachMode": { "default": "UNSPECIFIED", "enum": [ "UNSPECIFIED", "READ_ONLY", "READ_WRITE" ], "type": "string" }, "nebius.mk8s.v1alpha1.Cluster": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ClusterSpec" }, "status": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ClusterStatus" } }, "type": "object" }, "nebius.mk8s.v1alpha1.ClusterControlPlaneVersion": { "properties": { "version": { "description": "Format of the version includes only MAJOR.MINOR, the same as can be passed to cluster creation API. For example \"1.31\".", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1alpha1.ClusterSpec": { "properties": { "controlPlane": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ControlPlaneSpec" }, "kubeNetwork": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.KubeNetworkSpec" } ], "description": "Defines kubernetes network configuration, like IP allocation." } }, "required": [ "controlPlane" ], "type": "object" }, "nebius.mk8s.v1alpha1.ClusterStatus": { "properties": { "controlPlane": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ControlPlaneStatus" }, "reconciling": { "description": "Show that changes are in flight", "type": "boolean" }, "state": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ClusterStatus.State" } }, "type": "object" }, "nebius.mk8s.v1alpha1.ClusterStatus.State": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "DELETING" ], "type": "string" }, "nebius.mk8s.v1alpha1.ConditionStatus": { "default": "CONDITION_STATUS_UNSPECIFIED", "enum": [ "CONDITION_STATUS_UNSPECIFIED", "TRUE", "FALSE", "UNKNOWN" ], "type": "string" }, "nebius.mk8s.v1alpha1.ControlPlaneEndpointsSpec": { "properties": { "publicEndpoint": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.PublicEndpointSpec" } ], "description": "PublicEndpointSpec is a specification of public endpoint for control plane." } }, "type": "object" }, "nebius.mk8s.v1alpha1.ControlPlaneSpec": { "properties": { "endpoints": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ControlPlaneEndpointsSpec" }, "etcdClusterSize": { "description": "Number of instances in etcd cluster.\n3 by default.\nControl plane with `etcd_cluster_size: 3` called \"Highly Available\" (\"HA\"), because it's Kubernetes API\nwill be available despite a failure of one control plane instance.", "format": "int64", "type": "string" }, "subnetId": { "description": "Subnet ID where control plane instances will be located.", "type": "string" }, "version": { "description": "Version is desired Kubernetes version of the cluster. For now only acceptable format is\n`MAJOR.MINOR` like \"1.31\". Option for patch version update will be added later.", "type": "string" } }, "required": [ "subnetId" ], "type": "object" }, "nebius.mk8s.v1alpha1.ControlPlaneStatus": { "properties": { "auth": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ControlPlaneStatusAuth" }, "endpoints": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ControlPlaneStatusEndpoints" }, "etcdClusterSize": { "description": "Number of instances in etcd cluster.", "format": "int64", "type": "string" }, "version": { "description": "Version have format `major.minor.patch-nebius-cp.n` like \"1.30.0-nebius-cp.3\".", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1alpha1.ControlPlaneStatusAuth": { "properties": { "clusterCaCertificate": { "type": "string" } }, "type": "object" }, "nebius.mk8s.v1alpha1.ControlPlaneStatusEndpoints": { "description": "Endpoints of Kubernetes control plane. Kubernetes API can be accessed at `https://endpoint/`.", "properties": { "privateEndpoint": { "description": "DNS name or IP address accessible from the user VPC.", "type": "string" }, "publicEndpoint": { "description": "DNS name or IP address accessible from the Internet.", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1alpha1.CreateClusterRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ClusterSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.mk8s.v1alpha1.CreateNodeGroupRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeGroupSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.mk8s.v1alpha1.DiskSpec": { "properties": { "blockSizeBytes": { "format": "int64", "type": "string" }, "sizeBytes": { "format": "int64", "type": "string" }, "sizeGibibytes": { "format": "int64", "type": "string" }, "sizeKibibytes": { "format": "int64", "type": "string" }, "sizeMebibytes": { "format": "int64", "type": "string" }, "type": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.DiskSpec.DiskType" } }, "type": "object" }, "nebius.mk8s.v1alpha1.DiskSpec.DiskType": { "default": "UNSPECIFIED", "description": "- NETWORK_SSD: the list of available types will be clarified later, it is not final version", "enum": [ "UNSPECIFIED", "NETWORK_SSD", "NETWORK_HDD", "NETWORK_SSD_IO_M3", "NETWORK_SSD_NON_REPLICATED" ], "type": "string" }, "nebius.mk8s.v1alpha1.ExistingFilesystem": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.mk8s.v1alpha1.GpuClusterSpec": { "properties": { "id": { "type": "string" } }, "type": "object" }, "nebius.mk8s.v1alpha1.GpuSettings": { "description": "GPU-related settings.", "properties": { "driversPreset": { "description": "Identifier of the predefined set of drivers included in the ComputeImage deployed on ComputeInstances that are part of the NodeGroup.\nSupported presets for different platform / k8s version combinations:\n- gpu-l40s-a, gpu-l40s-d, gpu-h100-sxm, gpu-h200-sxm:\n - k8s: 1.30 → \"cuda12\" (CUDA 12.4)\n - k8s: 1.31 → \"cuda12\" (CUDA 12.4), \"cuda12.4\", \"cuda12.8\"\n- gpu-b200-sxm:\n - k8s: 1.31 → \"cuda12\" (CUDA 12.8), \"cuda12.8\"\n- gpu-b200-sxm-a:\n - k8s: 1.31 → \"cuda12.8\"", "type": "string" } }, "required": [ "driversPreset" ], "type": "object" }, "nebius.mk8s.v1alpha1.KubeNetworkSpec": { "properties": { "serviceCidrs": { "description": "CIDR blocks for Service ClusterIP allocation.\nFor now, only one value is supported.\nMust be a valid CIDR block or prefix length.\nIn case of prefix length, certain CIDR is auto allocated.\nSpecified CIDR blocks will be reserved in Cluster.spec.control_plane.subnet_id to prevent address duplication.\nAllowed prefix length is from \"/12\" to \"/28\".\nEmpty value treated as [\"/16\"].", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.mk8s.v1alpha1.ListClusterControlPlaneVersionsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ClusterControlPlaneVersion" }, "type": "array" } }, "type": "object" }, "nebius.mk8s.v1alpha1.ListClustersResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.Cluster" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.mk8s.v1alpha1.ListNodeGroupsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeGroup" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.mk8s.v1alpha1.NetworkInterfaceTemplate": { "properties": { "publicIpAddress": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.PublicIPAddress" } ], "description": "Public IPv4 address associated with the interface." }, "subnetId": { "description": "Subnet ID that will be attached to a node cloud instance network interface.\nBy default control plane subnet_id used.\nSubnet should be located in the same network with control plane and have same parent ID as cluster.", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1alpha1.NodeAutoRepairCondition": { "properties": { "disabled": { "description": "When true, disables the default auto-repair condition rules.", "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ConditionStatus" } ], "description": "Node condition status." }, "timeout": { "description": "The duration after which the node is automatically repaired if the condition remains in the specified status.", "type": "string" }, "type": { "description": "Node condition type.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "nebius.mk8s.v1alpha1.NodeGroup": { "description": "NodeGroup represents Kubernetes node pool", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "the parent_id is an ID of Cluster" }, "spec": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeGroupSpec" }, "status": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeGroupStatus" } }, "type": "object" }, "nebius.mk8s.v1alpha1.NodeGroupAutoRepairSpec": { "properties": { "conditions": { "description": "Conditions that determine whether a node should be auto repaired.", "items": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeAutoRepairCondition" }, "type": "array" } }, "type": "object" }, "nebius.mk8s.v1alpha1.NodeGroupAutoscalingSpec": { "properties": { "maxNodeCount": { "format": "int64", "type": "string" }, "minNodeCount": { "format": "int64", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1alpha1.NodeGroupDeploymentStrategy": { "properties": { "drainTimeout": { "description": "DrainTimeout is the total amount of time that the service will spend on draining a node.\nBy default, node can be drained without any time limitations.\nNOTE: NodeDrainTimeout is different from `kubectl drain --timeout`", "type": "string" }, "maxSurge": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.PercentOrCount" } ], "description": "The maximum number of machines that can be scheduled above the\ndesired number of machines.\nValue can be an absolute number (ex: 5) or a percentage of\ndesired machines (ex: 10%).\nThis can not be 0 if MaxUnavailable is 0.\nAbsolute number is calculated from percentage by rounding up.\nDefaults to 1.\nExample: when this is set to 30%, the new MachineSet can be scaled\nup immediately when the rolling update starts, such that the total\nnumber of old and new machines do not exceed 130% of desired\nmachines. Once old machines have been killed, new MachineSet can\nbe scaled up further, ensuring that total number of machines running\nat any time during the update is at most 130% of desired machines." }, "maxUnavailable": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.PercentOrCount" } ], "description": "The maximum number of machines that can be unavailable during the update.\nValue can be an absolute number (ex: 5) or a percentage of desired\nmachines (ex: 10%).\nAbsolute number is calculated from percentage by rounding down.\nThis can not be 0 if MaxSurge is 0.\nDefaults to 0.\nExample: when this is set to 30%, the old MachineSet can be scaled\ndown to 70% of desired machines immediately when the rolling update\nstarts. Once new machines are ready, old MachineSet can be scaled\ndown further, followed by scaling up the new MachineSet, ensuring\nthat the total number of machines available at all times\nduring the update is at least 70% of desired machines." } }, "type": "object" }, "nebius.mk8s.v1alpha1.NodeGroupSpec": { "properties": { "autoRepair": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeGroupAutoRepairSpec" } ], "description": "Parameters for nodes auto repair." }, "autoscaling": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeGroupAutoscalingSpec" }, "fixedNodeCount": { "format": "int64", "type": "string" }, "strategy": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeGroupDeploymentStrategy" }, "template": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeTemplate" }, "version": { "description": "Version is desired Kubernetes version of the cluster. For now only acceptable format is\n`MAJOR.MINOR` like \"1.31\". Option for patch version update will be added later.\nBy default the cluster control plane MAJOR.MINOR version will be used.", "type": "string" } }, "required": [ "template" ], "type": "object" }, "nebius.mk8s.v1alpha1.NodeGroupStatus": { "properties": { "nodeCount": { "description": "Total number of nodes that are currently in the node group.\nBoth ready and not ready nodes are counted.", "format": "int64", "type": "string" }, "outdatedNodeCount": { "description": "Total number of nodes that has outdated node configuration.\nThese nodes will be replaced by new nodes with up-to-date configuration.", "format": "int64", "type": "string" }, "readyNodeCount": { "description": "Total number of nodes that successfully joined the cluster and are ready to serve workloads.\nBoth outdated and up-to-date nodes are counted.", "format": "int64", "type": "string" }, "reconciling": { "description": "Show that changes are in flight", "type": "boolean" }, "state": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeGroupStatus.State" }, "targetNodeCount": { "description": "Desired total number of nodes that should be in the node group.\nIt is either fixed_node_count or arbitrary number between min_node_count and max_node_count decided by autoscaler.", "format": "int64", "type": "string" }, "version": { "description": "Version have format `MAJOR.MINOR.PATCH-nebius-node.n` like \"1.30.0-nebius-node.10\".", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1alpha1.NodeGroupStatus.State": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "DELETING" ], "type": "string" }, "nebius.mk8s.v1alpha1.NodeMetadataTemplate": { "properties": { "labels": { "additionalProperties": { "type": "string" }, "description": "Labels will be propagated into nodes metadata.\nSystem labels containing \"kubernetes.io\" and \"k8s.io\" will not be propagated.\nOn update labels they will not be updated in nodes right away, only on node group update.", "type": "object" } }, "type": "object" }, "nebius.mk8s.v1alpha1.NodeTaint": { "description": "See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/", "properties": { "effect": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeTaint.Effect" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value", "effect" ], "type": "object" }, "nebius.mk8s.v1alpha1.NodeTaint.Effect": { "default": "EFFECT_UNSPECIFIED", "enum": [ "EFFECT_UNSPECIFIED", "NO_EXECUTE", "NO_SCHEDULE", "PREFER_NO_SCHEDULE" ], "type": "string" }, "nebius.mk8s.v1alpha1.NodeTemplate": { "properties": { "bootDisk": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.DiskSpec" }, "cloudInitUserData": { "description": "cloud-init user-data. Must contain at least one SSH key.", "type": "string" }, "filesystems": { "items": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.AttachedFilesystemSpec" }, "type": "array" }, "gpuCluster": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.GpuClusterSpec" }, "gpuSettings": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.GpuSettings" } ], "description": "GPU-related settings." }, "metadata": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeMetadataTemplate" }, "networkInterfaces": { "items": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NetworkInterfaceTemplate" }, "type": "array" }, "os": { "description": "OS version that will be used to create the boot disk of Compute Instances in the NodeGroup.\nSupported platform / k8s version / OS / driver presets combinations\n- gpu-l40s-a, gpu-l40s-d, gpu-h100-sxm, gpu-h200-sxm, cpu-e1, cpu-e2, cpu-d3:\n - drivers_preset: \"\"\n - k8s: 1.30 → \"ubuntu22.04\"\n - k8s: 1.31 → \"ubuntu22.04\" (default), \"ubuntu24.04\"\n- gpu-l40s-a, gpu-l40s-d, gpu-h100-sxm, gpu-h200-sxm:\n - drivers_preset: \"cuda12\" (CUDA 12.4)\n - k8s: 1.30, 1.31 → \"ubuntu22.04\"\n - drivers_preset: \"cuda12.4\"\n - k8s: 1.31 → \"ubuntu22.04\"\n - drivers_preset: \"cuda12.8\"\n - k8s: 1.31 → \"ubuntu24.04\"\n- gpu-b200-sxm:\n - drivers_preset: \"\"\n - k8s: 1.30, 1.31 → \"ubuntu24.04\"\n - drivers_preset: \"cuda12\" (CUDA 12.8)\n - k8s: 1.30, 1.31 → \"ubuntu24.04\"\n - drivers_preset: \"cuda12.8\"\n - k8s: 1.31 → \"ubuntu24.04\"\n- gpu-b200-sxm-a:\n - drivers_preset: \"\"\n - k8s: 1.31 → \"ubuntu24.04\"\n - drivers_preset: \"cuda12.8\"\n - k8s: 1.31 → \"ubuntu24.04\"", "type": "string" }, "preemptible": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.PreemptibleSpec" } ], "description": "Configures whether the nodes in the group are preemptible.\nSet to empty value to enable preemptible nodes." }, "resources": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ResourcesSpec" }, "serviceAccountId": { "description": "the Nebius service account whose credentials will be available on the nodes of the group. With these credentials, it is possible to\nmake `nebius` CLI or public API requests from the nodes without the need for extra authentication. This service account is also used to\nmake requests to container registry.\n\n`resource.serviceaccount.issueAccessToken` permission is required to use this field.", "type": "string" }, "taints": { "items": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeTaint" }, "type": "array" } }, "required": [ "resources" ], "type": "object" }, "nebius.mk8s.v1alpha1.PercentOrCount": { "properties": { "count": { "format": "int64", "type": "string" }, "percent": { "format": "int64", "type": "string" } }, "type": "object" }, "nebius.mk8s.v1alpha1.PreemptibleSpec": { "type": "object" }, "nebius.mk8s.v1alpha1.PublicEndpointSpec": { "type": "object" }, "nebius.mk8s.v1alpha1.PublicIPAddress": { "description": "Describes a public IP address.", "type": "object" }, "nebius.mk8s.v1alpha1.ResourcesSpec": { "properties": { "platform": { "type": "string" }, "preset": { "type": "string" } }, "required": [ "platform" ], "type": "object" }, "nebius.mk8s.v1alpha1.UpdateClusterRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata associated with the instance.\nIncludes ID of the instance to update." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ClusterSpec" } ], "description": "Updated specifications for the instance." } }, "required": [ "metadata" ], "type": "object" }, "nebius.mk8s.v1alpha1.UpdateNodeGroupRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeGroupSpec" } }, "required": [ "metadata" ], "type": "object" }, "nebius.mk8s.v1alpha1.UpgradeNodeGroupRequest": { "properties": { "id": { "type": "string" }, "latestInfraVersion": { "description": "Upgrades to the latest infra version, which includes latest supported kubernetes patch version. Kubernetes minor version remain the\nsame.", "type": "object" } }, "required": [ "id" ], "type": "object" }, "nebius.msp.mlflow.v1alpha1.Cluster": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.msp.mlflow.v1alpha1.ClusterSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.mlflow.v1alpha1.MlflowClusterStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.msp.mlflow.v1alpha1.ClusterSpec": { "description": "Cluster specification", "properties": { "adminPassword": { "description": "MLflow admin password.", "type": "string" }, "adminUsername": { "description": "MLflow admin username.", "type": "string" }, "description": { "description": "Description of the cluster.", "type": "string" }, "networkId": { "description": "ID of the vpc network.", "type": "string" }, "publicAccess": { "description": "Either make cluster public accessible or accessible only via private VPC.", "type": "boolean" }, "serviceAccountId": { "description": "Id of the service account that will be used to access S3 bucket (and create one if not provided).", "type": "string" }, "size": { "description": "Size defines how much resources will be allocated to mlflow\nSee supported sizes in the documentation. Default size is the smallest available in the region.", "type": "string" }, "storageBucketName": { "description": "Name of the Nebius S3 bucket for MLflow artifacts. If not provided, will be created under the same parent.", "type": "string" } }, "required": [ "adminUsername", "adminPassword", "serviceAccountId", "networkId" ], "type": "object" }, "nebius.msp.mlflow.v1alpha1.CreateClusterRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata associated with the new cluster. Must include parent_id in which we create the cluster." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.mlflow.v1alpha1.ClusterSpec" } ], "description": "Specification for the new cluster." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.msp.mlflow.v1alpha1.Endpoints": { "properties": { "private": { "description": "Private endpoint", "type": "string" }, "public": { "description": "Public endpoint", "type": "string" } }, "type": "object" }, "nebius.msp.mlflow.v1alpha1.ListClustersResponse": { "properties": { "items": { "description": "List of clusters.", "items": { "$ref": "#/components/schemas/nebius.msp.mlflow.v1alpha1.Cluster" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.msp.mlflow.v1alpha1.MlflowClusterStatus": { "properties": { "effectiveStorageBucketName": { "description": "Name of the Nebius S3 bucket for MLflow artifacts.", "type": "string" }, "experimentsCount": { "description": "Count of experiments in the MLflow cluster", "format": "int64", "type": "integer" }, "mlflowVersion": { "description": "MLflow version", "type": "string" }, "phase": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.v1alpha1.ClusterStatus.Phase" } ], "description": "Current phase of the cluster." }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.v1alpha1.ClusterStatus.State" } ], "description": "State reflects substatus of the phase to define whether it's healthy or not." }, "trackingEndpoint": { "description": "Tracking endpoint url.\nWill be removed soon in favor of private_tracking_endpoint and public_tracking_endpoint.", "type": "string" }, "trackingEndpoints": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.mlflow.v1alpha1.Endpoints" } ], "description": "Public and private tracking endpoints" } }, "type": "object" }, "nebius.msp.mlflow.v1alpha1.StartClusterRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.msp.mlflow.v1alpha1.StopClusterRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.msp.postgresql.v1alpha1.Backup": { "properties": { "creationFinish": { "description": "Creation finish timestamp.", "format": "date-time", "type": "string" }, "creationStart": { "description": "Creation start timestamp.", "format": "date-time", "type": "string" }, "id": { "description": "Required. ID of the backup.", "type": "string" }, "onDemand": { "description": "Is the backup an on-demand manual backup.", "type": "boolean" }, "sizeBytes": { "description": "Size of the backup in bytes.", "format": "int64", "type": "string" }, "sourceClusterId": { "description": "ID of the PostgreSQL cluster that the backup was created for.", "type": "string" }, "sourceClusterName": { "description": "Name of the PostgreSQL cluster that the backup was created for.", "type": "string" }, "sourceClusterVisible": { "description": "Is PostgreSQL cluster that the backup was created for visible.", "type": "boolean" } }, "type": "object" }, "nebius.msp.postgresql.v1alpha1.BackupSpec": { "properties": { "backupWindowStart": { "description": "Backup window start in \"HH:MM:SS\" format (UTC Time)", "type": "string" }, "retentionPolicy": { "description": "Retention policy to be used for backups and WALs (i.e. '7d')", "type": "string" } }, "type": "object" }, "nebius.msp.postgresql.v1alpha1.BootstrapSpec": { "properties": { "dbName": { "description": "Name of the PostgreSQL database. 1-63 characters long.", "type": "string" }, "userName": { "description": "Name of the bootstrap PostgreSQL user.", "type": "string" }, "userPassword": { "description": "Password of the bootstrap PostgreSQL user.", "type": "string" } }, "required": [ "userName", "dbName" ], "type": "object" }, "nebius.msp.postgresql.v1alpha1.Cluster": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.ClusterSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.ClusterStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.msp.postgresql.v1alpha1.ClusterSpec": { "properties": { "backup": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.BackupSpec" }, "bootstrap": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.BootstrapSpec" }, "config": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.ConfigSpec" }, "description": { "description": "Description of the PostgreSQL cluster.", "type": "string" }, "networkId": { "description": "Network ID in which the cluster is created.", "type": "string" } }, "required": [ "networkId", "config", "bootstrap" ], "type": "object" }, "nebius.msp.postgresql.v1alpha1.ClusterStatus": { "properties": { "connectionEndpoints": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.Endpoints" } ], "description": "Connection endpoints of the PostgreSQL cluster." }, "phase": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.v1alpha1.ClusterStatus.Phase" } ], "description": "Current phase of the cluster." }, "presetDetails": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.v1alpha1.resource.PresetDetails" } ], "description": "Cluster resource preset details" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.v1alpha1.ClusterStatus.State" } ], "description": "State reflects substatus of the phase to define whether it's healthy or not." } }, "type": "object" }, "nebius.msp.postgresql.v1alpha1.ConfigSpec": { "properties": { "poolerConfig": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.ConnectionPoolerConfig" } ], "description": "Configuration of the connection pooler." }, "postgresqlConfig16": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.config.PostgresqlConfig16" } ], "description": "Configuration parameters for postgres" }, "publicAccess": { "description": "Either make cluster public accessible or accessible only via private VPC.", "type": "boolean" }, "template": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.TemplateSpec" } ], "description": "Resources allocated to PostgreSQL hosts." }, "version": { "description": "Version of PostgreSQL used in the cluster.\nPossible values: `16`", "type": "string" } }, "required": [ "version", "template" ], "type": "object" }, "nebius.msp.postgresql.v1alpha1.ConnectionPoolerConfig": { "properties": { "maxPoolSize": { "description": "Maximum number of connections in the pool for a single user/database pair.", "format": "int64", "type": "string" }, "poolingMode": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.ConnectionPoolerConfig.PoolingMode" } ], "description": "Mode that the connection pooler is working in." } }, "type": "object" }, "nebius.msp.postgresql.v1alpha1.ConnectionPoolerConfig.PoolingMode": { "default": "POOLING_MODE_UNSPECIFIED", "description": " - SESSION: Session pooling mode.\n - TRANSACTION: Transaction pooling mode.", "enum": [ "POOLING_MODE_UNSPECIFIED", "SESSION", "TRANSACTION" ], "type": "string" }, "nebius.msp.postgresql.v1alpha1.CreateBackupRequest": { "properties": { "clusterId": { "description": "ID of the PostgreSQL cluster that holds backup.", "type": "string" } }, "required": [ "clusterId" ], "type": "object" }, "nebius.msp.postgresql.v1alpha1.CreateClusterRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata associated with the new cluster." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.ClusterSpec" } ], "description": "Specification for the new cluster." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.msp.postgresql.v1alpha1.Endpoints": { "properties": { "privateReadOnly": { "description": "Read only endpoint of the PostgreSQL cluster accessible from the private VPC.", "readOnly": true, "type": "string" }, "privateReadWrite": { "description": "Read write endpoint of the PostgreSQL cluster accessible from the private VPC.", "readOnly": true, "type": "string" }, "publicReadOnly": { "description": "Read only endpoint of the PostgreSQL cluster accessible from the internet.", "readOnly": true, "type": "string" }, "publicReadWrite": { "description": "Read write endpoint of the PostgreSQL cluster accessible from the internet.", "readOnly": true, "type": "string" } }, "type": "object" }, "nebius.msp.postgresql.v1alpha1.ListBackupsResponse": { "properties": { "backups": { "description": "List of backups.", "items": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.Backup" }, "type": "array" } }, "type": "object" }, "nebius.msp.postgresql.v1alpha1.ListClustersResponse": { "properties": { "clusters": { "description": "List of PostgreSQL Cluster resources.", "items": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.Cluster" }, "type": "array" }, "nextPageToken": { "description": "This token allows you to get the next page of results for list requests. If the number of results\nis larger than [ListClustersRequest.page_size], use the [next_page_token] as the value\nfor the [ListClustersRequest.page_token] parameter in the next list request. Each subsequent\nlist request will have its own [next_page_token] to continue paging through the results.", "type": "string" } }, "type": "object" }, "nebius.msp.postgresql.v1alpha1.RestoreClusterRequest": { "properties": { "backupId": { "description": "ID of the backup to restore from.", "type": "string" }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata associated with the new cluster." }, "recoveryTime": { "description": "Timestamp for point in time recovery.", "format": "date-time", "type": "string" }, "sourceClusterId": { "description": "ID of the PostgreSQL cluster to restore from.", "type": "string" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.ClusterSpec" } ], "description": "Specification for the new cluster." } }, "required": [ "metadata", "spec", "backupId", "sourceClusterId" ], "type": "object" }, "nebius.msp.postgresql.v1alpha1.StartClusterRequest": { "properties": { "id": { "description": "ID of the PostgreSQL Cluster resource to resume.\nTo get the cluster ID use a [ClusterService.List] request.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.msp.postgresql.v1alpha1.StopClusterRequest": { "properties": { "id": { "description": "ID of the PostgreSQL Cluster resource to pause.\nTo get the cluster ID use a [ClusterService.List] request.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.msp.postgresql.v1alpha1.TemplateSpec": { "properties": { "disk": { "$ref": "#/components/schemas/nebius.msp.v1alpha1.resource.DiskSpec" }, "hosts": { "$ref": "#/components/schemas/nebius.msp.v1alpha1.resource.HostSpec" }, "resources": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.v1alpha1.resource.ResourcesSpec" } ], "description": "reduced msp.v1alpha1.resource.TemplateSpec" } }, "required": [ "resources", "hosts", "disk" ], "type": "object" }, "nebius.msp.postgresql.v1alpha1.UpdateClusterRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata associated with the cluster. Must include id of the cluster we are going to update." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.ClusterSpec" } ], "description": "Updated specification for the cluster." } }, "required": [ "metadata" ], "type": "object" }, "nebius.msp.postgresql.v1alpha1.config.PostgresqlConfig16": { "properties": { "autovacuumAnalyzeScaleFactor": { "format": "double", "type": "number" }, "autovacuumNaptime": { "description": "in seconds.", "format": "int64", "type": "string" }, "autovacuumVacuumCostDelay": { "description": "in milliseconds.", "format": "int64", "type": "string" }, "autovacuumVacuumCostLimit": { "format": "int64", "type": "string" }, "autovacuumVacuumScaleFactor": { "format": "double", "type": "number" }, "autovacuumWorkMem": { "description": "in kilobytes.", "format": "int64", "type": "string" }, "defaultTransactionReadOnly": { "type": "boolean" }, "idleInTransactionSessionTimeout": { "description": "in milliseconds.", "format": "int64", "type": "string" }, "maxConnections": { "format": "int64", "type": "string" }, "searchPath": { "type": "string" }, "sharedBuffers": { "description": "in kilobytes.", "format": "int64", "type": "string" }, "statementTimeout": { "description": "in milliseconds.", "format": "int64", "type": "string" } }, "type": "object" }, "nebius.msp.v1alpha1.ClusterStatus.Phase": { "default": "PHASE_UNSPECIFIED", "enum": [ "PHASE_UNSPECIFIED", "PHASE_PROVISIONING", "PHASE_RUNNING", "PHASE_UPDATING", "PHASE_DELETING", "PHASE_DELETED", "PHASE_PURGING", "PHASE_STOPPING", "PHASE_RESUMING" ], "type": "string" }, "nebius.msp.v1alpha1.ClusterStatus.State": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "STATE_IN_PROGRESS", "STATE_FINISHED", "STATE_ERROR", "STATE_DEGRADED", "STATE_SCHEDULED" ], "type": "string" }, "nebius.msp.v1alpha1.resource.DiskSpec": { "properties": { "sizeGibibytes": { "format": "int64", "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "sizeGibibytes" ], "type": "object" }, "nebius.msp.v1alpha1.resource.HostSpec": { "properties": { "count": { "format": "int64", "type": "string" } }, "required": [ "count" ], "type": "object" }, "nebius.msp.v1alpha1.resource.PresetDetails": { "properties": { "cpuCount": { "format": "int32", "type": "integer" }, "gpuCount": { "format": "int32", "type": "integer" }, "memoryGibibytes": { "format": "int64", "type": "string" } }, "type": "object" }, "nebius.msp.v1alpha1.resource.ResourcesSpec": { "properties": { "platform": { "type": "string" }, "preset": { "type": "string" } }, "required": [ "platform", "preset" ], "type": "object" }, "nebius.mysterybox.v1.CreateSecretRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretSpec" } }, "type": "object" }, "nebius.mysterybox.v1.CreateSecretVersionRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretVersionSpec" } }, "type": "object" }, "nebius.mysterybox.v1.ListSecretVersionsResponse": { "properties": { "items": { "description": "List of secret versions in the specified container, without its Payload.", "items": { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretVersion" }, "type": "array" }, "nextPageToken": { "description": "This token allows you to get the next page of results for list requests. If the number\nof results is greater than the specified [ListSecretVersionsRequest.page_size], use\nthe [next_page_token] as the value for the [ListSecretVersionsRequest.page_token] query parameter\nin the next list request. Each subsequent list request will have its own\n[next_page_token] to continue paging through the results.", "type": "string" } }, "type": "object" }, "nebius.mysterybox.v1.ListSecretsResponse": { "properties": { "items": { "description": "List of secrets in the specified container, without its Payload.", "items": { "$ref": "#/components/schemas/nebius.mysterybox.v1.Secret" }, "type": "array" }, "nextPageToken": { "description": "This token allows you to get the next page of results for list requests. If the number\nof results is greater than the specified [ListSecretsRequest.page_size], use\nthe [next_page_token] as the value for the [ListSecretsRequest.page_token] query parameter\nin the next list request. Each subsequent list request will have its own\n[next_page_token] to continue paging through the results.", "type": "string" } }, "type": "object" }, "nebius.mysterybox.v1.Payload": { "description": "Represents the secret's content as key-value pair.", "properties": { "binaryValue": { "description": "The binary data to encrypt and store in the version of the secret.", "format": "byte", "type": "string" }, "key": { "description": "Non-confidential key of the payload entry.", "type": "string" }, "stringValue": { "description": "The text data to encrypt and store in the version of the secret.", "type": "string" } }, "required": [ "key" ], "type": "object" }, "nebius.mysterybox.v1.Secret": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretSpec" } ], "description": "The specifications for creating a secret." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretStatus" } ], "description": "The status of the secret.", "readOnly": true } }, "type": "object" }, "nebius.mysterybox.v1.SecretPayload": { "properties": { "data": { "items": { "$ref": "#/components/schemas/nebius.mysterybox.v1.Payload" }, "type": "array" }, "versionId": { "description": "Secret's version related to returned payload.", "type": "string" } }, "type": "object" }, "nebius.mysterybox.v1.SecretPayloadEntry": { "properties": { "data": { "$ref": "#/components/schemas/nebius.mysterybox.v1.Payload" }, "versionId": { "description": "Secret's version related to returned payload.", "type": "string" } }, "type": "object" }, "nebius.mysterybox.v1.SecretSpec": { "properties": { "description": { "description": "Description of the secret.", "type": "string" }, "primaryVersionId": { "description": "Specifies the primary version of the secret to update its payload. This parameter should only be provided during update operations.", "type": "string" }, "secretVersion": { "allOf": [ { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretVersionSpec" } ], "description": "Secret's version specification, defines the secret version, including its payload. This parameter must be specified only during create\noperations." } }, "type": "object" }, "nebius.mysterybox.v1.SecretStatus": { "properties": { "deletedAt": { "description": "Time when user called soft delete method", "format": "date-time", "type": "string" }, "effectiveKmsKeyId": { "type": "string" }, "purgeAt": { "description": "Time when key should be totally deleted from DB", "format": "date-time", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretStatus.State" } ], "description": "State (ACTIVE, SCHEDULED_FOR_DELETION)" } }, "type": "object" }, "nebius.mysterybox.v1.SecretStatus.State": { "default": "STATE_UNSPECIFIED", "description": "- ACTIVE: Resource is active, ready for use\n - SCHEDULED_FOR_DELETION: Resource was marked as soft deleted", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "SCHEDULED_FOR_DELETION" ], "type": "string" }, "nebius.mysterybox.v1.SecretVersion": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretVersionSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretVersionStatus" } ], "description": "The status of the secret version.", "readOnly": true } }, "type": "object" }, "nebius.mysterybox.v1.SecretVersionSpec": { "properties": { "description": { "description": "Description of the version.", "type": "string" }, "payload": { "description": "Payload entries related to the version.", "items": { "$ref": "#/components/schemas/nebius.mysterybox.v1.Payload" }, "type": "array" }, "setPrimary": { "type": "boolean" } }, "type": "object" }, "nebius.mysterybox.v1.SecretVersionStatus": { "properties": { "deletedAt": { "description": "Time when user called soft delete method", "format": "date-time", "type": "string" }, "purgeAt": { "description": "Time when key should be totally deleted from DB", "format": "date-time", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretVersionStatus.State" } ], "description": "State (ACTIVE, SCHEDULED_FOR_DELETION)" } }, "type": "object" }, "nebius.mysterybox.v1.SecretVersionStatus.State": { "default": "STATE_UNSPECIFIED", "description": "- ACTIVE: Resource is active, ready for use\n - SCHEDULED_FOR_DELETION: Resource was marked as soft deleted", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "SCHEDULED_FOR_DELETION" ], "type": "string" }, "nebius.mysterybox.v1.UndeleteSecretRequest": { "properties": { "id": { "description": "ID of the secret version to soft-delete.", "type": "string" }, "name": { "description": "A new Secret name in case the current one is already in use.\nEmpty value in name field means \"use original name for undeleted Secret\".\nUndelete will fail if a Secret with the same name already exists.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.mysterybox.v1.UndeleteSecretVersionRequest": { "properties": { "id": { "description": "ID of the secret version to soft-delete.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.mysterybox.v1.UpdateSecretRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretSpec" } }, "type": "object" }, "nebius.quotas.v1.CreateQuotaAllowanceRequest": { "description": "Request to create a quota allowance with the specified spec and metadata.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.quotas.v1.QuotaAllowanceSpec" } }, "required": [ "spec" ], "type": "object" }, "nebius.quotas.v1.ListQuotaAllowancesResponse": { "description": "Response containing quota allowances and pagination token.", "properties": { "items": { "description": "List of quota allowances on this result page.", "items": { "$ref": "#/components/schemas/nebius.quotas.v1.QuotaAllowance" }, "type": "array" }, "nextPageToken": { "description": "Listing continuation token for the next page of results.", "type": "string" } }, "type": "object" }, "nebius.quotas.v1.QuotaAllowance": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.quotas.v1.QuotaAllowanceSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.quotas.v1.QuotaAllowanceStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.quotas.v1.QuotaAllowanceSpec": { "properties": { "limit": { "description": "Total amount of resources allocated.", "format": "uint64", "type": "string" }, "region": { "description": "Name of the region where the quota is allocated.\nExample: \"eu-north1\".", "type": "string" } }, "type": "object" }, "nebius.quotas.v1.QuotaAllowanceStatus": { "properties": { "description": { "description": "Human-readable description of the quota.\nExample: \"Total RAM across VMs\".", "type": "string" }, "service": { "description": "Service in which the quota is allocated.\nExample: \"mk8s\".", "type": "string" }, "serviceDescription": { "description": "Human-readable name of the service managing the quota.\nExample: \"Managed Kubernetes®\".", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.quotas.v1.QuotaAllowanceStatus.State" } ], "description": "Current state of the quota." }, "unit": { "description": "Quota unit.\nExample: \"byte\".", "type": "string" }, "usage": { "description": "Current quota usage.", "format": "uint64", "type": "string" }, "usagePercentage": { "description": "Current quota usage as a percentage.\nValues range from 0.0 to 1.0, representing 0% to 100%.\nValues can exceed 1.0 if usage exceeds the limit.\nExample: \"0.12\".", "type": "string" }, "usageState": { "allOf": [ { "$ref": "#/components/schemas/nebius.quotas.v1.QuotaAllowanceStatus.UsageState" } ], "description": "Current state of the quota usage." } }, "type": "object" }, "nebius.quotas.v1.QuotaAllowanceStatus.State": { "default": "STATE_UNSPECIFIED", "description": " - STATE_PROVISIONING: Quota is being allocated; the process can take up to several minutes.\n - STATE_ACTIVE: Quota is allocated and can be used.\n - STATE_FROZEN: Quota is allocated but cannot be used any longer\n - STATE_DELETED: Quota has been removed and is no longer allocated.", "enum": [ "STATE_UNSPECIFIED", "STATE_PROVISIONING", "STATE_ACTIVE", "STATE_FROZEN", "STATE_DELETED" ], "type": "string" }, "nebius.quotas.v1.QuotaAllowanceStatus.UsageState": { "default": "USAGE_STATE_UNSPECIFIED", "description": "- USAGE_STATE_USED: Quota is actively in use.\n - USAGE_STATE_NOT_USED: Quota is not currently in use.\n - USAGE_STATE_UNKNOWN: Quota region is unreachable, the current usage is therefore unknown.\nPlease, retry the request later.\n - USAGE_STATE_NOT_APPLICABLE: Quota usage is not applicable", "enum": [ "USAGE_STATE_UNSPECIFIED", "USAGE_STATE_USED", "USAGE_STATE_NOT_USED", "USAGE_STATE_UNKNOWN", "USAGE_STATE_NOT_APPLICABLE" ], "type": "string" }, "nebius.quotas.v1.UpdateQuotaAllowanceRequest": { "description": "Request to update an existing quota allowance using its metadata and the new spec.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.quotas.v1.QuotaAllowanceSpec" } }, "required": [ "spec" ], "type": "object" }, "nebius.registry.v1.Artifact": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "digest": { "type": "string" }, "id": { "type": "string" }, "mediaType": { "type": "string" }, "name": { "type": "string" }, "size": { "format": "int64", "type": "string" }, "status": { "$ref": "#/components/schemas/nebius.registry.v1.Artifact.Status" }, "tags": { "description": "List of tags associated with the artifact. Example: [\"v1.0\", \"latest\", \"stable\"].", "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/nebius.registry.v1.Artifact.Type" }, "updatedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "nebius.registry.v1.Artifact.Status": { "default": "STATUS_UNSPECIFIED", "enum": [ "STATUS_UNSPECIFIED", "ACTIVE", "DELETING" ], "type": "string" }, "nebius.registry.v1.Artifact.Type": { "default": "BLOB", "enum": [ "BLOB", "MANIFEST", "DEB_PACKAGE", "MANIFEST_LIST", "RELEASE_INDEX", "PACKAGE_INDEX", "GZIPPED_PACKAGE_INDEX" ], "type": "string" }, "nebius.registry.v1.CreateRegistryRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.registry.v1.RegistrySpec" } }, "type": "object" }, "nebius.registry.v1.ListArtifactsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.registry.v1.Artifact" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.registry.v1.ListRegistriesResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.registry.v1.Registry" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.registry.v1.Registry": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "This is metadata about the resource, such as its id, name, labels, etc.\nThis contains fields that may be updated both by the end user and the system." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.registry.v1.RegistrySpec" } ], "description": "This is defined by the user and describes the desired state of system.\nFill this in when creating or updating an object." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.registry.v1.RegistryStatus" } ], "description": "This is filled in by the server and reports the current state of the system.", "readOnly": true } }, "type": "object" }, "nebius.registry.v1.RegistrySpec": { "properties": { "description": { "type": "string" }, "imagesCount": { "description": "Registry.Type type = 2;", "format": "int32", "readOnly": true, "type": "integer" } }, "type": "object" }, "nebius.registry.v1.RegistryStatus": { "properties": { "imagesCount": { "format": "int32", "type": "integer" }, "registryFqdn": { "description": "regional fqdn \"cr.eu-north1.nebius.cloud\"", "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.registry.v1.RegistryStatus.State" } }, "type": "object" }, "nebius.registry.v1.RegistryStatus.State": { "default": "CREATING", "enum": [ "CREATING", "ACTIVE", "DELETING", "SUSPENDED" ], "type": "string" }, "nebius.registry.v1.UpdateRegistryRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.registry.v1.RegistrySpec" } }, "type": "object" }, "nebius.storage.v1.Bucket": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1.BucketSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.BucketStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.storage.v1.BucketCounters": { "properties": { "counters": { "$ref": "#/components/schemas/nebius.storage.v1.CurrentBucketCounters" }, "nonCurrentCounters": { "$ref": "#/components/schemas/nebius.storage.v1.NonCurrentBucketCounters" }, "storageClass": { "$ref": "#/components/schemas/nebius.storage.v1.StorageClass" } }, "type": "object" }, "nebius.storage.v1.BucketPolicy": { "description": "Bucket policy specifies granular permissions for a bucket.", "properties": { "rules": { "description": "Rule specifies which role must be given to a subject to access a set of objects with given\nprefixes or a whole bucket.", "items": { "$ref": "#/components/schemas/nebius.storage.v1.BucketPolicy.Rule" }, "type": "array" } }, "type": "object" }, "nebius.storage.v1.BucketPolicy.Rule": { "properties": { "anonymous": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.BucketPolicy.Rule.AnonymousAccess" } ], "description": "Enable anonymous access. Only read-only roles are allowed in anonymous mode." }, "groupId": { "description": "Group ID to grant access to.", "type": "string" }, "paths": { "description": "A list of paths each of which is either a full object key or a prefix ending with a\nsingle \"*\" wildcard character. A rule is only applied to objects matching any of paths.\nIf there is a path equal to \"*\", a rule applies to a whole bucket.", "items": { "type": "string" }, "type": "array" }, "roles": { "description": "A set of roles which a subject will have. All `storage.*` roles are supported.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.storage.v1.BucketPolicy.Rule.AnonymousAccess": { "type": "object" }, "nebius.storage.v1.BucketSpec": { "properties": { "bucketPolicy": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.BucketPolicy" } ], "description": "Bucket policy specifies granular permissions for a bucket." }, "cors": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.CORSConfiguration" } ], "description": "Cross-origin resource sharing configuration." }, "defaultStorageClass": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.StorageClass" } ], "description": "Storage class to use by default for uploads to the bucket. It may be overridden by `x-amz-storage-class` header.\nIf not set - STANDARD is used as a default storage class." }, "filesystemBucket": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.BucketSpec.FilesystemBucketType" } ], "description": "Bucket that uses the existing client's compute filesystem." }, "forceStorageClass": { "description": "Flag to force usage of default_storage_class, ignoring `x-amz-storage-class` header.", "type": "boolean" }, "lifecycleConfiguration": { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleConfiguration" }, "maxSizeBytes": { "description": "Maximum bucket size.\nZero means unlimited.\nActual limit can be lower if customer doesn't have enough quota.\nReal bucket size can go a little higher if customer writes too fast.", "format": "int64", "type": "string" }, "objectAuditLogging": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.BucketSpec.ObjectAuditLogging" } ], "description": "Object audit logging specifies which requests must be logged - none, all or mutational only." }, "versioningPolicy": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.VersioningPolicy" } ], "description": "Supports transitions:\n * disabled -\u003e enabled\n * disabled -\u003e suspended\n * enabled \u003c-\u003e suspended" } }, "type": "object" }, "nebius.storage.v1.BucketSpec.FilesystemBucketType": { "properties": { "directory": { "description": "Directory within the filesystem that will be used as a root for the bucket.\nIf not empty, it must be an absolute normalized path (no ., .., or doubled /).\nEmpty value means that the bucket will be mounted at the filesystem root (/).", "type": "string" }, "directoryMode": { "description": "Linux permissions that will be applied for uploaded directories.\nPermissions are specified in octal format (one to four octal numbers), e.g. \"644\" or \"755\".\nThe default value is 755 (rwxr-xr-x).", "type": "string" }, "fileMode": { "description": "Linux permissions that will be applied for uploaded files.\nPermissions are specified in octal format (one to four octal numbers), e.g. \"644\" or \"755\".\nThe default value is 644 (rw-r--r--).", "type": "string" }, "filesystemId": { "description": "Identifier of filesystem to be exposed via Object Storage API.", "type": "string" }, "gid": { "description": "GID that will be used for write operations to the filesystem.\nBy default, root user (UID=0, GID=0) is used.", "format": "int64", "type": "integer" }, "uid": { "description": "UID that will be used for write operations to the filesystem.\nBy default, root user (UID=0, GID=0) is used.", "format": "int64", "type": "integer" } }, "required": [ "filesystemId" ], "type": "object" }, "nebius.storage.v1.BucketSpec.ObjectAuditLogging": { "default": "OBJECT_AUDIT_LOGGING_UNSPECIFIED", "description": " - NONE: Logging is disabled.\n - MUTATE_ONLY: Logging enabled only for mutating requests.\n - ALL: Logging enabled for all requests.", "enum": [ "OBJECT_AUDIT_LOGGING_UNSPECIFIED", "NONE", "MUTATE_ONLY", "ALL" ], "type": "string" }, "nebius.storage.v1.BucketStatus": { "properties": { "anonymousAccessEnabled": { "description": "Indicator flag showing whether the bucket has any BucketPolicy rule\nthat grants anonymous access to any object, prefix, or the entire bucket.", "type": "boolean" }, "bucketType": { "$ref": "#/components/schemas/nebius.storage.v1.BucketStatus.BucketType" }, "counters": { "items": { "$ref": "#/components/schemas/nebius.storage.v1.BucketCounters" }, "type": "array" }, "deletedAt": { "description": "The time when the bucket was deleted (or scheduled for deletion).\nIt resets to null if the bucket is undeleted.", "format": "date-time", "type": "string" }, "domainName": { "description": "The domain of the endpoint where the bucket can be accessed. It omits the scheme (HTTPS) and the port (443)\nand contains only the FQDN address.", "type": "string" }, "insecureEndpoint": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.InsecureEndpoint" } ], "description": "Insecure endpoint mode shows whether plain HTTP (without TLS) is forbidden, allowed for traffic from the\nsame region or allowed from everywhere." }, "purgeAt": { "description": "The time when the bucket will be automatically purged in case it was soft-deleted.", "format": "date-time", "type": "string" }, "region": { "description": "The name of the region where the bucket is located for use with S3 clients, i.e. \"eu-west1\".", "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.storage.v1.BucketStatus.State" }, "suspensionState": { "$ref": "#/components/schemas/nebius.storage.v1.BucketStatus.SuspensionState" } }, "type": "object" }, "nebius.storage.v1.BucketStatus.BucketType": { "default": "BUCKET_TYPE_UNSPECIFIED", "description": "BucketType is a type of the bucket.\n\n - REGULAR: Regular object storage bucket.\n - FILESYSTEM: Object storage bucket that is mounted to an existing compute filesystem.", "enum": [ "BUCKET_TYPE_UNSPECIFIED", "REGULAR", "FILESYSTEM" ], "type": "string" }, "nebius.storage.v1.BucketStatus.State": { "default": "STATE_UNSPECIFIED", "description": " - CREATING: Bucket is under creation and cannot be used yet.\n - ACTIVE: Bucket is active and ready for usage.\n - UPDATING: Bucket is being updated.\nIt can be used, but some settings are being modified and you can observe their inconsistency.\n - SCHEDULED_FOR_DELETION: Bucket is scheduled for deletion.\nIt cannot be used in s3 api anymore.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "SCHEDULED_FOR_DELETION" ], "type": "string" }, "nebius.storage.v1.BucketStatus.SuspensionState": { "default": "SUSPENSION_STATE_UNSPECIFIED", "enum": [ "SUSPENSION_STATE_UNSPECIFIED", "NOT_SUSPENDED", "SUSPENDED" ], "type": "string" }, "nebius.storage.v1.CORSConfiguration": { "description": "Cross-origin resource sharing (CORS) configuration.", "properties": { "rules": { "description": "CORS rules.", "items": { "$ref": "#/components/schemas/nebius.storage.v1.CORSRule" }, "type": "array" } }, "type": "object" }, "nebius.storage.v1.CORSRule": { "properties": { "allowedHeaders": { "description": "Headers that are allowed in a preflight request through the Access-Control-Request-Headers header", "items": { "type": "string" }, "type": "array" }, "allowedMethods": { "description": "HTTP methods CORS is allowed for: GET, PUT, POST, DELETE, HEAD.", "items": { "required": [ "allowed_methods" ], "type": "string" }, "type": "array" }, "allowedOrigins": { "description": "The origins that you want to allow cross-domain requests from. Single wildcard * is allowed.", "items": { "required": [ "allowed_origins" ], "type": "string" }, "type": "array" }, "exposeHeaders": { "description": "Headers in the response that you want customers to be able to access from their applications.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Optional rule identifier.", "type": "string" }, "maxAgeSeconds": { "description": "Time in seconds that your browser can cache the response for a preflight request as identified by the resource.", "format": "int32", "type": "integer" } }, "type": "object" }, "nebius.storage.v1.CreateBucketRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1.BucketSpec" } }, "required": [ "metadata" ], "type": "object" }, "nebius.storage.v1.CreateInventoryRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1.InventorySpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.storage.v1.CreateTransferRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1.TransferSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.storage.v1.CurrentBucketCounters": { "properties": { "inflightPartsQuantity": { "format": "int64", "type": "string" }, "inflightPartsSize": { "format": "int64", "type": "string" }, "multipartObjectsQuantity": { "format": "int64", "type": "string" }, "multipartObjectsSize": { "format": "int64", "type": "string" }, "multipartUploadsQuantity": { "format": "int64", "type": "string" }, "simpleObjectsQuantity": { "format": "int64", "type": "string" }, "simpleObjectsSize": { "format": "int64", "type": "string" } }, "type": "object" }, "nebius.storage.v1.GetIterationHistoryResponse": { "properties": { "iterations": { "description": "List of transfer iterations sorted from newest to oldest.", "items": { "$ref": "#/components/schemas/nebius.storage.v1.TransferIteration" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.storage.v1.InsecureEndpoint": { "properties": { "mode": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.InsecureEndpoint.Mode" } ], "description": "Determines where the plain HTTP endpoint is available." } }, "type": "object" }, "nebius.storage.v1.InsecureEndpoint.Mode": { "default": "MODE_UNSPECIFIED", "description": "Defines where the plain HTTP endpoint is available.\n\n - DISABLED: Plain HTTP access is disabled.\n - REGION_LOCAL: Plain HTTP access is available only from the same region.\n - ALL: Plain HTTP access is available from any network.", "enum": [ "MODE_UNSPECIFIED", "DISABLED", "REGION_LOCAL", "ALL" ], "type": "string" }, "nebius.storage.v1.Inventory": { "description": "Inventory configures periodic generation of an object listing for a bucket.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1.InventorySpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.InventoryStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.storage.v1.InventorySpec": { "description": "Desired configuration of an inventory.", "properties": { "destinationBucketId": { "description": "ID of the destination bucket.", "type": "string" }, "destinationPrefix": { "description": "Prefix under which bucket inventory will be stored in the destination bucket.", "type": "string" }, "enabled": { "description": "Enable or disable inventory generation.", "type": "boolean" }, "noncurrentVersions": { "description": "Include noncurrent versions in inventory if set to true.", "type": "boolean" }, "optionalFields": { "description": "Optional fields to include in inventory.", "items": { "$ref": "#/components/schemas/nebius.storage.v1.InventorySpec.OptionalField" }, "type": "array" }, "outputFormat": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.InventorySpec.OutputFormat" } ], "description": "Inventory format." }, "schedule": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.InventorySpec.Schedule" } ], "description": "How often to generate the inventory." }, "sourcePrefix": { "description": "Prefix to filter objects in the source bucket.", "type": "string" } }, "required": [ "destinationBucketId", "outputFormat", "schedule" ], "type": "object" }, "nebius.storage.v1.InventorySpec.OptionalField": { "default": "OPTIONAL_FIELD_UNSPECIFIED", "description": " - LAST_ACCESS: Timestamp of the last access.\n - CHECKSUM_ALGORITHMS: Checksum algorithms used.\n - INTELLIGENT_TIER: Current intelligent tier (for Intelligent Storage Class).\n - IS_MULTIPART_UPLOAD: True for multipart uploads, false for simple objects.\n - LIFECYCLE_EXPIRATION: Timestamp of lifecycle expiration.\n - TAGS: Object tags.", "enum": [ "OPTIONAL_FIELD_UNSPECIFIED", "LAST_ACCESS", "CHECKSUM_ALGORITHMS", "INTELLIGENT_TIER", "IS_MULTIPART_UPLOAD", "LIFECYCLE_EXPIRATION", "TAGS" ], "type": "string" }, "nebius.storage.v1.InventorySpec.OutputFormat": { "default": "OUTPUT_FORMAT_UNSPECIFIED", "description": " - CSV_GZIP: CSV compressed with GZIP.\n - PARQUET_SNAPPY: Parquet compressed with Snappy.", "enum": [ "OUTPUT_FORMAT_UNSPECIFIED", "CSV_GZIP", "PARQUET_SNAPPY" ], "type": "string" }, "nebius.storage.v1.InventorySpec.Schedule": { "default": "SCHEDULE_UNSPECIFIED", "description": " - DAILY: Run once a day.\n - WEEKLY: Run once a week.", "enum": [ "SCHEDULE_UNSPECIFIED", "DAILY", "WEEKLY" ], "type": "string" }, "nebius.storage.v1.InventoryStatus": { "properties": { "errorCode": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.InventoryStatus.Error" } ], "description": "Error code, if the last run was not successful, otherwise NO_ERROR." }, "lastSuccess": { "description": "Timestamp of the last successful run.", "format": "date-time", "type": "string" } }, "type": "object" }, "nebius.storage.v1.InventoryStatus.Error": { "default": "NO_ERROR", "description": " - NO_ERROR: No error.\n - DESTINATION_BUCKET_NOT_FOUND: Destination bucket not found.\n - PERMISSION_DENIED: Permission denied: you don't have permission to the destination bucket.\n - INVALID_INTENT: Intent is invalid, does not exist or expired.\n - QUOTA_EXCEEDED: Quota exceeded in destination.", "enum": [ "NO_ERROR", "DESTINATION_BUCKET_NOT_FOUND", "PERMISSION_DENIED", "INVALID_INTENT", "QUOTA_EXCEEDED" ], "type": "string" }, "nebius.storage.v1.LifecycleAbortIncompleteMultipartUpload": { "properties": { "daysAfterInitiation": { "description": "Specifies the days since the initiation of an incomplete multipart upload that\nthe system will wait before permanently removing all parts of the upload.", "format": "int32", "type": "integer" } }, "type": "object" }, "nebius.storage.v1.LifecycleAccessFilter": { "description": "Specifies which requests are included in `days_since_last_access` calculations.", "properties": { "conditions": { "description": "A request is included in `days_since_last_access` calculations if:\n- The first condition matching the request has `INCLUDE` type.\nOR\n- The request doesn't match any conditions", "items": { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleAccessFilter.Condition" }, "type": "array" } }, "type": "object" }, "nebius.storage.v1.LifecycleAccessFilter.Condition": { "properties": { "methods": { "description": "The s3 methods to match.\nAn empty list matches all methods", "items": { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleAccessFilter.Condition.Method" }, "type": "array" }, "type": { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleAccessFilter.Condition.Type" }, "userAgents": { "description": "User agents to match. Condition is satisfied if the request's user agent contains any of these substrings.\nAn empty list matches all user agents.", "items": { "type": "string" }, "type": "array" } }, "required": [ "type" ], "type": "object" }, "nebius.storage.v1.LifecycleAccessFilter.Condition.Method": { "default": "METHOD_UNSPECIFIED", "description": " - COPY_OBJECT: Copy object method reads the source object.\nWe account for those operations as source object accesses when calculating `days_since_last_access` for source object.\n - UPLOAD_PART_COPY: Upload part copy method reads the source object.\nWe account for those operations as source object accesses when calculating `days_since_last_access` for source object.", "enum": [ "METHOD_UNSPECIFIED", "GET_OBJECT", "HEAD_OBJECT", "GET_OBJECT_TAGGING", "COPY_OBJECT", "UPLOAD_PART_COPY" ], "type": "string" }, "nebius.storage.v1.LifecycleAccessFilter.Condition.Type": { "default": "TYPE_UNSPECIFIED", "description": " - INCLUDE: If an include type condition is the first condition that the request match, the request will be included in\n`days_since_last_access` calculation.\n - EXCLUDE: If an exclude type condition is the first condition that the request match, the request will be ignored in `days_since_last_access`\ncalculation.", "enum": [ "TYPE_UNSPECIFIED", "INCLUDE", "EXCLUDE" ], "type": "string" }, "nebius.storage.v1.LifecycleConfiguration": { "description": "The lifecycle configuration consists of one or more rules.\nAn Lifecycle configuration can have up to 1,000 rules.\nEach rule consists of the following:\n- A filter identifying a subset of objects to which the rule applies.\n The filter can be based on a key name prefix, object size, or any combination of these.\n- A status indicating whether the rule is currently active.\n- One or more lifecycle expiration actions that you want to be performed on the objects\n identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended\n (bucket.spec.versioning_policy equals to ENABLED or SUSPENDED) you can have many versions of the same\n object (one current version and zero or more noncurrent versions). The system provides predefined actions\n that you can specify for current and noncurrent object versions.", "properties": { "lastAccessFilter": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleAccessFilter" } ], "description": "Specifies which requests are included in `days_since_last_access` calculations for all transition rules." }, "rules": { "items": { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleRule" }, "type": "array" } }, "type": "object" }, "nebius.storage.v1.LifecycleExpiration": { "properties": { "date": { "description": "Indicates at what date the object will be deleted. The time is always midnight UTC.", "format": "date-time", "type": "string" }, "days": { "description": "Indicates the lifetime, in days, of the objects that are subject to the rule.\nThe value must be a non-zero positive integer.", "format": "int32", "type": "integer" }, "expiredObjectDeleteMarker": { "description": "Indicates whether the system will remove a \"delete marker\" with no noncurrent versions.\nIf set to true, the \"delete marker\" will be permanently removed.\nIf set to false the policy takes no action.\nThis cannot be specified with Days or Date in a LifecycleExpiration Policy.", "type": "boolean" } }, "type": "object" }, "nebius.storage.v1.LifecycleFilter": { "properties": { "objectSizeGreaterThanBytes": { "description": "Minimum object size to which the rule applies.", "format": "int64", "type": "string" }, "objectSizeLessThanBytes": { "description": "Maximum object size to which the rule applies.", "format": "int64", "type": "string" }, "prefix": { "description": "Prefix identifying one or more objects to which the rule applies.\nIf prefix is empty, the rule applies to all objects in the bucket.", "type": "string" }, "tags": { "description": "Tags to filter objects by their tagging. Rule applies only to objects that\nmatch all tags in a filter.", "items": { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleFilter.Tag" }, "type": "array" } }, "type": "object" }, "nebius.storage.v1.LifecycleFilter.Tag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "nebius.storage.v1.LifecycleNoncurrentVersionExpiration": { "properties": { "newerNoncurrentVersions": { "description": "Specifies how many noncurrent versions the system will retain.", "format": "int32", "type": "integer" }, "noncurrentDays": { "description": "Specifies the number of days an object is noncurrent before the system will expire it.", "format": "int32", "type": "integer" } }, "type": "object" }, "nebius.storage.v1.LifecycleNoncurrentVersionTransition": { "properties": { "newerNoncurrentVersions": { "description": "Specifies how many noncurrent versions the system will retain without transition.", "format": "int32", "type": "integer" }, "noncurrentDays": { "description": "Specifies the number of days an object is noncurrent before the system will transit it.", "format": "int32", "type": "integer" }, "storageClass": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.StorageClass" } ], "description": "Target storage class to transit to." } }, "type": "object" }, "nebius.storage.v1.LifecycleRule": { "properties": { "abortIncompleteMultipartUpload": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleAbortIncompleteMultipartUpload" } ], "description": "Specifies the days since the initiation of an incomplete multipart upload that\nthe system will wait before permanently removing all parts of the upload." }, "expiration": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleExpiration" } ], "description": "Specifies the expiration for the lifecycle of the object in the form of date, days and,\nwhether the object has a delete marker." }, "filter": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleFilter" } ], "description": "The Filter is used to identify objects that a Lifecycle Rule applies to.\nThe Lifecycle Rule will apply to any object matching all of the predicates\nconfigured inside (using logical AND)." }, "id": { "description": "Unique identifier for the rule per configuration.\nThe value cannot be longer than 255 characters.", "type": "string" }, "noncurrentVersionExpiration": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleNoncurrentVersionExpiration" } ], "description": "Specifies when noncurrent object versions expire.\nIt works only on a bucket that has versioning enabled (or suspended)." }, "noncurrentVersionTransition": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleNoncurrentVersionTransition" } ], "description": "Specifies the transition for the lifecycle of a noncurrent object.\nIt works only on a bucket that has versioning enabled (or suspended)." }, "status": { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleRule.Status" }, "transition": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.LifecycleTransition" } ], "description": "Specifies the transition for the lifecycle of an object in the form of date or days and\ntarget storage class to transit object to." } }, "required": [ "id", "status" ], "type": "object" }, "nebius.storage.v1.LifecycleRule.Status": { "default": "STATUS_UNSPECIFIED", "enum": [ "STATUS_UNSPECIFIED", "ENABLED", "DISABLED" ], "type": "string" }, "nebius.storage.v1.LifecycleTransition": { "properties": { "date": { "description": "Indicates at what date the object will be transited. The time is always midnight UTC.", "format": "date-time", "type": "string" }, "days": { "description": "Amount of days since object was uploaded before it's transited to a new storage class.\nThe value must be a non-zero positive integer.", "format": "int32", "type": "integer" }, "daysSinceLastAccess": { "description": "The number of days since the object was last accessed before it is transitioned.", "format": "int32", "type": "integer" }, "storageClass": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.StorageClass" } ], "description": "Target storage class to transit to." } }, "type": "object" }, "nebius.storage.v1.ListBucketsResponse": { "properties": { "items": { "description": "List of buckets returned in the response. The field should be named as `items` for consistency.", "items": { "$ref": "#/components/schemas/nebius.storage.v1.Bucket" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.storage.v1.ListBucketsWithFilterRequest.Filters": { "properties": { "bucketType": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.BucketStatus.BucketType" } ], "description": "If set, only buckets of the specified type will be returned. If not set, all bucket types will be returned." }, "filesystemId": { "description": "If not empty, only buckets mounted to the specified filesystem will be returned.", "type": "string" } }, "type": "object" }, "nebius.storage.v1.ListBucketsWithFilterResponse": { "properties": { "items": { "description": "List of buckets returned in the response. The field should be named as `items` for consistency.", "items": { "$ref": "#/components/schemas/nebius.storage.v1.Bucket" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.storage.v1.ListInventoriesResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.storage.v1.Inventory" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.storage.v1.ListTransfersResponse": { "properties": { "items": { "description": "List of transfers returned in the response.", "items": { "$ref": "#/components/schemas/nebius.storage.v1.Transfer" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.storage.v1.NonCurrentBucketCounters": { "description": "Counters for non-current object versions (for versioning buckets).", "properties": { "multipartObjectsQuantity": { "format": "int64", "type": "string" }, "multipartObjectsSize": { "format": "int64", "type": "string" }, "simpleObjectsQuantity": { "format": "int64", "type": "string" }, "simpleObjectsSize": { "format": "int64", "type": "string" } }, "type": "object" }, "nebius.storage.v1.PurgeBucketRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.storage.v1.ResumeTransferRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.storage.v1.StopTransferRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.storage.v1.StorageClass": { "default": "STORAGE_CLASS_UNSPECIFIED", "description": " - FILESYSTEM: Special storage class only for filesystem buckets.", "enum": [ "STORAGE_CLASS_UNSPECIFIED", "STANDARD", "ENHANCED_THROUGHPUT", "INTELLIGENT", "FILESYSTEM" ], "type": "string" }, "nebius.storage.v1.Transfer": { "description": "Transfer that migrates data from other providers or across different regions of Nebius Object Storage.\nTransfer consists of consecutive iterations where the service lists objects in the source bucket and\nmoves those that need to be transferred according to the specified overwrite strategy and touch unmanaged flag value.\nIf the enable deletes in destination flag is set, the service also lists destination bucket and deletes\nobjects which do not exist in the source bucket according to the touch unmanaged flag value.\nAfter an iteration completes, the transfer will stop if its stop condition is met. Otherwise,\nit will wait for the defined inter-iteration interval before starting the next iteration.", "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1.TransferSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.storage.v1.TransferCredentialsAccessKey": { "properties": { "accessKeyId": { "description": "Access key ID.", "type": "string" }, "secretAccessKey": { "description": "Secret access key.", "type": "string" } }, "required": [ "accessKeyId" ], "type": "object" }, "nebius.storage.v1.TransferCredentialsAnonymous": { "type": "object" }, "nebius.storage.v1.TransferCredentialsAzureStorageAccount": { "properties": { "accessKey": { "description": "Storage account access key.", "type": "string" }, "accountName": { "description": "Storage account name.", "type": "string" } }, "required": [ "accountName" ], "type": "object" }, "nebius.storage.v1.TransferDestination": { "properties": { "nebius": { "$ref": "#/components/schemas/nebius.storage.v1.TransferDestination.NebiusProvider" }, "prefix": { "description": "Prefix to add to the beginning of each transferred object key in the destination.\nDuring transfer, the resulting object key in the destination is computed\nby removing source.prefix (if provided) from the original key and then prepending destination.prefix.\nImportant: This transformation may result in an empty object key or one that exceeds allowed length limits.\nUse prefixes that guarantee valid resulting object keys for your objects after transformation.", "type": "string" }, "s3Compatible": { "$ref": "#/components/schemas/nebius.storage.v1.TransferDestination.S3CompatibleProvider" } }, "type": "object" }, "nebius.storage.v1.TransferDestination.NebiusProvider": { "properties": { "accessKey": { "$ref": "#/components/schemas/nebius.storage.v1.TransferCredentialsAccessKey" }, "bucketName": { "description": "Name of the destination bucket.", "type": "string" }, "region": { "description": "Nebius region where the destination bucket is located.", "type": "string" } }, "required": [ "region", "bucketName" ], "type": "object" }, "nebius.storage.v1.TransferDestination.S3CompatibleProvider": { "properties": { "accessKey": { "$ref": "#/components/schemas/nebius.storage.v1.TransferCredentialsAccessKey" }, "anonymous": { "$ref": "#/components/schemas/nebius.storage.v1.TransferCredentialsAnonymous" }, "bucketName": { "description": "Name of the destination bucket.", "type": "string" }, "endpoint": { "description": "The endpoint must be in the form of a URL, starting with the protocol (https),\nfollowed by the endpoint address without a trailing slash.\nExample: \"https://storage.some-cloud\".", "type": "string" }, "region": { "description": "S3-compatible provider region where destination bucket is located.", "type": "string" } }, "required": [ "endpoint", "region", "bucketName" ], "type": "object" }, "nebius.storage.v1.TransferError": { "properties": { "code": { "description": "Error code, usually taken from the endpoint response.", "type": "string" }, "message": { "description": "Error message, usually taken from the endpoint response.", "type": "string" }, "origin": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferError.Origin" } ], "description": "Endpoint where the error occurred." } }, "type": "object" }, "nebius.storage.v1.TransferError.Origin": { "default": "ORIGIN_UNSPECIFIED", "description": " - SOURCE: Error originated from the source.\n - DESTINATION: Error originated from the destination.", "enum": [ "ORIGIN_UNSPECIFIED", "SOURCE", "DESTINATION" ], "type": "string" }, "nebius.storage.v1.TransferIteration": { "properties": { "averageThroughputBytes": { "description": "Average throughput in bytes per second during the iteration.", "format": "int64", "type": "string" }, "endTime": { "description": "Iteration end time.", "format": "date-time", "type": "string" }, "error": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferError" } ], "description": "Human-readable error description. Populated only if state is FAILED." }, "objectsDeletedCount": { "description": "Number of objects deleted from destination bucket during this iteration.", "format": "int64", "type": "string" }, "objectsTransferredCount": { "description": "Number of objects transferred during this iteration.", "format": "int64", "type": "string" }, "objectsTransferredSize": { "description": "Total size of objects transferred during this iteration.", "format": "int64", "type": "string" }, "sequenceNumber": { "description": "Sequence number of the iteration in the transfer, starting from 1.", "format": "int64", "type": "string" }, "startTime": { "description": "Iteration start time.", "format": "date-time", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferIteration.State" } ], "description": "Current iteration state." } }, "type": "object" }, "nebius.storage.v1.TransferIteration.State": { "default": "STATE_UNSPECIFIED", "description": "Iteration state.", "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "COMPLETED", "INTERRUPTED", "FAILED" ], "type": "string" }, "nebius.storage.v1.TransferSource": { "properties": { "azureBlobStorage": { "$ref": "#/components/schemas/nebius.storage.v1.TransferSource.AzureBlobStorageProvider" }, "nebius": { "$ref": "#/components/schemas/nebius.storage.v1.TransferSource.NebiusProvider" }, "prefix": { "description": "Prefix to filter objects in the source. Only objects whose keys start with this prefix will be transferred.\nDuring transfer, the resulting object key in the destination is computed\nby removing source.prefix from the original key and then prepending destination.prefix (if provided).\nImportant: This transformation may result in an empty object key or one that exceeds allowed length limits.\nUse prefixes that guarantee valid resulting object keys for your objects after transformation.", "type": "string" }, "s3Compatible": { "$ref": "#/components/schemas/nebius.storage.v1.TransferSource.S3CompatibleProvider" } }, "type": "object" }, "nebius.storage.v1.TransferSource.AzureBlobStorageProvider": { "properties": { "anonymous": { "$ref": "#/components/schemas/nebius.storage.v1.TransferCredentialsAnonymous" }, "azureStorageAccount": { "$ref": "#/components/schemas/nebius.storage.v1.TransferCredentialsAzureStorageAccount" }, "containerName": { "description": "Name of the source Azure Blob Storage container.", "type": "string" }, "endpoint": { "description": "The endpoint must be in the form of a URL, starting with the protocol (https),\nfollowed by the endpoint address without a trailing slash.\nExample: \"https://storageaccountname.blob.core.windows.net\".", "type": "string" } }, "required": [ "endpoint", "containerName" ], "type": "object" }, "nebius.storage.v1.TransferSource.NebiusProvider": { "properties": { "accessKey": { "$ref": "#/components/schemas/nebius.storage.v1.TransferCredentialsAccessKey" }, "anonymous": { "$ref": "#/components/schemas/nebius.storage.v1.TransferCredentialsAnonymous" }, "bucketName": { "description": "Name of the source bucket.", "type": "string" }, "region": { "description": "Nebius region where the source bucket is located.", "type": "string" } }, "required": [ "region", "bucketName" ], "type": "object" }, "nebius.storage.v1.TransferSource.S3CompatibleProvider": { "properties": { "accessKey": { "$ref": "#/components/schemas/nebius.storage.v1.TransferCredentialsAccessKey" }, "anonymous": { "$ref": "#/components/schemas/nebius.storage.v1.TransferCredentialsAnonymous" }, "bucketName": { "description": "Name of the source bucket.", "type": "string" }, "endpoint": { "description": "The endpoint must be in the form of a URL, starting with the protocol (https),\nfollowed by the endpoint address without a trailing slash.\nExample: \"https://storage.some-cloud\".", "type": "string" }, "region": { "description": "S3-compatible provider region where source bucket is located.", "type": "string" } }, "required": [ "endpoint", "region", "bucketName" ], "type": "object" }, "nebius.storage.v1.TransferSpec": { "properties": { "afterNEmptyIterations": { "$ref": "#/components/schemas/nebius.storage.v1.TransferSpec.StopConditionAfterNEmptyIterations" }, "afterOneIteration": { "$ref": "#/components/schemas/nebius.storage.v1.TransferSpec.StopConditionAfterOneIteration" }, "destination": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferDestination" } ], "description": "Destination to which the transfer writes data." }, "enableDeletesInDestination": { "description": "If enable_deletes_in_destination flag is set, service will delete objects that exist in destination, but don't exist in source.\nIf touch_unmanaged flag isn't set, we do not delete objects that haven't been created by Data Transfer service.", "type": "boolean" }, "infinite": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferSpec.StopConditionInfinite" } ], "description": "Infinite transfers do not stop automatically and can be stopped manually by the user." }, "interIterationInterval": { "description": "The time to wait since the previous iteration before starting the next one.\nDefault is 15 minutes if not specified.", "type": "string" }, "limiters": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferSpec.Limiters" } ], "description": "Limiters applied to source bucket operations. These limits include all operations\nrequired for transfer (HeadObject, GetObject, ListObjects). For details about\nwhich operations are used, see public documentation: http://docs.nebius.com/object-storage/transfer/quickstart#background.\n\nNote: Since the service performs comparable request volumes and data transfers\nto both source and destination, these limits will indirectly constrain\ndestination operations as well." }, "overwriteStrategy": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferSpec.OverwriteStrategy" } ], "description": "Overwrite strategy set logic of overwrite already existed objects in destination bucket." }, "source": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferSource" } ], "description": "Source from which the transfer reads data." }, "touchUnmanaged": { "description": "If touch_unmanaged flag is set, service will be allowed to overwrite and delete from destination objects that were not\ncreated by Data Transfer Service. If this flag is false, Data Transfer Service will never overwrite or delete objects\nthat haven't been created by Data Transfer service.", "type": "boolean" } }, "required": [ "source", "destination", "overwriteStrategy" ], "type": "object" }, "nebius.storage.v1.TransferSpec.Limiters": { "properties": { "bandwidthBytesPerSecond": { "description": "Maximum bandwidth in bytes per second. If set to zero, default limit will be applied.", "format": "uint64", "type": "string" }, "requestsPerSecond": { "description": "Maximum number of requests per second. If set to zero, default limit will be applied.", "format": "uint64", "type": "string" } }, "type": "object" }, "nebius.storage.v1.TransferSpec.OverwriteStrategy": { "default": "OVERWRITE_STRATEGY_UNSPECIFIED", "description": " - NEVER: Never overwrite objects that exist in the destination.\nIf object exists in destination bucket, skip it.\nSafest option to prevent any data loss.\n - IF_NEWER: Overwrite only if source object is newer than destination.\nComparison based on Last-Modified timestamp.\nRecommended for incremental sync scenarios.\nIf touch_unmanaged flag isn't set, we do not overwrite objects that haven't been created by Data Transfer service.", "enum": [ "OVERWRITE_STRATEGY_UNSPECIFIED", "NEVER", "IF_NEWER" ], "type": "string" }, "nebius.storage.v1.TransferSpec.StopConditionAfterNEmptyIterations": { "properties": { "emptyIterationsThreshold": { "description": "Number of consecutive iterations with zero transferred objects required to stop transfer.", "format": "int64", "type": "integer" } }, "required": [ "emptyIterationsThreshold" ], "type": "object" }, "nebius.storage.v1.TransferSpec.StopConditionAfterOneIteration": { "type": "object" }, "nebius.storage.v1.TransferSpec.StopConditionInfinite": { "type": "object" }, "nebius.storage.v1.TransferStatus": { "properties": { "error": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferError" } ], "description": "Error information if the transfer has failed." }, "lastIteration": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferIteration" } ], "description": "If there is active iteration, its status will be given.\nIf it is a new transfer that doesn't have iteration yet, nothing will be returned.\nOtherwise, last finished transaction will be returned." }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferStatus.State" } ], "description": "Current transfer state." }, "suspensionState": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1.TransferStatus.SuspensionState" } ], "description": "If the transfer is suspended, transfer's suspension state becomes SUSPENDED." } }, "type": "object" }, "nebius.storage.v1.TransferStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Transfer state.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "STOPPING", "STOPPED", "FAILING", "FAILED", "DELETING" ], "type": "string" }, "nebius.storage.v1.TransferStatus.SuspensionState": { "default": "SUSPENSION_STATE_UNSPECIFIED", "description": "Transfer suspension state.", "enum": [ "SUSPENSION_STATE_UNSPECIFIED", "NOT_SUSPENDED", "SUSPENDED" ], "type": "string" }, "nebius.storage.v1.UndeleteBucketRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.storage.v1.UpdateBucketRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1.BucketSpec" } }, "required": [ "metadata" ], "type": "object" }, "nebius.storage.v1.UpdateInventoryRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1.InventorySpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.storage.v1.UpdateTransferRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1.TransferSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.storage.v1.VersioningPolicy": { "default": "VERSIONING_POLICY_UNSPECIFIED", "enum": [ "VERSIONING_POLICY_UNSPECIFIED", "DISABLED", "ENABLED", "SUSPENDED" ], "type": "string" }, "nebius.storage.v1alpha1.CreateTransferRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.storage.v1alpha1.GetIterationHistoryResponse": { "properties": { "iterations": { "description": "List of transfer iterations sorted from newest to oldest.", "items": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferIteration" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.storage.v1alpha1.ListTransfersResponse": { "properties": { "items": { "description": "List of transfers returned in the response.", "items": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.Transfer" }, "type": "array" }, "nextPageToken": { "description": "Token for pagination, indicating the next set of results can be retrieved using this token.", "type": "string" } }, "type": "object" }, "nebius.storage.v1alpha1.ResumeTransferRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.storage.v1alpha1.StopTransferRequest": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.storage.v1alpha1.Transfer": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec" }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferStatus" } ], "readOnly": true } }, "type": "object" }, "nebius.storage.v1alpha1.TransferIteration": { "properties": { "averageThroughputBytes": { "format": "int64", "type": "string" }, "endTime": { "format": "date-time", "type": "string" }, "error": { "description": "Human-readable error description. Populated only if state is FAILED.", "type": "string" }, "objectsDiscoveredCount": { "format": "int64", "type": "string" }, "objectsMigratedCount": { "format": "int64", "type": "string" }, "objectsMigratedSize": { "format": "int64", "type": "string" }, "objectsSkippedCount": { "format": "int64", "type": "string" }, "sequenceNumber": { "format": "int64", "type": "string" }, "startTime": { "format": "date-time", "type": "string" }, "state": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferIteration.State" } }, "type": "object" }, "nebius.storage.v1alpha1.TransferIteration.State": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "IN_PROGRESS", "COMPLETED", "STOPPED", "FAILED" ], "type": "string" }, "nebius.storage.v1alpha1.TransferSpec": { "properties": { "afterNEmptyIterations": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.StopConditionAfterNEmptyIterations" }, "afterOneIteration": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.StopConditionAfterOneIteration" }, "destination": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.DestinationBucket" }, "infinite": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.StopConditionInfinite" } ], "description": "Infinite transfers do not stop automatically and can be stopped manually by the user." }, "interIterationInterval": { "description": "Time to wait between transfer iterations. Default is 15 minutes if not specified.", "type": "string" }, "overwriteStrategy": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.OverwriteStrategy" } ], "description": "Overwrite strategy set logic of overwrite already existed objects in destination bucket." }, "source": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.SourceBucket" } }, "required": [ "source", "destination", "overwriteStrategy" ], "type": "object" }, "nebius.storage.v1alpha1.TransferSpec.BucketCredentials": { "properties": { "accessKey": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.BucketCredentials.CredentialsAccessKey" }, "anonymous": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.BucketCredentials.CredentialsAnonymous" }, "azureAccessKey": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.BucketCredentials.AzureAccessKey" } }, "type": "object" }, "nebius.storage.v1alpha1.TransferSpec.BucketCredentials.AzureAccessKey": { "properties": { "accessKey": { "type": "string" }, "accountName": { "type": "string" } }, "required": [ "accountName", "accessKey" ], "type": "object" }, "nebius.storage.v1alpha1.TransferSpec.BucketCredentials.CredentialsAccessKey": { "properties": { "accessKeyId": { "type": "string" }, "secretAccessKey": { "type": "string" } }, "required": [ "accessKeyId", "secretAccessKey" ], "type": "object" }, "nebius.storage.v1alpha1.TransferSpec.BucketCredentials.CredentialsAnonymous": { "type": "object" }, "nebius.storage.v1alpha1.TransferSpec.DestinationBucket": { "properties": { "bucketName": { "type": "string" }, "credentials": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.BucketCredentials" } ], "description": "Credentials for accessing the destination bucket. These credentials must have head and write permissions.\nThis parameter must be specified only during create operations." }, "endpoint": { "description": "The endpoint must be in the form of a URL, starting with the protocol (https),\nfollowed by the endpoint address without a trailing slash.\nExample: https://storage.us-central1.nebius.cloud", "type": "string" }, "prefix": { "description": "Prefix to add to the beginning of each transferred object key in the destination bucket.\nDuring transfer, the resulting object key in the destination bucket is computed\nby removing source.prefix (if provided) from the original key and then prepending destination.prefix.\nImportant: This transformation may result in an empty object key or one that exceeds allowed length limits.\nUse prefixes that guarantee valid resulting object keys for your objects after transformation.", "type": "string" }, "region": { "type": "string" } }, "required": [ "bucketName" ], "type": "object" }, "nebius.storage.v1alpha1.TransferSpec.Limiters": { "properties": { "bandwidthBytesPerSecond": { "description": "Maximum bandwidth in bytes per second. If set to zero, default limit will be applied.", "format": "uint64", "type": "string" }, "requestsPerSecond": { "description": "Maximum number of requests per second. If set to zero, default limit will be applied.", "format": "uint64", "type": "string" } }, "type": "object" }, "nebius.storage.v1alpha1.TransferSpec.OverwriteStrategy": { "default": "OVERWRITE_STRATEGY_UNSPECIFIED", "description": " - NEVER: Never overwrite objects that exist in the destination.\nIf object exists in destination bucket, skip it.\nSafest option to prevent data loss.\n - IF_NEWER: Overwrite only if source object is newer than destination.\nComparison based on Last-Modified timestamp.\nRecommended for incremental sync scenarios.\n - ALWAYS: Always overwrite destination objects unconditionally.\nUse with caution - may cause data loss in destination.\nSuitable for full bucket synchronization.", "enum": [ "OVERWRITE_STRATEGY_UNSPECIFIED", "NEVER", "IF_NEWER", "ALWAYS" ], "type": "string" }, "nebius.storage.v1alpha1.TransferSpec.SourceBucket": { "properties": { "bucketName": { "type": "string" }, "credentials": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.BucketCredentials" } ], "description": "Credentials for accessing the source bucket. These credentials must have list and get permissions.\nThis parameter must be specified only during create operations." }, "endpoint": { "description": "The endpoint must be in the form of a URL, starting with the protocol (https),\nfollowed by the endpoint address without a trailing slash.\nExample: https://storage.us-central1.nebius.cloud", "type": "string" }, "limiters": { "allOf": [ { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec.Limiters" } ], "description": "Limiters applied to source bucket operations. These limits include all operations\nrequired for transfer (HeadObject, GetObject, ListObjects). For details about\nwhich operations are used, see public documentation: http://docs.nebius.com/object-storage/transfer/quickstart#background.\n\nNote: Since the service performs comparable request volumes and data transfers\nto both source and destination, these limits will indirectly constrain\ndestination operations as well." }, "prefix": { "description": "Prefix to filter objects in the source bucket. Only objects whose keys start with this prefix will be transferred.\nDuring transfer, the resulting object key in the destination bucket is computed\nby removing source.prefix from the original key and then prepending destination.prefix (if provided).\nImportant: This transformation may result in an empty object key or one that exceeds allowed length limits.\nUse prefixes that guarantee valid resulting object keys for your objects after transformation.", "type": "string" }, "region": { "type": "string" } }, "required": [ "endpoint", "bucketName", "region" ], "type": "object" }, "nebius.storage.v1alpha1.TransferSpec.StopConditionAfterNEmptyIterations": { "properties": { "emptyIterationsThreshold": { "description": "Number of consecutive iterations with zero transferred objects required to stop transfer.", "format": "int64", "type": "integer" } }, "required": [ "emptyIterationsThreshold" ], "type": "object" }, "nebius.storage.v1alpha1.TransferSpec.StopConditionAfterOneIteration": { "type": "object" }, "nebius.storage.v1alpha1.TransferSpec.StopConditionInfinite": { "type": "object" }, "nebius.storage.v1alpha1.TransferStatus": { "properties": { "error": { "description": "Error information if the transfer has failed.", "type": "string" }, "lastIteration": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferIteration" }, "state": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferStatus.State" }, "suspensionState": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferStatus.SuspensionState" } }, "type": "object" }, "nebius.storage.v1alpha1.TransferStatus.State": { "default": "STATE_UNSPECIFIED", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "STOPPING", "STOPPED", "FAILING", "FAILED" ], "type": "string" }, "nebius.storage.v1alpha1.TransferStatus.SuspensionState": { "default": "SUSPENSION_STATE_UNSPECIFIED", "enum": [ "SUSPENSION_STATE_UNSPECIFIED", "NOT_SUSPENDED", "SUSPENDED" ], "type": "string" }, "nebius.storage.v1alpha1.UpdateTransferRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.TransferSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.tunnel.v1.ConnectionState": { "default": "CONNECTION_STATE_UNSPECIFIED", "description": "ConnectionState reports whether the tunnel has an agent behind it. Values are\nprefixed because a top-level enum puts them in the package scope.\n\n - CONNECTION_STATE_UNSPECIFIED: Proto3 zero value. A read of the tunnel never returns it; a mutation\nrecords it, because it reports the tunnel that was written.\n - CONNECTION_STATE_DISCONNECTED: No agent is connected. Nothing the tunnel exposes is reachable.\n - CONNECTION_STATE_CONNECTED: At least one agent is connected.", "enum": [ "CONNECTION_STATE_UNSPECIFIED", "CONNECTION_STATE_DISCONNECTED", "CONNECTION_STATE_CONNECTED" ], "type": "string" }, "nebius.tunnel.v1.CreateTunnelRequest": { "description": "Request to create a new tunnel.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the new tunnel." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.tunnel.v1.TunnelSpec" } ], "description": "Specification for the new tunnel." } }, "type": "object" }, "nebius.tunnel.v1.ListTunnelsResponse": { "description": "Response containing a list of tunnels.", "properties": { "items": { "description": "List of tunnels matching the request.", "items": { "$ref": "#/components/schemas/nebius.tunnel.v1.Tunnel" }, "type": "array" }, "nextPageToken": { "description": "Token to retrieve the next page of results, empty if no more results.", "type": "string" } }, "type": "object" }, "nebius.tunnel.v1.ServiceStatus": { "description": "ServiceStatus is a service reachable through the tunnel.", "properties": { "endpoint": { "description": "Where to reach the service, as host:port. The tunnel terminates TLS, so a\nclient connects over TLS and sends the host as SNI. What travels inside is\nwhatever the service speaks, which the tunnel does not interpret.\nFor example, \"app-hy3wnb3wstpk7dz.tunnel.example.com:443\".", "type": "string" }, "name": { "description": "Name of the service, as the agent announced it. 1-20 characters, lowercase\nletters and digits only: the hostname joins the name to the tunnel id with\na dash, so a name may not contain one. For example, \"app\".", "type": "string" } }, "type": "object" }, "nebius.tunnel.v1.Tunnel": { "description": "Tunnel represents a secure tunnel connection for applications.\nIt enables connectivity between applications and external services within a parent.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Resource metadata containing identification and hierarchy information." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.tunnel.v1.TunnelSpec" } ], "description": "Specification of the tunnel configuration." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.tunnel.v1.TunnelStatus" } ], "description": "Current status of the tunnel.", "readOnly": true } }, "type": "object" }, "nebius.tunnel.v1.TunnelSpec": { "description": "TunnelSpec defines the configuration for the tunnel.", "properties": { "description": { "description": "Arbitrary description of the tunnel provided by the user.", "type": "string" }, "title": { "description": "Human-readable display name for the tunnel.", "type": "string" } }, "type": "object" }, "nebius.tunnel.v1.TunnelStatus": { "description": "TunnelStatus represents the current state of the tunnel.", "properties": { "connectionState": { "allOf": [ { "$ref": "#/components/schemas/nebius.tunnel.v1.ConnectionState" } ], "description": "Whether any agent is connected to the tunnel now." }, "services": { "description": "Services reachable through the tunnel. A service is listed while at least\none agent announces it, and follows the agents within about 30 seconds.", "items": { "$ref": "#/components/schemas/nebius.tunnel.v1.ServiceStatus" }, "type": "array" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.tunnel.v1.TunnelStatus.State" } ], "description": "Current lifecycle state of the tunnel." } }, "type": "object" }, "nebius.tunnel.v1.TunnelStatus.State": { "default": "UNSPECIFIED", "description": "State represents the lifecycle state of the tunnel.\n\n - UNSPECIFIED: Default unspecified state.\n - CREATED: The tunnel has been created and is active.\n - DELETED: The tunnel has been deleted.", "enum": [ "UNSPECIFIED", "CREATED", "DELETED" ], "type": "string" }, "nebius.tunnel.v1.UpdateTunnelRequest": { "description": "Request to update an existing tunnel.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata identifying the tunnel to update. The `id` field is required;\n`resource_version`, when non-zero, enables optimistic concurrency control." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.tunnel.v1.TunnelSpec" } ], "description": "New specification for the tunnel." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.vpc.v1.AddressBlockState": { "default": "STATE_UNSPECIFIED", "description": "Controls provisioning of IP addresses from this pool to other pools\nor allocations. Defaults to AVAILABLE.\n\n - STATE_UNSPECIFIED: Not used, mandated by the protocol.\n - AVAILABLE: Default state. Provision of the IP addresses from this CIDR block is allowed.\n - DISABLED: Provision of the IP addresses from this CIDR block is denied.", "enum": [ "STATE_UNSPECIFIED", "AVAILABLE", "DISABLED" ], "type": "string" }, "nebius.vpc.v1.Allocation": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the Allocation.\n`metadata.parent_id` represents IAM Container." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.AllocationSpec" } ], "description": "Specifications for the allocation, detailing its name and IP configuration." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.AllocationStatus" } ], "description": "Contains the current status of the allocation, indicating its state and\nany additional details." } }, "type": "object" }, "nebius.vpc.v1.AllocationDetails": { "properties": { "allocatedCidr": { "description": "The actual CIDR block that has been allocated.", "type": "string" }, "poolId": { "description": "ID of the pool from which this allocation was made.", "type": "string" }, "subnetId": { "description": "ID of the subnet associated with this allocation.\nPopulated when created with explicit subnet_id, from a subnet-specific pool,\nor when assigned to a resource.", "type": "string" }, "version": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.IpVersion" } ], "description": "The IP version of this allocation (IPv4 or IPv6)." } }, "type": "object" }, "nebius.vpc.v1.AllocationNextHop": { "description": "AllocationNextHop specifies an IP allocation as the next hop.", "properties": { "id": { "description": "ID of the IP allocation to use as the next hop.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.vpc.v1.AllocationNextHopState": { "properties": { "cidr": { "description": "The CIDR of the allocation being used as the next hop.", "type": "string" } }, "type": "object" }, "nebius.vpc.v1.AllocationSpec": { "properties": { "ipv4Private": { "$ref": "#/components/schemas/nebius.vpc.v1.IPv4PrivateAllocationSpec" }, "ipv4Public": { "$ref": "#/components/schemas/nebius.vpc.v1.IPv4PublicAllocationSpec" } }, "type": "object" }, "nebius.vpc.v1.AllocationStatus": { "properties": { "assignment": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.Assignment" } ], "description": "Information about the assignment associated with the allocation,\nsuch as network interface or load balancer assignment." }, "details": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.AllocationDetails" } ], "description": "Detailed information about the allocation status,\nincluding the allocated CIDR, pool ID and IP version." }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.AllocationStatus.State" } ], "description": "This field represents the current state of the allocation." }, "static": { "description": "If false - Lifecycle of allocation depends on resource that using it.", "type": "boolean" } }, "type": "object" }, "nebius.vpc.v1.AllocationStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Enumeration of possible states of the Allocation.\n\n - STATE_UNSPECIFIED: Default state, unspecified.\n - CREATING: Allocation is being created.\n - ALLOCATED: Allocation is ready for use.\n - ASSIGNED: Allocation is used.\n - DELETING: Allocation is being deleted.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ALLOCATED", "ASSIGNED", "DELETING" ], "type": "string" }, "nebius.vpc.v1.Assignment": { "properties": { "loadBalancer": { "$ref": "#/components/schemas/nebius.vpc.v1.LoadBalancerAssignment" }, "networkInterface": { "$ref": "#/components/schemas/nebius.vpc.v1.NetworkInterfaceAssignment" } }, "type": "object" }, "nebius.vpc.v1.ComputeInstance": { "description": "Target representing compute instance", "properties": { "id": { "description": "Compute instance id to send traffic to", "type": "string" }, "networkInterfaceName": { "description": "Name of the compute instance's NetworkInterface to send traffic to. If not specified the first one will be used.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.vpc.v1.CreateAllocationRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata of the allocation." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.AllocationSpec" } ], "description": "Specification of the allocation." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.vpc.v1.CreateDefaultNetworkRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata of the default network." } }, "required": [ "metadata" ], "type": "object" }, "nebius.vpc.v1.CreateNetworkRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata of the network." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.NetworkSpec" } ], "description": "Specification of the network." } }, "required": [ "metadata" ], "type": "object" }, "nebius.vpc.v1.CreatePoolRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata of the pool." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.PoolSpec" } ], "description": "Specification of the pool." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.vpc.v1.CreateRouteRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata of the route." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteSpec" } ], "description": "Specification of the route." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.vpc.v1.CreateRouteTableRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata of the route table." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteTableSpec" } ], "description": "Specification of the route table." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.vpc.v1.CreateSecurityGroupRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata of the security group." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityGroupSpec" } ], "description": "Specification of the security group." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.vpc.v1.CreateSecurityRuleRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata of the security rule." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityRuleSpec" } ], "description": "Specification of the security rule." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.vpc.v1.CreateSubnetRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata of the subnet." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SubnetSpec" } ], "description": "Specification of the subnet." } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.vpc.v1.DefaultEgressGatewayState": { "type": "object" }, "nebius.vpc.v1.DestinationMatch": { "properties": { "cidr": { "description": "Destination CIDR block in IPv4 format (e.g., \"0.0.0.0/0\" for default route, \"192.168.100.0/24\" for specific subnet).\nThe CIDR notation specifies the range of IP addresses that this route will match.\nMust be unique within a route table.", "type": "string" } }, "required": [ "cidr" ], "type": "object" }, "nebius.vpc.v1.IPv4PrivateAllocationSpec": { "description": "Private IPv4 address configuration for the allocation.", "properties": { "cidr": { "description": "A single IP address (e.g 10.1.2.1), a CIDR block (e.g., \"10.1.2.0/24\") or\na prefix length (e.g., \"/32\").\nIf prefix length is specified, the CIDR block will be auto-allocated from\nthe available space in the pool or subnet.\nIf not specified, defaults to \"/32\".", "type": "string" }, "poolId": { "description": "ID of the pool that allocation will receive its IP address from.", "type": "string" }, "subnetId": { "description": "ID of the subnet that allocation will be associated with.\nIP address of the allocation must be within a CIDR block associated\nwith this subnet.\nIn order to assign an allocation to a resource (i.e. network interface)\nboth must be associated with the same subnet.", "type": "string" } }, "type": "object" }, "nebius.vpc.v1.IPv4PrivateNetworkPools": { "properties": { "pools": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1.NetworkPool" }, "type": "array" } }, "type": "object" }, "nebius.vpc.v1.IPv4PrivateSubnetPools": { "properties": { "pools": { "description": "List of private IPv4 CIDR blocks for this subnet.\nMust not overlap with other resources in the network\nMust be empty if `use_network_pools` is true.", "items": { "$ref": "#/components/schemas/nebius.vpc.v1.SubnetPool" }, "type": "array" }, "useNetworkPools": { "description": "If true, inherit private IPv4 pools from the network. Defaults to true.\nMust be false if `pools` is specified.", "type": "boolean" } }, "type": "object" }, "nebius.vpc.v1.IPv4PublicAllocationSpec": { "description": "Public IPv4 address configuration for the allocation.", "properties": { "cidr": { "description": "A single IP address (e.g. 1.2.3.4), a CIDR block (e.g., \"1.2.3.4/24\")\nor a prefix length (e.g., \"/32\").\nIf prefix length is specified, the CIDR block will be auto-allocated from\nthe available space in the pool or subnet.\nIf not specified, defaults to \"/32\".", "type": "string" }, "poolId": { "description": "ID of the pool that allocation will receive its IP address from.", "type": "string" }, "subnetId": { "description": "ID of the subnet that allocation will be associated with.\nIP address of the allocation must be within a CIDR block associated with\nthis subnet.\nAssigning an allocation to a resource (i.e. network interface) requires\nboth to be associated with the same subnet.", "type": "string" } }, "type": "object" }, "nebius.vpc.v1.IPv4PublicNetworkPools": { "properties": { "pools": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1.NetworkPool" }, "type": "array" } }, "type": "object" }, "nebius.vpc.v1.IPv4PublicSubnetPools": { "properties": { "pools": { "description": "List of public IPv4 CIDR blocks for this subnet.\nMust not overlap with other resources in the network.\nMust be empty if `use_network_pools` is true.", "items": { "$ref": "#/components/schemas/nebius.vpc.v1.SubnetPool" }, "type": "array" }, "useNetworkPools": { "description": "If true, inherit public IPv4 pools from the network.\nMust be false if `pools` is specified.", "type": "boolean" } }, "type": "object" }, "nebius.vpc.v1.IpVersion": { "default": "IP_VERSION_UNSPECIFIED", "description": " - IP_VERSION_UNSPECIFIED: Default, unspecified IP version.\n - IPV4: IPv4 address.\n - IPV6: IPv6 address.", "enum": [ "IP_VERSION_UNSPECIFIED", "IPV4", "IPV6" ], "type": "string" }, "nebius.vpc.v1.IpVisibility": { "default": "IP_VISIBILITY_UNSPECIFIED", "description": " - IP_VISIBILITY_UNSPECIFIED: Default, unspecified IP visibility.\n - PRIVATE: Private address.\n - PUBLIC: Public address.", "enum": [ "IP_VISIBILITY_UNSPECIFIED", "PRIVATE", "PUBLIC" ], "type": "string" }, "nebius.vpc.v1.ListAllocationsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1.Allocation" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1.ListNetworksResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1.Network" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1.ListPoolsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1.Pool" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1.ListRouteTablesResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1.RouteTable" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1.ListRoutesResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1.Route" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1.ListSecurityGroupsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityGroup" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1.ListSecurityRulesResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityRule" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1.ListSubnetsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1.Subnet" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1.LoadBalancerAssignment": { "properties": { "id": { "description": "ID of the Load Balancer.", "type": "string" } }, "type": "object" }, "nebius.vpc.v1.Network": { "description": "Defines a Network, which serves as a virtual representation of a traditional LAN\nwithin a cloud environment.\nNetworks facilitate communication between subnets.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the network resource.\n`metadata.parent_id` represents IAM container" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.NetworkSpec" } ], "description": "Specification of the network." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.NetworkStatus" } ], "description": "Status of the network." } }, "type": "object" }, "nebius.vpc.v1.NetworkInterfaceAssignment": { "properties": { "instanceId": { "description": "ID of the Compute instance network interface belongs to.", "type": "string" }, "name": { "description": "Network interface name", "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.NetworkInterfaceAssignment.Type" } ], "description": "Type of allocation attachment on the network interface." } }, "type": "object" }, "nebius.vpc.v1.NetworkInterfaceAssignment.Type": { "default": "TYPE_UNSPECIFIED", "description": " - PRIMARY: Allocation is attached as the interface private IPv4 address.\n - ALIAS: Allocation is attached as an IP alias.\n - PUBLIC: Allocation is attached as the interface public IPv4 address.", "enum": [ "TYPE_UNSPECIFIED", "PRIMARY", "ALIAS", "PUBLIC" ], "type": "string" }, "nebius.vpc.v1.NetworkPool": { "properties": { "id": { "description": "ID of the pool.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "nebius.vpc.v1.NetworkSpec": { "properties": { "ipv4PrivatePools": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.IPv4PrivateNetworkPools" } ], "description": "Pools for private IPv4 addresses.\nDefault private pools will be created if not specified.\nDefault private pools are referred here\nhttps://docs.nebius.com/vpc/addressing/available-addresses" }, "ipv4PublicPools": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.IPv4PublicNetworkPools" } ], "description": "Pools for public IPv4 addresses.\nDefault public pool will be used if not specified." } }, "type": "object" }, "nebius.vpc.v1.NetworkStatus": { "properties": { "defaultRouteTableId": { "description": "ID of the network's default route table.", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.NetworkStatus.State" } ], "description": "Current state of the network." } }, "type": "object" }, "nebius.vpc.v1.NetworkStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Enumeration of possible states of the network.\n\n - STATE_UNSPECIFIED: Default state, unspecified.\n - CREATING: Network is being created.\n - READY: Network is ready for use.\n - DELETING: Network is being deleted.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING" ], "type": "string" }, "nebius.vpc.v1.NextHop": { "properties": { "allocation": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.AllocationNextHop" } ], "description": "Forward traffic to a specific IP allocation (/32 address only).\nThe allocation must be from the same network as the route table.\nThe allocation must be assigned to either a Compute instance or a Load Balancer.\nWarning: If the allocation exists but is not assigned to any resource,\ntraffic will be forwarded to a \"black hole\" and dropped." }, "defaultEgressGateway": { "description": "Use the default egress gateway for outbound traffic.\nNote: For VMs with public addresses (Floating IPs/FIPs), the FIP-specific route\ntakes precedence over this default egress gateway route.", "type": "boolean" } }, "type": "object" }, "nebius.vpc.v1.NextHopState": { "properties": { "allocation": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.AllocationNextHopState" } ], "description": "Status of an allocation-based next hop." }, "defaultEgressGateway": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.DefaultEgressGatewayState" } ], "description": "Status of the default egress gateway configuration." } }, "type": "object" }, "nebius.vpc.v1.Pool": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata associated with the Pool.\n`metadata.parent_id` represents the Project." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.PoolSpec" } ], "description": "Specification of the Pool." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.PoolStatus" } ], "description": "Status information for the Pool." } }, "type": "object" }, "nebius.vpc.v1.PoolAssignment": { "properties": { "networks": { "description": "IDs of Networks to which the Pool is assigned.", "items": { "type": "string" }, "type": "array" }, "subnets": { "description": "IDs of Subnets to which the Pool is assigned.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.vpc.v1.PoolCidr": { "properties": { "cidr": { "description": "A CIDR block (e.g., \"10.1.2.0/24\") or a prefix length (e.g., \"/24\").\nIf prefix length is specified, the CIDR block will be auto-allocated from\nthe available space in the parent pool.", "type": "string" }, "maxMaskLength": { "description": "Maximum mask length for this pool child pools and allocations.\nDefault max_mask_length is 32 for IPv4.", "format": "int64", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.AddressBlockState" } ], "description": "Controls provisioning of IP addresses from the CIDR block to other pools\nor allocations. Defaults to AVAILABLE." } }, "required": [ "cidr" ], "type": "object" }, "nebius.vpc.v1.PoolSpec": { "properties": { "cidrs": { "description": "CIDR blocks defined by the pool.", "items": { "$ref": "#/components/schemas/nebius.vpc.v1.PoolCidr" }, "type": "array" }, "sourcePoolId": { "description": "ID of the source pool.\nCIDR blocks of a pool must be within the range defined by its source pool.", "type": "string" }, "version": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.IpVersion" } ], "description": "IP version of the pool." }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.IpVisibility" } ], "description": "Configures whether the pool is private or public.\nOnly public pools IP addresses are routable in the Internet." } }, "required": [ "version", "visibility" ], "type": "object" }, "nebius.vpc.v1.PoolStatus": { "properties": { "assignment": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.PoolAssignment" } ], "description": "Assignment details for this Pool" }, "cidrs": { "description": "CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "scopeId": { "description": "Scope is the unique identifier for single pool tree.", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.PoolStatus.State" } ], "description": "Current state of the Pool." } }, "type": "object" }, "nebius.vpc.v1.PoolStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Possible states of the Pool.\n\n - STATE_UNSPECIFIED: Default, unspecified state.\n - CREATING: Pool is being created.\n - READY: Pool is ready for use.\n - DELETING: Pool is being deleted.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING" ], "type": "string" }, "nebius.vpc.v1.Route": { "description": "Routes determine how network traffic is directed within a VPC network,\nspecifying the path that traffic should take based on destination addresses.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "`metadata.parent_id` represents the RouteTable." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteSpec" } ], "description": "Specification of the route's configuration." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteStatus" } ], "description": "Current status of the route." } }, "type": "object" }, "nebius.vpc.v1.RouteSpec": { "properties": { "description": { "description": "Optional description of the route.", "type": "string" }, "destination": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.DestinationMatch" } ], "description": "Destination for the route.\nEach destination CIDR must be unique within a route table.\nWhen multiple routes match a destination IP, the route with the longest\nmatching prefix (most specific match) is selected." }, "nextHop": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.NextHop" } ], "description": "Next hop configuration specifying where to send matching traffic." } }, "required": [ "destination", "nextHop" ], "type": "object" }, "nebius.vpc.v1.RouteStatus": { "properties": { "nextHop": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.NextHopState" } ], "description": "Detailed status of the next hop configuration." }, "priority": { "description": "Indicates priority of the route.\nThat is 0 or a positive number.\nLower value = higher priority; 0 is the highest priority.", "format": "int32", "type": "integer" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteStatus.State" } ], "description": "Current state of the route." }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteStatus.Type" } ], "description": "Indicates the route type.\nREDISTRIBUTED routes cannot be deleted directly." } }, "type": "object" }, "nebius.vpc.v1.RouteStatus.State": { "default": "STATE_UNSPECIFIED", "description": " - STATE_UNSPECIFIED: The state is unknown or not yet set.\n - READY: The route is configured and operational.", "enum": [ "STATE_UNSPECIFIED", "READY" ], "type": "string" }, "nebius.vpc.v1.RouteStatus.Type": { "default": "TYPE_UNSPECIFIED", "description": "Route type.", "enum": [ "TYPE_UNSPECIFIED", "STATIC", "REDISTRIBUTED" ], "type": "string" }, "nebius.vpc.v1.RouteTable": { "description": "RouteTable represents a routing configuration for a VPC network.\nEach route table can be associated with multiple subnets\nand contains rules for routing traffic to different destinations.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "`metadata.parent_id` represents the Project." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteTableSpec" } ], "description": "Specification of the route table's configuration." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteTableStatus" } ], "description": "Current status of the route table." } }, "type": "object" }, "nebius.vpc.v1.RouteTableAssignment": { "properties": { "subnets": { "description": "List of subnet IDs that use this route table for their routing configuration.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "nebius.vpc.v1.RouteTableSpec": { "properties": { "networkId": { "description": "ID of the VPC network this route table belongs to.", "type": "string" } }, "required": [ "networkId" ], "type": "object" }, "nebius.vpc.v1.RouteTableStatus": { "properties": { "assignment": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteTableAssignment" } ], "description": "Information about which subnets are using this route table." }, "default": { "description": "Indicates if this is the default route table for the network.\nOnly one route table can be default per network.", "type": "boolean" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteTableStatus.State" } ], "description": "Current state of the route table." } }, "type": "object" }, "nebius.vpc.v1.RouteTableStatus.State": { "default": "STATE_UNSPECIFIED", "description": "State indicates the current operational state of the route table.\n\n - STATE_UNSPECIFIED: The state is unknown or not yet set.\n - READY: The route table is configured and operational.", "enum": [ "STATE_UNSPECIFIED", "READY" ], "type": "string" }, "nebius.vpc.v1.RuleAccessAction": { "default": "ACCESS_UNSPECIFIED", "description": "Access specifies action on matching traffic: ALLOW or DENY.", "enum": [ "ACCESS_UNSPECIFIED", "ALLOW", "DENY" ], "type": "string" }, "nebius.vpc.v1.RuleDirection": { "default": "DIRECTION_UNSPECIFIED", "description": "Direction specifies whether traffic is INGRESS (incoming) or EGRESS (outgoing).", "enum": [ "DIRECTION_UNSPECIFIED", "INGRESS", "EGRESS" ], "type": "string" }, "nebius.vpc.v1.RuleEgress": { "description": "Defines match for outgoing traffic.", "properties": { "destinationCidrs": { "description": "CIDR blocks as the destination.\nOptional. Empty list means any address.\nMust be a valid IPv4.\nMaximum of 8 CIDRs can be specified.", "items": { "type": "string" }, "type": "array" }, "destinationPorts": { "description": "List of ports to which the rule applies.\nOptional. Empty list means any port.\nValid range: 1–65535.\nMaximum of 8 ports can be specified.", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "destinationSecurityGroupId": { "description": "ID of the referenced Security Group as the destination.", "type": "string" } }, "type": "object" }, "nebius.vpc.v1.RuleIngress": { "description": "Defines match for incoming traffic.", "properties": { "destinationPorts": { "description": "List of destination ports to which the rule applies.\nOptional. Empty list means any port.\nValid range: 1–65535.\nMaximum of 8 ports can be specified.", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "sourceCidrs": { "description": "CIDR blocks as the source.\nOptional. Empty list means any address.\nMust be a valid IPv4\nMaximum of 8 CIDRs can be specified.", "items": { "type": "string" }, "type": "array" }, "sourceSecurityGroupId": { "description": "ID of the referenced Security Group as the source.", "type": "string" } }, "type": "object" }, "nebius.vpc.v1.RuleMatchStatus": { "properties": { "cidrs": { "description": "List of CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "ports": { "description": "List of ports.", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "securityGroupId": { "description": "ID of the Security Group.", "type": "string" } }, "type": "object" }, "nebius.vpc.v1.RuleProtocol": { "default": "PROTOCOL_UNSPECIFIED", "description": "Protocol specifies traffic protocol.", "enum": [ "PROTOCOL_UNSPECIFIED", "ANY", "TCP", "UDP", "ICMP" ], "type": "string" }, "nebius.vpc.v1.RuleType": { "default": "RULE_TYPE_UNSPECIFIED", "description": "RuleType specifies whether the security rule is stateful or stateless.", "enum": [ "RULE_TYPE_UNSPECIFIED", "STATEFUL", "STATELESS" ], "type": "string" }, "nebius.vpc.v1.SecurityGroup": { "description": "SecurityGroup is a logical grouping of resources\nused to manage and apply network security policies collectively.\nSecurity group applies implicit deny at the end (traffic not matched by any rule will be denied).", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "`metadata.parent_id` represents the Project." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityGroupSpec" } ], "description": "Specification of the security group's configuration." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityGroupStatus" } ], "description": "Current status of the security group." } }, "type": "object" }, "nebius.vpc.v1.SecurityGroupSpec": { "properties": { "networkId": { "description": "ID of the VPC network this security group belongs to.", "type": "string" } }, "required": [ "networkId" ], "type": "object" }, "nebius.vpc.v1.SecurityGroupStatus": { "properties": { "default": { "description": "Indicates if this is the default security group for the network.\nOnly one security group can be default per network.\nWill be used on the interface if no other is specified.", "type": "boolean" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityGroupStatus.State" } ], "description": "Current state of the security group." } }, "type": "object" }, "nebius.vpc.v1.SecurityGroupStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Enumeration of possible states of the security group.\n\n - STATE_UNSPECIFIED: Default state, unspecified.\n - READY: Security group is ready for use.", "enum": [ "STATE_UNSPECIFIED", "READY" ], "type": "string" }, "nebius.vpc.v1.SecurityRule": { "description": "SecurityRules define rules for controlling network traffic within a network.\nThese rules specify when traffic is ALLOWED or DENIED based on direction, protocol,\nmatch source, and ports.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "`metadata.parent_id` represents the SecurityGroup." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityRuleSpec" } ], "description": "Specification of the security rule's configuration.\nDefines the parameters and constraints for rules that control network traffic." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityRuleStatus" } ], "description": "Current status of the security rule." } }, "type": "object" }, "nebius.vpc.v1.SecurityRuleSpec": { "properties": { "access": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RuleAccessAction" } ], "description": "Access action for the rule.\nRequired. Determines whether matching traffic is allowed or denied." }, "egress": { "$ref": "#/components/schemas/nebius.vpc.v1.RuleEgress" }, "ingress": { "$ref": "#/components/schemas/nebius.vpc.v1.RuleIngress" }, "priority": { "description": "Priority of the rule. Valid range: 0-1000.\nOptional. If not specified or set to 0, defaults to 500.\nRules are evaluated in priority order (lower numbers first) using a first-match algorithm:\nonly the first matching rule takes effect (ALLOW or DENY), and subsequent rules are skipped.\n\nWhen multiple rules share the same priority, DENY rules are evaluated before ALLOW rules.\nThe final evaluation order is reflected in 'effective_priority' (see SecurityRuleStatus).", "format": "int32", "type": "integer" }, "protocol": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RuleProtocol" } ], "description": "Protocol used in the rule.\nSupported values: ANY, TCP, UDP, ICMP." }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RuleType" } ], "description": "Type of the rule (STATEFUL or STATELESS)\nDefault value is STATEFUL" } }, "required": [ "access", "protocol" ], "type": "object" }, "nebius.vpc.v1.SecurityRuleStatus": { "properties": { "destination": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RuleMatchStatus" } ], "description": "Destination of the traffic that matched the rule." }, "direction": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RuleDirection" } ], "description": "Direction of traffic affected by the rule." }, "effectivePriority": { "description": "Effective priority used for rule evaluation order, calculated by the system.\nThis value is computed from the user-specified 'priority' (SecurityRuleSpec).\nRules are evaluated in ascending order of effective_priority using a first-match algorithm.", "format": "int32", "type": "integer" }, "source": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RuleMatchStatus" } ], "description": "Source of the traffic that matched the rule." }, "state": { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityRuleStatus.State" } }, "type": "object" }, "nebius.vpc.v1.SecurityRuleStatus.State": { "default": "STATE_UNSPECIFIED", "description": "State describes lifecycle phases of a security rule.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING" ], "type": "string" }, "nebius.vpc.v1.Subnet": { "description": "Defines a Subnet, a segment of a network used for more granular control and management.\nSubnet uses pools to organize address space.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the subnet resource.\n`metadata.parent_id` represents IAM container" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SubnetSpec" } ], "description": "Specification of the subnet." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SubnetStatus" } ], "description": "Status of the subnet." } }, "type": "object" }, "nebius.vpc.v1.SubnetAssociatedRouteTable": { "properties": { "default": { "description": "Indicates whether this is the network's default route table.\nIf true, this is the default route table inherited from the network.\nIf false, this is a custom route table explicitly associated with the subnet via spec.", "type": "boolean" }, "id": { "description": "ID of the route table.", "type": "string" } }, "type": "object" }, "nebius.vpc.v1.SubnetCidr": { "properties": { "cidr": { "description": "A CIDR block (e.g., \"10.1.2.0/24\") or a prefix length (e.g., \"/24\").\nIf prefix length is specified, the CIDR block will be auto-allocated\nfrom the network's available space.", "type": "string" }, "maxMaskLength": { "description": "Maximum mask length for an allocation from this block. Defaults to /32 for IPv4.", "format": "int64", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.AddressBlockState" } ], "description": "Controls provisioning of IP addresses from the CIDR block. Defaults to AVAILABLE." } }, "required": [ "cidr" ], "type": "object" }, "nebius.vpc.v1.SubnetPool": { "properties": { "cidrs": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1.SubnetCidr" }, "type": "array" } }, "type": "object" }, "nebius.vpc.v1.SubnetSpec": { "properties": { "ipv4PrivatePools": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.IPv4PrivateSubnetPools" } ], "description": "Private IPv4 address pools for this subnet.\nIf unspecified, pools from the associated network are used." }, "ipv4PublicPools": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.IPv4PublicSubnetPools" } ], "description": "Public IPv4 address pools for this subnet.\nIf unspecified, pools from the associated network are used." }, "networkId": { "description": "ID of the network this subnet belongs to.", "type": "string" }, "routeTableId": { "description": "ID of the route table to associate with the subnet.\nIf unspecified, the network's default route table is used.", "type": "string" } }, "required": [ "networkId" ], "type": "object" }, "nebius.vpc.v1.SubnetStatus": { "properties": { "ipv4PrivateCidrs": { "description": "CIDR blocks.\nDeprecated: Use `ipv4_private_pools.cidrs` instead.", "items": { "type": "string" }, "type": "array" }, "ipv4PrivatePools": { "description": "Private IPv4 pools available for allocations in this subnet.", "items": { "$ref": "#/components/schemas/nebius.vpc.v1.SubnetStatusPool" }, "type": "array" }, "ipv4PublicCidrs": { "description": "CIDR blocks.\nDeprecated: Use `ipv4_public_pools.cidrs` instead.", "items": { "type": "string" }, "type": "array" }, "ipv4PublicPools": { "description": "Public IPv4 pools available for allocations in this subnet.", "items": { "$ref": "#/components/schemas/nebius.vpc.v1.SubnetStatusPool" }, "type": "array" }, "routeTable": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SubnetAssociatedRouteTable" } ], "description": "Information about the route table associated with this subnet.\nCan be either a custom route table or the network's default route table." }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SubnetStatus.State" } ], "description": "Current state of the subnet." } }, "type": "object" }, "nebius.vpc.v1.SubnetStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Enumeration of possible states of the subnet.\n\n - STATE_UNSPECIFIED: Default state, unspecified.\n - CREATING: Subnet is being created.\n - READY: Subnet is ready for use.\n - DELETING: Subnet is being deleted.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING" ], "type": "string" }, "nebius.vpc.v1.SubnetStatusPool": { "properties": { "cidrs": { "description": "CIDR blocks sourced from this pool.", "items": { "type": "string" }, "type": "array" }, "poolId": { "description": "ID of the pool available for allocations in this subnet.", "type": "string" } }, "type": "object" }, "nebius.vpc.v1.Target": { "description": "Represents the target which can receive traffic from a load balancer listener", "properties": { "computeInstance": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.ComputeInstance" } ], "description": "Compute instance used as a target" } }, "type": "object" }, "nebius.vpc.v1.TargetGroup": { "description": "Target group represents the set of resources that receive traffic from a load balancer listener", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the TargetGroup resource.\n`metadata.parent_id` represents IAM container" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.TargetGroupSpec" } ], "description": "Specification of the TargetGroup." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.TargetGroupStatus" } ], "description": "Status of the TargetGroup." } }, "type": "object" }, "nebius.vpc.v1.TargetGroupSpec": { "properties": { "targets": { "description": "Targets of the TargetGroup", "items": { "$ref": "#/components/schemas/nebius.vpc.v1.Target" }, "type": "array" } }, "type": "object" }, "nebius.vpc.v1.TargetGroupStatus": { "properties": { "loadBalancerIds": { "description": "LoadBalancer ids target group is attached to", "items": { "type": "string" }, "type": "array" }, "targetStatuses": { "description": "Statuses of specified targets", "items": { "$ref": "#/components/schemas/nebius.vpc.v1.TargetStatus" }, "type": "array" } }, "type": "object" }, "nebius.vpc.v1.TargetStatus": { "properties": { "computeInstanceId": { "type": "string" }, "targetState": { "$ref": "#/components/schemas/nebius.vpc.v1.TargetStatus.TargetState" } }, "type": "object" }, "nebius.vpc.v1.TargetStatus.TargetState": { "default": "TARGET_STATE_UNSPECIFIED", "description": "- READY: The target exists and ready to receive traffic\n - DISABLED: The target exists, but not ready to receive traffic (i.e. network interface is not allocated)\n - DELETED: The target does not exist anymore (i.e. network interface was deleted)", "enum": [ "TARGET_STATE_UNSPECIFIED", "READY", "DISABLED", "DELETED" ], "type": "string" }, "nebius.vpc.v1.UpdateAllocationRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Updated metadata of the allocation." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.AllocationSpec" } ], "description": "Updated specification of the allocation." } }, "type": "object" }, "nebius.vpc.v1.UpdateNetworkRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Updated metadata of the network." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.NetworkSpec" } ], "description": "Updated specification of the network." } }, "type": "object" }, "nebius.vpc.v1.UpdatePoolRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Updated metadata of the pool." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.PoolSpec" } ], "description": "Updated specification of the pool." } }, "type": "object" }, "nebius.vpc.v1.UpdateRouteRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Updated metadata of the route." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteSpec" } ], "description": "Updated specification of the route." } }, "type": "object" }, "nebius.vpc.v1.UpdateRouteTableRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Updated metadata of the route table." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.RouteTableSpec" } ], "description": "Updated specification of the route table." } }, "type": "object" }, "nebius.vpc.v1.UpdateSecurityGroupRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Updated metadata of the security group." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityGroupSpec" } ], "description": "Updated specification of the security group." } }, "type": "object" }, "nebius.vpc.v1.UpdateSecurityRuleRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Updated metadata of the security rule." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityRuleSpec" } ], "description": "Updated specification of the security rule." } }, "type": "object" }, "nebius.vpc.v1.UpdateSubnetRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Updated metadata of the subnet." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.SubnetSpec" } ], "description": "Updated specification of the subnet." } }, "type": "object" }, "nebius.vpc.v1.UpdateTargetGroupRequest": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Updated metadata of the target group." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1.TargetGroupSpec" } ], "description": "Updated specification of the target group." } }, "type": "object" }, "nebius.vpc.v1alpha1.Allocation": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the Allocation.\n`metadata.parent_id` represents IAM Container." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.AllocationSpec" } ], "description": "Specifications for the allocation, detailing its name and IP configuration." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.AllocationStatus" } ], "description": "Contains the current status of the allocation, indicating its state and any additional details." } }, "type": "object" }, "nebius.vpc.v1alpha1.AllocationDetails": { "properties": { "allocatedCidr": { "type": "string" }, "poolId": { "type": "string" }, "version": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.IpVersion" } }, "type": "object" }, "nebius.vpc.v1alpha1.AllocationSpec": { "properties": { "ipv4Private": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.IPv4PrivateAllocationSpec" }, "ipv4Public": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.IPv4PublicAllocationSpec" } }, "type": "object" }, "nebius.vpc.v1alpha1.AllocationStatus": { "properties": { "assignment": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Assignment" } ], "description": "Information about the assignment associated with the allocation,\nsuch as network interface or load balancer assignment." }, "details": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.AllocationDetails" } ], "description": "Detailed information about the allocation status,\nincluding the allocated CIDR, pool ID, scope type, and IP version." }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.AllocationStatus.State" } ], "description": "This field represents the current state of the allocation." }, "static": { "description": "If false - Lifecycle of allocation depends on resource that using it.", "type": "boolean" } }, "type": "object" }, "nebius.vpc.v1alpha1.AllocationStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Enumeration of possible states of the Allocation.\n\n - STATE_UNSPECIFIED: Default state, unspecified.\n - CREATING: Allocation is being created.\n - ALLOCATED: Allocation is ready for use.\n - ASSIGNED: Allocation is used.\n - DELETING: Allocation is being deleted.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ALLOCATED", "ASSIGNED", "DELETING" ], "type": "string" }, "nebius.vpc.v1alpha1.Assignment": { "properties": { "loadBalancer": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.LoadBalancerAssignment" }, "networkInterface": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.NetworkInterfaceAssignment" } }, "type": "object" }, "nebius.vpc.v1alpha1.CreateAllocationRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.AllocationSpec" } }, "required": [ "metadata", "spec" ], "type": "object" }, "nebius.vpc.v1alpha1.IPv4PrivateAllocationSpec": { "properties": { "cidr": { "description": "CIDR block for IPv4 Allocation.\nMay be a single IP address (such as 10.2.3.4),\na prefix length (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).\nRandom address (/32) from pool would be allocated if field is omitted.", "type": "string" }, "poolId": { "description": "Pool for the IPv4 private allocation.", "type": "string" }, "subnetId": { "description": "Subnet ID.\nRequired same subnet to use allocation in subnet-resources (e.g. Network Interface)", "type": "string" } }, "type": "object" }, "nebius.vpc.v1alpha1.IPv4PublicAllocationSpec": { "properties": { "cidr": { "description": "CIDR block for IPv4 Allocation.\nMay be a single IP address (such as 10.2.3.4),\na prefix length (such as /32) or a CIDR-formatted string (such as 10.1.2.0/32).\nRandom address (/32) from pool would be allocated if field is omitted.", "type": "string" }, "poolId": { "description": "Pool for the IPv4 public allocation.", "type": "string" } }, "type": "object" }, "nebius.vpc.v1alpha1.IpVersion": { "default": "IP_VERSION_UNSPECIFIED", "description": " - IP_VERSION_UNSPECIFIED: Default, unspecified IP version.\n - IPV4: IPv4 address.\n - IPV6: IPv6 address.", "enum": [ "IP_VERSION_UNSPECIFIED", "IPV4", "IPV6" ], "type": "string" }, "nebius.vpc.v1alpha1.ListAllocationsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Allocation" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1alpha1.ListNetworksResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Network" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1alpha1.ListPoolsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Pool" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1alpha1.ListScopesResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Scope" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1alpha1.ListSubnetsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Subnet" }, "type": "array" }, "nextPageToken": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1alpha1.LoadBalancerAssignment": { "properties": { "id": { "description": "ID of the Load Balancer.", "type": "string" } }, "type": "object" }, "nebius.vpc.v1alpha1.Network": { "description": "Defines a Network, which serves as a virtual representation of a traditional LAN\nwithin a cloud environment.\nNetworks facilitate communication between subnets.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the network resource.\n`metadata.parent_id` represents IAM container" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.NetworkSpec" } ], "description": "Specification of the network." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.NetworkStatus" } ], "description": "Status of the network." } }, "type": "object" }, "nebius.vpc.v1alpha1.NetworkInterfaceAssignment": { "properties": { "instanceId": { "description": "ID of the Compute instance network interface belongs to.", "type": "string" }, "name": { "description": "Network interface name", "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.NetworkInterfaceAssignment.Type" } ], "description": "Type of allocation attachment on the network interface." } }, "type": "object" }, "nebius.vpc.v1alpha1.NetworkInterfaceAssignment.Type": { "default": "TYPE_UNSPECIFIED", "description": " - PRIMARY: Allocation is attached as the interface private IPv4 address.\n - ALIAS: Allocation is attached as an IP alias.\n - PUBLIC: Allocation is attached as the interface public IPv4 address.", "enum": [ "TYPE_UNSPECIFIED", "PRIMARY", "ALIAS", "PUBLIC" ], "type": "string" }, "nebius.vpc.v1alpha1.NetworkPool": { "properties": { "poolId": { "type": "string" } }, "type": "object" }, "nebius.vpc.v1alpha1.NetworkSpec": { "properties": { "pools": { "description": "Pools for addresses", "items": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.NetworkPool" }, "type": "array" } }, "type": "object" }, "nebius.vpc.v1alpha1.NetworkStatus": { "properties": { "scopeId": { "description": "Scope ID of all pools", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.NetworkStatus.State" } ], "description": "Current state of the network." } }, "type": "object" }, "nebius.vpc.v1alpha1.NetworkStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Enumeration of possible states of the network.\n\n - STATE_UNSPECIFIED: Default state, unspecified.\n - CREATING: Network is being created.\n - READY: Network is ready for use.\n - DELETING: Network is being deleted.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING" ], "type": "string" }, "nebius.vpc.v1alpha1.Pool": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata associated with the Pool.\n`metadata.parent_id` represents the Project." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.PoolSpec" } ], "description": "Specification of the Pool." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.PoolStatus" } ], "description": "Status information for the Pool." } }, "type": "object" }, "nebius.vpc.v1alpha1.PoolCidr": { "properties": { "allowedMask": { "description": "Maximum mask length for allocation from this IP pool including creation of sub-pools", "format": "int64", "type": "string" }, "cidr": { "description": "CIDR block.\nMay be a prefix length (such as /24) for non-top-level pools\nor a CIDR-formatted string (such as 10.1.2.0/24).", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.PoolCidrState" } ], "description": "State of the Cidr." } }, "type": "object" }, "nebius.vpc.v1alpha1.PoolCidrState": { "default": "STATE_UNSPECIFIED", "description": " - STATE_UNSPECIFIED: Default, unspecified state.\n - AVAILABLE: Allocation from range is available.\n - DISABLED: New allocation would not be created.", "enum": [ "STATE_UNSPECIFIED", "AVAILABLE", "DISABLED" ], "type": "string" }, "nebius.vpc.v1alpha1.PoolSpec": { "properties": { "cidrs": { "description": "CIDR blocks.", "items": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.PoolCidr" }, "type": "array" }, "sourcePoolId": { "description": "ID of source pool. Current pool will be created with the same scope.", "type": "string" }, "sourceScopeId": { "description": "ID of the scope. Pool will be considered as top-level pool within scope.", "type": "string" }, "version": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.IpVersion" } ], "description": "IP version for the Pool." } }, "type": "object" }, "nebius.vpc.v1alpha1.PoolStatus": { "properties": { "cidrs": { "description": "CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "scopeId": { "description": "ID of the scope", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.PoolStatus.State" } ], "description": "Current state of the Pool." } }, "type": "object" }, "nebius.vpc.v1alpha1.PoolStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Possible states of the Pool.\n\n - STATE_UNSPECIFIED: Default, unspecified state.\n - CREATING: Pool is being created.\n - READY: Pool is ready for use.\n - DELETING: Pool is being deleted.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING" ], "type": "string" }, "nebius.vpc.v1alpha1.Scope": { "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata associated with the Scope.\n`metadata.parent_id` represents the parent IAM container." }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.ScopeSpec" } ], "description": "Specification of the Scope." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.ScopeStatus" } ], "description": "Status information for the Scope." } }, "type": "object" }, "nebius.vpc.v1alpha1.ScopeSpec": { "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.ScopeSpec.Type" } ], "description": "Type of the Scope (Private or Public)." } }, "type": "object" }, "nebius.vpc.v1alpha1.ScopeSpec.Type": { "default": "SCOPE_TYPE_UNSPECIFIED", "description": "Type of scope.\n\n - SCOPE_TYPE_UNSPECIFIED: Default, unspecified scope type.\n - PUBLIC: Public scope.\n - PRIVATE: Private scope.", "enum": [ "SCOPE_TYPE_UNSPECIFIED", "PUBLIC", "PRIVATE" ], "type": "string" }, "nebius.vpc.v1alpha1.ScopeStatus": { "properties": { "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.ScopeStatus.State" } ], "description": "Current state of the Scope." } }, "type": "object" }, "nebius.vpc.v1alpha1.ScopeStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Possible states of the Scope.\n\n - STATE_UNSPECIFIED: Default, unspecified state.\n - CREATING: Scope is being created.\n - READY: Scope is ready for use.\n - DELETING: Scope is being deleted.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING" ], "type": "string" }, "nebius.vpc.v1alpha1.Subnet": { "description": "Defines a Subnet, a segment of a network used for more granular control and management.\nSubnet uses pools to organize address space.", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" } ], "description": "Metadata for the subnet resource.\n`metadata.parent_id` represents IAM container" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.SubnetSpec" } ], "description": "Specification of the subnet." }, "status": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.SubnetStatus" } ], "description": "Status of the subnet." } }, "type": "object" }, "nebius.vpc.v1alpha1.SubnetCidr": { "properties": { "allowedMask": { "description": "Maximum mask length for allocation from this cidr", "format": "int64", "type": "string" }, "cidr": { "description": "CIDR block.\nMay be a prefix length (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).", "type": "string" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.PoolCidrState" } ], "description": "State of the Cidr." } }, "type": "object" }, "nebius.vpc.v1alpha1.SubnetPool": { "properties": { "poolId": { "type": "string" }, "spec": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.SubnetPoolSpec" } }, "type": "object" }, "nebius.vpc.v1alpha1.SubnetPoolSpec": { "properties": { "cidrs": { "items": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.SubnetCidr" }, "type": "array" }, "version": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.IpVersion" } }, "type": "object" }, "nebius.vpc.v1alpha1.SubnetSpec": { "properties": { "enableEgressNat": { "description": "Enable egress NAT gateway", "type": "boolean" }, "networkId": { "description": "Network ID.", "type": "string" }, "pools": { "description": "Pool for addresses", "items": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.SubnetPool" }, "type": "array" } }, "type": "object" }, "nebius.vpc.v1alpha1.SubnetStatus": { "properties": { "ipv4Cidrs": { "description": "CIDR blocks.", "items": { "type": "string" }, "type": "array" }, "state": { "allOf": [ { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.SubnetStatus.State" } ], "description": "Current state of the subnet." } }, "type": "object" }, "nebius.vpc.v1alpha1.SubnetStatus.State": { "default": "STATE_UNSPECIFIED", "description": "Enumeration of possible states of the subnet.\n\n - STATE_UNSPECIFIED: Default state, unspecified.\n - CREATING: Subnet is being created.\n - READY: Subnet is ready for use.\n - DELETING: Subnet is being deleted.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "DELETING" ], "type": "string" }, "nebius.vpc.v1alpha1.UpdateAllocationRequest": { "properties": { "metadata": { "$ref": "#/components/schemas/nebius.common.v1.ResourceMetadata" }, "spec": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.AllocationSpec" } }, "type": "object" } }, "securitySchemes": { "bearerAuth": { "description": "The Authorization header expects a Bearer token.", "scheme": "bearer", "type": "http" } } }, "info": { "title": "Nebius API", "version": "version not set" }, "openapi": "3.0.3", "paths": { "/ai/v1/devlabs": { "get": { "description": "Retrieves a list of Devlabs.", "operationId": "DevlabService_List", "parameters": [ { "description": "The ID of the project that contains the Devlabs.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "The maximum number of Devlabs to return. The default and maximum are 100.\nValues outside the range 1 to 100 use the default.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "The next_page_token from the previous response. Use an empty string for the first page.\nKeep parent_id unchanged when you request the next page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.ListDevlabsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.ai.v1.DevlabService" ], "x-mint": { "href": "/rest-api/ai/v1/devlabs/list", "metadata": { "sidebarTitle": "List" } } }, "post": { "description": "Creates a Devlab.", "operationId": "DevlabService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.CreateDevlabRequest" } } }, "description": "A request to create a Devlab.", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.ai.v1.DevlabService" ], "x-mint": { "href": "/rest-api/ai/v1/devlabs/create", "metadata": { "sidebarTitle": "Create" } } } }, "/ai/v1/devlabs/get-by-name": { "get": { "description": "Returns the specified Devlab by name.", "operationId": "DevlabService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.Devlab" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.ai.v1.DevlabService" ], "x-mint": { "href": "/rest-api/ai/v1/devlabs/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/ai/v1/devlabs/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_ai_v1_DevlabService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.ai.v1.DevlabService" ], "x-mint": { "href": "/rest-api/ai/v1/devlabs/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/ai/v1/devlabs/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_ai_v1_DevlabService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.ai.v1.DevlabService" ], "x-mint": { "href": "/rest-api/ai/v1/devlabs/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/ai/v1/devlabs/restart": { "post": { "description": "Restarts a Devlab.", "operationId": "DevlabService_Restart", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.RestartDevlabRequest" } } }, "description": "A request to restart a Devlab.", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Restart", "tags": [ "nebius.ai.v1.DevlabService" ], "x-mint": { "href": "/rest-api/ai/v1/devlabs/restart", "metadata": { "sidebarTitle": "Restart" } } } }, "/ai/v1/devlabs/stop": { "post": { "description": "Stops a Devlab.", "operationId": "DevlabService_Stop", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.StopDevlabRequest" } } }, "description": "A request to stop a Devlab.", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Stop", "tags": [ "nebius.ai.v1.DevlabService" ], "x-mint": { "href": "/rest-api/ai/v1/devlabs/stop", "metadata": { "sidebarTitle": "Stop" } } } }, "/ai/v1/devlabs/{id}": { "delete": { "description": "Deletes a Devlab.", "operationId": "DevlabService_Delete", "parameters": [ { "description": "The ID of the Devlab to delete.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.ai.v1.DevlabService" ], "x-mint": { "href": "/rest-api/ai/v1/devlabs/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Returns the specified Devlab.", "operationId": "DevlabService_Get", "parameters": [ { "description": "The ID of the Devlab to retrieve.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "The response view. The default is VIEW_UNSPECIFIED.\n\n - VIEW_UNSPECIFIED: Masks environment-variable values and omits injected-file content.\n - SECRET: Includes unmasked environment-variable values and injected-file content.\nRequires the resource.devlab.getSensitiveData permission.", "in": "query", "name": "view", "schema": { "default": "VIEW_UNSPECIFIED", "enum": [ "VIEW_UNSPECIFIED", "SECRET" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.Devlab" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.ai.v1.DevlabService" ], "x-mint": { "href": "/rest-api/ai/v1/devlabs/get", "metadata": { "sidebarTitle": "Get" } } } }, "/ai/v1/endpoints": { "get": { "description": "Retrieves a list of endpoints.", "operationId": "EndpointService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.ListEndpointsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.ai.v1.EndpointService" ], "x-mint": { "href": "/rest-api/ai/v1/endpoints/list", "metadata": { "sidebarTitle": "List" } } }, "post": { "description": "Creates an endpoint.", "operationId": "EndpointService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.CreateEndpointRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.ai.v1.EndpointService" ], "x-mint": { "href": "/rest-api/ai/v1/endpoints/create", "metadata": { "sidebarTitle": "Create" } } } }, "/ai/v1/endpoints/get-by-name": { "get": { "description": "Returns the specified endpoint by name.", "operationId": "EndpointService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.Endpoint" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.ai.v1.EndpointService" ], "x-mint": { "href": "/rest-api/ai/v1/endpoints/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/ai/v1/endpoints/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_ai_v1_EndpointService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.ai.v1.EndpointService" ], "x-mint": { "href": "/rest-api/ai/v1/endpoints/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/ai/v1/endpoints/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_ai_v1_EndpointService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.ai.v1.EndpointService" ], "x-mint": { "href": "/rest-api/ai/v1/endpoints/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/ai/v1/endpoints/restart": { "post": { "description": "Restarts an endpoint.", "operationId": "EndpointService_Restart", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.RestartEndpointRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Restart", "tags": [ "nebius.ai.v1.EndpointService" ], "x-mint": { "href": "/rest-api/ai/v1/endpoints/restart", "metadata": { "sidebarTitle": "Restart" } } } }, "/ai/v1/endpoints/start": { "post": { "description": "Starts an endpoint.", "operationId": "EndpointService_Start", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.StartEndpointRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Start", "tags": [ "nebius.ai.v1.EndpointService" ], "x-mint": { "href": "/rest-api/ai/v1/endpoints/start", "metadata": { "sidebarTitle": "Start" } } } }, "/ai/v1/endpoints/stop": { "post": { "description": "Stops an endpoint.", "operationId": "EndpointService_Stop", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.StopEndpointRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Stop", "tags": [ "nebius.ai.v1.EndpointService" ], "x-mint": { "href": "/rest-api/ai/v1/endpoints/stop", "metadata": { "sidebarTitle": "Stop" } } } }, "/ai/v1/endpoints/{id}": { "delete": { "description": "Deletes an endpoint.", "operationId": "EndpointService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.ai.v1.EndpointService" ], "x-mint": { "href": "/rest-api/ai/v1/endpoints/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Returns the specified endpoint.", "operationId": "EndpointService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "SECRET includes injected-file content and unmasked inline S3 credentials and requires\nresource.aiendpoint.getSensitiveData.", "in": "query", "name": "view", "schema": { "default": "VIEW_UNSPECIFIED", "enum": [ "VIEW_UNSPECIFIED", "SECRET" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.Endpoint" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.ai.v1.EndpointService" ], "x-mint": { "href": "/rest-api/ai/v1/endpoints/get", "metadata": { "sidebarTitle": "Get" } } } }, "/ai/v1/jobs": { "get": { "description": "Retrieves a list of jobs.", "operationId": "JobService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.ListJobsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.ai.v1.JobService" ], "x-mint": { "href": "/rest-api/ai/v1/jobs/list", "metadata": { "sidebarTitle": "List" } } }, "post": { "description": "Creates a job.", "operationId": "JobService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.CreateJobRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.ai.v1.JobService" ], "x-mint": { "href": "/rest-api/ai/v1/jobs/create", "metadata": { "sidebarTitle": "Create" } } } }, "/ai/v1/jobs/cancel": { "post": { "description": "Cancels a job.", "operationId": "JobService_Cancel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.CancelJobRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Cancel", "tags": [ "nebius.ai.v1.JobService" ], "x-mint": { "href": "/rest-api/ai/v1/jobs/cancel", "metadata": { "sidebarTitle": "Cancel" } } } }, "/ai/v1/jobs/get-by-name": { "get": { "description": "Returns the specified job by name.", "operationId": "JobService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.Job" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.ai.v1.JobService" ], "x-mint": { "href": "/rest-api/ai/v1/jobs/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/ai/v1/jobs/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_ai_v1_JobService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.ai.v1.JobService" ], "x-mint": { "href": "/rest-api/ai/v1/jobs/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/ai/v1/jobs/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_ai_v1_JobService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.ai.v1.JobService" ], "x-mint": { "href": "/rest-api/ai/v1/jobs/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/ai/v1/jobs/restart": { "post": { "description": "Restarts a job.", "operationId": "JobService_Restart", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.RestartJobRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Restart", "tags": [ "nebius.ai.v1.JobService" ], "x-mint": { "href": "/rest-api/ai/v1/jobs/restart", "metadata": { "sidebarTitle": "Restart" } } } }, "/ai/v1/jobs/{id}": { "delete": { "description": "Deletes a job.", "operationId": "JobService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.ai.v1.JobService" ], "x-mint": { "href": "/rest-api/ai/v1/jobs/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Returns the specified job.", "operationId": "JobService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "SECRET includes injected-file content and unmasked inline S3 credentials and requires\nresource.aijob.getSensitiveData.", "in": "query", "name": "view", "schema": { "default": "VIEW_UNSPECIFIED", "enum": [ "VIEW_UNSPECIFIED", "SECRET" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.ai.v1.Job" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.ai.v1.JobService" ], "x-mint": { "href": "/rest-api/ai/v1/jobs/get", "metadata": { "sidebarTitle": "Get" } } } }, "/applications/v1alpha1/k8s-releases": { "get": { "operationId": "K8sReleaseService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } }, { "in": "query", "name": "clusterId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ListK8sReleasesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.applications.v1alpha1.K8sReleaseService" ], "x-mint": { "href": "/rest-api/applications/v1alpha1/k8s-releases/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "K8sReleaseService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.UpdateK8sReleaseRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.applications.v1alpha1.K8sReleaseService" ], "x-mint": { "href": "/rest-api/applications/v1alpha1/k8s-releases/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "K8sReleaseService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.CreateK8sReleaseRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.applications.v1alpha1.K8sReleaseService" ], "x-mint": { "href": "/rest-api/applications/v1alpha1/k8s-releases/create", "metadata": { "sidebarTitle": "Create" } } } }, "/applications/v1alpha1/k8s-releases/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_applications_v1alpha1_K8sReleaseService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.applications.v1alpha1.K8sReleaseService" ], "x-mint": { "href": "/rest-api/applications/v1alpha1/k8s-releases/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/applications/v1alpha1/k8s-releases/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_applications_v1alpha1_K8sReleaseService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.applications.v1alpha1.K8sReleaseService" ], "x-mint": { "href": "/rest-api/applications/v1alpha1/k8s-releases/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/applications/v1alpha1/k8s-releases/{id}": { "delete": { "operationId": "K8sReleaseService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.applications.v1alpha1.K8sReleaseService" ], "x-mint": { "href": "/rest-api/applications/v1alpha1/k8s-releases/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "K8sReleaseService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.K8sRelease" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.applications.v1alpha1.K8sReleaseService" ], "x-mint": { "href": "/rest-api/applications/v1alpha1/k8s-releases/get", "metadata": { "sidebarTitle": "Get" } } } }, "/applications/v1alpha1/vm-app-templates": { "get": { "description": "Retrieves a list of VM app templates.", "operationId": "VmAppTemplateService_List", "parameters": [ { "description": "The project ID. The response includes templates from this project and the global catalog.\nRequired unless global_only is true.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "The requested page size. The service currently ignores this field and returns all matching templates.\nThe default value is 0.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "The pagination token. The service currently ignores this field. Leave it empty.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "The text to find in template names and descriptions. The search is case-sensitive.", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "The categories to match. The response includes templates that match at least one category.", "in": "query", "name": "categories", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Returns only global templates when true. The service ignores parent_id in this mode.\nGlobal catalog reads require authentication but do not require a resource permission.", "in": "query", "name": "globalOnly", "schema": { "type": "boolean" } }, { "description": "The template kind: \"covm\" or \"devlab\". The default is \"covm\".", "in": "query", "name": "kind", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.ListVmAppTemplatesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.applications.v1alpha1.VmAppTemplateService" ], "x-mint": { "href": "/rest-api/applications/v1alpha1/vm-app-templates/list", "metadata": { "sidebarTitle": "List" } } } }, "/applications/v1alpha1/vm-app-templates/{id}": { "get": { "description": "Returns the specified VM app template.", "operationId": "VmAppTemplateService_Get", "parameters": [ { "description": "The ID of the template to retrieve.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.applications.v1alpha1.VmAppTemplate" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.applications.v1alpha1.VmAppTemplateService" ], "x-mint": { "href": "/rest-api/applications/v1alpha1/vm-app-templates/get", "metadata": { "sidebarTitle": "Get" } } } }, "/audit/v2/audit-event-exports": { "get": { "description": "Returns a list of exports created for a specific parent_id.", "operationId": "AuditEventExportService_List", "parameters": [ { "description": "Parent id used when creating the audit export.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Region to retrieve audit exports (e.g. eu-north2, us-central1, eu-west1)\nSee https://docs.nebius.com/overview/regions", "in": "query", "name": "region", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.audit.v2.ListAuditEventExportResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.audit.v2.AuditEventExportService" ], "x-mint": { "href": "/rest-api/audit/v2/audit-event-exports/list", "metadata": { "sidebarTitle": "List" } } } }, "/audit/v2/audit-event-exports/cancel": { "post": { "description": "Stop active audit events export to s3 bucket, all data written before calling this API remains in the bucket.", "operationId": "AuditEventExportService_Cancel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.audit.v2.CancelRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Cancel", "tags": [ "nebius.audit.v2.AuditEventExportService" ], "x-mint": { "href": "/rest-api/audit/v2/audit-event-exports/cancel", "metadata": { "sidebarTitle": "Cancel" } } } }, "/audit/v2/audit-event-exports/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_audit_v2_AuditEventExportService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.audit.v2.AuditEventExportService" ], "x-mint": { "href": "/rest-api/audit/v2/audit-event-exports/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/audit/v2/audit-event-exports/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_audit_v2_AuditEventExportService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.audit.v2.AuditEventExportService" ], "x-mint": { "href": "/rest-api/audit/v2/audit-event-exports/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/audit/v2/audit-event-exports/start": { "post": { "description": "Start audit events export to s3 bucket for specific period.", "operationId": "AuditEventExportService_Start", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.audit.v2.StartRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Start", "tags": [ "nebius.audit.v2.AuditEventExportService" ], "x-mint": { "href": "/rest-api/audit/v2/audit-event-exports/start", "metadata": { "sidebarTitle": "Start" } } } }, "/audit/v2/audit-event-exports/{id}": { "get": { "description": "Returns the audit event export with the current progress status and the parameters with which it was created.", "operationId": "AuditEventExportService_Get", "parameters": [ { "description": "Id of the audit event export.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.audit.v2.AuditEventExport" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.audit.v2.AuditEventExportService" ], "x-mint": { "href": "/rest-api/audit/v2/audit-event-exports/get", "metadata": { "sidebarTitle": "Get" } } } }, "/audit/v2/audit-events": { "get": { "operationId": "AuditEventService_List", "parameters": [ { "description": "A tenant id must be provided", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "start", "required": true, "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "end", "required": true, "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Example:\nservice.name = 'iam' AND resource.hierarchy.id:'container-e0t' AND regex(resource.metadata.name, '^.*test.*$')\n\nSupported filters:\n\"=\" - equals\n\"!=\" - not equals\n\":\" - contains\nregex - regular expression\n\nFields that can be used for filtering:\naction\nauthentication.static_key_credential.id\nauthentication.subject.name\nauthentication.subject.service_account_id\nauthentication.subject.tenant_user_id\nauthentication.token_credential.masked_token\nresource.hierarchy.id\nresource.hierarchy.name\nresource.metadata.id\nresource.metadata.name\nresource.metadata.type\nservice.name\ntype\nstatus", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "Type of audit event to filter by.\n\n - EVENT_TYPE_UNSPECIFIED: Unspecified event type.\n - CONTROL_PLANE: Control plane events.\n - DATA_PLANE: Data plane events (S3).", "in": "query", "name": "eventType", "schema": { "default": "EVENT_TYPE_UNSPECIFIED", "enum": [ "EVENT_TYPE_UNSPECIFIED", "CONTROL_PLANE", "DATA_PLANE" ], "type": "string" } }, { "description": "Region to retrieve audit logs (e.g. eu-north2, us-central1, eu-west1)\nSee https://docs.nebius.com/overview/regions", "in": "query", "name": "region", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.audit.v2.ListAuditEventResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.audit.v2.AuditEventService" ], "x-mint": { "href": "/rest-api/audit/v2/audit-events/list", "metadata": { "sidebarTitle": "List" } } } }, "/billing/v1/calculator/estimate-batch": { "post": { "description": "Estimates prices for multiple resources.\nReturns aggregated hourly and monthly cost estimates for all specified resources.", "operationId": "CalculatorService_EstimateBatch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1.EstimateBatchRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1.EstimateBatchResponse" } } }, "description": "A successful response." } }, "summary": "Estimate Batch", "tags": [ "nebius.billing.v1.CalculatorService" ], "x-mint": { "href": "/rest-api/billing/v1/calculator/estimate-batch", "metadata": { "sidebarTitle": "Estimate Batch" } } } }, "/billing/v1/pricing-policies": { "get": { "operationId": "PricingPolicyService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1.ListPricingPoliciesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.billing.v1.PricingPolicyService" ], "x-mint": { "href": "/rest-api/billing/v1/pricing-policies/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates a pricing policy. `metadata.name` may change any time; the bid in\n`spec.pricing.max_price_v1` only while `status.running_vm_count` is 0\n(FAILED_PRECONDITION otherwise). Other spec fields are immutable\n(INVALID_ARGUMENT).", "operationId": "PricingPolicyService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1.UpdatePricingPolicyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.billing.v1.PricingPolicyService" ], "x-mint": { "href": "/rest-api/billing/v1/pricing-policies/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a pricing policy. A bid outside the allowed price range fails\nwith OUT_OF_RANGE; below the current market price it is accepted but the\npolicy starts SCHEDULING_STATE_BLOCKED. Policies per tenant are\nquota-limited (RESOURCE_EXHAUSTED past the limit).\nThe Operation completes once the policy is ready to back VMs.", "operationId": "PricingPolicyService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1.CreatePricingPolicyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.billing.v1.PricingPolicyService" ], "x-mint": { "href": "/rest-api/billing/v1/pricing-policies/create", "metadata": { "sidebarTitle": "Create" } } } }, "/billing/v1/pricing-policies/get-by-name": { "get": { "operationId": "PricingPolicyService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1.PricingPolicy" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.billing.v1.PricingPolicyService" ], "x-mint": { "href": "/rest-api/billing/v1/pricing-policies/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/billing/v1/pricing-policies/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_billing_v1_PricingPolicyService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.billing.v1.PricingPolicyService" ], "x-mint": { "href": "/rest-api/billing/v1/pricing-policies/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/billing/v1/pricing-policies/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_billing_v1_PricingPolicyService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.billing.v1.PricingPolicyService" ], "x-mint": { "href": "/rest-api/billing/v1/pricing-policies/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/billing/v1/pricing-policies/{id}": { "delete": { "description": "Deletes a pricing policy. Requires that no VM runs under the policy and\nnothing is being preempted (FAILED_PRECONDITION otherwise).", "operationId": "PricingPolicyService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.billing.v1.PricingPolicyService" ], "x-mint": { "href": "/rest-api/billing/v1/pricing-policies/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "PricingPolicyService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1.PricingPolicy" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.billing.v1.PricingPolicyService" ], "x-mint": { "href": "/rest-api/billing/v1/pricing-policies/get", "metadata": { "sidebarTitle": "Get" } } } }, "/billing/v1alpha1/calculators/estimate": { "post": { "description": "Estimates prices for a single resource.\nReturns both hourly and monthly cost estimates for the specified resource configuration.", "operationId": "CalculatorService_Estimate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1alpha1.EstimateRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1alpha1.EstimateResponse" } } }, "description": "A successful response." } }, "summary": "Estimate", "tags": [ "nebius.billing.v1alpha1.CalculatorService" ], "x-mint": { "href": "/rest-api/billing/v1alpha1/calculators/estimate", "metadata": { "sidebarTitle": "Estimate" } } } }, "/billing/v1alpha1/calculators/estimate-batch": { "post": { "description": "Estimates prices for multiple resources.\nReturns aggregated hourly and monthly cost estimates for all specified resources.", "operationId": "CalculatorService_EstimateBatch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1alpha1.EstimateBatchRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1alpha1.EstimateBatchResponse" } } }, "description": "A successful response." } }, "summary": "Estimate Batch", "tags": [ "nebius.billing.v1alpha1.CalculatorService" ], "x-mint": { "href": "/rest-api/billing/v1alpha1/calculators/estimate-batch", "metadata": { "sidebarTitle": "Estimate Batch" } } } }, "/billing/v1alpha1/one-time-exports": { "get": { "description": "Lists one-time exports for a given contract.", "operationId": "OneTimeExportService_List", "parameters": [ { "description": "Parent contract ID for which to list one-time exports.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of items to return per page.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for retrieving the next page of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1alpha1.ListOneTimeExportsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.billing.v1alpha1.OneTimeExportService" ], "x-mint": { "href": "/rest-api/billing/v1alpha1/one-time-exports/list", "metadata": { "sidebarTitle": "List" } } }, "post": { "description": "Creates a new one-time export of billing reports for the requested period.", "operationId": "OneTimeExportService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1alpha1.CreateOneTimeExportRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.billing.v1alpha1.OneTimeExportService" ], "x-mint": { "href": "/rest-api/billing/v1alpha1/one-time-exports/create", "metadata": { "sidebarTitle": "Create" } } } }, "/billing/v1alpha1/one-time-exports/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_billing_v1alpha1_OneTimeExportService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.billing.v1alpha1.OneTimeExportService" ], "x-mint": { "href": "/rest-api/billing/v1alpha1/one-time-exports/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/billing/v1alpha1/one-time-exports/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_billing_v1alpha1_OneTimeExportService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.billing.v1alpha1.OneTimeExportService" ], "x-mint": { "href": "/rest-api/billing/v1alpha1/one-time-exports/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/billing/v1alpha1/one-time-exports/{id}": { "get": { "description": "Retrieves details of a specific one-time export.\nWhen the export is complete, the response includes a fresh presigned download URL.", "operationId": "OneTimeExportService_Get", "parameters": [ { "description": "Unique identifier of the one-time export.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.billing.v1alpha1.OneTimeExport" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.billing.v1alpha1.OneTimeExportService" ], "x-mint": { "href": "/rest-api/billing/v1alpha1/one-time-exports/get", "metadata": { "sidebarTitle": "Get" } } } }, "/capacity/v1/capacity-allowances": { "get": { "description": "Lists project limits.\nLists non-created Capacity Allowances as well for clarity, showing the default limit.", "operationId": "CapacityAllowanceService_List", "parameters": [ { "description": "ID of the Project to list capacity allowances for.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. Must be between [1...1000].\nOptional; if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Pass an empty string to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.ListCapacityAllowancesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.capacity.v1.CapacityAllowanceService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-allowances/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates a Capacity Allowance by project ID and Capacity Block Group NID.", "operationId": "CapacityAllowanceService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.UpdateCapacityAllowanceRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.capacity.v1.CapacityAllowanceService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-allowances/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a Capacity Allowance by project ID and Capacity Block Group NID.", "operationId": "CapacityAllowanceService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.CreateCapacityAllowanceRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.capacity.v1.CapacityAllowanceService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-allowances/create", "metadata": { "sidebarTitle": "Create" } } } }, "/capacity/v1/capacity-allowances/get-by-parent-and-capacity-block-group": { "get": { "description": "Gets a Capacity Allowance by a project and a Capacity Block Group NID.\nReturns non-created Capacity Allowances as well for clarity, showing the default limit.", "operationId": "CapacityAllowanceService_GetByParentAndCapacityBlockGroup", "parameters": [ { "description": "ID of the Project to get capacity allowance for.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "ID of a Capacity Block Group to get capacity allowance for.", "in": "query", "name": "capacityBlockGroupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityAllowance" } } }, "description": "A successful response." } }, "summary": "Get By Parent And Capacity Block Group", "tags": [ "nebius.capacity.v1.CapacityAllowanceService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-allowances/get-by-parent-and-capacity-block-group", "metadata": { "sidebarTitle": "Get By Parent And Capacity Block Group" } } } }, "/capacity/v1/capacity-allowances/list-by-capacity-block-group": { "get": { "description": "Lists project limits for a Capacity Block Group.", "operationId": "CapacityAllowanceService_ListByCapacityBlockGroup", "parameters": [ { "description": "ID of a Capacity Block Group to list capacity allowances for.", "in": "query", "name": "capacityBlockGroupId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. Must be between [1...1000].\nOptional; if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Pass an empty string to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.ListCapacityAllowancesResponse" } } }, "description": "A successful response." } }, "summary": "List By Capacity Block Group", "tags": [ "nebius.capacity.v1.CapacityAllowanceService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-allowances/list-by-capacity-block-group", "metadata": { "sidebarTitle": "List By Capacity Block Group" } } } }, "/capacity/v1/capacity-allowances/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_capacity_v1_CapacityAllowanceService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.capacity.v1.CapacityAllowanceService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-allowances/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/capacity/v1/capacity-allowances/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_capacity_v1_CapacityAllowanceService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.capacity.v1.CapacityAllowanceService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-allowances/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/capacity/v1/capacity-allowances/{id}": { "delete": { "description": "Resets Capacity Allowance limit to the default value.", "operationId": "CapacityAllowanceService_Delete", "parameters": [ { "description": "ID of the Capacity Allowance.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.capacity.v1.CapacityAllowanceService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-allowances/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Gets a Capacity Allowance by its ID.", "operationId": "CapacityAllowanceService_Get", "parameters": [ { "description": "ID of the Capacity Allowance.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityAllowance" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.capacity.v1.CapacityAllowanceService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-allowances/get", "metadata": { "sidebarTitle": "Get" } } } }, "/capacity/v1/capacity-block-groups": { "get": { "description": "List all Capacity Block Groups for the specified Tenant.", "operationId": "CapacityBlockGroupService_List", "parameters": [ { "description": "Tenant ID of the Capacity Block Group.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. Must be between [1...200].\nOptional; if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Pass an empty string to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.ListCapacityBlockGroupsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.capacity.v1.CapacityBlockGroupService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-block-groups/list", "metadata": { "sidebarTitle": "List" } } } }, "/capacity/v1/capacity-block-groups/get-by-resource-affinity": { "get": { "description": "Get Capacity Block Group by its specification.", "operationId": "CapacityBlockGroupService_GetByResourceAffinity", "parameters": [ { "description": "Tenant ID of the Capacity Block Group.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the region where the Capacity Block Group is allocated.\nExample: \"eu-north1\".", "in": "query", "name": "region", "required": true, "schema": { "type": "string" } }, { "description": "The fabric where the Capacity Block Group is allocated.", "in": "query", "name": "resourceAffinity.computeV1.fabric", "schema": { "type": "string" } }, { "description": "The platform for which the Capacity Block Group is allocated.", "in": "query", "name": "resourceAffinity.computeV1.platform", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityBlockGroup" } } }, "description": "A successful response." } }, "summary": "Get By Resource Affinity", "tags": [ "nebius.capacity.v1.CapacityBlockGroupService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-block-groups/get-by-resource-affinity", "metadata": { "sidebarTitle": "Get By Resource Affinity" } } } }, "/capacity/v1/capacity-block-groups/list-resources": { "get": { "description": "List virtual machines instances' IDs that occupy a Capacity Block Group by its ID.", "operationId": "CapacityBlockGroupService_ListResources", "parameters": [ { "description": "ID of a Capacity Block Group.", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.ListCapacityBlockGroupResourcesResponse" } } }, "description": "A successful response." } }, "summary": "List Resources", "tags": [ "nebius.capacity.v1.CapacityBlockGroupService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-block-groups/list-resources", "metadata": { "sidebarTitle": "List Resources" } } } }, "/capacity/v1/capacity-block-groups/{id}": { "get": { "description": "Get Capacity Block Group by its ID.", "operationId": "CapacityBlockGroupService_Get", "parameters": [ { "description": "ID of the Capacity Block Group.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityBlockGroup" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.capacity.v1.CapacityBlockGroupService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-block-groups/get", "metadata": { "sidebarTitle": "Get" } } } }, "/capacity/v1/capacity-intervals": { "get": { "description": "List all capacity intervals in a Capacity Block Group.", "operationId": "CapacityIntervalService_List", "parameters": [ { "description": "Capacity Block Group ID for which the Capacity Intervals should be listed.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. Must be between [1...200].\nOptional; if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Pass an empty string to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.ListCapacityIntervalsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.capacity.v1.CapacityIntervalService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-intervals/list", "metadata": { "sidebarTitle": "List" } } } }, "/capacity/v1/capacity-intervals/{id}": { "get": { "description": "Get Capacity Interval by its ID.", "operationId": "CapacityIntervalService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.CapacityInterval" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.capacity.v1.CapacityIntervalService" ], "x-mint": { "href": "/rest-api/capacity/v1/capacity-intervals/get", "metadata": { "sidebarTitle": "Get" } } } }, "/capacity/v1/resource-advice": { "get": { "description": "Returns a list of resource advice entries for the caller's tenant.\nEach entry represents a unique combination of region, fabric, platform, and preset\n(e.g., gpu-b200-sxm / 8gpu-160vcpu-1792gb in us-central1-b) and reports current\ncapacity availability across three allocation types: reserved, on-demand, and preemptible.\nUse this method to determine where and which compute instances can be launched\ngiven the tenant's quotas, capacity block groups, and the current physical capacity in data centers.\nSupports filtering by region, resource type, or platform.", "operationId": "ResourceAdviceService_List", "parameters": [ { "description": "Tenant NID.\nRequired to calculate 'available' numbers clipped by user quotas.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of items to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Page token for pagination.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.capacity.v1.ListResourceAdviceResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.capacity.v1.ResourceAdviceService" ], "x-mint": { "href": "/rest-api/capacity/v1/resource-advice/list", "metadata": { "sidebarTitle": "List" } } } }, "/compute/v1/disk-snapshots": { "get": { "description": "Lists all snapshots in a specific parent resource.", "operationId": "DiskSnapshotService_List", "parameters": [ { "description": "Identifier of the parent resource", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListDiskSnapshotsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.compute.v1.DiskSnapshotService" ], "x-mint": { "href": "/rest-api/compute/v1/disk-snapshots/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing snapshot with new configuration parameters.", "operationId": "DiskSnapshotService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.UpdateDiskSnapshotRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.compute.v1.DiskSnapshotService" ], "x-mint": { "href": "/rest-api/compute/v1/disk-snapshots/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new snapshot resource of a disk.", "operationId": "DiskSnapshotService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.CreateDiskSnapshotRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.compute.v1.DiskSnapshotService" ], "x-mint": { "href": "/rest-api/compute/v1/disk-snapshots/create", "metadata": { "sidebarTitle": "Create" } } } }, "/compute/v1/disk-snapshots/get-by-name": { "get": { "description": "Retrieves information about a snapshot by its parent and name.", "operationId": "DiskSnapshotService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSnapshot" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.compute.v1.DiskSnapshotService" ], "x-mint": { "href": "/rest-api/compute/v1/disk-snapshots/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/compute/v1/disk-snapshots/list-by-disk": { "get": { "description": "Lists all snapshots with a specific source disk.", "operationId": "DiskSnapshotService_ListByDisk", "parameters": [ { "description": "ID of computedisk resource", "in": "query", "name": "diskId", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListDiskSnapshotsByDiskResponse" } } }, "description": "A successful response." } }, "summary": "List By Disk", "tags": [ "nebius.compute.v1.DiskSnapshotService" ], "x-mint": { "href": "/rest-api/compute/v1/disk-snapshots/list-by-disk", "metadata": { "sidebarTitle": "List By Disk" } } } }, "/compute/v1/disk-snapshots/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_compute_v1_DiskSnapshotService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.compute.v1.DiskSnapshotService" ], "x-mint": { "href": "/rest-api/compute/v1/disk-snapshots/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/compute/v1/disk-snapshots/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_compute_v1_DiskSnapshotService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.compute.v1.DiskSnapshotService" ], "x-mint": { "href": "/rest-api/compute/v1/disk-snapshots/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/compute/v1/disk-snapshots/{id}": { "delete": { "description": "Deletes snapshot.", "operationId": "DiskSnapshotService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.compute.v1.DiskSnapshotService" ], "x-mint": { "href": "/rest-api/compute/v1/disk-snapshots/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves detailed information about a specific snapshot by its ID.", "operationId": "DiskSnapshotService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.DiskSnapshot" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.compute.v1.DiskSnapshotService" ], "x-mint": { "href": "/rest-api/compute/v1/disk-snapshots/get", "metadata": { "sidebarTitle": "Get" } } } }, "/compute/v1/disks": { "get": { "description": "Lists all disks within a specified parent.", "operationId": "DiskService_List", "parameters": [ { "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListDisksResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.compute.v1.DiskService" ], "x-mint": { "href": "/rest-api/compute/v1/disks/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing disk with new configuration parameters.\nFor details, see https://docs.nebius.com/compute/storage/manage#parameters", "operationId": "DiskService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.UpdateDiskRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.compute.v1.DiskService" ], "x-mint": { "href": "/rest-api/compute/v1/disks/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new disk with the specified configuration.\nFor details, see https://docs.nebius.com/compute/storage/manage", "operationId": "DiskService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.CreateDiskRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.compute.v1.DiskService" ], "x-mint": { "href": "/rest-api/compute/v1/disks/create", "metadata": { "sidebarTitle": "Create" } } } }, "/compute/v1/disks/get-by-name": { "get": { "description": "Retrieves information about a disk by its parent and name.", "operationId": "DiskService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.Disk" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.compute.v1.DiskService" ], "x-mint": { "href": "/rest-api/compute/v1/disks/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/compute/v1/disks/list-operations-by-parent": { "get": { "description": "Lists all operations that were performed within a specific parent resource.", "operationId": "DiskService_ListOperationsByParent", "parameters": [ { "description": "ID of the parent to list operations for resource type at.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations By Parent", "tags": [ "nebius.compute.v1.DiskService" ], "x-mint": { "href": "/rest-api/compute/v1/disks/list-operations-by-parent", "metadata": { "sidebarTitle": "List Operations By Parent" } } } }, "/compute/v1/disks/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_compute_v1_DiskService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.compute.v1.DiskService" ], "x-mint": { "href": "/rest-api/compute/v1/disks/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/compute/v1/disks/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_compute_v1_DiskService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.compute.v1.DiskService" ], "x-mint": { "href": "/rest-api/compute/v1/disks/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/compute/v1/disks/{id}": { "delete": { "description": "Deletes a disk by its ID.", "operationId": "DiskService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.compute.v1.DiskService" ], "x-mint": { "href": "/rest-api/compute/v1/disks/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves information about a disk by its ID.", "operationId": "DiskService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.Disk" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.compute.v1.DiskService" ], "x-mint": { "href": "/rest-api/compute/v1/disks/get", "metadata": { "sidebarTitle": "Get" } } } }, "/compute/v1/filesystems": { "get": { "description": "Lists all filesystems within a specified parent.", "operationId": "FilesystemService_List", "parameters": [ { "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListFilesystemsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.compute.v1.FilesystemService" ], "x-mint": { "href": "/rest-api/compute/v1/filesystems/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing filesystem with new configuration parameters.\nFor details, see https://docs.nebius.com/compute/storage/manage#parameters", "operationId": "FilesystemService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.UpdateFilesystemRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.compute.v1.FilesystemService" ], "x-mint": { "href": "/rest-api/compute/v1/filesystems/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new filesystem with the specified configuration.\nFor details, see https://docs.nebius.com/compute/storage/manage", "operationId": "FilesystemService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.CreateFilesystemRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.compute.v1.FilesystemService" ], "x-mint": { "href": "/rest-api/compute/v1/filesystems/create", "metadata": { "sidebarTitle": "Create" } } } }, "/compute/v1/filesystems/get-by-name": { "get": { "description": "Retrieves information about a filesystem by its parent and name.", "operationId": "FilesystemService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.Filesystem" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.compute.v1.FilesystemService" ], "x-mint": { "href": "/rest-api/compute/v1/filesystems/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/compute/v1/filesystems/list-operations-by-parent": { "get": { "description": "Lists all operations that were performed within a specific parent resource.", "operationId": "FilesystemService_ListOperationsByParent", "parameters": [ { "description": "ID of the parent to list operations for resource type at.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations By Parent", "tags": [ "nebius.compute.v1.FilesystemService" ], "x-mint": { "href": "/rest-api/compute/v1/filesystems/list-operations-by-parent", "metadata": { "sidebarTitle": "List Operations By Parent" } } } }, "/compute/v1/filesystems/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_compute_v1_FilesystemService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.compute.v1.FilesystemService" ], "x-mint": { "href": "/rest-api/compute/v1/filesystems/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/compute/v1/filesystems/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_compute_v1_FilesystemService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.compute.v1.FilesystemService" ], "x-mint": { "href": "/rest-api/compute/v1/filesystems/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/compute/v1/filesystems/{id}": { "delete": { "description": "Deletes a disk by its ID.", "operationId": "FilesystemService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.compute.v1.FilesystemService" ], "x-mint": { "href": "/rest-api/compute/v1/filesystems/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves information about a filesystem by its ID.", "operationId": "FilesystemService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.Filesystem" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.compute.v1.FilesystemService" ], "x-mint": { "href": "/rest-api/compute/v1/filesystems/get", "metadata": { "sidebarTitle": "Get" } } } }, "/compute/v1/gpu-clusters": { "get": { "description": "Lists GPU Clusters in the specified parent.", "operationId": "GpuClusterService_List", "parameters": [ { "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListGpuClustersResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.compute.v1.GpuClusterService" ], "x-mint": { "href": "/rest-api/compute/v1/gpu-clusters/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Modifies the configuration of an existing GPU Cluster.", "operationId": "GpuClusterService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.UpdateGpuClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.compute.v1.GpuClusterService" ], "x-mint": { "href": "/rest-api/compute/v1/gpu-clusters/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new GPU Cluster.\nFor details, see https://docs.nebius.com/compute/clusters/gpu#create-cluster", "operationId": "GpuClusterService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.CreateGpuClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.compute.v1.GpuClusterService" ], "x-mint": { "href": "/rest-api/compute/v1/gpu-clusters/create", "metadata": { "sidebarTitle": "Create" } } } }, "/compute/v1/gpu-clusters/get-by-name": { "get": { "description": "Retrieves the specified GPU Cluster by its parent and name.", "operationId": "GpuClusterService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.GpuCluster" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.compute.v1.GpuClusterService" ], "x-mint": { "href": "/rest-api/compute/v1/gpu-clusters/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/compute/v1/gpu-clusters/list-operations-by-parent": { "get": { "description": "Lists all operations that were performed within a specific parent resource.", "operationId": "GpuClusterService_ListOperationsByParent", "parameters": [ { "description": "ID of the parent to list operations for resource type at.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations By Parent", "tags": [ "nebius.compute.v1.GpuClusterService" ], "x-mint": { "href": "/rest-api/compute/v1/gpu-clusters/list-operations-by-parent", "metadata": { "sidebarTitle": "List Operations By Parent" } } } }, "/compute/v1/gpu-clusters/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_compute_v1_GpuClusterService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.compute.v1.GpuClusterService" ], "x-mint": { "href": "/rest-api/compute/v1/gpu-clusters/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/compute/v1/gpu-clusters/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_compute_v1_GpuClusterService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.compute.v1.GpuClusterService" ], "x-mint": { "href": "/rest-api/compute/v1/gpu-clusters/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/compute/v1/gpu-clusters/{id}": { "delete": { "description": "Deletes a GPU Cluster by its ID.", "operationId": "GpuClusterService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.compute.v1.GpuClusterService" ], "x-mint": { "href": "/rest-api/compute/v1/gpu-clusters/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves the specified GPU Cluster by its ID.", "operationId": "GpuClusterService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.GpuCluster" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.compute.v1.GpuClusterService" ], "x-mint": { "href": "/rest-api/compute/v1/gpu-clusters/get", "metadata": { "sidebarTitle": "Get" } } } }, "/compute/v1/images": { "get": { "description": "Lists all images in a specific parent resource.", "operationId": "ImageService_List", "parameters": [ { "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListImagesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.compute.v1.ImageService" ], "x-mint": { "href": "/rest-api/compute/v1/images/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing image resource. Only specific fields can be updated, such as labels and name.", "operationId": "ImageService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.UpdateImageRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.compute.v1.ImageService" ], "x-mint": { "href": "/rest-api/compute/v1/images/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new image resource.", "operationId": "ImageService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.CreateImageRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.compute.v1.ImageService" ], "x-mint": { "href": "/rest-api/compute/v1/images/create", "metadata": { "sidebarTitle": "Create" } } } }, "/compute/v1/images/get-by-name": { "get": { "description": "Retrieves detailed information about a specific image by its parent and name.", "operationId": "ImageService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.Image" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.compute.v1.ImageService" ], "x-mint": { "href": "/rest-api/compute/v1/images/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/compute/v1/images/get-latest-by-family": { "get": { "description": "Retrieves the most recent image from a specified family.\nImage families are used to organize related images and ensure easy access to the latest version.", "operationId": "ImageService_GetLatestByFamily", "parameters": [ { "in": "query", "name": "imageFamily", "schema": { "type": "string" } }, { "description": "The default is `project-{region}public-images`.", "in": "query", "name": "parentId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.Image" } } }, "description": "A successful response." } }, "summary": "Get Latest By Family", "tags": [ "nebius.compute.v1.ImageService" ], "x-mint": { "href": "/rest-api/compute/v1/images/get-latest-by-family", "metadata": { "sidebarTitle": "Get Latest By Family" } } } }, "/compute/v1/images/list-operations-by-parent": { "get": { "description": "Lists all operations that were performed within a specific parent resource.", "operationId": "ImageService_ListOperationsByParent", "parameters": [ { "description": "ID of the parent to list operations for resource type at.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations By Parent", "tags": [ "nebius.compute.v1.ImageService" ], "x-mint": { "href": "/rest-api/compute/v1/images/list-operations-by-parent", "metadata": { "sidebarTitle": "List Operations By Parent" } } } }, "/compute/v1/images/list-public": { "get": { "description": "Lists all public images available in a specific region. Regions doc https://docs.nebius.com/overview/regions\nPublic images can contain specific labels in metadata like:\n\"os_name: Ubuntu\", \"os_version: 22.04 LTS\", \"linux_kernel: 5.15\", \"cuda_toolkit: 13.0\"\n\"nvidia_gpu_drivers: 550\", \"networking_package: OFED 23.10\"", "operationId": "ImageService_ListPublic", "parameters": [ { "description": "Region name (eu-north2, us-central1, eu-west1, etc.)\nFor details, see https://docs.nebius.com/overview/regions", "in": "query", "name": "region", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListImagesResponse" } } }, "description": "A successful response." } }, "summary": "List Public", "tags": [ "nebius.compute.v1.ImageService" ], "x-mint": { "href": "/rest-api/compute/v1/images/list-public", "metadata": { "sidebarTitle": "List Public" } } } }, "/compute/v1/images/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_compute_v1_ImageService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.compute.v1.ImageService" ], "x-mint": { "href": "/rest-api/compute/v1/images/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/compute/v1/images/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_compute_v1_ImageService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.compute.v1.ImageService" ], "x-mint": { "href": "/rest-api/compute/v1/images/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/compute/v1/images/{id}": { "delete": { "description": "Deletes an existing image resource by its ID.", "operationId": "ImageService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.compute.v1.ImageService" ], "x-mint": { "href": "/rest-api/compute/v1/images/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves detailed information about a specific image by its ID.", "operationId": "ImageService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.Image" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.compute.v1.ImageService" ], "x-mint": { "href": "/rest-api/compute/v1/images/get", "metadata": { "sidebarTitle": "Get" } } } }, "/compute/v1/instances": { "get": { "description": "Lists all VM instances within a specified parent.", "operationId": "InstanceService_List", "parameters": [ { "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListInstancesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing VM instance with new configuration parameters.", "operationId": "InstanceService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.UpdateInstanceRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new VM instance based on the provided specification.\nFor details, see https://docs.nebius.com/compute/virtual-machines/manage", "operationId": "InstanceService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.CreateInstanceRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/create", "metadata": { "sidebarTitle": "Create" } } } }, "/compute/v1/instances/batch-get": { "get": { "description": "Retrieves detailed information about specific VMs by their IDs.\nIf instance cannot be retrieved (e.g. not found) error is returned in place of instance instead.", "operationId": "InstanceService_BatchGet", "parameters": [ { "description": "List of instances to fetch.", "in": "query", "name": "instanceIds", "schema": { "items": { "required": [ "instance_ids" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.BatchGetResponse" } } }, "description": "A successful response." } }, "summary": "Batch Get", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/batch-get", "metadata": { "sidebarTitle": "Batch Get" } } } }, "/compute/v1/instances/get-by-name": { "get": { "description": "Retrieves detailed information about a specific VM instance by its parent and name.", "operationId": "InstanceService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.Instance" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/compute/v1/instances/list-instances-by-nvl-instance-group": { "get": { "description": "Lists all VM instances that belong to the specified NVL instance group.", "operationId": "InstanceService_ListInstancesByNVLInstanceGroup", "parameters": [ { "description": "ID of the NVL instance group whose instances will be listed.", "in": "query", "name": "nvlInstanceGroupId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of instances to return in a single page.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Page token returned by a previous call, used to fetch the next page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListInstancesResponse" } } }, "description": "A successful response." } }, "summary": "List Instances By Nvl Instance Group", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/list-instances-by-nvl-instance-group", "metadata": { "sidebarTitle": "List Instances By Nvl Instance Group" } } } }, "/compute/v1/instances/list-operations-by-parent": { "get": { "description": "Lists all operations that were performed within a specific parent resource.", "operationId": "InstanceService_ListOperationsByParent", "parameters": [ { "description": "ID of the parent to list operations for resource type at.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations By Parent", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/list-operations-by-parent", "metadata": { "sidebarTitle": "List Operations By Parent" } } } }, "/compute/v1/instances/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_compute_v1_InstanceService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/compute/v1/instances/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_compute_v1_InstanceService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/compute/v1/instances/start": { "post": { "description": "Starts a stopped VM instance.", "operationId": "InstanceService_Start", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.StartInstanceRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Start", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/start", "metadata": { "sidebarTitle": "Start" } } } }, "/compute/v1/instances/stop": { "post": { "description": "Stops a running VM instance.", "operationId": "InstanceService_Stop", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.StopInstanceRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Stop", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/stop", "metadata": { "sidebarTitle": "Stop" } } } }, "/compute/v1/instances/{id}": { "delete": { "description": "Deletes a VM instance by its ID. Also deletes all the managed disks, declared in the instance spec.\nFails if cannot delete any of the managed disks.", "operationId": "InstanceService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves detailed information about a specific VM instance by its ID.", "operationId": "InstanceService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.Instance" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.compute.v1.InstanceService" ], "x-mint": { "href": "/rest-api/compute/v1/instances/get", "metadata": { "sidebarTitle": "Get" } } } }, "/compute/v1/maintenances/get-by-instance": { "get": { "description": "Returns only active maintenance event for the instance", "operationId": "MaintenanceService_GetByInstance", "parameters": [ { "in": "query", "name": "instanceId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.MaintenanceEvent" } } }, "description": "A successful response." } }, "summary": "Get By Instance", "tags": [ "nebius.compute.v1.MaintenanceService" ], "x-mint": { "href": "/rest-api/compute/v1/maintenances/get-by-instance", "metadata": { "sidebarTitle": "Get By Instance" } } } }, "/compute/v1/maintenances/list-active": { "get": { "description": "Returns all unfinished maintenance events for the parent", "operationId": "MaintenanceService_ListActive", "parameters": [ { "description": "Parent ID of maintenance events.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListMaintenanceEventsResponse" } } }, "description": "A successful response." } }, "summary": "List Active", "tags": [ "nebius.compute.v1.MaintenanceService" ], "x-mint": { "href": "/rest-api/compute/v1/maintenances/list-active", "metadata": { "sidebarTitle": "List Active" } } } }, "/compute/v1/nodes/set-unhealthy": { "post": { "description": "1. Scheduler makes the best effort not to assign new VMs to the unhealthy node,\n but in case of no capacity, the VM can be assigned to an unhealthy node.\n2. The existing VMs continue to work on the node, but after stop/start via\n Compute API they most probably will be assigned to a different node.\n\nTo use this rpc one needs to obtain `compute.node.setUnhealthy` permission\nfor the VM's parent container. The permission is granted to the TSA inside the VM.", "operationId": "NodeService_SetUnhealthy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.NodeSetUnhealthyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.NodeSetUnhealthyResponse" } } }, "description": "A successful response." } }, "summary": "Set Unhealthy", "tags": [ "nebius.compute.v1.NodeService" ], "x-mint": { "href": "/rest-api/compute/v1/nodes/set-unhealthy", "metadata": { "sidebarTitle": "Set Unhealthy" } } } }, "/compute/v1/nvl-instance-groups": { "get": { "description": "List lists all NVL InstanceGroups in the specified parent.", "operationId": "NVLInstanceGroupService_List", "parameters": [ { "description": "Identifier of the parent project for the NVL InstanceGroup.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListNVLInstanceGroupsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.compute.v1.NVLInstanceGroupService" ], "x-mint": { "href": "/rest-api/compute/v1/nvl-instance-groups/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Update modifies the specified NVL InstanceGroup by its ID.", "operationId": "NVLInstanceGroupService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.UpdateNVLInstanceGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.compute.v1.NVLInstanceGroupService" ], "x-mint": { "href": "/rest-api/compute/v1/nvl-instance-groups/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Create creates a new NVL InstanceGroup.", "operationId": "NVLInstanceGroupService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.CreateNVLInstanceGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.compute.v1.NVLInstanceGroupService" ], "x-mint": { "href": "/rest-api/compute/v1/nvl-instance-groups/create", "metadata": { "sidebarTitle": "Create" } } } }, "/compute/v1/nvl-instance-groups/get-by-name": { "get": { "description": "GetByName retrieves the specified NVL InstanceGroup by its parent and name.", "operationId": "NVLInstanceGroupService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.NVLInstanceGroup" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.compute.v1.NVLInstanceGroupService" ], "x-mint": { "href": "/rest-api/compute/v1/nvl-instance-groups/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/compute/v1/nvl-instance-groups/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_compute_v1_NVLInstanceGroupService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.compute.v1.NVLInstanceGroupService" ], "x-mint": { "href": "/rest-api/compute/v1/nvl-instance-groups/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/compute/v1/nvl-instance-groups/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_compute_v1_NVLInstanceGroupService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.compute.v1.NVLInstanceGroupService" ], "x-mint": { "href": "/rest-api/compute/v1/nvl-instance-groups/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/compute/v1/nvl-instance-groups/{id}": { "delete": { "description": "Delete deletes the specified NVL InstanceGroup by its ID.", "operationId": "NVLInstanceGroupService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.compute.v1.NVLInstanceGroupService" ], "x-mint": { "href": "/rest-api/compute/v1/nvl-instance-groups/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Get retrieves the specified NVL InstanceGroup by its ID.", "operationId": "NVLInstanceGroupService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.NVLInstanceGroup" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.compute.v1.NVLInstanceGroupService" ], "x-mint": { "href": "/rest-api/compute/v1/nvl-instance-groups/get", "metadata": { "sidebarTitle": "Get" } } } }, "/compute/v1/platforms": { "get": { "description": "Lists all compute platforms within a specified parent.", "operationId": "PlatformService_List", "parameters": [ { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "ID of the parent project for the platform request.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.ListPlatformsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.compute.v1.PlatformService" ], "x-mint": { "href": "/rest-api/compute/v1/platforms/list", "metadata": { "sidebarTitle": "List" } } } }, "/compute/v1/platforms/get-by-name": { "get": { "description": "Retrieves detailed information about a specific compute platform by its parent and name.", "operationId": "PlatformService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.compute.v1.Platform" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.compute.v1.PlatformService" ], "x-mint": { "href": "/rest-api/compute/v1/platforms/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/dns/v1/records": { "get": { "description": "Lists DNS records in the specified DNS zone", "operationId": "RecordService_List", "parameters": [ { "description": "Parent DNS zone ID", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Page size\nIf not specified or set to `0`, a default page size of `100` will be used", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "An opaque listing continuation token\n- If not specified or empty, the first page of results will be returned\n- If specified, the next page of results (as identified by the token) will be returned", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.dns.v1.ListRecordsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.dns.v1.RecordService" ], "x-mint": { "href": "/rest-api/dns/v1/records/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates the DNS record with the specified ID", "operationId": "RecordService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.dns.v1.UpdateRecordRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.dns.v1.RecordService" ], "x-mint": { "href": "/rest-api/dns/v1/records/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a DNS record", "operationId": "RecordService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.dns.v1.CreateRecordRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.dns.v1.RecordService" ], "x-mint": { "href": "/rest-api/dns/v1/records/create", "metadata": { "sidebarTitle": "Create" } } } }, "/dns/v1/records/get-by-name": { "get": { "description": "Gets the DNS record by its parent DNS zone (`metadata.parent_id`) and `metadata.name`", "operationId": "RecordService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.dns.v1.Record" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.dns.v1.RecordService" ], "x-mint": { "href": "/rest-api/dns/v1/records/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/dns/v1/records/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_dns_v1_RecordService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.dns.v1.RecordService" ], "x-mint": { "href": "/rest-api/dns/v1/records/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/dns/v1/records/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_dns_v1_RecordService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.dns.v1.RecordService" ], "x-mint": { "href": "/rest-api/dns/v1/records/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/dns/v1/records/{id}": { "delete": { "description": "Deletes the DNS record with the specified ID", "operationId": "RecordService_Delete", "parameters": [ { "description": "ID of the DNS record to delete", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Optional: expected DNS record version (`metadata.resource_version`)\n- If specified, ensures that only the requested version is deleted (and a `FAILED_PRECONDITION` error is returned on version mismatch)\n- If not specified or set to `0`, the latest version will be deleted", "in": "query", "name": "resourceVersion", "schema": { "format": "int64", "type": "string" } }, { "description": "Indicates that deletion-protected records should be also deleted\nAttempt to delete a protected record without this flag set to `true` will cause a `FAILED_PRECONDITION` error", "in": "query", "name": "force", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.dns.v1.RecordService" ], "x-mint": { "href": "/rest-api/dns/v1/records/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Gets the DNS record with the specified ID", "operationId": "RecordService_Get", "parameters": [ { "description": "Record ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Optional: expected record version (`metadata.resource_version`)\n- If specified, the requested version will be returned if possible\n (if the version has changed, you will get a `FAILED_PRECONDITION` error)\n- If not specified or set to `0`, the latest version will be returned", "in": "query", "name": "resourceVersion", "schema": { "format": "int64", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.dns.v1.Record" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.dns.v1.RecordService" ], "x-mint": { "href": "/rest-api/dns/v1/records/get", "metadata": { "sidebarTitle": "Get" } } } }, "/dns/v1/zones": { "get": { "description": "Lists DNS zones in the specified parent IAM container", "operationId": "ZoneService_List", "parameters": [ { "description": "Parent IAM container ID", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Page size\nIf not specified or set to `0`, a default page size of `100` will be used", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "An opaque listing continuation token\n- If not specified or empty, the first page of results will be returned\n- If specified, the next page of results (as identified by the token) will be returned", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.dns.v1.ListZonesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.dns.v1.ZoneService" ], "x-mint": { "href": "/rest-api/dns/v1/zones/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates the DNS zone with the specified ID", "operationId": "ZoneService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.dns.v1.UpdateZoneRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.dns.v1.ZoneService" ], "x-mint": { "href": "/rest-api/dns/v1/zones/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a DNS zone", "operationId": "ZoneService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.dns.v1.CreateZoneRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.dns.v1.ZoneService" ], "x-mint": { "href": "/rest-api/dns/v1/zones/create", "metadata": { "sidebarTitle": "Create" } } } }, "/dns/v1/zones/get-by-name": { "get": { "description": "Gets the DNS zone by its parent IAM container (`metadata.parent_id`) and `metadata.name`", "operationId": "ZoneService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.dns.v1.Zone" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.dns.v1.ZoneService" ], "x-mint": { "href": "/rest-api/dns/v1/zones/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/dns/v1/zones/list-by-network": { "get": { "description": "Lists DNS zones in the specified virtual network", "operationId": "ZoneService_ListByNetwork", "parameters": [ { "description": "Network ID", "in": "query", "name": "networkId", "required": true, "schema": { "type": "string" } }, { "description": "Page size\nIf not specified or set to `0`, a default page size of `100` will be used", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "An opaque listing continuation token\n- If not specified or empty, the first page of results will be returned\n- If specified, the next page of results (as identified by the token) will be returned", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.dns.v1.ListZonesResponse" } } }, "description": "A successful response." } }, "summary": "List By Network", "tags": [ "nebius.dns.v1.ZoneService" ], "x-mint": { "href": "/rest-api/dns/v1/zones/list-by-network", "metadata": { "sidebarTitle": "List By Network" } } } }, "/dns/v1/zones/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_dns_v1_ZoneService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.dns.v1.ZoneService" ], "x-mint": { "href": "/rest-api/dns/v1/zones/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/dns/v1/zones/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_dns_v1_ZoneService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.dns.v1.ZoneService" ], "x-mint": { "href": "/rest-api/dns/v1/zones/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/dns/v1/zones/{id}": { "delete": { "description": "Deletes the DNS zone with the specified ID", "operationId": "ZoneService_Delete", "parameters": [ { "description": "ID of the DNS zone to delete", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Optional: expected DNS zone version (`metadata.resource_version`)\n- If specified, ensures that only the requested version is deleted (and a `FAILED_PRECONDITION` error is returned on version mismatch)\n- If not specified or set to `0`, the latest version will be deleted", "in": "query", "name": "resourceVersion", "schema": { "format": "int64", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.dns.v1.ZoneService" ], "x-mint": { "href": "/rest-api/dns/v1/zones/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Gets the DNS zone with the specified ID", "operationId": "ZoneService_Get", "parameters": [ { "description": "Zone ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Optional: expected zone version (`metadata.resource_version`)\n- If specified, the requested version will be returned if possible (if the version has changed, you will get a `FAILED_PRECONDITION`\n error)\n- If not specified or set to `0`, the latest zone version will be returned", "in": "query", "name": "resourceVersion", "schema": { "format": "int64", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.dns.v1.Zone" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.dns.v1.ZoneService" ], "x-mint": { "href": "/rest-api/dns/v1/zones/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/access-keys": { "delete": { "operationId": "AccessKeyService_Delete", "parameters": [ { "in": "query", "name": "id.id", "schema": { "type": "string" } }, { "in": "query", "name": "id.awsAccessKeyId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "AccessKeyService_List", "parameters": [ { "description": "Represents the container ID.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListAccessKeysResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "AccessKeyService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.UpdateAccessKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "AccessKeyService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.CreateAccessKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v1/access-keys/activate": { "post": { "operationId": "AccessKeyService_Activate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ActivateAccessKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Activate", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/activate", "metadata": { "sidebarTitle": "Activate" } } } }, "/iam/v1/access-keys/deactivate": { "post": { "operationId": "AccessKeyService_Deactivate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.DeactivateAccessKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Deactivate", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/deactivate", "metadata": { "sidebarTitle": "Deactivate" } } } }, "/iam/v1/access-keys/get-by-aws-id": { "get": { "operationId": "AccessKeyService_GetByAwsId", "parameters": [ { "in": "query", "name": "awsAccessKeyId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.AccessKey" } } }, "description": "A successful response." } }, "summary": "Get By Aws Id", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/get-by-aws-id", "metadata": { "sidebarTitle": "Get By Aws Id" } } } }, "/iam/v1/access-keys/get-by-id": { "get": { "operationId": "AccessKeyService_GetById", "parameters": [ { "in": "query", "name": "id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.AccessKey" } } }, "description": "A successful response." } }, "summary": "Get By Id", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/get-by-id", "metadata": { "sidebarTitle": "Get By Id" } } } }, "/iam/v1/access-keys/get-secret-once": { "get": { "operationId": "AccessKeyService_GetSecretOnce", "parameters": [ { "in": "query", "name": "id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.GetAccessKeySecretOnceResponse" } } }, "description": "A successful response." } }, "summary": "Get Secret Once", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/get-secret-once", "metadata": { "sidebarTitle": "Get Secret Once" } } } }, "/iam/v1/access-keys/list-by-account": { "get": { "operationId": "AccessKeyService_ListByAccount", "parameters": [ { "in": "query", "name": "account.userAccount.id", "schema": { "type": "string" } }, { "in": "query", "name": "account.serviceAccount.id", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListAccessKeysResponse" } } }, "description": "A successful response." } }, "summary": "List By Account", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/list-by-account", "metadata": { "sidebarTitle": "List By Account" } } } }, "/iam/v1/access-keys/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_AccessKeyService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/access-keys/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_AccessKeyService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/access-keys/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/access-permits": { "get": { "description": "Lists access permits for provided parent", "operationId": "AccessPermitService_List", "parameters": [ { "description": "Represents the container ID.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListAccessPermitResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.AccessPermitService" ], "x-mint": { "href": "/rest-api/iam/v1/access-permits/list", "metadata": { "sidebarTitle": "List" } } }, "post": { "description": "Creates access permit for provided resource with provided role.\nSubject of access permit is also a parent of access permit.\nIf resource is unknown - NOT_FOUND will be thrown.\nIf parent of subject is not from resource's hierarchy - NOT_FOUND will be thrown.", "operationId": "AccessPermitService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.CreateAccessPermitRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v1.AccessPermitService" ], "x-mint": { "href": "/rest-api/iam/v1/access-permits/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v1/access-permits/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_AccessPermitService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.AccessPermitService" ], "x-mint": { "href": "/rest-api/iam/v1/access-permits/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/access-permits/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_AccessPermitService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.AccessPermitService" ], "x-mint": { "href": "/rest-api/iam/v1/access-permits/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/access-permits/{id}": { "delete": { "description": "Delete access permit by id", "operationId": "AccessPermitService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v1.AccessPermitService" ], "x-mint": { "href": "/rest-api/iam/v1/access-permits/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Gets access permit by id", "operationId": "AccessPermitService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.AccessPermit" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.AccessPermitService" ], "x-mint": { "href": "/rest-api/iam/v1/access-permits/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/auth-public-keys": { "get": { "operationId": "AuthPublicKeyService_List", "parameters": [ { "description": "Represents the container ID.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListAuthPublicKeyResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.AuthPublicKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/auth-public-keys/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "AuthPublicKeyService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.UpdateAuthPublicKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v1.AuthPublicKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/auth-public-keys/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "AuthPublicKeyService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.CreateAuthPublicKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v1.AuthPublicKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/auth-public-keys/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v1/auth-public-keys/activate": { "post": { "operationId": "AuthPublicKeyService_Activate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ActivateAuthPublicKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Activate", "tags": [ "nebius.iam.v1.AuthPublicKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/auth-public-keys/activate", "metadata": { "sidebarTitle": "Activate" } } } }, "/iam/v1/auth-public-keys/deactivate": { "post": { "operationId": "AuthPublicKeyService_Deactivate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.DeactivateAuthPublicKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Deactivate", "tags": [ "nebius.iam.v1.AuthPublicKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/auth-public-keys/deactivate", "metadata": { "sidebarTitle": "Deactivate" } } } }, "/iam/v1/auth-public-keys/list-by-account": { "get": { "operationId": "AuthPublicKeyService_ListByAccount", "parameters": [ { "in": "query", "name": "account.userAccount.id", "schema": { "type": "string" } }, { "in": "query", "name": "account.serviceAccount.id", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListAuthPublicKeyResponse" } } }, "description": "A successful response." } }, "summary": "List By Account", "tags": [ "nebius.iam.v1.AuthPublicKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/auth-public-keys/list-by-account", "metadata": { "sidebarTitle": "List By Account" } } } }, "/iam/v1/auth-public-keys/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_AuthPublicKeyService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.AuthPublicKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/auth-public-keys/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/auth-public-keys/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_AuthPublicKeyService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.AuthPublicKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/auth-public-keys/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/auth-public-keys/{id}": { "delete": { "operationId": "AuthPublicKeyService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v1.AuthPublicKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/auth-public-keys/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "AuthPublicKeyService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.AuthPublicKey" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.AuthPublicKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/auth-public-keys/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/federated-credentials": { "get": { "description": "Lists federated credentials by parent container.", "operationId": "FederatedCredentialsService_List", "parameters": [ { "description": "Parent container ID for the federated credentials.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of items to return in the response. Default value: 10.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Filter expression for narrowing down the results.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListFederatedCredentialsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.FederatedCredentialsService" ], "x-mint": { "href": "/rest-api/iam/v1/federated-credentials/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates federated credentials.", "operationId": "FederatedCredentialsService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.UpdateFederatedCredentialsRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v1.FederatedCredentialsService" ], "x-mint": { "href": "/rest-api/iam/v1/federated-credentials/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates federated credentials.", "operationId": "FederatedCredentialsService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.CreateFederatedCredentialsRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v1.FederatedCredentialsService" ], "x-mint": { "href": "/rest-api/iam/v1/federated-credentials/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v1/federated-credentials/get-by-name": { "get": { "description": "Retrieves information about federated credentials by name and parent container.", "operationId": "FederatedCredentialsService_GetByName", "parameters": [ { "description": "Parent container ID for the federated credentials.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Target federated credentials name.", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.FederatedCredentials" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.iam.v1.FederatedCredentialsService" ], "x-mint": { "href": "/rest-api/iam/v1/federated-credentials/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/iam/v1/federated-credentials/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_FederatedCredentialsService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.FederatedCredentialsService" ], "x-mint": { "href": "/rest-api/iam/v1/federated-credentials/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/federated-credentials/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_FederatedCredentialsService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.FederatedCredentialsService" ], "x-mint": { "href": "/rest-api/iam/v1/federated-credentials/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/federated-credentials/{id}": { "delete": { "description": "Deletes federated credentials.", "operationId": "FederatedCredentialsService_Delete", "parameters": [ { "description": "Target federated credentials ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v1.FederatedCredentialsService" ], "x-mint": { "href": "/rest-api/iam/v1/federated-credentials/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves information about federated credentials by ID.", "operationId": "FederatedCredentialsService_Get", "parameters": [ { "description": "Target federated credentials ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.FederatedCredentials" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.FederatedCredentialsService" ], "x-mint": { "href": "/rest-api/iam/v1/federated-credentials/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/federation-certificates": { "patch": { "operationId": "FederationCertificateService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.UpdateFederationCertificateRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v1.FederationCertificateService" ], "x-mint": { "href": "/rest-api/iam/v1/federation-certificates/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "FederationCertificateService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.CreateFederationCertificateRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v1.FederationCertificateService" ], "x-mint": { "href": "/rest-api/iam/v1/federation-certificates/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v1/federation-certificates/list-by-federation": { "get": { "operationId": "FederationCertificateService_ListByFederation", "parameters": [ { "description": "Represents the parent federation ID. Corresponds to the parent_id value.", "in": "query", "name": "federationId", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListFederationCertificateResponse" } } }, "description": "A successful response." } }, "summary": "List By Federation", "tags": [ "nebius.iam.v1.FederationCertificateService" ], "x-mint": { "href": "/rest-api/iam/v1/federation-certificates/list-by-federation", "metadata": { "sidebarTitle": "List By Federation" } } } }, "/iam/v1/federation-certificates/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_FederationCertificateService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.FederationCertificateService" ], "x-mint": { "href": "/rest-api/iam/v1/federation-certificates/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/federation-certificates/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_FederationCertificateService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.FederationCertificateService" ], "x-mint": { "href": "/rest-api/iam/v1/federation-certificates/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/federation-certificates/update-bulk": { "post": { "description": "Replaces all federation's certificates with provided in the request. Certificates which are not presented will be removed.", "operationId": "FederationCertificateService_UpdateBulk", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.UpdateBulkFederationCertificateRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update Bulk", "tags": [ "nebius.iam.v1.FederationCertificateService" ], "x-mint": { "href": "/rest-api/iam/v1/federation-certificates/update-bulk", "metadata": { "sidebarTitle": "Update Bulk" } } } }, "/iam/v1/federation-certificates/{id}": { "delete": { "operationId": "FederationCertificateService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v1.FederationCertificateService" ], "x-mint": { "href": "/rest-api/iam/v1/federation-certificates/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "FederationCertificateService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.FederationCertificate" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.FederationCertificateService" ], "x-mint": { "href": "/rest-api/iam/v1/federation-certificates/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/federations": { "get": { "description": "Lists federations by parent container.", "operationId": "FederationService_List", "parameters": [ { "description": "Parent container ID for the federations.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of items to return in the response. Default value: 10.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Filter expression for narrowing down the results.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListFederationsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.FederationService" ], "x-mint": { "href": "/rest-api/iam/v1/federations/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates a federation.", "operationId": "FederationService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.UpdateFederationRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v1.FederationService" ], "x-mint": { "href": "/rest-api/iam/v1/federations/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a federation.", "operationId": "FederationService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.CreateFederationRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v1.FederationService" ], "x-mint": { "href": "/rest-api/iam/v1/federations/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v1/federations/activate": { "post": { "description": "Activates an existing federation.\nBy default, a newly created federation is in the active state.", "operationId": "FederationService_Activate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ActivateFederationRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Activate", "tags": [ "nebius.iam.v1.FederationService" ], "x-mint": { "href": "/rest-api/iam/v1/federations/activate", "metadata": { "sidebarTitle": "Activate" } } } }, "/iam/v1/federations/deactivate": { "post": { "description": "Deactivates an existing federation.\nWhen a federation is inactive, all users under it cannot authenticate.", "operationId": "FederationService_Deactivate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.DeactivateFederationRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Deactivate", "tags": [ "nebius.iam.v1.FederationService" ], "x-mint": { "href": "/rest-api/iam/v1/federations/deactivate", "metadata": { "sidebarTitle": "Deactivate" } } } }, "/iam/v1/federations/get-by-name": { "get": { "description": "Retrieves information about a federation by name and parent container.", "operationId": "FederationService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.Federation" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.iam.v1.FederationService" ], "x-mint": { "href": "/rest-api/iam/v1/federations/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/iam/v1/federations/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_FederationService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.FederationService" ], "x-mint": { "href": "/rest-api/iam/v1/federations/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/federations/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_FederationService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.FederationService" ], "x-mint": { "href": "/rest-api/iam/v1/federations/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/federations/{id}": { "delete": { "description": "Deletes a federation. An active federation cannot be deleted and must be deactivated first.", "operationId": "FederationService_Delete", "parameters": [ { "description": "Target federation ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v1.FederationService" ], "x-mint": { "href": "/rest-api/iam/v1/federations/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves information about a federation by ID.", "operationId": "FederationService_Get", "parameters": [ { "description": "Target federation ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.Federation" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.FederationService" ], "x-mint": { "href": "/rest-api/iam/v1/federations/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/group-memberships": { "post": { "operationId": "GroupMembershipService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.CreateGroupMembershipRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v1.GroupMembershipService" ], "x-mint": { "href": "/rest-api/iam/v1/group-memberships/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v1/group-memberships/get-with-attributes": { "get": { "operationId": "GroupMembershipService_GetWithAttributes", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.GroupMembershipWithAttributes" } } }, "description": "A successful response." } }, "summary": "Get With Attributes", "tags": [ "nebius.iam.v1.GroupMembershipService" ], "x-mint": { "href": "/rest-api/iam/v1/group-memberships/get-with-attributes", "metadata": { "sidebarTitle": "Get With Attributes" } } } }, "/iam/v1/group-memberships/list-member-of": { "get": { "operationId": "GroupMembershipService_ListMemberOf", "parameters": [ { "description": "Requested subject id. Can be tenant user account id or service account id.", "in": "query", "name": "subjectId", "required": true, "schema": { "type": "string" } }, { "description": "Default value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListMemberOfResponse" } } }, "description": "A successful response." } }, "summary": "List Member Of", "tags": [ "nebius.iam.v1.GroupMembershipService" ], "x-mint": { "href": "/rest-api/iam/v1/group-memberships/list-member-of", "metadata": { "sidebarTitle": "List Member Of" } } } }, "/iam/v1/group-memberships/list-members": { "get": { "operationId": "GroupMembershipService_ListMembers", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Default value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListGroupMembershipsResponse" } } }, "description": "A successful response." } }, "summary": "List Members", "tags": [ "nebius.iam.v1.GroupMembershipService" ], "x-mint": { "href": "/rest-api/iam/v1/group-memberships/list-members", "metadata": { "sidebarTitle": "List Members" } } } }, "/iam/v1/group-memberships/list-members-with-attributes": { "get": { "operationId": "GroupMembershipService_ListMembersWithAttributes", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Default value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListGroupMembershipsWithAttributesResponse" } } }, "description": "A successful response." } }, "summary": "List Members With Attributes", "tags": [ "nebius.iam.v1.GroupMembershipService" ], "x-mint": { "href": "/rest-api/iam/v1/group-memberships/list-members-with-attributes", "metadata": { "sidebarTitle": "List Members With Attributes" } } } }, "/iam/v1/group-memberships/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_GroupMembershipService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.GroupMembershipService" ], "x-mint": { "href": "/rest-api/iam/v1/group-memberships/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/group-memberships/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_GroupMembershipService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.GroupMembershipService" ], "x-mint": { "href": "/rest-api/iam/v1/group-memberships/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/group-memberships/{id}": { "delete": { "operationId": "GroupMembershipService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v1.GroupMembershipService" ], "x-mint": { "href": "/rest-api/iam/v1/group-memberships/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "GroupMembershipService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.GroupMembership" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.GroupMembershipService" ], "x-mint": { "href": "/rest-api/iam/v1/group-memberships/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/groups": { "get": { "operationId": "GroupService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Default value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListGroupsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.GroupService" ], "x-mint": { "href": "/rest-api/iam/v1/groups/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "GroupService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.UpdateGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v1.GroupService" ], "x-mint": { "href": "/rest-api/iam/v1/groups/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "GroupService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.CreateGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v1.GroupService" ], "x-mint": { "href": "/rest-api/iam/v1/groups/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v1/groups/get-by-name": { "get": { "operationId": "GroupService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.Group" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.iam.v1.GroupService" ], "x-mint": { "href": "/rest-api/iam/v1/groups/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/iam/v1/groups/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_GroupService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.GroupService" ], "x-mint": { "href": "/rest-api/iam/v1/groups/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/groups/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_GroupService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.GroupService" ], "x-mint": { "href": "/rest-api/iam/v1/groups/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/groups/{id}": { "delete": { "operationId": "GroupService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v1.GroupService" ], "x-mint": { "href": "/rest-api/iam/v1/groups/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "GroupService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.Group" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.GroupService" ], "x-mint": { "href": "/rest-api/iam/v1/groups/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/invitations": { "get": { "operationId": "InvitationService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListInvitationsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.InvitationService" ], "x-mint": { "href": "/rest-api/iam/v1/invitations/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "InvitationService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.UpdateInvitationRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v1.InvitationService" ], "x-mint": { "href": "/rest-api/iam/v1/invitations/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "InvitationService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.CreateInvitationRequest" } } }, "description": "Request to create an invitation.", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v1.InvitationService" ], "x-mint": { "href": "/rest-api/iam/v1/invitations/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v1/invitations/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_InvitationService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.InvitationService" ], "x-mint": { "href": "/rest-api/iam/v1/invitations/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/invitations/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_InvitationService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.InvitationService" ], "x-mint": { "href": "/rest-api/iam/v1/invitations/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/invitations/resend": { "post": { "operationId": "InvitationService_Resend", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ResendInvitationRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Resend", "tags": [ "nebius.iam.v1.InvitationService" ], "x-mint": { "href": "/rest-api/iam/v1/invitations/resend", "metadata": { "sidebarTitle": "Resend" } } } }, "/iam/v1/invitations/{id}": { "delete": { "operationId": "InvitationService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v1.InvitationService" ], "x-mint": { "href": "/rest-api/iam/v1/invitations/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "InvitationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.Invitation" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.InvitationService" ], "x-mint": { "href": "/rest-api/iam/v1/invitations/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/profiles": { "get": { "description": "Returns the current user's profile.", "operationId": "ProfileService_Get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.GetProfileResponse" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.ProfileService" ], "x-mint": { "href": "/rest-api/iam/v1/profiles/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/projects": { "get": { "operationId": "ProjectService_List", "parameters": [ { "description": "Represents the container ID.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListProjectsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v1/projects/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "ProjectService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.UpdateProjectRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v1.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v1/projects/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "ProjectService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.CreateProjectRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v1.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v1/projects/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v1/projects/get-by-name": { "get": { "operationId": "ProjectService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.Container" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.iam.v1.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v1/projects/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/iam/v1/projects/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_ProjectService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v1/projects/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/projects/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_ProjectService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v1/projects/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/projects/{id}": { "get": { "operationId": "ProjectService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.Container" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v1/projects/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/service-accounts": { "get": { "operationId": "ServiceAccountService_List", "parameters": [ { "description": "Represents the container ID.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListServiceAccountResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.ServiceAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/service-accounts/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "ServiceAccountService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.UpdateServiceAccountRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v1.ServiceAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/service-accounts/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "ServiceAccountService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.CreateServiceAccountRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v1.ServiceAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/service-accounts/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v1/service-accounts/get-by-name": { "get": { "operationId": "ServiceAccountService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ServiceAccount" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.iam.v1.ServiceAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/service-accounts/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/iam/v1/service-accounts/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_ServiceAccountService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.ServiceAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/service-accounts/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/service-accounts/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_ServiceAccountService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.ServiceAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/service-accounts/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/service-accounts/{id}": { "delete": { "operationId": "ServiceAccountService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v1.ServiceAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/service-accounts/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "ServiceAccountService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ServiceAccount" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.ServiceAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/service-accounts/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/session-management/revoke": { "post": { "description": "Revoke sessions/tokens", "operationId": "SessionManagementService_Revoke", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.RevokeSessionRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.RevokeSessionResponse" } } }, "description": "A successful response." } }, "summary": "Revoke", "tags": [ "nebius.iam.v1.SessionManagementService" ], "x-mint": { "href": "/rest-api/iam/v1/session-management/revoke", "metadata": { "sidebarTitle": "Revoke" } } } }, "/iam/v1/static-keys": { "get": { "operationId": "StaticKeyService_List", "parameters": [ { "description": "Represents the container ID.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListStaticKeysResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.StaticKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/static-keys/list", "metadata": { "sidebarTitle": "List" } } } }, "/iam/v1/static-keys/find": { "post": { "operationId": "StaticKeyService_Find", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.FindStaticKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.FindStaticKeyResponse" } } }, "description": "A successful response." } }, "summary": "Find", "tags": [ "nebius.iam.v1.StaticKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/static-keys/find", "metadata": { "sidebarTitle": "Find" } } } }, "/iam/v1/static-keys/get-by-name": { "get": { "operationId": "StaticKeyService_GetByName", "parameters": [ { "description": "id of the parent container (service account)", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "name of the static key", "in": "query", "name": "name", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.StaticKey" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.iam.v1.StaticKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/static-keys/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/iam/v1/static-keys/issue": { "post": { "operationId": "StaticKeyService_Issue", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.IssueStaticKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.IssueStaticKeyResponse" } } }, "description": "A successful response." } }, "summary": "Issue", "tags": [ "nebius.iam.v1.StaticKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/static-keys/issue", "metadata": { "sidebarTitle": "Issue" } } } }, "/iam/v1/static-keys/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_StaticKeyService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.StaticKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/static-keys/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/static-keys/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_StaticKeyService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.StaticKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/static-keys/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/static-keys/revoke": { "post": { "operationId": "StaticKeyService_Revoke", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.RevokeStaticKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Revoke", "tags": [ "nebius.iam.v1.StaticKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/static-keys/revoke", "metadata": { "sidebarTitle": "Revoke" } } } }, "/iam/v1/static-keys/{id}": { "delete": { "operationId": "StaticKeyService_Delete", "parameters": [ { "description": "id of the static key to delete", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v1.StaticKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/static-keys/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "StaticKeyService_Get", "parameters": [ { "description": "id of the static key", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.StaticKey" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.StaticKeyService" ], "x-mint": { "href": "/rest-api/iam/v1/static-keys/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/tenant-user-account-with-attributes": { "get": { "operationId": "TenantUserAccountWithAttributesService_List", "parameters": [ { "description": "Represents the tenant ID, such as `tenant-{region}someuniquesuffix`.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListTenantUserAccountsWithAttributesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.TenantUserAccountWithAttributesService" ], "x-mint": { "href": "/rest-api/iam/v1/tenant-user-account-with-attributes/list", "metadata": { "sidebarTitle": "List" } } } }, "/iam/v1/tenant-user-account-with-attributes/{id}": { "get": { "operationId": "TenantUserAccountWithAttributesService_Get", "parameters": [ { "description": "Tenant user account ID, such as `tenantuseraccount-{region}someuniquesuffix`.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.TenantUserAccountWithAttributes" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.TenantUserAccountWithAttributesService" ], "x-mint": { "href": "/rest-api/iam/v1/tenant-user-account-with-attributes/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/tenant-user-accounts": { "get": { "operationId": "TenantUserAccountService_List", "parameters": [ { "description": "Represents the tenant ID like 'tenant-someuniqueprefix'", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListTenantUserAccountsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.TenantUserAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/tenant-user-accounts/list", "metadata": { "sidebarTitle": "List" } } } }, "/iam/v1/tenant-user-accounts/block": { "post": { "operationId": "TenantUserAccountService_Block", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.BlockTenantUserAccountRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Block", "tags": [ "nebius.iam.v1.TenantUserAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/tenant-user-accounts/block", "metadata": { "sidebarTitle": "Block" } } } }, "/iam/v1/tenant-user-accounts/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v1_TenantUserAccountService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v1.TenantUserAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/tenant-user-accounts/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v1/tenant-user-accounts/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v1_TenantUserAccountService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v1.TenantUserAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/tenant-user-accounts/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v1/tenant-user-accounts/unblock": { "post": { "operationId": "TenantUserAccountService_Unblock", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.UnblockTenantUserAccountRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Unblock", "tags": [ "nebius.iam.v1.TenantUserAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/tenant-user-accounts/unblock", "metadata": { "sidebarTitle": "Unblock" } } } }, "/iam/v1/tenant-user-accounts/{id}": { "get": { "operationId": "TenantUserAccountService_Get", "parameters": [ { "description": "Tenant user account ID, such as `tenantuseraccount-{region}someuniquesuffix`.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.TenantUserAccount" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.TenantUserAccountService" ], "x-mint": { "href": "/rest-api/iam/v1/tenant-user-accounts/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v1/tenants": { "get": { "operationId": "TenantService_List", "parameters": [ { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.ListTenantsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v1.TenantService" ], "x-mint": { "href": "/rest-api/iam/v1/tenants/list", "metadata": { "sidebarTitle": "List" } } } }, "/iam/v1/tenants/{id}": { "get": { "operationId": "TenantService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v1.Container" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v1.TenantService" ], "x-mint": { "href": "/rest-api/iam/v1/tenants/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v2/access-keys": { "get": { "operationId": "AccessKeyService_List", "parameters": [ { "description": "Represents the container ID.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.ListAccessKeysResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "AccessKeyService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.UpdateAccessKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "AccessKeyService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.CreateAccessKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v2/access-keys/activate": { "post": { "operationId": "AccessKeyService_Activate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.ActivateAccessKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Activate", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/activate", "metadata": { "sidebarTitle": "Activate" } } } }, "/iam/v2/access-keys/activate-by-aws-id": { "post": { "operationId": "AccessKeyService_ActivateByAwsId", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.ActivateAccessKeyByAwsIdRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Activate By Aws Id", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/activate-by-aws-id", "metadata": { "sidebarTitle": "Activate By Aws Id" } } } }, "/iam/v2/access-keys/deactivate": { "post": { "operationId": "AccessKeyService_Deactivate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.DeactivateAccessKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Deactivate", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/deactivate", "metadata": { "sidebarTitle": "Deactivate" } } } }, "/iam/v2/access-keys/deactivate-by-aws-id": { "post": { "operationId": "AccessKeyService_DeactivateByAwsId", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.DeactivateAccessKeyByAwsIdRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Deactivate By Aws Id", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/deactivate-by-aws-id", "metadata": { "sidebarTitle": "Deactivate By Aws Id" } } } }, "/iam/v2/access-keys/delete-by-aws-id": { "post": { "operationId": "AccessKeyService_DeleteByAwsId", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.DeleteAccessKeyByAwsIdRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete By Aws Id", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/delete-by-aws-id", "metadata": { "sidebarTitle": "Delete By Aws Id" } } } }, "/iam/v2/access-keys/get-by-aws-id": { "get": { "operationId": "AccessKeyService_GetByAwsId", "parameters": [ { "in": "query", "name": "awsAccessKeyId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.AccessKey" } } }, "description": "A successful response." } }, "summary": "Get By Aws Id", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/get-by-aws-id", "metadata": { "sidebarTitle": "Get By Aws Id" } } } }, "/iam/v2/access-keys/get-secret": { "get": { "operationId": "AccessKeyService_GetSecret", "parameters": [ { "in": "query", "name": "id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.GetAccessKeySecretResponse" } } }, "description": "A successful response." } }, "summary": "Get Secret", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/get-secret", "metadata": { "sidebarTitle": "Get Secret" } } } }, "/iam/v2/access-keys/list-by-account": { "get": { "operationId": "AccessKeyService_ListByAccount", "parameters": [ { "in": "query", "name": "account.userAccount.id", "schema": { "type": "string" } }, { "in": "query", "name": "account.serviceAccount.id", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.ListAccessKeysResponse" } } }, "description": "A successful response." } }, "summary": "List By Account", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/list-by-account", "metadata": { "sidebarTitle": "List By Account" } } } }, "/iam/v2/access-keys/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v2_AccessKeyService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v2/access-keys/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v2_AccessKeyService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v2/access-keys/{id}": { "delete": { "operationId": "AccessKeyService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "AccessKeyService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.AccessKey" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v2.AccessKeyService" ], "x-mint": { "href": "/rest-api/iam/v2/access-keys/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v2/projects": { "get": { "description": "Lists projects under a specified parent.", "operationId": "ProjectService_List", "parameters": [ { "description": "Identifier of container to list projects from.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.ListProjectsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v2.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v2/projects/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing project.", "operationId": "ProjectService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.UpdateProjectRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v2.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v2/projects/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new project.", "operationId": "ProjectService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.CreateProjectRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.iam.v2.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v2/projects/create", "metadata": { "sidebarTitle": "Create" } } } }, "/iam/v2/projects/get-by-name": { "get": { "description": "Retrieves a project by its name within a specified parent.", "operationId": "ProjectService_GetByName", "parameters": [ { "description": "Identifier of the project parent container.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the project to retrieve.", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.Project" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.iam.v2.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v2/projects/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/iam/v2/projects/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v2_ProjectService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v2.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v2/projects/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v2/projects/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v2_ProjectService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v2.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v2/projects/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v2/projects/{id}": { "delete": { "description": "Deletes a project by its ID.", "operationId": "ProjectService_Delete", "parameters": [ { "description": "Identifier of project to delete.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "If true, performs a dry run of the deletion without actually deleting the project.", "in": "query", "name": "dryRun", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.iam.v2.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v2/projects/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves a project by its ID.", "operationId": "ProjectService_Get", "parameters": [ { "description": "Identifier of project to retrieve.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.Project" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v2.ProjectService" ], "x-mint": { "href": "/rest-api/iam/v2/projects/get", "metadata": { "sidebarTitle": "Get" } } } }, "/iam/v2/tenants": { "get": { "operationId": "TenantService_List", "parameters": [ { "description": "Specifies the maximum number of items to return in the response.\nDefault value: 10", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.ListTenantsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.iam.v2.TenantService" ], "x-mint": { "href": "/rest-api/iam/v2/tenants/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "TenantService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.UpdateTenantRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.iam.v2.TenantService" ], "x-mint": { "href": "/rest-api/iam/v2/tenants/update", "metadata": { "sidebarTitle": "Update" } } } }, "/iam/v2/tenants/get-by-name": { "get": { "operationId": "TenantService_GetByName", "parameters": [ { "description": "Only empty value is allowed. Field is needed for compatibility.\nparent_id parameter for tenants doesn't make real sense, because tenants are top-level objects.", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.Tenant" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.iam.v2.TenantService" ], "x-mint": { "href": "/rest-api/iam/v2/tenants/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/iam/v2/tenants/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_iam_v2_TenantService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.iam.v2.TenantService" ], "x-mint": { "href": "/rest-api/iam/v2/tenants/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/iam/v2/tenants/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_iam_v2_TenantService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.iam.v2.TenantService" ], "x-mint": { "href": "/rest-api/iam/v2/tenants/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/iam/v2/tenants/{id}": { "get": { "operationId": "TenantService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.iam.v2.Tenant" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.iam.v2.TenantService" ], "x-mint": { "href": "/rest-api/iam/v2/tenants/get", "metadata": { "sidebarTitle": "Get" } } } }, "/kms/v1/asymmetric-crypto/decrypt": { "post": { "description": "Decrypts the ciphertext with the specified key.", "operationId": "AsymmetricCryptoService_Decrypt", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricDecryptRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricDecryptResponse" } } }, "description": "A successful response." } }, "summary": "Decrypt", "tags": [ "nebius.kms.v1.AsymmetricCryptoService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-crypto/decrypt", "metadata": { "sidebarTitle": "Decrypt" } } } }, "/kms/v1/asymmetric-crypto/get-public-key": { "get": { "description": "Retrieves the public key of an asymmetric key pair.", "operationId": "AsymmetricCryptoService_GetPublicKey", "parameters": [ { "description": "ID of the asymmetric KMS key whose public key should be returned.", "in": "query", "name": "keyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricGetPublicKeyResponse" } } }, "description": "A successful response." } }, "summary": "Get Public Key", "tags": [ "nebius.kms.v1.AsymmetricCryptoService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-crypto/get-public-key", "metadata": { "sidebarTitle": "Get Public Key" } } } }, "/kms/v1/asymmetric-crypto/sign-hash": { "post": { "description": "Signs a hashed value using an asymmetric key.", "operationId": "AsymmetricCryptoService_SignHash", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricSignHashRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricSignHashResponse" } } }, "description": "A successful response." } }, "summary": "Sign Hash", "tags": [ "nebius.kms.v1.AsymmetricCryptoService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-crypto/sign-hash", "metadata": { "sidebarTitle": "Sign Hash" } } } }, "/kms/v1/asymmetric-keys": { "get": { "description": "Returns the list of asymmetric KMS keys in the specified container.", "operationId": "AsymmetricKeyService_List", "parameters": [ { "description": "ID of the container to list asymmetric KMS keys in.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "The maximum number of results per page to return. If the number of available\nresults is larger than [page_size], the service returns a [ListAsymmetricKeysResponse.next_page_token]\nthat can be used to get the next page of results in subsequent list requests.\nDefault value: 100.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Page token. To get the next page of results, set [page_token] to the\n[ListAsymmetricKeysResponse.next_page_token] returned by a previous list request.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "By default, List operation doesn't include resources that are scheduled for deletion.\nIf show_scheduled_for_deletion = true, the listing includes resources that are scheduled for deletion.", "in": "query", "name": "showScheduledForDeletion", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.ListAsymmetricKeysResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.kms.v1.AsymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-keys/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an asymmetric KMS key.", "operationId": "AsymmetricKeyService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.UpdateAsymmetricKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.kms.v1.AsymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-keys/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates an asymmetric KMS key in the specified container.", "operationId": "AsymmetricKeyService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.CreateAsymmetricKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.kms.v1.AsymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-keys/create", "metadata": { "sidebarTitle": "Create" } } } }, "/kms/v1/asymmetric-keys/get-by-name": { "get": { "description": "Returns the specified asymmetric KMS key by name.", "operationId": "AsymmetricKeyService_GetByName", "parameters": [ { "description": "Parent Id and name of the asymmetric KMS key to return.\nTo get the name of an asymmetric KMS key use an [AsymmetricKeyService.List] request.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricKey" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.kms.v1.AsymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-keys/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/kms/v1/asymmetric-keys/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_kms_v1_AsymmetricKeyService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.kms.v1.AsymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-keys/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/kms/v1/asymmetric-keys/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_kms_v1_AsymmetricKeyService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.kms.v1.AsymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-keys/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/kms/v1/asymmetric-keys/undelete": { "post": { "description": "Restores an asymmetric KMS key scheduled for deletion.", "operationId": "AsymmetricKeyService_Undelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.UndeleteAsymmetricKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Undelete", "tags": [ "nebius.kms.v1.AsymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-keys/undelete", "metadata": { "sidebarTitle": "Undelete" } } } }, "/kms/v1/asymmetric-keys/update-deletion-delay": { "post": { "description": "Update deletion delay for an asymmetric KMS key scheduled for deletion.", "operationId": "AsymmetricKeyService_UpdateDeletionDelay", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.UpdateAsymmetricKeyDeletionDelayRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update Deletion Delay", "tags": [ "nebius.kms.v1.AsymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-keys/update-deletion-delay", "metadata": { "sidebarTitle": "Update Deletion Delay" } } } }, "/kms/v1/asymmetric-keys/{id}": { "delete": { "description": "Schedules an asymmetric KMS key for deletion.", "operationId": "AsymmetricKeyService_Delete", "parameters": [ { "description": "ID of the asymmetric KMS key to schedule for deletion.\nTo get the ID of an asymmetric KMS key use an [AsymmetricKeyService.List] request.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.kms.v1.AsymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-keys/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Returns the specified asymmetric KMS key by id.", "operationId": "AsymmetricKeyService_Get", "parameters": [ { "description": "ID of the asymmetric KMS key to return.\nTo get the ID of an asymmetric KMS key use an [AsymmetricKeyService.List] request.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "By default, Get doesn't return resource if it is scheduled for deletion.\nIf show_scheduled_for_deletion = true, the Get operation returns the resource even if it is scheduled for deletion.\nIf show_scheduled_for_deletion = false, the Get method returns the NOT_FOUND gRPC status code.", "in": "query", "name": "showScheduledForDeletion", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.AsymmetricKey" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.kms.v1.AsymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/asymmetric-keys/get", "metadata": { "sidebarTitle": "Get" } } } }, "/kms/v1/symmetric-crypto/decrypt": { "post": { "description": "Decrypts the given ciphertext with the specified key.", "operationId": "SymmetricCryptoService_Decrypt", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricDecryptRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricDecryptResponse" } } }, "description": "A successful response." } }, "summary": "Decrypt", "tags": [ "nebius.kms.v1.SymmetricCryptoService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-crypto/decrypt", "metadata": { "sidebarTitle": "Decrypt" } } } }, "/kms/v1/symmetric-crypto/encrypt": { "post": { "description": "Encrypts given plaintext with the specified key.", "operationId": "SymmetricCryptoService_Encrypt", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricEncryptRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricEncryptResponse" } } }, "description": "A successful response." } }, "summary": "Encrypt", "tags": [ "nebius.kms.v1.SymmetricCryptoService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-crypto/encrypt", "metadata": { "sidebarTitle": "Encrypt" } } } }, "/kms/v1/symmetric-crypto/generate-data-key": { "post": { "description": "Generates a new symmetric data encryption key (not a KMS key) and returns\nthe generated key as plaintext and as ciphertext encrypted with the specified symmetric KMS key.", "operationId": "SymmetricCryptoService_GenerateDataKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.GenerateDataKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.GenerateDataKeyResponse" } } }, "description": "A successful response." } }, "summary": "Generate Data Key", "tags": [ "nebius.kms.v1.SymmetricCryptoService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-crypto/generate-data-key", "metadata": { "sidebarTitle": "Generate Data Key" } } } }, "/kms/v1/symmetric-keys": { "get": { "description": "Returns the list of symmetric KMS keys in the specified container.", "operationId": "SymmetricKeyService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "The maximum number of results per page to return. If the number of available\nresults is larger than [page_size], the service returns a [ListSymmetricKeysResponse.next_page_token]\nthat can be used to get the next page of results in subsequent list requests.\nDefault value: 100.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Page token. To get the next page of results, set [page_token] to the\n[ListSymmetricKeysResponse.next_page_token] returned by a previous list request.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "By default, List operation doesn't include resources that are scheduled for deletion.\nIf show_scheduled_for_deletion = true, the listing includes resources that are scheduled for deletion.", "in": "query", "name": "showScheduledForDeletion", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.ListSymmetricKeysResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.kms.v1.SymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-keys/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates a symmetric KMS key.", "operationId": "SymmetricKeyService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.UpdateSymmetricKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.kms.v1.SymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-keys/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a symmetric KMS key in the specified container.", "operationId": "SymmetricKeyService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.CreateSymmetricKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.kms.v1.SymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-keys/create", "metadata": { "sidebarTitle": "Create" } } } }, "/kms/v1/symmetric-keys/get-by-name": { "get": { "description": "Returns the specified symmetric KMS key by name.", "operationId": "SymmetricKeyService_GetByName", "parameters": [ { "description": "ParentId and name of the symmetric KMS key to return.\nTo get the name of a symmetric KMS key use a [SymmetricKeyService.List] request.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricKey" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.kms.v1.SymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-keys/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/kms/v1/symmetric-keys/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_kms_v1_SymmetricKeyService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.kms.v1.SymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-keys/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/kms/v1/symmetric-keys/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_kms_v1_SymmetricKeyService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.kms.v1.SymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-keys/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/kms/v1/symmetric-keys/rotate": { "post": { "description": "Rotates the specified key: creates a new key version and makes it the primary version.\nThe old version remains available for decryption of ciphertext encrypted with it.", "operationId": "SymmetricKeyService_Rotate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.RotateSymmetricKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Rotate", "tags": [ "nebius.kms.v1.SymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-keys/rotate", "metadata": { "sidebarTitle": "Rotate" } } } }, "/kms/v1/symmetric-keys/undelete": { "post": { "description": "Restores a symmetric KMS key scheduled for deletion.", "operationId": "SymmetricKeyService_Undelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.UndeleteSymmetricKeyRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Undelete", "tags": [ "nebius.kms.v1.SymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-keys/undelete", "metadata": { "sidebarTitle": "Undelete" } } } }, "/kms/v1/symmetric-keys/update-deletion-delay": { "post": { "description": "Update deletion delay for a symmetric KMS key scheduled for deletion.", "operationId": "SymmetricKeyService_UpdateDeletionDelay", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.UpdateSymmetricKeyDeletionDelayRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update Deletion Delay", "tags": [ "nebius.kms.v1.SymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-keys/update-deletion-delay", "metadata": { "sidebarTitle": "Update Deletion Delay" } } } }, "/kms/v1/symmetric-keys/{id}": { "delete": { "description": "Schedules a symmetric KMS key for deletion.", "operationId": "SymmetricKeyService_Delete", "parameters": [ { "description": "ID of the symmetric KMS key to schedule for deletion.\nTo get the ID of a symmetric KMS key use a [SymmetricKeyService.List] request.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.kms.v1.SymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-keys/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Returns the specified symmetric KMS key by id.", "operationId": "SymmetricKeyService_Get", "parameters": [ { "description": "ID of the symmetric KMS key to return.\nTo get the ID of a symmetric KMS key use a [SymmetricKeyService.List] request.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "By default, Get doesn't return resource if it is scheduled for deletion.\nIf show_scheduled_for_deletion = true, the Get operation returns the resource even if it is scheduled for deletion.\nIf show_scheduled_for_deletion = false, the Get method returns the NOT_FOUND gRPC status code.", "in": "query", "name": "showScheduledForDeletion", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.kms.v1.SymmetricKey" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.kms.v1.SymmetricKeyService" ], "x-mint": { "href": "/rest-api/kms/v1/symmetric-keys/get", "metadata": { "sidebarTitle": "Get" } } } }, "/logging/agentmanager/v1/versions/get-version": { "get": { "description": "GetVersion retrieves version information and receives instructions for agent updates\nor maintenance based on the current state and health of the agent.", "operationId": "VersionService_GetVersion", "parameters": [ { "description": "Type of the agent. Must be O11Y_AGENT (1).\n\n - AGENT_UNDEFINED: Default undefined state.\n - O11Y_AGENT: Observability agent type.", "in": "query", "name": "type", "schema": { "default": "AGENT_UNDEFINED", "enum": [ "AGENT_UNDEFINED", "O11Y_AGENT" ], "type": "string" } }, { "description": "Current version of the agent software.", "in": "query", "name": "agentVersion", "schema": { "type": "string" } }, { "description": "Version of the updater component.", "in": "query", "name": "updaterVersion", "schema": { "type": "string" } }, { "description": "Parent identifier for the VM", "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "description": "Unique identifier for the instance where agent is running.", "in": "query", "name": "instanceId", "schema": { "type": "string" } }, { "description": "Operating system name and version.\nExample: \"Ubuntu 22.04.4 LTS\"", "in": "query", "name": "osInfo.name", "schema": { "type": "string" } }, { "description": "Detailed system information from uname command.\n\nExample:\n```\nLinux computeimage-abcdef 6.5.0-44-generic #44~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Tue Jun 18 14:36:16 UTC 2 x86_64 x86_64 x86_64 GNU/Linux\n```", "in": "query", "name": "osInfo.uname", "schema": { "type": "string" } }, { "description": "System architecture.", "in": "query", "name": "osInfo.architecture", "schema": { "type": "string" } }, { "description": "Current operational state of the agent.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "in": "query", "name": "agentState", "schema": { "default": "STATE_UNDEFINED", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" } }, { "description": "Time duration since the agent started.", "in": "query", "name": "agentUptime", "schema": { "type": "string" } }, { "description": "Total system uptime.", "in": "query", "name": "systemUptime", "schema": { "type": "string" } }, { "description": "Time duration since the updater component started.", "in": "query", "name": "updaterUptime", "schema": { "type": "string" } }, { "description": "Status messages from the agent describing its current state.", "in": "query", "name": "agentStateMessages", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Description of the last update failure, if any.", "in": "query", "name": "lastUpdateError", "schema": { "type": "string" } }, { "description": "Managed Kubernetes cluster identifier, if applicable.", "in": "query", "name": "mk8sClusterId", "schema": { "type": "string" } }, { "description": "Current operational state of the module.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "in": "query", "name": "modulesHealth.process.state", "schema": { "default": "STATE_UNDEFINED", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" } }, { "description": "Status messages describing the module's state.", "in": "query", "name": "modulesHealth.process.messages", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Current operational state of the module.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "in": "query", "name": "modulesHealth.gpuPipeline.state", "schema": { "default": "STATE_UNDEFINED", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" } }, { "description": "Status messages describing the module's state.", "in": "query", "name": "modulesHealth.gpuPipeline.messages", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Current operational state of the module.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "in": "query", "name": "modulesHealth.cpuPipeline.state", "schema": { "default": "STATE_UNDEFINED", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" } }, { "description": "Status messages describing the module's state.", "in": "query", "name": "modulesHealth.cpuPipeline.messages", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Current operational state of the module.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "in": "query", "name": "modulesHealth.ciliumPipeline.state", "schema": { "default": "STATE_UNDEFINED", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" } }, { "description": "Status messages describing the module's state.", "in": "query", "name": "modulesHealth.ciliumPipeline.messages", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Current operational state of the module.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "in": "query", "name": "modulesHealth.vmappsPipeline.state", "schema": { "default": "STATE_UNDEFINED", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" } }, { "description": "Status messages describing the module's state.", "in": "query", "name": "modulesHealth.vmappsPipeline.messages", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Current operational state of the module.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "in": "query", "name": "modulesHealth.commonServiceLogsPipeline.state", "schema": { "default": "STATE_UNDEFINED", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" } }, { "description": "Status messages describing the module's state.", "in": "query", "name": "modulesHealth.commonServiceLogsPipeline.messages", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Current operational state of the module.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "in": "query", "name": "modulesHealth.vmServiceLogsPipeline.state", "schema": { "default": "STATE_UNDEFINED", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" } }, { "description": "Status messages describing the module's state.", "in": "query", "name": "modulesHealth.vmServiceLogsPipeline.messages", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Current operational state of the module.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "in": "query", "name": "modulesHealth.computeGpuLogsPipeline.state", "schema": { "default": "STATE_UNDEFINED", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" } }, { "description": "Status messages describing the module's state.", "in": "query", "name": "modulesHealth.computeGpuLogsPipeline.messages", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Current operational state of the module.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "in": "query", "name": "modulesHealth.journaldPipeline.state", "schema": { "default": "STATE_UNDEFINED", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" } }, { "description": "Status messages describing the module's state.", "in": "query", "name": "modulesHealth.journaldPipeline.messages", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Current operational state of the module.\n\n - STATE_UNDEFINED: Default undefined state.\n - STATE_HEALTHY: Agent is functioning normally.\n - STATE_ERROR: Agent is in error state.", "in": "query", "name": "modulesHealth.ncclMetricsPipeline.state", "schema": { "default": "STATE_UNDEFINED", "enum": [ "STATE_UNDEFINED", "STATE_HEALTHY", "STATE_ERROR" ], "type": "string" } }, { "description": "Status messages describing the module's state.", "in": "query", "name": "modulesHealth.ncclMetricsPipeline.messages", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Status of cloud initialization process.", "in": "query", "name": "cloudInitStatus", "schema": { "type": "string" } }, { "description": "Indicates if a fallback method was used to determine instance_id.", "in": "query", "name": "instanceIdUsedFallback", "schema": { "type": "boolean" } }, { "description": "Recent agent log entries for diagnostic purposes.", "in": "query", "name": "lastAgentLogs", "schema": { "type": "string" } }, { "description": "Model of the GPU used in the system.", "in": "query", "name": "gpuModel", "schema": { "type": "string" } }, { "description": "Number of GPUs available in the system.", "in": "query", "name": "gpuNumber", "schema": { "format": "int32", "type": "integer" } }, { "description": "Version of the DCGM (Data Center GPU Manager) used.", "in": "query", "name": "dcgmVersion", "schema": { "type": "string" } }, { "description": "Size of the healthcheck directory in bytes.", "in": "query", "name": "healthcheckLogs.directorySizeBytes", "schema": { "format": "int64", "type": "string" } }, { "description": "Total size of the healthcheck mountpoint in bytes.", "in": "query", "name": "healthcheckLogs.mountpointTotalBytes", "schema": { "format": "int64", "type": "string" } }, { "description": "Largest config_version this agent has already accepted; 0 if none.", "in": "query", "name": "lastSeenConfigVersion", "schema": { "format": "uint64", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.logging.agentmanager.v1.GetVersionResponse" } } }, "description": "A successful response." } }, "summary": "Get Version", "tags": [ "nebius.logging.agentmanager.v1.VersionService" ], "x-mint": { "href": "/rest-api/logging/agentmanager/v1/versions/get-version", "metadata": { "sidebarTitle": "Get Version" } } } }, "/logging/v1/log-exports/cancel-export-logs": { "post": { "description": "Cancel an in-progress export operation by its ID. Has no effect on exports that have already finished or failed.", "operationId": "LogExportService_CancelExportLogs", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.logging.v1.CancelExportLogsRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "A successful response." } }, "summary": "Cancel Export Logs", "tags": [ "nebius.logging.v1.LogExportService" ], "x-mint": { "href": "/rest-api/logging/v1/log-exports/cancel-export-logs", "metadata": { "sidebarTitle": "Cancel Export Logs" } } } }, "/logging/v1/log-exports/export-logs": { "post": { "description": "Create a new log export", "operationId": "LogExportService_ExportLogs", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.logging.v1.ExportLogsRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Export Logs", "tags": [ "nebius.logging.v1.LogExportService" ], "x-mint": { "href": "/rest-api/logging/v1/log-exports/export-logs", "metadata": { "sidebarTitle": "Export Logs" } } } }, "/logging/v1/log-exports/get-export-info": { "get": { "description": "Get the status of a single export operation by its ID.", "operationId": "LogExportService_GetExportInfo", "parameters": [ { "description": "ID of the export operation to look up, as returned by `create` or shown by `list`.", "in": "query", "name": "exportOperationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.logging.v1.ExportStatus" } } }, "description": "A successful response." } }, "summary": "Get Export Info", "tags": [ "nebius.logging.v1.LogExportService" ], "x-mint": { "href": "/rest-api/logging/v1/log-exports/get-export-info", "metadata": { "sidebarTitle": "Get Export Info" } } } }, "/logging/v1/log-exports/list-exports": { "get": { "description": "List export operations in the container given by `--parent-id`.", "operationId": "LogExportService_ListExports", "parameters": [ { "description": "Project ID whose export operations are listed.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Listing continuation token. Pass an empty string to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Maximum number of export operations to return in a single response page.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Sort order for the returned export operations by creation time (ascending or descending).", "in": "query", "name": "orderBy", "schema": { "default": "ORDER_BY_UNSPECIFIED", "enum": [ "ORDER_BY_UNSPECIFIED", "ORDER_BY_ASC", "ORDER_BY_DESC" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.logging.v1.ListExportsResponse" } } }, "description": "A successful response." } }, "summary": "List Exports", "tags": [ "nebius.logging.v1.LogExportService" ], "x-mint": { "href": "/rest-api/logging/v1/log-exports/list-exports", "metadata": { "sidebarTitle": "List Exports" } } } }, "/logging/v1/log-exports/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_logging_v1_LogExportService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.logging.v1.LogExportService" ], "x-mint": { "href": "/rest-api/logging/v1/log-exports/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/logging/v1/log-exports/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_logging_v1_LogExportService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.logging.v1.LogExportService" ], "x-mint": { "href": "/rest-api/logging/v1/log-exports/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/maintenance/v1alpha1/maintenances": { "get": { "description": "Retrieves the list of maintenance operations that belong\nto the specified container.", "operationId": "MaintenanceService_List", "parameters": [ { "description": "Identifier of IAM container to list maintenance operations from.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.maintenance.v1alpha1.ListMaintenancesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.maintenance.v1alpha1.MaintenanceService" ], "x-mint": { "href": "/rest-api/maintenance/v1alpha1/maintenances/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates the specified maintenance operation.", "operationId": "MaintenanceService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.maintenance.v1alpha1.UpdateMaintenanceRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.maintenance.v1alpha1.UpdateMaintenanceResponse" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.maintenance.v1alpha1.MaintenanceService" ], "x-mint": { "href": "/rest-api/maintenance/v1alpha1/maintenances/update", "metadata": { "sidebarTitle": "Update" } } } }, "/maintenance/v1alpha1/maintenances/{id}": { "get": { "description": "Returns the specified maintenance operation.\nTo get the list of upcoming and past maintenance operations, make a [List] request.", "operationId": "MaintenanceService_Get", "parameters": [ { "description": "ID of the maintenance operation to return.\nTo get the maintenance ID use a [MaintenanceService.List] request.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.maintenance.v1alpha1.Maintenance" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.maintenance.v1alpha1.MaintenanceService" ], "x-mint": { "href": "/rest-api/maintenance/v1alpha1/maintenances/get", "metadata": { "sidebarTitle": "Get" } } } }, "/mk8s/v1/clusters": { "get": { "description": "Returns a list of all mk8s clusters in the specified project.", "operationId": "ClusterService_List", "parameters": [ { "description": "ID of the IAM container we are listing the resources in.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.ListClustersResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.mk8s.v1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1/clusters/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Modifies an existing mk8s cluster.", "operationId": "ClusterService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.UpdateClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.mk8s.v1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1/clusters/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new mk8s cluster.", "operationId": "ClusterService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.CreateClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.mk8s.v1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1/clusters/create", "metadata": { "sidebarTitle": "Create" } } } }, "/mk8s/v1/clusters/get-by-name": { "get": { "description": "Returns a specific mk8s cluster by its unique name.", "operationId": "ClusterService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.Cluster" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.mk8s.v1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1/clusters/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/mk8s/v1/clusters/list-control-plane-versions": { "get": { "description": "ListControlPlaneVersions returns all k8s release versions available in Nebius API.", "operationId": "ClusterService_ListControlPlaneVersions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.ListClusterControlPlaneVersionsResponse" } } }, "description": "A successful response." } }, "summary": "List Control Plane Versions", "tags": [ "nebius.mk8s.v1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1/clusters/list-control-plane-versions", "metadata": { "sidebarTitle": "List Control Plane Versions" } } } }, "/mk8s/v1/clusters/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_mk8s_v1_ClusterService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.mk8s.v1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1/clusters/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/mk8s/v1/clusters/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_mk8s_v1_ClusterService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.mk8s.v1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1/clusters/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/mk8s/v1/clusters/{id}": { "delete": { "description": "Deletes an mk8s cluster.", "operationId": "ClusterService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.mk8s.v1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1/clusters/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Returns a specific mk8s cluster by its unique identifier.", "operationId": "ClusterService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "resourceVersion", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.Cluster" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.mk8s.v1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1/clusters/get", "metadata": { "sidebarTitle": "Get" } } } }, "/mk8s/v1/node-groups": { "get": { "operationId": "NodeGroupService_List", "parameters": [ { "description": "ID of the parent Cluster.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.ListNodeGroupsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.mk8s.v1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1/node-groups/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "NodeGroupService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.UpdateNodeGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.mk8s.v1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1/node-groups/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "NodeGroupService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.CreateNodeGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.mk8s.v1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1/node-groups/create", "metadata": { "sidebarTitle": "Create" } } } }, "/mk8s/v1/node-groups/get-by-name": { "get": { "operationId": "NodeGroupService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroup" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.mk8s.v1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1/node-groups/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/mk8s/v1/node-groups/get-compatibility-matrix": { "get": { "operationId": "NodeGroupService_GetCompatibilityMatrix", "parameters": [ { "description": "Cluster kubernetes version.", "in": "query", "name": "clusterKubernetesVersion", "required": true, "schema": { "type": "string" } }, { "description": "Hardware platform for which the capabilities are requested.", "in": "query", "name": "platform", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroupCompatibilityMatrix" } } }, "description": "A successful response." } }, "summary": "Get Compatibility Matrix", "tags": [ "nebius.mk8s.v1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1/node-groups/get-compatibility-matrix", "metadata": { "sidebarTitle": "Get Compatibility Matrix" } } } }, "/mk8s/v1/node-groups/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_mk8s_v1_NodeGroupService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.mk8s.v1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1/node-groups/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/mk8s/v1/node-groups/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_mk8s_v1_NodeGroupService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.mk8s.v1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1/node-groups/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/mk8s/v1/node-groups/preflight-check": { "post": { "operationId": "NodeGroupService_PreflightCheck", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.PreflightCheckNodeGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.PreflightCheckNodeGroupResponse" } } }, "description": "A successful response." } }, "summary": "Preflight Check", "tags": [ "nebius.mk8s.v1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1/node-groups/preflight-check", "metadata": { "sidebarTitle": "Preflight Check" } } } }, "/mk8s/v1/node-groups/upgrade": { "post": { "operationId": "NodeGroupService_Upgrade", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.UpgradeNodeGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Upgrade", "tags": [ "nebius.mk8s.v1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1/node-groups/upgrade", "metadata": { "sidebarTitle": "Upgrade" } } } }, "/mk8s/v1/node-groups/{id}": { "delete": { "operationId": "NodeGroupService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.mk8s.v1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1/node-groups/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "NodeGroupService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "resourceVersion", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1.NodeGroup" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.mk8s.v1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1/node-groups/get", "metadata": { "sidebarTitle": "Get" } } } }, "/mk8s/v1alpha1/clusters": { "get": { "operationId": "ClusterService_List", "parameters": [ { "description": "ID of the IAM container we are listing the resources in.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ListClustersResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.mk8s.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/clusters/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "ClusterService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.UpdateClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.mk8s.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/clusters/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "ClusterService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.CreateClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.mk8s.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/clusters/create", "metadata": { "sidebarTitle": "Create" } } } }, "/mk8s/v1alpha1/clusters/get-by-name": { "get": { "operationId": "ClusterService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.Cluster" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.mk8s.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/clusters/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/mk8s/v1alpha1/clusters/list-control-plane-versions": { "get": { "description": "ListControlPlaneVersions returns all k8s release versions available in Nebius API.", "operationId": "ClusterService_ListControlPlaneVersions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ListClusterControlPlaneVersionsResponse" } } }, "description": "A successful response." } }, "summary": "List Control Plane Versions", "tags": [ "nebius.mk8s.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/clusters/list-control-plane-versions", "metadata": { "sidebarTitle": "List Control Plane Versions" } } } }, "/mk8s/v1alpha1/clusters/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_mk8s_v1alpha1_ClusterService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Filter expression for the listing results. Optional.\nFilter expression format: TBD.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.mk8s.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/clusters/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/mk8s/v1alpha1/clusters/operations/{id}": { "get": { "description": "Returns the latest state of the specified operation.", "operationId": "nebius_mk8s_v1alpha1_ClusterService_OperationService_Get", "parameters": [ { "description": "Operation ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.mk8s.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/clusters/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/mk8s/v1alpha1/clusters/{id}": { "delete": { "operationId": "ClusterService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.mk8s.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/clusters/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "ClusterService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "resourceVersion", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.Cluster" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.mk8s.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/clusters/get", "metadata": { "sidebarTitle": "Get" } } } }, "/mk8s/v1alpha1/node-groups": { "get": { "operationId": "NodeGroupService_List", "parameters": [ { "description": "ID of the parent Cluster.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.ListNodeGroupsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.mk8s.v1alpha1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/node-groups/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "NodeGroupService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.UpdateNodeGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.mk8s.v1alpha1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/node-groups/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "NodeGroupService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.CreateNodeGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.mk8s.v1alpha1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/node-groups/create", "metadata": { "sidebarTitle": "Create" } } } }, "/mk8s/v1alpha1/node-groups/get-by-name": { "get": { "operationId": "NodeGroupService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeGroup" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.mk8s.v1alpha1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/node-groups/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/mk8s/v1alpha1/node-groups/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_mk8s_v1alpha1_NodeGroupService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Filter expression for the listing results. Optional.\nFilter expression format: TBD.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.mk8s.v1alpha1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/node-groups/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/mk8s/v1alpha1/node-groups/operations/{id}": { "get": { "description": "Returns the latest state of the specified operation.", "operationId": "nebius_mk8s_v1alpha1_NodeGroupService_OperationService_Get", "parameters": [ { "description": "Operation ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.mk8s.v1alpha1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/node-groups/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/mk8s/v1alpha1/node-groups/upgrade": { "post": { "operationId": "NodeGroupService_Upgrade", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.UpgradeNodeGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Upgrade", "tags": [ "nebius.mk8s.v1alpha1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/node-groups/upgrade", "metadata": { "sidebarTitle": "Upgrade" } } } }, "/mk8s/v1alpha1/node-groups/{id}": { "delete": { "operationId": "NodeGroupService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.mk8s.v1alpha1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/node-groups/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "NodeGroupService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "resourceVersion", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mk8s.v1alpha1.NodeGroup" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.mk8s.v1alpha1.NodeGroupService" ], "x-mint": { "href": "/rest-api/mk8s/v1alpha1/node-groups/get", "metadata": { "sidebarTitle": "Get" } } } }, "/msp/mlflow/v1alpha1/clusters": { "get": { "description": "Retrieves a list of clusters.", "operationId": "ClusterService_List", "parameters": [ { "description": "Identifier of IAM container to list clusters from.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response. Default value is 100.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.mlflow.v1alpha1.ListClustersResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.msp.mlflow.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/mlflow/v1alpha1/clusters/list", "metadata": { "sidebarTitle": "List" } } }, "post": { "description": "Creates a cluster.", "operationId": "ClusterService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.mlflow.v1alpha1.CreateClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.msp.mlflow.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/mlflow/v1alpha1/clusters/create", "metadata": { "sidebarTitle": "Create" } } } }, "/msp/mlflow/v1alpha1/clusters/get-by-name": { "get": { "description": "Returns the specified cluster.", "operationId": "ClusterService_GetByName", "parameters": [ { "description": "Identifier of IAM container to get cluster from.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the cluster.", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.mlflow.v1alpha1.Cluster" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.msp.mlflow.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/mlflow/v1alpha1/clusters/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/msp/mlflow/v1alpha1/clusters/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_msp_mlflow_v1alpha1_ClusterService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Filter expression for the listing results. Optional.\nFilter expression format: TBD.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.msp.mlflow.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/mlflow/v1alpha1/clusters/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/msp/mlflow/v1alpha1/clusters/operations/{id}": { "get": { "description": "Returns the latest state of the specified operation.", "operationId": "nebius_msp_mlflow_v1alpha1_ClusterService_OperationService_Get", "parameters": [ { "description": "Operation ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.msp.mlflow.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/mlflow/v1alpha1/clusters/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/msp/mlflow/v1alpha1/clusters/start": { "post": { "description": "Starts a cluster.", "operationId": "ClusterService_Start", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.mlflow.v1alpha1.StartClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Start", "tags": [ "nebius.msp.mlflow.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/mlflow/v1alpha1/clusters/start", "metadata": { "sidebarTitle": "Start" } } } }, "/msp/mlflow/v1alpha1/clusters/stop": { "post": { "description": "Stops a cluster.", "operationId": "ClusterService_Stop", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.mlflow.v1alpha1.StopClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Stop", "tags": [ "nebius.msp.mlflow.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/mlflow/v1alpha1/clusters/stop", "metadata": { "sidebarTitle": "Stop" } } } }, "/msp/mlflow/v1alpha1/clusters/{id}": { "delete": { "description": "Delete a cluster.", "operationId": "ClusterService_Delete", "parameters": [ { "description": "ID of the cluster to delete.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.msp.mlflow.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/mlflow/v1alpha1/clusters/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Returns the specified cluster.", "operationId": "ClusterService_Get", "parameters": [ { "description": "ID of the cluster to retrieve.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.mlflow.v1alpha1.Cluster" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.msp.mlflow.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/mlflow/v1alpha1/clusters/get", "metadata": { "sidebarTitle": "Get" } } } }, "/msp/postgresql/v1alpha1/backups": { "delete": { "description": "Deletes an on-demand backup.", "operationId": "BackupService_Delete", "parameters": [ { "description": "ID of the PostgreSQL cluster that holds backup.", "in": "query", "name": "clusterId", "required": true, "schema": { "type": "string" } }, { "description": "ID of the designated backup.", "in": "query", "name": "backupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.msp.postgresql.v1alpha1.BackupService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/backups/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves the list of PostgreSQL Cluster backups by project.", "operationId": "BackupService_List", "parameters": [ { "description": "Identifier of IAM container to list backups from.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.ListBackupsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.msp.postgresql.v1alpha1.BackupService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/backups/list", "metadata": { "sidebarTitle": "List" } } }, "post": { "description": "Creates a new on-demand backup.", "operationId": "BackupService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.CreateBackupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.msp.postgresql.v1alpha1.BackupService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/backups/create", "metadata": { "sidebarTitle": "Create" } } } }, "/msp/postgresql/v1alpha1/backups/get": { "get": { "description": "Returns the specified PostgreSQL Cluster backup.\nTo get the list of available PostgreSQL Cluster backups, make a [List] or [ListByCluster] request.", "operationId": "BackupService_Get", "parameters": [ { "description": "ID of the PostgreSQL cluster that holds backup.", "in": "query", "name": "clusterId", "required": true, "schema": { "type": "string" } }, { "description": "ID of the designated backup.", "in": "query", "name": "backupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.Backup" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.msp.postgresql.v1alpha1.BackupService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/backups/get", "metadata": { "sidebarTitle": "Get" } } } }, "/msp/postgresql/v1alpha1/backups/list-by-cluster": { "get": { "description": "Retrieves the list of PostgreSQL Cluster backups by cluster.", "operationId": "BackupService_ListByCluster", "parameters": [ { "description": "ID of the PostgreSQL cluster to list backups from.", "in": "query", "name": "clusterId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.ListBackupsResponse" } } }, "description": "A successful response." } }, "summary": "List By Cluster", "tags": [ "nebius.msp.postgresql.v1alpha1.BackupService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/backups/list-by-cluster", "metadata": { "sidebarTitle": "List By Cluster" } } } }, "/msp/postgresql/v1alpha1/backups/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_msp_postgresql_v1alpha1_BackupService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Filter expression for the listing results. Optional.\nFilter expression format: TBD.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.msp.postgresql.v1alpha1.BackupService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/backups/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/msp/postgresql/v1alpha1/backups/operations/{id}": { "get": { "description": "Returns the latest state of the specified operation.", "operationId": "nebius_msp_postgresql_v1alpha1_BackupService_OperationService_Get", "parameters": [ { "description": "Operation ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.msp.postgresql.v1alpha1.BackupService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/backups/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/msp/postgresql/v1alpha1/clusters": { "get": { "description": "Retrieves the list of PostgreSQL Cluster resources that belong\nto the specified folder.", "operationId": "ClusterService_List", "parameters": [ { "description": "Identifier of IAM container to list clusters from.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.ListClustersResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates the PostgreSQL cluster.", "operationId": "ClusterService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.UpdateClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a PostgreSQL cluster in the specified folder.", "operationId": "ClusterService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.CreateClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/create", "metadata": { "sidebarTitle": "Create" } } } }, "/msp/postgresql/v1alpha1/clusters/get-by-name": { "get": { "description": "Returns the specified PostgreSQL Cluster resource by name.", "operationId": "ClusterService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.Cluster" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/msp/postgresql/v1alpha1/clusters/get-for-backup": { "get": { "description": "Returns the specified PostgreSQL Cluster resource for backup.\nIt should be used as a hint of cluster configuration in case of backup restoration.", "operationId": "ClusterService_GetForBackup", "parameters": [ { "description": "ID of the PostgreSQL cluster that holds backup.", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "ID of the backup for which source cluster is requested.", "in": "query", "name": "backupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.Cluster" } } }, "description": "A successful response." } }, "summary": "Get For Backup", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/get-for-backup", "metadata": { "sidebarTitle": "Get For Backup" } } } }, "/msp/postgresql/v1alpha1/clusters/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_msp_postgresql_v1alpha1_ClusterService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Filter expression for the listing results. Optional.\nFilter expression format: TBD.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/msp/postgresql/v1alpha1/clusters/operations/{id}": { "get": { "description": "Returns the latest state of the specified operation.", "operationId": "nebius_msp_postgresql_v1alpha1_ClusterService_OperationService_Get", "parameters": [ { "description": "Operation ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/msp/postgresql/v1alpha1/clusters/restore": { "post": { "description": "Creates a new PostgreSQL cluster from a previously created backup.", "operationId": "ClusterService_Restore", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.RestoreClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Restore", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/restore", "metadata": { "sidebarTitle": "Restore" } } } }, "/msp/postgresql/v1alpha1/clusters/start": { "post": { "description": "Wakes up suspended PostgreSQL cluster.", "operationId": "ClusterService_Start", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.StartClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Start", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/start", "metadata": { "sidebarTitle": "Start" } } } }, "/msp/postgresql/v1alpha1/clusters/stop": { "post": { "description": "Suspends the PostgreSQL cluster to save resources.", "operationId": "ClusterService_Stop", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.StopClusterRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Stop", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/stop", "metadata": { "sidebarTitle": "Stop" } } } }, "/msp/postgresql/v1alpha1/clusters/{id}": { "delete": { "description": "Deletes the specified PostgreSQL cluster.", "operationId": "ClusterService_Delete", "parameters": [ { "description": "ID of the PostgreSQL cluster to delete.\nTo get the PostgreSQL cluster ID, use a [ClusterService.List] request.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Returns the specified PostgreSQL Cluster resource.\nTo get the list of available PostgreSQL Cluster resources, make a [List] request.", "operationId": "ClusterService_Get", "parameters": [ { "description": "ID of the PostgreSQL Cluster resource to return.\nTo get the cluster ID use a [ClusterService.List] request.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.msp.postgresql.v1alpha1.Cluster" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.msp.postgresql.v1alpha1.ClusterService" ], "x-mint": { "href": "/rest-api/msp/postgresql/v1alpha1/clusters/get", "metadata": { "sidebarTitle": "Get" } } } }, "/mysterybox/v1/payloads": { "get": { "description": "Returns the secret's payload in its decrypted format.", "operationId": "PayloadService_Get", "parameters": [ { "in": "query", "name": "secretId", "schema": { "type": "string" } }, { "description": "Desired version of the secret. If not provided, the primary version of the secret will be returned.", "in": "query", "name": "versionId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretPayload" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.mysterybox.v1.PayloadService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/payloads/get", "metadata": { "sidebarTitle": "Get" } } } }, "/mysterybox/v1/payloads/get-by-key": { "get": { "description": "Returns the secret's payload value by key in its decrypted format.", "operationId": "PayloadService_GetByKey", "parameters": [ { "in": "query", "name": "secretId", "schema": { "type": "string" } }, { "description": "Desired version of the secret. If not provided, the primary version of the secret will be returned.", "in": "query", "name": "versionId", "schema": { "type": "string" } }, { "description": "Payload's key to be retrieved.", "in": "query", "name": "key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretPayloadEntry" } } }, "description": "A successful response." } }, "summary": "Get By Key", "tags": [ "nebius.mysterybox.v1.PayloadService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/payloads/get-by-key", "metadata": { "sidebarTitle": "Get By Key" } } } }, "/mysterybox/v1/secret-versions": { "get": { "description": "Returns the list of secret versions in a specified container, without its Payload.", "operationId": "SecretVersionService_List", "parameters": [ { "description": "Secret id related to the version.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "The maximum number of results per page to return. If the number of available\nresults is larger than [page_size], the service returns a [ListSecretVersionsResponse.next_page_token]\nthat can be used to get the next page of results in subsequent list requests.\nDefault value: 100.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Page token. To get the next page of results, set [page_token] to the\n[ListSecretVersionsResponse.next_page_token] returned by a previous list request.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "By default, List operation doesn't include resources that are scheduled for deletion.\nIf show_scheduled_for_deletion = true, the listing includes resources that are scheduled for deletion.", "in": "query", "name": "showScheduledForDeletion", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.ListSecretVersionsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.mysterybox.v1.SecretVersionService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secret-versions/list", "metadata": { "sidebarTitle": "List" } } }, "post": { "description": "Creates a new secret version in the specified container.", "operationId": "SecretVersionService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.CreateSecretVersionRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.mysterybox.v1.SecretVersionService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secret-versions/create", "metadata": { "sidebarTitle": "Create" } } } }, "/mysterybox/v1/secret-versions/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_mysterybox_v1_SecretVersionService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.mysterybox.v1.SecretVersionService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secret-versions/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/mysterybox/v1/secret-versions/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_mysterybox_v1_SecretVersionService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.mysterybox.v1.SecretVersionService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secret-versions/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/mysterybox/v1/secret-versions/undelete": { "post": { "description": "Undelete secret version", "operationId": "SecretVersionService_Undelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.UndeleteSecretVersionRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Undelete", "tags": [ "nebius.mysterybox.v1.SecretVersionService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secret-versions/undelete", "metadata": { "sidebarTitle": "Undelete" } } } }, "/mysterybox/v1/secret-versions/{id}": { "delete": { "description": "Soft delete secret version.", "operationId": "SecretVersionService_Delete", "parameters": [ { "description": "ID of the secret version to soft-delete.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.mysterybox.v1.SecretVersionService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secret-versions/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Returns the specified secret version, without its Payload.", "operationId": "SecretVersionService_Get", "parameters": [ { "description": "ID of secret versions to return.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "By default, Get doesn't return resource if it is scheduled for deletion.\nIf show_scheduled_for_deletion = true, the Get operation returns the resource even if it is scheduled for deletion.\nIf show_scheduled_for_deletion = false, the Get method returns the NOT_FOUND gRPC status code.", "in": "query", "name": "showScheduledForDeletion", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.SecretVersion" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.mysterybox.v1.SecretVersionService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secret-versions/get", "metadata": { "sidebarTitle": "Get" } } } }, "/mysterybox/v1/secrets": { "get": { "description": "Returns the list of secrets in a specified container, without its Payload.", "operationId": "SecretService_List", "parameters": [ { "description": "ParentId of the secret to return.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "The maximum number of results per page to return. If the number of available\nresults is larger than [page_size], the service returns a [ListSecretsResponse.next_page_token]\nthat can be used to get the next page of results in subsequent list requests.\nDefault value: 100.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Page token. To get the next page of results, set [page_token] to the\n[ListSecretsResponse.next_page_token] returned by a previous list request.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "By default, List operation doesn't include resources that are scheduled for deletion.\nIf show_scheduled_for_deletion = true, the listing includes resources that are scheduled for deletion.", "in": "query", "name": "showScheduledForDeletion", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.ListSecretsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.mysterybox.v1.SecretService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secrets/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing secret, excluded its Payload.", "operationId": "SecretService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.UpdateSecretRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.mysterybox.v1.SecretService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secrets/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new secret in the specified container.", "operationId": "SecretService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.CreateSecretRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.mysterybox.v1.SecretService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secrets/create", "metadata": { "sidebarTitle": "Create" } } } }, "/mysterybox/v1/secrets/get-by-name": { "get": { "description": "Returns the specified secret by name, without its Payload.", "operationId": "SecretService_GetByName", "parameters": [ { "description": "ParentId and name of the secret to return.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.Secret" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.mysterybox.v1.SecretService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secrets/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/mysterybox/v1/secrets/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_mysterybox_v1_SecretService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.mysterybox.v1.SecretService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secrets/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/mysterybox/v1/secrets/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_mysterybox_v1_SecretService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.mysterybox.v1.SecretService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secrets/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/mysterybox/v1/secrets/undelete": { "post": { "description": "Undelete secret version", "operationId": "SecretService_Undelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.UndeleteSecretRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Undelete", "tags": [ "nebius.mysterybox.v1.SecretService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secrets/undelete", "metadata": { "sidebarTitle": "Undelete" } } } }, "/mysterybox/v1/secrets/{id}": { "delete": { "description": "Soft delete secret", "operationId": "SecretService_Delete", "parameters": [ { "description": "ID of the secret to soft-delete.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.mysterybox.v1.SecretService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secrets/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Returns the specified secret, without its Payload.", "operationId": "SecretService_Get", "parameters": [ { "description": "ID of secret to return.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "By default, Get doesn't return resource if it is scheduled for deletion.\nIf show_scheduled_for_deletion = true, the Get operation returns the resource even if it is scheduled for deletion.\nIf show_scheduled_for_deletion = false, the Get method returns the NOT_FOUND gRPC status code.", "in": "query", "name": "showScheduledForDeletion", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.mysterybox.v1.Secret" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.mysterybox.v1.SecretService" ], "x-mint": { "href": "/rest-api/mysterybox/v1/secrets/get", "metadata": { "sidebarTitle": "Get" } } } }, "/quotas/v1/quota-allowances": { "get": { "description": "Lists quota allowances for the specified Tenant or Project.", "operationId": "QuotaAllowanceService_List", "parameters": [ { "description": "ID of the Container to list quotas for.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. Must be between [1...1000].\nOptional; if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Pass an empty string to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.quotas.v1.ListQuotaAllowancesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.quotas.v1.QuotaAllowanceService" ], "x-mint": { "href": "/rest-api/quotas/v1/quota-allowances/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates a quota allowance by its ID.", "operationId": "QuotaAllowanceService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.quotas.v1.UpdateQuotaAllowanceRequest" } } }, "description": "Request to update an existing quota allowance using its metadata and the new spec.", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.quotas.v1.QuotaAllowanceService" ], "x-mint": { "href": "/rest-api/quotas/v1/quota-allowances/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a quota allowance for a Project.\nIf the quota already exists, its value is replaced with the provided one.", "operationId": "QuotaAllowanceService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.quotas.v1.CreateQuotaAllowanceRequest" } } }, "description": "Request to create a quota allowance with the specified spec and metadata.", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.quotas.v1.QuotaAllowanceService" ], "x-mint": { "href": "/rest-api/quotas/v1/quota-allowances/create", "metadata": { "sidebarTitle": "Create" } } } }, "/quotas/v1/quota-allowances/get-by-name": { "get": { "description": "Gets a quota allowance for a Tenant or Project by container ID, region, and name.", "operationId": "QuotaAllowanceService_GetByName", "parameters": [ { "description": "ID of the Container to list quotas for.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the quota.\nExample: \"compute.disk.size.network-ssd\".", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Name of the region where the quota is allocated.\nExample: \"eu-north1\".", "in": "query", "name": "region", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.quotas.v1.QuotaAllowance" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.quotas.v1.QuotaAllowanceService" ], "x-mint": { "href": "/rest-api/quotas/v1/quota-allowances/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/quotas/v1/quota-allowances/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_quotas_v1_QuotaAllowanceService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.quotas.v1.QuotaAllowanceService" ], "x-mint": { "href": "/rest-api/quotas/v1/quota-allowances/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/quotas/v1/quota-allowances/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_quotas_v1_QuotaAllowanceService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.quotas.v1.QuotaAllowanceService" ], "x-mint": { "href": "/rest-api/quotas/v1/quota-allowances/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/quotas/v1/quota-allowances/{id}": { "delete": { "description": "Deletes a quota by its ID.\nThis is used to reset the quota value. It does not remove the quota entry.", "operationId": "QuotaAllowanceService_Delete", "parameters": [ { "description": "ID of the quota.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.quotas.v1.QuotaAllowanceService" ], "x-mint": { "href": "/rest-api/quotas/v1/quota-allowances/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Gets a quota allowance by its ID.", "operationId": "QuotaAllowanceService_Get", "parameters": [ { "description": "ID of the quota.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.quotas.v1.QuotaAllowance" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.quotas.v1.QuotaAllowanceService" ], "x-mint": { "href": "/rest-api/quotas/v1/quota-allowances/get", "metadata": { "sidebarTitle": "Get" } } } }, "/registry/v1/artifacts": { "get": { "operationId": "ArtifactService_List", "parameters": [ { "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.registry.v1.ListArtifactsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.registry.v1.ArtifactService" ], "x-mint": { "href": "/rest-api/registry/v1/artifacts/list", "metadata": { "sidebarTitle": "List" } } } }, "/registry/v1/artifacts/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_registry_v1_ArtifactService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.registry.v1.ArtifactService" ], "x-mint": { "href": "/rest-api/registry/v1/artifacts/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/registry/v1/artifacts/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_registry_v1_ArtifactService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.registry.v1.ArtifactService" ], "x-mint": { "href": "/rest-api/registry/v1/artifacts/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/registry/v1/artifacts/{id}": { "delete": { "operationId": "ArtifactService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.registry.v1.ArtifactService" ], "x-mint": { "href": "/rest-api/registry/v1/artifacts/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "ArtifactService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.registry.v1.Artifact" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.registry.v1.ArtifactService" ], "x-mint": { "href": "/rest-api/registry/v1/artifacts/get", "metadata": { "sidebarTitle": "Get" } } } }, "/registry/v1/registries": { "get": { "operationId": "RegistryService_List", "parameters": [ { "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.registry.v1.ListRegistriesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.registry.v1.RegistryService" ], "x-mint": { "href": "/rest-api/registry/v1/registries/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "RegistryService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.registry.v1.UpdateRegistryRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.registry.v1.RegistryService" ], "x-mint": { "href": "/rest-api/registry/v1/registries/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "RegistryService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.registry.v1.CreateRegistryRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.registry.v1.RegistryService" ], "x-mint": { "href": "/rest-api/registry/v1/registries/create", "metadata": { "sidebarTitle": "Create" } } } }, "/registry/v1/registries/get-by-name": { "get": { "description": "Gets the Registry resource by its parent IAM container `parent_id` and `name`", "operationId": "RegistryService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.registry.v1.Registry" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.registry.v1.RegistryService" ], "x-mint": { "href": "/rest-api/registry/v1/registries/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/registry/v1/registries/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_registry_v1_RegistryService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.registry.v1.RegistryService" ], "x-mint": { "href": "/rest-api/registry/v1/registries/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/registry/v1/registries/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_registry_v1_RegistryService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.registry.v1.RegistryService" ], "x-mint": { "href": "/rest-api/registry/v1/registries/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/registry/v1/registries/{id}": { "delete": { "operationId": "RegistryService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.registry.v1.RegistryService" ], "x-mint": { "href": "/rest-api/registry/v1/registries/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "RegistryService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.registry.v1.Registry" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.registry.v1.RegistryService" ], "x-mint": { "href": "/rest-api/registry/v1/registries/get", "metadata": { "sidebarTitle": "Get" } } } }, "/storage/v1/buckets": { "get": { "operationId": "BucketService_List", "parameters": [ { "description": "Represents the container ID.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "A filter to narrow down the results based on specific criteria.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.ListBucketsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.storage.v1.BucketService" ], "x-mint": { "href": "/rest-api/storage/v1/buckets/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "BucketService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.UpdateBucketRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.storage.v1.BucketService" ], "x-mint": { "href": "/rest-api/storage/v1/buckets/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "BucketService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.CreateBucketRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.storage.v1.BucketService" ], "x-mint": { "href": "/rest-api/storage/v1/buckets/create", "metadata": { "sidebarTitle": "Create" } } } }, "/storage/v1/buckets/get-by-name": { "get": { "operationId": "BucketService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.Bucket" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.storage.v1.BucketService" ], "x-mint": { "href": "/rest-api/storage/v1/buckets/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/storage/v1/buckets/list-with-filter": { "get": { "description": "ListWithFilter lists only buckets with specified filters (e.g. bucket_type and filesystem_id).", "operationId": "BucketService_ListWithFilter", "parameters": [ { "description": "Represents the container ID.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "If set, only buckets of the specified type will be returned. If not set, all bucket types will be returned.\n\n - REGULAR: Regular object storage bucket.\n - FILESYSTEM: Object storage bucket that is mounted to an existing compute filesystem.", "in": "query", "name": "filters.bucketType", "schema": { "default": "BUCKET_TYPE_UNSPECIFIED", "enum": [ "BUCKET_TYPE_UNSPECIFIED", "REGULAR", "FILESYSTEM" ], "type": "string" } }, { "description": "If not empty, only buckets mounted to the specified filesystem will be returned.", "in": "query", "name": "filters.filesystemId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.ListBucketsWithFilterResponse" } } }, "description": "A successful response." } }, "summary": "List With Filter", "tags": [ "nebius.storage.v1.BucketService" ], "x-mint": { "href": "/rest-api/storage/v1/buckets/list-with-filter", "metadata": { "sidebarTitle": "List With Filter" } } } }, "/storage/v1/buckets/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_storage_v1_BucketService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.storage.v1.BucketService" ], "x-mint": { "href": "/rest-api/storage/v1/buckets/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/storage/v1/buckets/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_storage_v1_BucketService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.storage.v1.BucketService" ], "x-mint": { "href": "/rest-api/storage/v1/buckets/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/storage/v1/buckets/purge": { "post": { "description": "Purge instantly deletes the bucket in ScheduledForDeletion state.\nIt can be used only for buckets in ScheduledForDeletion state.\nIf you want to delete Active bucket instantly, use Delete with zero ttl.", "operationId": "BucketService_Purge", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.PurgeBucketRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Purge", "tags": [ "nebius.storage.v1.BucketService" ], "x-mint": { "href": "/rest-api/storage/v1/buckets/purge", "metadata": { "sidebarTitle": "Purge" } } } }, "/storage/v1/buckets/undelete": { "post": { "description": "Undelete recovers the bucket from ScheduledForDeletion state to Active.", "operationId": "BucketService_Undelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.UndeleteBucketRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Undelete", "tags": [ "nebius.storage.v1.BucketService" ], "x-mint": { "href": "/rest-api/storage/v1/buckets/undelete", "metadata": { "sidebarTitle": "Undelete" } } } }, "/storage/v1/buckets/{id}": { "delete": { "operationId": "BucketService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Absolute purging time: status.purge_at will be set to this value.", "in": "query", "name": "purgeAt", "schema": { "format": "date-time", "type": "string" } }, { "description": "Relative purging time: status.purge_at will be set to (current timestamp + ttl).", "in": "query", "name": "ttl", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.storage.v1.BucketService" ], "x-mint": { "href": "/rest-api/storage/v1/buckets/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "BucketService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.Bucket" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.storage.v1.BucketService" ], "x-mint": { "href": "/rest-api/storage/v1/buckets/get", "metadata": { "sidebarTitle": "Get" } } } }, "/storage/v1/inventories": { "get": { "operationId": "InventoryService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.ListInventoriesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.storage.v1.InventoryService" ], "x-mint": { "href": "/rest-api/storage/v1/inventories/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "InventoryService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.UpdateInventoryRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.storage.v1.InventoryService" ], "x-mint": { "href": "/rest-api/storage/v1/inventories/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "InventoryService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.CreateInventoryRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.storage.v1.InventoryService" ], "x-mint": { "href": "/rest-api/storage/v1/inventories/create", "metadata": { "sidebarTitle": "Create" } } } }, "/storage/v1/inventories/get-by-name": { "get": { "operationId": "InventoryService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.Inventory" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.storage.v1.InventoryService" ], "x-mint": { "href": "/rest-api/storage/v1/inventories/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/storage/v1/inventories/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_storage_v1_InventoryService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.storage.v1.InventoryService" ], "x-mint": { "href": "/rest-api/storage/v1/inventories/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/storage/v1/inventories/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_storage_v1_InventoryService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.storage.v1.InventoryService" ], "x-mint": { "href": "/rest-api/storage/v1/inventories/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/storage/v1/inventories/{id}": { "delete": { "operationId": "InventoryService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.storage.v1.InventoryService" ], "x-mint": { "href": "/rest-api/storage/v1/inventories/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "InventoryService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.Inventory" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.storage.v1.InventoryService" ], "x-mint": { "href": "/rest-api/storage/v1/inventories/get", "metadata": { "sidebarTitle": "Get" } } } }, "/storage/v1/transfers": { "get": { "operationId": "TransferService_List", "parameters": [ { "description": "Represents the container ID.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response. Default: 10.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.ListTransfersResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.storage.v1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1/transfers/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "TransferService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.UpdateTransferRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.storage.v1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1/transfers/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "TransferService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.CreateTransferRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.storage.v1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1/transfers/create", "metadata": { "sidebarTitle": "Create" } } } }, "/storage/v1/transfers/get-by-name": { "get": { "operationId": "TransferService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.Transfer" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.storage.v1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1/transfers/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/storage/v1/transfers/get-iteration-history": { "get": { "description": "Get transfer iteration history.", "operationId": "TransferService_GetIterationHistory", "parameters": [ { "description": "ID of the transfer whose iteration history to return.", "in": "query", "name": "transferId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.GetIterationHistoryResponse" } } }, "description": "A successful response." } }, "summary": "Get Iteration History", "tags": [ "nebius.storage.v1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1/transfers/get-iteration-history", "metadata": { "sidebarTitle": "Get Iteration History" } } } }, "/storage/v1/transfers/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_storage_v1_TransferService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.storage.v1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1/transfers/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/storage/v1/transfers/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_storage_v1_TransferService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.storage.v1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1/transfers/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/storage/v1/transfers/resume": { "post": { "description": "Resume stopped or failed transfer.", "operationId": "TransferService_Resume", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.ResumeTransferRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Resume", "tags": [ "nebius.storage.v1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1/transfers/resume", "metadata": { "sidebarTitle": "Resume" } } } }, "/storage/v1/transfers/stop": { "post": { "description": "Stop active transfer. If the transfer is currently moving data,\nit will be transitioned to the Stopping state and will move to the Stopped state once all processes have been stopped.\nIf the transfer is waiting between iterations, it will stop immediately.\nOnly transfers in Active state can be stopped.", "operationId": "TransferService_Stop", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.StopTransferRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Stop", "tags": [ "nebius.storage.v1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1/transfers/stop", "metadata": { "sidebarTitle": "Stop" } } } }, "/storage/v1/transfers/{id}": { "delete": { "description": "Fully delete a transfer along with its history. If the transfer is active, it will be stopped and then deleted.", "operationId": "TransferService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Optional: expected transfer version (`metadata.resource_version`)\n- If specified, ensures that only the requested version is deleted (and a `FAILED_PRECONDITION` error is returned on version mismatch)\n- If not specified or set to `0`, the latest version will be deleted", "in": "query", "name": "resourceVersion", "schema": { "format": "int64", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.storage.v1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1/transfers/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "TransferService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1.Transfer" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.storage.v1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1/transfers/get", "metadata": { "sidebarTitle": "Get" } } } }, "/storage/v1alpha1/transfers": { "get": { "operationId": "TransferService_List", "parameters": [ { "description": "Represents the container ID.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response. Default: 10.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.ListTransfersResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.storage.v1alpha1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1alpha1/transfers/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "TransferService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.UpdateTransferRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.storage.v1alpha1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1alpha1/transfers/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "TransferService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.CreateTransferRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.storage.v1alpha1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1alpha1/transfers/create", "metadata": { "sidebarTitle": "Create" } } } }, "/storage/v1alpha1/transfers/get-by-name": { "get": { "operationId": "TransferService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.Transfer" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.storage.v1alpha1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1alpha1/transfers/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/storage/v1alpha1/transfers/get-iteration-history": { "get": { "operationId": "TransferService_GetIterationHistory", "parameters": [ { "in": "query", "name": "transferId", "required": true, "schema": { "type": "string" } }, { "description": "Specifies the maximum number of items to return in the response.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for pagination, allowing the retrieval of the next set of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.GetIterationHistoryResponse" } } }, "description": "A successful response." } }, "summary": "Get Iteration History", "tags": [ "nebius.storage.v1alpha1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1alpha1/transfers/get-iteration-history", "metadata": { "sidebarTitle": "Get Iteration History" } } } }, "/storage/v1alpha1/transfers/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_storage_v1alpha1_TransferService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.storage.v1alpha1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1alpha1/transfers/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/storage/v1alpha1/transfers/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_storage_v1alpha1_TransferService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.storage.v1alpha1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1alpha1/transfers/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/storage/v1alpha1/transfers/resume": { "post": { "description": "Resume stopped or failed transfer.", "operationId": "TransferService_Resume", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.ResumeTransferRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Resume", "tags": [ "nebius.storage.v1alpha1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1alpha1/transfers/resume", "metadata": { "sidebarTitle": "Resume" } } } }, "/storage/v1alpha1/transfers/stop": { "post": { "description": "Stop active transfer. If the transfer is currently moving data,\nit will be transitioned to the Stopping state and will move to the Stopped state once all processes have been stopped.\nIf the transfer is waiting between iterations, it will stop immediately.\nOnly transfer in Active state can be stopped.", "operationId": "TransferService_Stop", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.StopTransferRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Stop", "tags": [ "nebius.storage.v1alpha1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1alpha1/transfers/stop", "metadata": { "sidebarTitle": "Stop" } } } }, "/storage/v1alpha1/transfers/{id}": { "delete": { "description": "Fully delete a transfer along with its history. Only stopped or failed transfers can be deleted.", "operationId": "TransferService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "resourceVersion", "schema": { "format": "int64", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.storage.v1alpha1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1alpha1/transfers/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "TransferService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.storage.v1alpha1.Transfer" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.storage.v1alpha1.TransferService" ], "x-mint": { "href": "/rest-api/storage/v1alpha1/transfers/get", "metadata": { "sidebarTitle": "Get" } } } }, "/tunnel/v1/tunnels": { "get": { "description": "Lists all tunnels within a parent.", "operationId": "TunnelService_List", "parameters": [ { "description": "Identifier of the parent resource.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of items to return per page.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token for retrieving the next page of results.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Filter expression for narrowing results.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.tunnel.v1.ListTunnelsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.tunnel.v1.TunnelService" ], "x-mint": { "href": "/rest-api/tunnel/v1/tunnels/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing tunnel.", "operationId": "TunnelService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.tunnel.v1.UpdateTunnelRequest" } } }, "description": "Request to update an existing tunnel.", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.tunnel.v1.TunnelService" ], "x-mint": { "href": "/rest-api/tunnel/v1/tunnels/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new tunnel.", "operationId": "TunnelService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.tunnel.v1.CreateTunnelRequest" } } }, "description": "Request to create a new tunnel.", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.tunnel.v1.TunnelService" ], "x-mint": { "href": "/rest-api/tunnel/v1/tunnels/create", "metadata": { "sidebarTitle": "Create" } } } }, "/tunnel/v1/tunnels/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_tunnel_v1_TunnelService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.tunnel.v1.TunnelService" ], "x-mint": { "href": "/rest-api/tunnel/v1/tunnels/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/tunnel/v1/tunnels/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_tunnel_v1_TunnelService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.tunnel.v1.TunnelService" ], "x-mint": { "href": "/rest-api/tunnel/v1/tunnels/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/tunnel/v1/tunnels/{id}": { "delete": { "description": "Deletes a tunnel by its identifier.", "operationId": "TunnelService_Delete", "parameters": [ { "description": "Unique identifier of the tunnel to delete.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.tunnel.v1.TunnelService" ], "x-mint": { "href": "/rest-api/tunnel/v1/tunnels/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves a tunnel by its identifier.", "operationId": "TunnelService_Get", "parameters": [ { "description": "Unique identifier of the tunnel.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.tunnel.v1.Tunnel" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.tunnel.v1.TunnelService" ], "x-mint": { "href": "/rest-api/tunnel/v1/tunnels/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1/allocations": { "get": { "description": "Lists allocations within a specified parent.", "operationId": "AllocationService_List", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of allocations to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of allocations.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListAllocationsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1/allocations/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing allocation with new configuration parameters.", "operationId": "AllocationService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.UpdateAllocationRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.vpc.v1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1/allocations/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new allocation with the specified configuration.", "operationId": "AllocationService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.CreateAllocationRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.vpc.v1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1/allocations/create", "metadata": { "sidebarTitle": "Create" } } } }, "/vpc/v1/allocations/get-by-name": { "get": { "description": "Retrieves an allocation by its name within a specified parent.", "operationId": "AllocationService_GetByName", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the allocation.", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.Allocation" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1/allocations/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1/allocations/list-aggregated": { "get": { "description": "Lists allocations across regions for the specified parent.", "operationId": "AllocationService_ListAggregated", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListAllocationsResponse" } } }, "description": "A successful response." } }, "summary": "List Aggregated", "tags": [ "nebius.vpc.v1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1/allocations/list-aggregated", "metadata": { "sidebarTitle": "List Aggregated" } } } }, "/vpc/v1/allocations/list-by-pool": { "get": { "description": "Lists allocations from a specified pool.", "operationId": "AllocationService_ListByPool", "parameters": [ { "description": "ID of the source pool.", "in": "query", "name": "poolId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of allocations to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of allocations.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListAllocationsResponse" } } }, "description": "A successful response." } }, "summary": "List By Pool", "tags": [ "nebius.vpc.v1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1/allocations/list-by-pool", "metadata": { "sidebarTitle": "List By Pool" } } } }, "/vpc/v1/allocations/list-by-subnet": { "get": { "description": "Lists allocations available to a specified subnet, including unassigned allocations from compatible pools.", "operationId": "AllocationService_ListBySubnet", "parameters": [ { "description": "ID of the subnet.", "in": "query", "name": "subnetId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of allocations to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of allocations.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListAllocationsResponse" } } }, "description": "A successful response." } }, "summary": "List By Subnet", "tags": [ "nebius.vpc.v1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1/allocations/list-by-subnet", "metadata": { "sidebarTitle": "List By Subnet" } } } }, "/vpc/v1/allocations/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_vpc_v1_AllocationService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.vpc.v1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1/allocations/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/vpc/v1/allocations/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_vpc_v1_AllocationService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.vpc.v1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1/allocations/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/vpc/v1/allocations/{id}": { "delete": { "description": "Deletes an allocation by its ID.", "operationId": "AllocationService_Delete", "parameters": [ { "description": "ID of the allocation.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.vpc.v1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1/allocations/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves an allocation by its ID.", "operationId": "AllocationService_Get", "parameters": [ { "description": "ID of the allocation.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.Allocation" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1/allocations/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1/networks": { "get": { "description": "Lists networks within a specified parent.", "operationId": "NetworkService_List", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of networks to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of networks.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListNetworksResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1/networks/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing network with new configuration parameters.", "operationId": "NetworkService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.UpdateNetworkRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.vpc.v1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1/networks/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new network with the specified configuration.", "operationId": "NetworkService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.CreateNetworkRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.vpc.v1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1/networks/create", "metadata": { "sidebarTitle": "Create" } } } }, "/vpc/v1/networks/create-default": { "post": { "description": "Creates a default network, subnet, pools, and route table for a specified project.\nCreates a default security group when that feature is enabled for the project.", "operationId": "NetworkService_CreateDefault", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.CreateDefaultNetworkRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create Default", "tags": [ "nebius.vpc.v1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1/networks/create-default", "metadata": { "sidebarTitle": "Create Default" } } } }, "/vpc/v1/networks/get-by-name": { "get": { "description": "Retrieves a network by its name within a specified parent.", "operationId": "NetworkService_GetByName", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the network.", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.Network" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1/networks/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1/networks/list-aggregated": { "get": { "description": "Lists networks across regions for the specified parent.", "operationId": "NetworkService_ListAggregated", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListNetworksResponse" } } }, "description": "A successful response." } }, "summary": "List Aggregated", "tags": [ "nebius.vpc.v1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1/networks/list-aggregated", "metadata": { "sidebarTitle": "List Aggregated" } } } }, "/vpc/v1/networks/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_vpc_v1_NetworkService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.vpc.v1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1/networks/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/vpc/v1/networks/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_vpc_v1_NetworkService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.vpc.v1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1/networks/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/vpc/v1/networks/{id}": { "delete": { "description": "Deletes a network by its ID.", "operationId": "NetworkService_Delete", "parameters": [ { "description": "ID of the network.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.vpc.v1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1/networks/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves a network by its ID.", "operationId": "NetworkService_Get", "parameters": [ { "description": "ID of the network.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.Network" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1/networks/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1/pools": { "get": { "description": "Lists pools within a specified parent.", "operationId": "PoolService_List", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of pools to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of pools.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListPoolsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1/pools/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing pool with new configuration parameters.", "operationId": "PoolService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.UpdatePoolRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.vpc.v1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1/pools/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new pool with the specified configuration.", "operationId": "PoolService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.CreatePoolRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.vpc.v1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1/pools/create", "metadata": { "sidebarTitle": "Create" } } } }, "/vpc/v1/pools/get-by-name": { "get": { "description": "Retrieves a pool by its name within a specified parent.", "operationId": "PoolService_GetByName", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the pool.", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.Pool" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1/pools/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1/pools/list-aggregated": { "get": { "description": "Lists pools across regions for the specified parent.", "operationId": "PoolService_ListAggregated", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListPoolsResponse" } } }, "description": "A successful response." } }, "summary": "List Aggregated", "tags": [ "nebius.vpc.v1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1/pools/list-aggregated", "metadata": { "sidebarTitle": "List Aggregated" } } } }, "/vpc/v1/pools/list-by-source-pool": { "get": { "description": "Lists pools that use a specified pool as their source.", "operationId": "PoolService_ListBySourcePool", "parameters": [ { "description": "ID of the source pool.", "in": "query", "name": "poolId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of pools to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of pools.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListPoolsResponse" } } }, "description": "A successful response." } }, "summary": "List By Source Pool", "tags": [ "nebius.vpc.v1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1/pools/list-by-source-pool", "metadata": { "sidebarTitle": "List By Source Pool" } } } }, "/vpc/v1/pools/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_vpc_v1_PoolService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.vpc.v1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1/pools/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/vpc/v1/pools/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_vpc_v1_PoolService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.vpc.v1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1/pools/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/vpc/v1/pools/{id}": { "delete": { "description": "Deletes a pool by its ID.", "operationId": "PoolService_Delete", "parameters": [ { "description": "ID of the pool.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.vpc.v1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1/pools/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves a pool by its ID.", "operationId": "PoolService_Get", "parameters": [ { "description": "ID of the pool.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.Pool" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1/pools/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1/route-tables": { "get": { "description": "Lists route tables within a specified parent.", "operationId": "RouteTableService_List", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of route tables to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of route tables.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListRouteTablesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1.RouteTableService" ], "x-mint": { "href": "/rest-api/vpc/v1/route-tables/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing route table with new configuration parameters.", "operationId": "RouteTableService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.UpdateRouteTableRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.vpc.v1.RouteTableService" ], "x-mint": { "href": "/rest-api/vpc/v1/route-tables/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new route table with the specified configuration.", "operationId": "RouteTableService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.CreateRouteTableRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.vpc.v1.RouteTableService" ], "x-mint": { "href": "/rest-api/vpc/v1/route-tables/create", "metadata": { "sidebarTitle": "Create" } } } }, "/vpc/v1/route-tables/get-by-name": { "get": { "description": "Retrieves a route table by its name within a specified parent.", "operationId": "RouteTableService_GetByName", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the route table.", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.RouteTable" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1.RouteTableService" ], "x-mint": { "href": "/rest-api/vpc/v1/route-tables/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1/route-tables/list-aggregated": { "get": { "description": "Lists route tables across regions for the specified parent.", "operationId": "RouteTableService_ListAggregated", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListRouteTablesResponse" } } }, "description": "A successful response." } }, "summary": "List Aggregated", "tags": [ "nebius.vpc.v1.RouteTableService" ], "x-mint": { "href": "/rest-api/vpc/v1/route-tables/list-aggregated", "metadata": { "sidebarTitle": "List Aggregated" } } } }, "/vpc/v1/route-tables/list-by-network": { "get": { "description": "Lists route tables that belong to a specified network.", "operationId": "RouteTableService_ListByNetwork", "parameters": [ { "description": "ID of the network.", "in": "query", "name": "networkId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of route tables to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of route tables.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListRouteTablesResponse" } } }, "description": "A successful response." } }, "summary": "List By Network", "tags": [ "nebius.vpc.v1.RouteTableService" ], "x-mint": { "href": "/rest-api/vpc/v1/route-tables/list-by-network", "metadata": { "sidebarTitle": "List By Network" } } } }, "/vpc/v1/route-tables/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_vpc_v1_RouteTableService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.vpc.v1.RouteTableService" ], "x-mint": { "href": "/rest-api/vpc/v1/route-tables/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/vpc/v1/route-tables/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_vpc_v1_RouteTableService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.vpc.v1.RouteTableService" ], "x-mint": { "href": "/rest-api/vpc/v1/route-tables/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/vpc/v1/route-tables/{id}": { "delete": { "description": "Deletes a route table by its ID.", "operationId": "RouteTableService_Delete", "parameters": [ { "description": "ID of the route table.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.vpc.v1.RouteTableService" ], "x-mint": { "href": "/rest-api/vpc/v1/route-tables/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves a route table by its ID.", "operationId": "RouteTableService_Get", "parameters": [ { "description": "ID of the route table.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.RouteTable" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1.RouteTableService" ], "x-mint": { "href": "/rest-api/vpc/v1/route-tables/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1/routes": { "get": { "description": "Lists routes in a specified route table.", "operationId": "RouteService_List", "parameters": [ { "description": "ID of the parent route table.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of routes to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of routes.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListRoutesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1.RouteService" ], "x-mint": { "href": "/rest-api/vpc/v1/routes/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing route with new configuration parameters.", "operationId": "RouteService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.UpdateRouteRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.vpc.v1.RouteService" ], "x-mint": { "href": "/rest-api/vpc/v1/routes/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new route with the specified configuration.", "operationId": "RouteService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.CreateRouteRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.vpc.v1.RouteService" ], "x-mint": { "href": "/rest-api/vpc/v1/routes/create", "metadata": { "sidebarTitle": "Create" } } } }, "/vpc/v1/routes/get-by-name": { "get": { "description": "Retrieves a route by its name within a specified route table.", "operationId": "RouteService_GetByName", "parameters": [ { "description": "ID of the parent route table.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the route.", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.Route" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1.RouteService" ], "x-mint": { "href": "/rest-api/vpc/v1/routes/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1/routes/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_vpc_v1_RouteService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.vpc.v1.RouteService" ], "x-mint": { "href": "/rest-api/vpc/v1/routes/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/vpc/v1/routes/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_vpc_v1_RouteService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.vpc.v1.RouteService" ], "x-mint": { "href": "/rest-api/vpc/v1/routes/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/vpc/v1/routes/{id}": { "delete": { "description": "Deletes a route by its ID.", "operationId": "RouteService_Delete", "parameters": [ { "description": "ID of the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.vpc.v1.RouteService" ], "x-mint": { "href": "/rest-api/vpc/v1/routes/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves a route by its ID.", "operationId": "RouteService_Get", "parameters": [ { "description": "ID of the route.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.Route" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1.RouteService" ], "x-mint": { "href": "/rest-api/vpc/v1/routes/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1/security-groups": { "get": { "description": "Lists security groups within a specified parent.", "operationId": "SecurityGroupService_List", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of security groups to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of security groups.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListSecurityGroupsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1.SecurityGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-groups/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing security group with new configuration parameters.", "operationId": "SecurityGroupService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.UpdateSecurityGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.vpc.v1.SecurityGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-groups/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new security group with the specified configuration.", "operationId": "SecurityGroupService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.CreateSecurityGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.vpc.v1.SecurityGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-groups/create", "metadata": { "sidebarTitle": "Create" } } } }, "/vpc/v1/security-groups/get-by-name": { "get": { "description": "Retrieves a security group by its name within a specified parent.", "operationId": "SecurityGroupService_GetByName", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the security group.", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityGroup" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1.SecurityGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-groups/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1/security-groups/list-aggregated": { "get": { "description": "Lists security groups across regions for the specified parent.", "operationId": "SecurityGroupService_ListAggregated", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListSecurityGroupsResponse" } } }, "description": "A successful response." } }, "summary": "List Aggregated", "tags": [ "nebius.vpc.v1.SecurityGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-groups/list-aggregated", "metadata": { "sidebarTitle": "List Aggregated" } } } }, "/vpc/v1/security-groups/list-by-network": { "get": { "description": "Lists security groups in a specified network.", "operationId": "SecurityGroupService_ListByNetwork", "parameters": [ { "description": "ID of the network.", "in": "query", "name": "networkId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of security groups to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of security groups.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListSecurityGroupsResponse" } } }, "description": "A successful response." } }, "summary": "List By Network", "tags": [ "nebius.vpc.v1.SecurityGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-groups/list-by-network", "metadata": { "sidebarTitle": "List By Network" } } } }, "/vpc/v1/security-groups/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_vpc_v1_SecurityGroupService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.vpc.v1.SecurityGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-groups/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/vpc/v1/security-groups/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_vpc_v1_SecurityGroupService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.vpc.v1.SecurityGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-groups/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/vpc/v1/security-groups/{id}": { "delete": { "description": "Deletes a security group by its ID.", "operationId": "SecurityGroupService_Delete", "parameters": [ { "description": "ID of the security group.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.vpc.v1.SecurityGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-groups/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves a security group by its ID.", "operationId": "SecurityGroupService_Get", "parameters": [ { "description": "ID of the security group.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityGroup" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1.SecurityGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-groups/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1/security-rules": { "get": { "description": "Lists security rules in a specified security group.", "operationId": "SecurityRuleService_List", "parameters": [ { "description": "ID of the parent security group.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of security rules to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of security rules.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListSecurityRulesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1.SecurityRuleService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-rules/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing security rule with new configuration parameters.", "operationId": "SecurityRuleService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.UpdateSecurityRuleRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.vpc.v1.SecurityRuleService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-rules/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new security rule with the specified configuration.", "operationId": "SecurityRuleService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.CreateSecurityRuleRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.vpc.v1.SecurityRuleService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-rules/create", "metadata": { "sidebarTitle": "Create" } } } }, "/vpc/v1/security-rules/get-by-name": { "get": { "description": "Retrieves a security rule by its name within a specified security group.", "operationId": "SecurityRuleService_GetByName", "parameters": [ { "description": "ID of the parent security group.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the security rule.", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityRule" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1.SecurityRuleService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-rules/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1/security-rules/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_vpc_v1_SecurityRuleService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.vpc.v1.SecurityRuleService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-rules/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/vpc/v1/security-rules/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_vpc_v1_SecurityRuleService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.vpc.v1.SecurityRuleService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-rules/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/vpc/v1/security-rules/{id}": { "delete": { "description": "Deletes a security rule by its ID.", "operationId": "SecurityRuleService_Delete", "parameters": [ { "description": "ID of the security rule.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.vpc.v1.SecurityRuleService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-rules/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves a security rule by its ID.", "operationId": "SecurityRuleService_Get", "parameters": [ { "description": "ID of the security rule.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.SecurityRule" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1.SecurityRuleService" ], "x-mint": { "href": "/rest-api/vpc/v1/security-rules/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1/subnets": { "get": { "description": "Lists subnets within a specified parent.", "operationId": "SubnetService_List", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of subnets to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of subnets.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListSubnetsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1/subnets/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "description": "Updates an existing subnet with new configuration parameters.", "operationId": "SubnetService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.UpdateSubnetRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.vpc.v1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1/subnets/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "description": "Creates a new subnet with the specified configuration.", "operationId": "SubnetService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.CreateSubnetRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.vpc.v1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1/subnets/create", "metadata": { "sidebarTitle": "Create" } } } }, "/vpc/v1/subnets/get-by-name": { "get": { "description": "Retrieves a subnet by its name within a specified parent.", "operationId": "SubnetService_GetByName", "parameters": [ { "description": "ID of the parent project.", "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "description": "Name of the subnet.", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.Subnet" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1/subnets/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1/subnets/list-aggregated": { "get": { "description": "Lists subnets across regions for the specified parent.", "operationId": "SubnetService_ListAggregated", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListSubnetsResponse" } } }, "description": "A successful response." } }, "summary": "List Aggregated", "tags": [ "nebius.vpc.v1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1/subnets/list-aggregated", "metadata": { "sidebarTitle": "List Aggregated" } } } }, "/vpc/v1/subnets/list-by-network": { "get": { "description": "Lists subnets that belong to a specified network.", "operationId": "SubnetService_ListByNetwork", "parameters": [ { "description": "ID of the network.", "in": "query", "name": "networkId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of subnets to return.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Token to retrieve the next page of subnets.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.ListSubnetsResponse" } } }, "description": "A successful response." } }, "summary": "List By Network", "tags": [ "nebius.vpc.v1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1/subnets/list-by-network", "metadata": { "sidebarTitle": "List By Network" } } } }, "/vpc/v1/subnets/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_vpc_v1_SubnetService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.vpc.v1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1/subnets/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/vpc/v1/subnets/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_vpc_v1_SubnetService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.vpc.v1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1/subnets/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/vpc/v1/subnets/{id}": { "delete": { "description": "Deletes a subnet by its ID.", "operationId": "SubnetService_Delete", "parameters": [ { "description": "ID of the subnet.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.vpc.v1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1/subnets/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "description": "Retrieves a subnet by its ID.", "operationId": "SubnetService_Get", "parameters": [ { "description": "ID of the subnet.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.Subnet" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1/subnets/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1/target-groups": { "patch": { "description": "Updates an existing target group with new configuration parameters.", "operationId": "TargetGroupService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.UpdateTargetGroupRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.vpc.v1.TargetGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/target-groups/update", "metadata": { "sidebarTitle": "Update" } } } }, "/vpc/v1/target-groups/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_vpc_v1_TargetGroupService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.vpc.v1.TargetGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/target-groups/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/vpc/v1/target-groups/operations/{id}": { "get": { "description": "Returns the current state of the specified operation.", "operationId": "nebius_vpc_v1_TargetGroupService_OperationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.vpc.v1.TargetGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/target-groups/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/vpc/v1/target-groups/{id}": { "get": { "description": "Retrieves a target group by its ID.", "operationId": "TargetGroupService_Get", "parameters": [ { "description": "ID of the target group.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1.TargetGroup" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1.TargetGroupService" ], "x-mint": { "href": "/rest-api/vpc/v1/target-groups/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1alpha1/allocations": { "get": { "operationId": "AllocationService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.ListAllocationsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1alpha1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/allocations/list", "metadata": { "sidebarTitle": "List" } } }, "patch": { "operationId": "AllocationService_Update", "parameters": [ { "description": "Field mask specifying fields to reset to their default values.", "in": "header", "name": "X-ResetMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.UpdateAllocationRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Update", "tags": [ "nebius.vpc.v1alpha1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/allocations/update", "metadata": { "sidebarTitle": "Update" } } }, "post": { "operationId": "AllocationService_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.CreateAllocationRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Create", "tags": [ "nebius.vpc.v1alpha1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/allocations/create", "metadata": { "sidebarTitle": "Create" } } } }, "/vpc/v1alpha1/allocations/get-by-name": { "get": { "operationId": "AllocationService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Allocation" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1alpha1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/allocations/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1alpha1/allocations/operations": { "get": { "description": "Lists operations for the specified resource.", "operationId": "nebius_vpc_v1alpha1_AllocationService_OperationService_List", "parameters": [ { "description": "ID of the Resource to list operations for.", "in": "query", "name": "resourceId", "required": true, "schema": { "type": "string" } }, { "description": "Page size. [1...1000]. Optional, if not specified, a reasonable default will be chosen by the service.", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "description": "Listing continuation token. Empty to start listing from the first page.", "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "description": "Filter expression for the listing results. Optional.\nFilter expression format: TBD.", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.ListOperationsResponse" } } }, "description": "A successful response." } }, "summary": "List Operations", "tags": [ "nebius.vpc.v1alpha1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/allocations/operations/list", "metadata": { "sidebarTitle": "List Operations" } } } }, "/vpc/v1alpha1/allocations/operations/{id}": { "get": { "description": "Returns the latest state of the specified operation.", "operationId": "nebius_vpc_v1alpha1_AllocationService_OperationService_Get", "parameters": [ { "description": "Operation ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Get Operation", "tags": [ "nebius.vpc.v1alpha1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/allocations/operations/get", "metadata": { "sidebarTitle": "Get Operation" } } } }, "/vpc/v1alpha1/allocations/{id}": { "delete": { "operationId": "AllocationService_Delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.common.v1alpha1.Operation" } } }, "description": "A successful response." } }, "summary": "Delete", "tags": [ "nebius.vpc.v1alpha1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/allocations/delete", "metadata": { "sidebarTitle": "Delete" } } }, "get": { "operationId": "AllocationService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Allocation" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1alpha1.AllocationService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/allocations/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1alpha1/networks": { "get": { "operationId": "NetworkService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.ListNetworksResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1alpha1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/networks/list", "metadata": { "sidebarTitle": "List" } } } }, "/vpc/v1alpha1/networks/get-by-name": { "get": { "operationId": "NetworkService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Network" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1alpha1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/networks/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1alpha1/networks/{id}": { "get": { "operationId": "NetworkService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Network" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1alpha1.NetworkService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/networks/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1alpha1/pools": { "get": { "operationId": "PoolService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.ListPoolsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1alpha1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/pools/list", "metadata": { "sidebarTitle": "List" } } } }, "/vpc/v1alpha1/pools/get-by-name": { "get": { "operationId": "PoolService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Pool" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1alpha1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/pools/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1alpha1/pools/{id}": { "get": { "operationId": "PoolService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Pool" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1alpha1.PoolService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/pools/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1alpha1/scopes": { "get": { "operationId": "ScopeService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.ListScopesResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1alpha1.ScopeService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/scopes/list", "metadata": { "sidebarTitle": "List" } } } }, "/vpc/v1alpha1/scopes/get-by-name": { "get": { "operationId": "ScopeService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Scope" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1alpha1.ScopeService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/scopes/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1alpha1/scopes/{id}": { "get": { "operationId": "ScopeService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Scope" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1alpha1.ScopeService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/scopes/get", "metadata": { "sidebarTitle": "Get" } } } }, "/vpc/v1alpha1/subnets": { "get": { "operationId": "SubnetService_List", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.ListSubnetsResponse" } } }, "description": "A successful response." } }, "summary": "List", "tags": [ "nebius.vpc.v1alpha1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/subnets/list", "metadata": { "sidebarTitle": "List" } } } }, "/vpc/v1alpha1/subnets/get-by-name": { "get": { "operationId": "SubnetService_GetByName", "parameters": [ { "in": "query", "name": "parentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Subnet" } } }, "description": "A successful response." } }, "summary": "Get By Name", "tags": [ "nebius.vpc.v1alpha1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/subnets/get-by-name", "metadata": { "sidebarTitle": "Get By Name" } } } }, "/vpc/v1alpha1/subnets/list-by-network": { "get": { "operationId": "SubnetService_ListByNetwork", "parameters": [ { "in": "query", "name": "networkId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "string" } }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.ListSubnetsResponse" } } }, "description": "A successful response." } }, "summary": "List By Network", "tags": [ "nebius.vpc.v1alpha1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/subnets/list-by-network", "metadata": { "sidebarTitle": "List By Network" } } } }, "/vpc/v1alpha1/subnets/{id}": { "get": { "operationId": "SubnetService_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nebius.vpc.v1alpha1.Subnet" } } }, "description": "A successful response." } }, "summary": "Get", "tags": [ "nebius.vpc.v1alpha1.SubnetService" ], "x-mint": { "href": "/rest-api/vpc/v1alpha1/subnets/get", "metadata": { "sidebarTitle": "Get" } } } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "https://api.nebius.cloud" } ], "tags": [ { "name": "nebius.ai.v1.DevlabService" }, { "name": "nebius.ai.v1.EndpointService" }, { "name": "nebius.ai.v1.JobService" }, { "name": "nebius.applications.v1alpha1.K8sReleaseService" }, { "name": "nebius.applications.v1alpha1.VmAppTemplateService" }, { "name": "nebius.audit.v2.AuditEventExportService" }, { "name": "nebius.audit.v2.AuditEventService" }, { "name": "nebius.billing.v1.CalculatorService" }, { "name": "nebius.billing.v1.PricingPolicyService" }, { "name": "nebius.billing.v1alpha1.CalculatorService" }, { "name": "nebius.billing.v1alpha1.OneTimeExportService" }, { "name": "nebius.capacity.v1.CapacityAllowanceService" }, { "name": "nebius.capacity.v1.CapacityBlockGroupService" }, { "name": "nebius.capacity.v1.CapacityIntervalService" }, { "name": "nebius.capacity.v1.ResourceAdviceService" }, { "name": "nebius.compute.v1.DiskService" }, { "name": "nebius.compute.v1.DiskSnapshotService" }, { "name": "nebius.compute.v1.FilesystemService" }, { "name": "nebius.compute.v1.GpuClusterService" }, { "name": "nebius.compute.v1.ImageService" }, { "name": "nebius.compute.v1.InstanceService" }, { "name": "nebius.compute.v1.MaintenanceService" }, { "name": "nebius.compute.v1.NVLInstanceGroupService" }, { "name": "nebius.compute.v1.NodeService" }, { "name": "nebius.compute.v1.PlatformService" }, { "name": "nebius.dns.v1.RecordService" }, { "name": "nebius.dns.v1.ZoneService" }, { "name": "nebius.iam.v1.AccessKeyService" }, { "name": "nebius.iam.v1.AccessPermitService" }, { "name": "nebius.iam.v1.AuthPublicKeyService" }, { "name": "nebius.iam.v1.FederatedCredentialsService" }, { "name": "nebius.iam.v1.FederationCertificateService" }, { "name": "nebius.iam.v1.FederationService" }, { "name": "nebius.iam.v1.GroupMembershipService" }, { "name": "nebius.iam.v1.GroupService" }, { "name": "nebius.iam.v1.InvitationService" }, { "name": "nebius.iam.v1.ProfileService" }, { "name": "nebius.iam.v1.ProjectService" }, { "name": "nebius.iam.v1.ServiceAccountService" }, { "name": "nebius.iam.v1.SessionManagementService" }, { "name": "nebius.iam.v1.StaticKeyService" }, { "name": "nebius.iam.v1.TenantService" }, { "name": "nebius.iam.v1.TenantUserAccountService" }, { "name": "nebius.iam.v1.TenantUserAccountWithAttributesService" }, { "name": "nebius.iam.v2.AccessKeyService" }, { "name": "nebius.iam.v2.ProjectService" }, { "name": "nebius.iam.v2.TenantService" }, { "name": "nebius.kms.v1.AsymmetricCryptoService" }, { "name": "nebius.kms.v1.AsymmetricKeyService" }, { "name": "nebius.kms.v1.SymmetricCryptoService" }, { "name": "nebius.kms.v1.SymmetricKeyService" }, { "name": "nebius.logging.agentmanager.v1.VersionService" }, { "name": "nebius.logging.v1.LogExportService" }, { "name": "nebius.maintenance.v1alpha1.MaintenanceService" }, { "name": "nebius.mk8s.v1.ClusterService" }, { "name": "nebius.mk8s.v1.NodeGroupService" }, { "name": "nebius.mk8s.v1alpha1.ClusterService" }, { "name": "nebius.mk8s.v1alpha1.NodeGroupService" }, { "name": "nebius.msp.mlflow.v1alpha1.ClusterService" }, { "name": "nebius.msp.postgresql.v1alpha1.BackupService" }, { "name": "nebius.msp.postgresql.v1alpha1.ClusterService" }, { "name": "nebius.mysterybox.v1.PayloadService" }, { "name": "nebius.mysterybox.v1.SecretService" }, { "name": "nebius.mysterybox.v1.SecretVersionService" }, { "name": "nebius.quotas.v1.QuotaAllowanceService" }, { "name": "nebius.registry.v1.ArtifactService" }, { "name": "nebius.registry.v1.RegistryService" }, { "name": "nebius.storage.v1.BucketService" }, { "name": "nebius.storage.v1.InventoryService" }, { "name": "nebius.storage.v1.TransferService" }, { "name": "nebius.storage.v1alpha1.TransferService" }, { "name": "nebius.tunnel.v1.TunnelService" }, { "name": "nebius.vpc.v1.AllocationService" }, { "name": "nebius.vpc.v1.NetworkService" }, { "name": "nebius.vpc.v1.PoolService" }, { "name": "nebius.vpc.v1.RouteService" }, { "name": "nebius.vpc.v1.RouteTableService" }, { "name": "nebius.vpc.v1.SecurityGroupService" }, { "name": "nebius.vpc.v1.SecurityRuleService" }, { "name": "nebius.vpc.v1.SubnetService" }, { "name": "nebius.vpc.v1.TargetGroupService" }, { "name": "nebius.vpc.v1alpha1.AllocationService" }, { "name": "nebius.vpc.v1alpha1.NetworkService" }, { "name": "nebius.vpc.v1alpha1.PoolService" }, { "name": "nebius.vpc.v1alpha1.ScopeService" }, { "name": "nebius.vpc.v1alpha1.SubnetService" } ] }