Basic principles

Nebius Israel APIs are based on the gRPC mechanism. Methods and data structures in APIs are described using Protocol Buffers (proto 3).

Nebius Israel services provide a JSON REST interface that you can access directly. REST is supported via the gRPC-JSON transcoder. Nebius Israel services use this mechanism to translate incoming HTTP requests into gRPC calls. The service translates the results of request handling into an HTTP response and returns it to the client.

Resource-based approachResource-based approach

APIs use a resource-based approach. The concepts that apply to all Nebius Israel APIs are described below:

• In APIs, resources are VMs, disks, images, etc. Each resource has a unique ID.

• Two sets of methods are defined for managing resources in APIs:

  • Standard API methods allow you to perform CRUD operations: create, retrieve, update, and delete resources. Standard methods have the same signature and work in the same way for all APIs.
  • Additional API methods enhance the functionality of standard methods. You can use them to attach a disk, restart a VM, and perform other operations. The signature of additional methods differs from that of standard ones.

• Any operations that change the state of a resource are asynchronous signature operations. When these operations are called, the server returns the Operation object. This object contains the state of the operation and the ID of the resource the operation is being performed on.

• Operations for creating, updating, and deleting resources support idempotency.