Yandex.Cloud SDK (nodejs)

Need to automate your infrastructure or use services provided by Yandex.Cloud? We've got you covered.

Requirements

• nodejs >= 18

Installation

npm install @yandex-cloud/nodejs-sdk

Getting started

There are three options for authorization your requests:

• OAuth Token
• IAM token
• Metadata Service (if you're executing code inside VMs or Functions running in Yandex.Cloud)

OAuth Token

import { Session, cloudApi, serviceClients } from '@yandex-cloud/nodejs-sdk';

const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;

// Initialize SDK with your token
const session = new Session({ oauthToken: 'YOUR_TOKEN' });

// Create service client
const cloudService = session.client(serviceClients.CloudServiceClient);

// Issue request (returns Promise)
const response = await cloudService.list(ListCloudsRequest.fromPartial({
    pageSize: 100,
}));

Metadata Service

Don't forget to assign Service Account for your Instance or Function.

import { Session, cloudApi, serviceClients } from '@yandex-cloud/nodejs-sdk';

const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;

// Initialize SDK with your token
const session = new Session();

// Create service client
const cloudService = session.client(serviceClients.CloudServiceClient);

// Issue request (returns Promise)
const response = await cloudService.list(ListCloudsRequest.fromPartial({
    pageSize: 100,
}));

IAM Token

import { Session, cloudApi, serviceClients } from '@yandex-cloud/nodejs-sdk';

const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;

// Initialize SDK with your token
const session = new Session({ iamToken: 'YOUR_TOKEN' });

// Create service client
const cloudService = session.client(serviceClients.CloudServiceClient);

// Issue request (returns Promise)
const response = await cloudService.list(ListCloudsRequest.fromPartial({
    pageSize: 100,
}));

Check examples directory for more examples.

To run example scripts, you should execute the following commands:

cd examples
npm i
YC_OAUTH_TOKEN=... YC_FOLDER_ID=... npm run start path/to/example.ts

Services

• AI Translate;
• AI Vision.
• Application Load Balancer
• Billing
• Cloud CDN
• Certificate Manager
• Compute Cloud
• Container Registry
• Data Proc
• DataSphere
• Data Transfer
• DNS
• Identity and Access Management (IAM)
• IoT Core
• Managed Service for Kubernetes
• Key Management Service (KMS)
• Load Balancer
• Lockbox
• Logging
• Managed DataBase
  • ClickHouse
  • ElasticSearch
  • Greenplum
  • Kafka
  • MongoDB
  • MySQL
  • PostgreSQL
  • Redis
  • MS SQL Server
• Organization Manager
• Resource Manager
• Serverless
  • Functions
  • API Gateway
  • Containers
  • Triggers
  • MDB Proxy
• Virtual Private Cloud (VPC)
• Yandex Database (YDB)

If you need generated client for other Yandex.Cloud services, just open an issue.