Skip to main content
API docs by Redocly

Cloud for 1C (v2.0)

Cloud for 1C is the cloud infrastructure prepared for work with 1C program.

Note: In the examples below, a hostname of a specific regional endpoint (i.e. ru-3) is used. The typical workflow begins with retrieving the list of available regional endpoints by sending a request to: https://api.selectel.ru/ones/paas/v2/service/endpoints. A regional endpoint should be selected based on the region where the resources are intended to be created. After selecting the desired regional endpoint from the response, all subsequent API requests should be directed to that endpoint while honoring the base prefix mentioned in this documentation (i.e. /v2).
The response format of the /service/endpoints request is described below.

Backups

Create infobase backup

Creates an on-demand backup of an infobase and uploads it to either a customer-specified backup vault or Selectel-managed storage. If a name isn’t provided, one is generated automatically. The DB dump backup is performed without affecting other clients in the cluster. For .dt file dumps, user sessions and scheduled jobs are temporarily blocked to ensure consistency, as recommended by 1C.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
infobaseId
required
string

The ID of the infobase to be backed up.

name
string

Optional user-provided name for the backup. If not provided, a name will be automatically generated.

vaultId
string

The ID of the backup vault to store and access this backup. If left empty, a default vault managed by Selectel will be used.

Responses

Request samples

Content type
application/json
{
  • "infobaseId": "string",
  • "name": "string",
  • "vaultId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "backup": {
    }
}

List infobase backups

Returns a paginated list of backups for a specific infobase, along with a cursor for fetching the next page of results.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string[^/]+

The ID of the infobase to retrieve backups for.

query Parameters
type
string
Default: "BACKUP_TYPE_UNSPECIFIED"
Enum: "BACKUP_TYPE_UNSPECIFIED" "BACKUP_TYPE_DB_DUMP" "BACKUP_TYPE_DT_DUMP"

Optional filter for backup type (e.g., database dump or .dt file). If not specified, no filtering by task type will be applied.

  • BACKUP_TYPE_DB_DUMP: Database dump backup.
  • BACKUP_TYPE_DT_DUMP: DT file backup.
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

Responses

Response samples

Content type
application/json
{
  • "backups": [
    ],
  • "cursor": {
    }
}

Delete backup

Deletes specific backup.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string[^/]+

The ID of the backup to delete.

Responses

Response samples

Content type
application/json
{ }

Download infobase backup

Generates a URL that allows downloading a specific infobase backup.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string[^/]+

The ID of the backup to download.

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

Create .dt dump of infobase

Creates an on-demand .dt file dump of an infobase and uploads it to Selectel-managed storage.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
infobaseId
string

The ID of the infobase that needs to be dumped to a .dt file. This must be a valid UUID identifying the infobase.

infobaseUser
string

The username with admin privileges required to access the infobase and perform the dump. This is required for non-empty infobases.

infobasePassword
string

The password for the admin user to authenticate and authorize the dump operation. This is required for non-empty infobases.

Responses

Request samples

Content type
application/json
{
  • "infobaseId": "string",
  • "infobaseUser": "string",
  • "infobasePassword": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "backup": {
    }
}

Restore infobase from .dt file

Restores the infobase from a .dt file, either identified by the upload ID or via a direct link to the .dt file stored externally. This operation can only restore a .dt file to an empty infobase.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
infobaseId
string

ID of the infobase to restore.

uploadId
string

ID of the .dt file upload.

uri
string

External URL of the .dt file.

Responses

Request samples

Content type
application/json
{
  • "infobaseId": "string",
  • "uploadId": "string",
  • "uri": "string"
}

Response samples

Content type
application/json
{ }

Generate URL for .dt file upload

Generates a URL and upload ID for uploading a .dt file to restore an infobase. Only files up to 5 GB in size can be uploaded via this URL.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "uploadId": "string",
  • "uploadUrl": "string"
}

List backed-up infobases

Returns infobases with successful backups.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "infobases": [
    ]
}

Create infobase backup plan

Creates a backup plan for an infobase which defines a schedule and retention policy for automated backups, including when backups are taken, how long they are retained, and where they are kept — either in a user-managed or Selectel-owned backup vault.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (BackupPlan)

A backup plan defines a schedule and retention policy for automated backups of infobase, including when backups are taken, how long they are retained, and where they are kept — either in a customer-managed or Selectel-owned backup vault.

infobaseId
required
string

The ID of the infobase this backup plan is created for.

schedule
required
string

A cron expression that defines the start time of the backup window.

scheduleGuiEditor
boolean

A boolean flag indicating which tab in the UI (visual editor or plain cron expression input) was used to create the cron expression in the schedule field. This is only a UI hint for selecting the correct tab when editing because the visual editor cannot handle all cron expressions. Default value is false.

enabled
boolean

Indicates whether this backup plan is enabled. A disabled backup plan won't trigger automated backups. Default value is true.

maxBackupsToRetain
required
string <uint64>

Defines the maximum number of backups to retain for this backup plan. Older backups exceeding this count will be deleted.

vaultId
string

The ID of the backup vault used for storing and accessing backups for this backup plan. If left empty, a default storage managed by Selectel will be used.

object (BackupVault)

A backup vault is a customer-managed object storage container used for storing backups. By using their own storage container, customers gain full control over their backup data, enabling advanced automation workflows—such as mirroring backups to other regions or third-party service providers for redundancy, disaster recovery, or compliance purposes.

disabledReason
string (BackupPlanDisabledReason)
Default: "BACKUP_PLAN_DISABLED_REASON_UNSPECIFIED"
Enum: "BACKUP_PLAN_DISABLED_REASON_UNSPECIFIED" "BACKUP_PLAN_DISABLED_REASON_CUSTOMER_REQUEST" "BACKUP_PLAN_DISABLED_REASON_VAULT_ERROR"

Represents the reasons why a backup plan was disabled.

  • BACKUP_PLAN_DISABLED_REASON_CUSTOMER_REQUEST: Disabled per the customer's request.
  • BACKUP_PLAN_DISABLED_REASON_VAULT_ERROR: Disabled due to an issue with the vault.

Responses

Request samples

Content type
application/json
{
  • "backupPlan": {
    }
}

Response samples

Content type
application/json
{
  • "backupPlan": {
    }
}

Update infobase backup plan

Updates the backup plan for an infobase. Replaces the entire resource with the data provided — any missing fields may be removed.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (BackupPlan)

A backup plan defines a schedule and retention policy for automated backups of infobase, including when backups are taken, how long they are retained, and where they are kept — either in a customer-managed or Selectel-owned backup vault.

infobaseId
required
string

The ID of the infobase this backup plan is created for.

schedule
required
string

A cron expression that defines the start time of the backup window.

scheduleGuiEditor
boolean

A boolean flag indicating which tab in the UI (visual editor or plain cron expression input) was used to create the cron expression in the schedule field. This is only a UI hint for selecting the correct tab when editing because the visual editor cannot handle all cron expressions. Default value is false.

enabled
boolean

Indicates whether this backup plan is enabled. A disabled backup plan won't trigger automated backups. Default value is true.

maxBackupsToRetain
required
string <uint64>

Defines the maximum number of backups to retain for this backup plan. Older backups exceeding this count will be deleted.

vaultId
string

The ID of the backup vault used for storing and accessing backups for this backup plan. If left empty, a default storage managed by Selectel will be used.

object (BackupVault)

A backup vault is a customer-managed object storage container used for storing backups. By using their own storage container, customers gain full control over their backup data, enabling advanced automation workflows—such as mirroring backups to other regions or third-party service providers for redundancy, disaster recovery, or compliance purposes.

disabledReason
string (BackupPlanDisabledReason)
Default: "BACKUP_PLAN_DISABLED_REASON_UNSPECIFIED"
Enum: "BACKUP_PLAN_DISABLED_REASON_UNSPECIFIED" "BACKUP_PLAN_DISABLED_REASON_CUSTOMER_REQUEST" "BACKUP_PLAN_DISABLED_REASON_VAULT_ERROR"

Represents the reasons why a backup plan was disabled.

  • BACKUP_PLAN_DISABLED_REASON_CUSTOMER_REQUEST: Disabled per the customer's request.
  • BACKUP_PLAN_DISABLED_REASON_VAULT_ERROR: Disabled due to an issue with the vault.

Responses

Request samples

Content type
application/json
{
  • "backupPlan": {
    }
}

Response samples

Content type
application/json
{
  • "backupPlan": {
    }
}

Partially updates infobase backup plan

Allows partial updates to the backup plan for an infobase. Only specify the fields you want to update in the request. Other data remains unchanged.

Authorizations:
iam_token_project_scoped
path Parameters
infobaseId
required
string[^/]+

The ID of the infobase which backup plan is being patched.

Request Body schema: application/json
required

The updated backup plan specification containing partial updated.

infobaseId
required
string

The ID of the infobase this backup plan is created for.

schedule
required
string

A cron expression that defines the start time of the backup window.

scheduleGuiEditor
boolean

A boolean flag indicating which tab in the UI (visual editor or plain cron expression input) was used to create the cron expression in the schedule field. This is only a UI hint for selecting the correct tab when editing because the visual editor cannot handle all cron expressions. Default value is false.

enabled
boolean

Indicates whether this backup plan is enabled. A disabled backup plan won't trigger automated backups. Default value is true.

maxBackupsToRetain
required
string <uint64>

Defines the maximum number of backups to retain for this backup plan. Older backups exceeding this count will be deleted.

vaultId
string

The ID of the backup vault used for storing and accessing backups for this backup plan. If left empty, a default storage managed by Selectel will be used.

object (BackupVault)

A backup vault is a customer-managed object storage container used for storing backups. By using their own storage container, customers gain full control over their backup data, enabling advanced automation workflows—such as mirroring backups to other regions or third-party service providers for redundancy, disaster recovery, or compliance purposes.

disabledReason
string (BackupPlanDisabledReason)
Default: "BACKUP_PLAN_DISABLED_REASON_UNSPECIFIED"
Enum: "BACKUP_PLAN_DISABLED_REASON_UNSPECIFIED" "BACKUP_PLAN_DISABLED_REASON_CUSTOMER_REQUEST" "BACKUP_PLAN_DISABLED_REASON_VAULT_ERROR"

Represents the reasons why a backup plan was disabled.

  • BACKUP_PLAN_DISABLED_REASON_CUSTOMER_REQUEST: Disabled per the customer's request.
  • BACKUP_PLAN_DISABLED_REASON_VAULT_ERROR: Disabled due to an issue with the vault.

Responses

Request samples

Content type
application/json
{
  • "infobaseId": "string",
  • "schedule": "string",
  • "scheduleGuiEditor": true,
  • "enabled": true,
  • "maxBackupsToRetain": "string",
  • "vaultId": "string",
  • "vault": {
    },
  • "disabledReason": "BACKUP_PLAN_DISABLED_REASON_UNSPECIFIED"
}

Response samples

Content type
application/json
{
  • "backupPlan": {
    }
}

Restore infobase from backup

Restores an infobase from the specified backup (only supports restoring DB dumps; use the other endpoint for .dt file restores). Currently, it’s not possible to restore a backup into an existing infobase — you can only restore it to a new one. However, you can delete the existing infobase and create a new one with the same name as the deleted one. For more details on the specifics and limitations of the restore process, refer to the documentation.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
infobaseId
required
string

ID of the infobase to restore.

backupId
required
string

ID of the backup to restore from.

Responses

Request samples

Content type
application/json
{
  • "infobaseId": "string",
  • "backupId": "string"
}

Response samples

Content type
application/json
{ }

Retrieve restore status of infobase

Returns the current or most recent status of the infobase restore process from a backup, returning status for both DB dumps and .dt file restores. Unspecified restore status indicates that no restore attempts have been made for the infobase.

Authorizations:
iam_token_project_scoped
path Parameters
infobaseId
required
string[^/]+

ID of the infobase to get restore status for.

Responses

Response samples

Content type
application/json
{
  • "status": "RESTORE_STATUS_UNSPECIFIED"
}

List supported regions for backup vaults

Returns the list of supported object storage regions that can be used for backup vaults. These regions determine where backup data can be stored in customer-owned storage and help ensure data locality, compliance with regulations, and optimized performance based on proximity. Currently, Selectel is the only supported object storage service provider.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "regions": [
    ]
}

List backup vaults

Returns a paginated list of backup vaults, along with a cursor for fetching the next page of results.

Authorizations:
iam_token_project_scoped
query Parameters
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

Responses

Response samples

Content type
application/json
{
  • "vaults": [
    ],
  • "cursor": {
    }
}

Create backup vault

Creates a vault to store backups. A backup vault is a customer-managed object storage container used for storing backups. By using their own storage container, customers gain full control over their backup data, enabling advanced automation workflows — such as mirroring backups to other regions or third-party service providers for redundancy, disaster recovery, or compliance purposes.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (BackupVaultSpec)

Defines the configuration for a backup vault.

required
object (S3Config)

Contains the configuration for authenticating and interacting with S3-compatible object storage. Currently, Selectel is the only supported object storage service provider.

bucketName
required
string

Name of the S3 bucket (object storage container).

bucketPrefix
string

Prefix in the bucket.

region
string

Region of the bucket. Default value is ru-1.

accessKeyId
required
string

Access key ID for authentication.

secretAccessKey
string

Secret access key for authentication.

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "vault": {
    }
}

Verify backup vault specification

Tests and verifies the backup vault specification before creating a new one or modifying an existing vault. Validates object storage configurations, including S3 credentials, bucket accessibility, and required permissions.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (BackupVaultSpec)

Defines the configuration for a backup vault.

required
object (S3Config)

Contains the configuration for authenticating and interacting with S3-compatible object storage. Currently, Selectel is the only supported object storage service provider.

bucketName
required
string

Name of the S3 bucket (object storage container).

bucketPrefix
string

Prefix in the bucket.

region
string

Region of the bucket. Default value is ru-1.

accessKeyId
required
string

Access key ID for authentication.

secretAccessKey
string

Secret access key for authentication.

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{ }

Get backup vault

Returns details of a specific backup vault.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

An ID of the vault to return.

Responses

Response samples

Content type
application/json
{
  • "vault": {
    }
}

Delete backup vault

Deletes a backup vault. The backups stored in the vault remain intact and are not deleted. Any active backup plans associated with the vault will be disabled.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the backup vault to delete.

query Parameters
force
boolean

Whether to force the deletion of the backup vault. If true, all backup plans associated with the vault will be disabled, and the customer will no longer be able to download or restore backups from this vault. Backups themselves remain intact.

Responses

Response samples

Content type
application/json
{ }

Modify backup vault

Modifies the configuration of an existing backup vault. Only specify the fields you want to update in the request. Other data remains unchanged.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

An ID of the vault to patch.

Request Body schema: application/json
required

A new spec for the vault.

required
object (S3Config)

Contains the configuration for authenticating and interacting with S3-compatible object storage. Currently, Selectel is the only supported object storage service provider.

bucketName
required
string

Name of the S3 bucket (object storage container).

bucketPrefix
string

Prefix in the bucket.

region
string

Region of the bucket. Default value is ru-1.

accessKeyId
required
string

Access key ID for authentication.

secretAccessKey
string

Secret access key for authentication.

Responses

Request samples

Content type
application/json
{
  • "s3": {
    }
}

Response samples

Content type
application/json
{
  • "vault": {
    }
}

Clusters

List supported cluster flavors

Returns a list of supported cluster flavors. Deprecated flavors are filtered out by default unless explicitly requested. Creating a cluster with a deprecated flavor is not allowed.

Authorizations:
iam_token_project_scoped
query Parameters
includeDeprecated
boolean

Whether to include deprecated cluster flavors in the result set.

Responses

Response samples

Content type
application/json
{
  • "flavors": [
    ]
}

List resource allocation constraints for cluster flavors

Returns resource allocation constraints for custom cluster flavors.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "constraints": {
    }
}

List supported cluster platforms

Returns a list of supported cluster platforms. Deprecated platform versions are filtered out by default unless explicitly requested. Creating a cluster with a deprecated platform is not allowed.

Authorizations:
iam_token_project_scoped
query Parameters
includeDeprecated
boolean

Whether to include deprecated platforms in the result set.

Responses

Response samples

Content type
application/json
{
  • "platforms": [
    ]
}

List cluster proxies

Returns a paginated list of cluster proxies using cursor-based pagination. Supports optional filtering by cluster ID.

Authorizations:
iam_token_project_scoped
query Parameters
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

clusterId
string

The ID of the cluster to filter cluster proxies on.

Responses

Response samples

Content type
application/json
{
  • "clusterProxies": [
    ],
  • "cursor": {
    }
}

Create cluster proxy

Creates a proxy to access a cluster. A public proxy uses TCP and allows access via the 1C thick client from the Internet. A private proxy supports both TCP and HTTP, enabling access via both the 1C thick and thin clients from the customer's private network.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (ClusterProxySpec)

Represents the desired configuration for a cluster proxy. This includes details on the associated cluster, access configurations, and networking options for the proxy.

clusterId
required
string

The ID of the cluster this proxy belongs to.

publicAccess
boolean

Whether the cluster proxy is publicly available (i.e., has a public IPv4 and is reachable through the public internet).

networkId
string

The ID of the customer's OpenStack network shared with our project. Required if public_access = true.

subnetId
string

The ID of the OpenStack subnet of the specified network shared with our project. If left empty, the first subnet in the list will be used.

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "clusterProxy": {
    }
}

Get OpenStack project ID for creating private cluster proxy

Returns the ID of the OpenStack project with which a customer needs to share their private network in order to create a private proxy for the cluster.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "projectId": "string"
}

Get cluster proxy

Returns details of a cluster proxy.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster proxy to retrieve.

Responses

Response samples

Content type
application/json
{
  • "clusterProxy": {
    }
}

Delete cluster proxy

Deletes a cluster proxy.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster proxy to delete.

Responses

Response samples

Content type
application/json
{
  • "clusterProxy": {
    }
}

List clusters

Retrieves a paginated list of clusters using cursor-based pagination.

Authorizations:
iam_token_project_scoped
query Parameters
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

Responses

Response samples

Content type
application/json
{
  • "clusters": [
    ],
  • "cursor": {
    }
}

Create cluster

Creates a new cluster. Creating a cluster with a deprecated platform or flavor is not allowed.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (ClusterSpec)

Defines the desired configuration of a cluster. Specifies parameters such as platform version, resource allocation, and maintenance settings.

name
required
string

The name given to the cluster by the user.

required
object (ClusterPlatform)

The 1C platform settings used by the cluster.

required
object (ClusterFlavor)

Defines the configuration of a cluster flavor, which includes details about the virtual machine's resources like CPU, RAM, and disk size. It also specifies whether the flavor is deprecated and the type of VM.

object (TimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

object (ClusterConfig)

Defines additional configuration settings for a cluster. Includes web access control, debug mode, and other platform-specific options.

enableStorageAutoScaling
boolean

When true, enables automatic storage scaling during the maintenance window.

With auto scaling enabled, the system can automatically increase the allocated storage capacity if the current usage approaches the limit, helping to avoid outages or degraded performance due to insufficient storage.

Auto scaling occurs only during the maintenance window and is subject to several conditions. It is available only for flavors that support dynamic scaling and may be disabled if the cluster is in an error state or if other resource constraints apply.

This setting is optional and can be used to ensure storage scales with growing workloads.

Defaults to True.

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

List supported object storage regions for cluster volumes

Retrieves a list of object storage regions supported for cluster volumes.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "regions": [
    ]
}

Verify cluster volume spec

Verifies the cluster volume spec before creating a volume, mainly to validate mount options like credentials, permissions, etc.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (ClusterVolumeSpec)

Defines the desired configuration and parameters for a cluster volume, including the type, size, and specific mount options.

clusterId
required
string

The ID of the cluster this volume is mounted to.

type
string (ClusterVolumeType)
Default: "CLUSTER_VOLUME_TYPE_UNSPECIFIED"
Enum: "CLUSTER_VOLUME_TYPE_UNSPECIFIED" "CLUSTER_VOLUME_TYPE_S3"

Enum representing the different types of volumes supported by the cluster.

  • CLUSTER_VOLUME_TYPE_S3: The S3 volume type.
size
string <uint64>

The size of the volume in bytes.

object (S3VolumeOptions)

Defines the specific configuration options for mounting an S3 volume within the cluster, including bucket name, access keys, and other parameters.

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{ }

Get cluster

Returns the details of a specific cluster.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to retrieve.

Responses

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

Delete cluster

Deletes a cluster. All infobases linked to the cluster must be removed beforehand.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to delete.

Responses

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

Patch cluster

Allows partial updates to specific fields of the cluster spec. Patching allowed fields does not require a cluster restart or downtime.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to patch.

Request Body schema: application/json
required

The new spec for the cluster.

name
required
string

The name given to the cluster by the user.

required
object (ClusterPlatform)

The 1C platform settings used by the cluster.

required
object (ClusterFlavor)

Defines the configuration of a cluster flavor, which includes details about the virtual machine's resources like CPU, RAM, and disk size. It also specifies whether the flavor is deprecated and the type of VM.

object (TimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

object (ClusterConfig)

Defines additional configuration settings for a cluster. Includes web access control, debug mode, and other platform-specific options.

enableStorageAutoScaling
boolean

When true, enables automatic storage scaling during the maintenance window.

With auto scaling enabled, the system can automatically increase the allocated storage capacity if the current usage approaches the limit, helping to avoid outages or degraded performance due to insufficient storage.

Auto scaling occurs only during the maintenance window and is subject to several conditions. It is available only for flavors that support dynamic scaling and may be disabled if the cluster is in an error state or if other resource constraints apply.

This setting is optional and can be used to ensure storage scales with growing workloads.

Defaults to True.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "platform": { },
  • "flavor": {
    },
  • "maintenanceWindowStart": {
    },
  • "config": {
    },
  • "enableStorageAutoScaling": true
}

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

Change cluster configuration

Changes cluster settings related to 1C platform configuration and networking. Typically requires short downtime and/or a cluster restart to apply the changes.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to modify.

Request Body schema: application/json
required
required
object (ClusterConfig)

Defines additional configuration settings for a cluster. Includes web access control, debug mode, and other platform-specific options.

webServerEnabled
boolean

Indicates whether the web server (Apache2) is enabled for the cluster. Disabling the web server will make all cluster's web publications unavailable. Defaults to True.

webClientInternetIngressEnabled
boolean

Indicates whether web publications are accessible through the Internet. Defaults to True.

webClientIpAllowList
Array of strings

A list of allowed IPv4 prefixes for web publications access. An empty list means unrestricted access is allowed.

debugMode
boolean

Enables or disables 1C debug mode for troubleshooting purposes.

Responses

Request samples

Content type
application/json
{
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

List cluster maintenance events

Retrieves a paginated list of maintenance events for a specific cluster using cursor-based pagination.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to retrieve maintenance events for.

query Parameters
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "cursor": {
    }
}

Get cluster metrics

Retrieves metrics for a specific cluster.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to retrieve metrics for.

query Parameters
timeRange.start
string <date-time>

The start timestamp of the time range.

timeRange.end
string <date-time>

The end timestamp of the time range.

Responses

Response samples

Content type
application/json
{
  • "metrics": {
    }
}

Resize cluster

Allows adding more compute resources and/or storage to the cluster. Storage size can only be increased or remain the same; downsizing is not supported. Compute resources such as CPU and RAM can be downsized.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to resize.

Request Body schema: application/json
required
required
object (ClusterFlavor)

Defines the configuration of a cluster flavor, which includes details about the virtual machine's resources like CPU, RAM, and disk size. It also specifies whether the flavor is deprecated and the type of VM.

id
string

The ID of the flavor. This field is optional if the user selects a custom resource configuration.

vCpu
required
string <int64>

The number of vCPUs allocated for this flavor.

ramMb
required
string <int64>

The amount of RAM allocated for this flavor, in megabytes.

diskGb
required
string <int64>

The size of the disk allocated for this flavor, in gigabytes.

vmType
string (ClusterFlavorVMType)
Default: "CLUSTER_FLAVOR_VM_TYPE_UNSPECIFIED"
Enum: "CLUSTER_FLAVOR_VM_TYPE_UNSPECIFIED" "CLUSTER_FLAVOR_VM_TYPE_STANDARD" "CLUSTER_FLAVOR_VM_TYPE_HI_FREQ"

Defines the type of virtual machine used for the cluster flavor. This determines the CPU performance characteristics of the VM.

  • CLUSTER_FLAVOR_VM_TYPE_STANDARD: The virtual machine with standard CPU type.
  • CLUSTER_FLAVOR_VM_TYPE_HI_FREQ: The virtual machine high frequency CPU type.

Responses

Request samples

Content type
application/json
{
  • "flavor": {
    }
}

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

Restart cluster

Restarts a cluster, typically requiring short downtime.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

An ID of the cluster to restart.

Responses

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

List cluster sessions

Retrieves a list of user sessions for a specific cluster.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to retrieve sessions for.

query Parameters
infobaseId
string

The ID of the infobase to filter the sessions.

Responses

Response samples

Content type
application/json
{
  • "sessions": [
    ]
}

Terminate cluster session

Terminates one or more user sessions in the specified cluster.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to terminate sessions for.

Request Body schema: application/json
required
sessionId
string

The identifier of the session to terminate.

object (ClusterSessionFilter)
reason
string

An optional reason for terminating the session(s).

Responses

Request samples

Content type
application/json
{
  • "sessionId": "string",
  • "filter": {
    },
  • "reason": "string"
}

Response samples

Content type
application/json
{ }

Upgrade cluster

Upgrades the 1C platform version of the cluster. Downgrading is not allowed.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

An ID of the cluster to upgrade.

Request Body schema: application/json
required
required
object (ClusterPlatform)

The 1C platform settings used by the cluster.

Responses

Request samples

Content type
application/json
{
  • "platform": { }
}

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

List cluster volumes

Retrieves a list of volumes mounted to the cluster.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to retrieve volumes for.

query Parameters
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

Responses

Response samples

Content type
application/json
{
  • "volumes": [
    ],
  • "cursor": {
    }
}

Mount volume to the cluster

Mounts a volume to the specified cluster.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to mount the volume to.

Request Body schema: application/json
required
required
object (ClusterVolumeSpec)

Defines the desired configuration and parameters for a cluster volume, including the type, size, and specific mount options.

clusterId
required
string

The ID of the cluster this volume is mounted to.

type
string (ClusterVolumeType)
Default: "CLUSTER_VOLUME_TYPE_UNSPECIFIED"
Enum: "CLUSTER_VOLUME_TYPE_UNSPECIFIED" "CLUSTER_VOLUME_TYPE_S3"

Enum representing the different types of volumes supported by the cluster.

  • CLUSTER_VOLUME_TYPE_S3: The S3 volume type.
size
string <uint64>

The size of the volume in bytes.

object (S3VolumeOptions)

Defines the specific configuration options for mounting an S3 volume within the cluster, including bucket name, access keys, and other parameters.

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "cluster": {
    },
  • "volume": {
    }
}

Unmount specific volume from cluster

Unmounts a specific volume from the specified cluster.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to unmount the volume from.

volumeId
required
string

The ID of the volume to unmount.

Responses

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

Proxies

List cluster proxies

Returns a paginated list of cluster proxies using cursor-based pagination. Supports optional filtering by cluster ID.

Authorizations:
iam_token_project_scoped
query Parameters
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

clusterId
string

The ID of the cluster to filter cluster proxies on.

Responses

Response samples

Content type
application/json
{
  • "clusterProxies": [
    ],
  • "cursor": {
    }
}

Create cluster proxy

Creates a proxy to access a cluster. A public proxy uses TCP and allows access via the 1C thick client from the Internet. A private proxy supports both TCP and HTTP, enabling access via both the 1C thick and thin clients from the customer's private network.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (ClusterProxySpec)

Represents the desired configuration for a cluster proxy. This includes details on the associated cluster, access configurations, and networking options for the proxy.

clusterId
required
string

The ID of the cluster this proxy belongs to.

publicAccess
boolean

Whether the cluster proxy is publicly available (i.e., has a public IPv4 and is reachable through the public internet).

networkId
string

The ID of the customer's OpenStack network shared with our project. Required if public_access = true.

subnetId
string

The ID of the OpenStack subnet of the specified network shared with our project. If left empty, the first subnet in the list will be used.

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "clusterProxy": {
    }
}

Get OpenStack project ID for creating private cluster proxy

Returns the ID of the OpenStack project with which a customer needs to share their private network in order to create a private proxy for the cluster.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "projectId": "string"
}

Get cluster proxy

Returns details of a cluster proxy.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster proxy to retrieve.

Responses

Response samples

Content type
application/json
{
  • "clusterProxy": {
    }
}

Delete cluster proxy

Deletes a cluster proxy.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster proxy to delete.

Responses

Response samples

Content type
application/json
{
  • "clusterProxy": {
    }
}

Volumes

List supported object storage regions for cluster volumes

Retrieves a list of object storage regions supported for cluster volumes.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "regions": [
    ]
}

Verify cluster volume spec

Verifies the cluster volume spec before creating a volume, mainly to validate mount options like credentials, permissions, etc.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (ClusterVolumeSpec)

Defines the desired configuration and parameters for a cluster volume, including the type, size, and specific mount options.

clusterId
required
string

The ID of the cluster this volume is mounted to.

type
string (ClusterVolumeType)
Default: "CLUSTER_VOLUME_TYPE_UNSPECIFIED"
Enum: "CLUSTER_VOLUME_TYPE_UNSPECIFIED" "CLUSTER_VOLUME_TYPE_S3"

Enum representing the different types of volumes supported by the cluster.

  • CLUSTER_VOLUME_TYPE_S3: The S3 volume type.
size
string <uint64>

The size of the volume in bytes.

object (S3VolumeOptions)

Defines the specific configuration options for mounting an S3 volume within the cluster, including bucket name, access keys, and other parameters.

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{ }

List cluster volumes

Retrieves a list of volumes mounted to the cluster.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to retrieve volumes for.

query Parameters
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

Responses

Response samples

Content type
application/json
{
  • "volumes": [
    ],
  • "cursor": {
    }
}

Mount volume to the cluster

Mounts a volume to the specified cluster.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to mount the volume to.

Request Body schema: application/json
required
required
object (ClusterVolumeSpec)

Defines the desired configuration and parameters for a cluster volume, including the type, size, and specific mount options.

clusterId
required
string

The ID of the cluster this volume is mounted to.

type
string (ClusterVolumeType)
Default: "CLUSTER_VOLUME_TYPE_UNSPECIFIED"
Enum: "CLUSTER_VOLUME_TYPE_UNSPECIFIED" "CLUSTER_VOLUME_TYPE_S3"

Enum representing the different types of volumes supported by the cluster.

  • CLUSTER_VOLUME_TYPE_S3: The S3 volume type.
size
string <uint64>

The size of the volume in bytes.

object (S3VolumeOptions)

Defines the specific configuration options for mounting an S3 volume within the cluster, including bucket name, access keys, and other parameters.

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "cluster": {
    },
  • "volume": {
    }
}

Unmount specific volume from cluster

Unmounts a specific volume from the specified cluster.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the cluster to unmount the volume from.

volumeId
required
string

The ID of the volume to unmount.

Responses

Response samples

Content type
application/json
{
  • "cluster": {
    }
}

Datastores

List datastore flavors

Retrieves a list of supported datastore flavors.

Authorizations:
iam_token_project_scoped
query Parameters
includeDeprecated
boolean

Whether to include deprecated datastore flavors in the result set.

Responses

Response samples

Content type
application/json
{
  • "flavors": [
    ]
}

Get resource allocation constraints for datastore flavors

Retrieves resource allocation constraints for custom datastore flavors.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "constraints": {
    }
}

List datastores

Retrieves a paginated list of datastores using cursor-based pagination.

Authorizations:
iam_token_project_scoped
query Parameters
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

Responses

Response samples

Content type
application/json
{
  • "datastores": [
    ],
  • "cursor": {
    }
}

Create datastore

Creates a new datastore (database cluster) that can store data for multiple infobases.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (DatastoreSpec)

Defines the desired configuration of a datastore. Specifies parameters such as resource allocation, storage autoscaling and maintenance settings.

name
required
string

The name given to the datastore by the user.

required
object (DatastoreFlavor)

Defines the configuration of a datastore flavor, which includes details about the virtual machine's resources like CPU, RAM, and disk size. It also specifies whether the flavor is deprecated and the type of VM.

nodeCount
string <int64>

The number of nodes in the datastore cluster.

object (TimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

enableStorageAutoScaling
boolean

When true, enables automatic storage scaling during the maintenance window.

With auto scaling enabled, the system can automatically increase the allocated storage capacity if the current usage approaches the limit, helping to avoid outages or degraded performance due to insufficient storage.

Auto scaling occurs only during the maintenance window and is subject to several conditions. It is available only for flavors that support dynamic scaling and may be disabled if the cluster is in an error state or if other resource constraints apply.

This setting is optional and can be used to ensure storage scales with growing workloads.

Defaults to True.

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Get datastore

Retrieves the details of a datastore.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the datastore to retrieve.

Responses

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Delete datastore

Deletes a datastore. All infobases linked to the datastore must be deleted first.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the datastore to delete.

Responses

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Patch datastore

Enables partial updates to the datastore specification.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the datastore to patch.

Request Body schema: application/json
required

The new spec for the datastore.

name
required
string

The name given to the datastore by the user.

required
object (DatastoreFlavor)

Defines the configuration of a datastore flavor, which includes details about the virtual machine's resources like CPU, RAM, and disk size. It also specifies whether the flavor is deprecated and the type of VM.

nodeCount
string <int64>

The number of nodes in the datastore cluster.

object (TimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

enableStorageAutoScaling
boolean

When true, enables automatic storage scaling during the maintenance window.

With auto scaling enabled, the system can automatically increase the allocated storage capacity if the current usage approaches the limit, helping to avoid outages or degraded performance due to insufficient storage.

Auto scaling occurs only during the maintenance window and is subject to several conditions. It is available only for flavors that support dynamic scaling and may be disabled if the cluster is in an error state or if other resource constraints apply.

This setting is optional and can be used to ensure storage scales with growing workloads.

Defaults to True.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "flavor": {
    },
  • "nodeCount": "string",
  • "maintenanceWindowStart": {
    },
  • "enableStorageAutoScaling": true
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

List datastore maintenance events

Retrieves a list of maintenance events for a specific datastore, ordered in reverse chronological order.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the datastore to retrieve maintenance events for.

query Parameters
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "cursor": {
    }
}

Resize datastore

Enables adding more compute resources and/or storage to the datastore. Storage can only be increased or remain the same; downsizing is not supported.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the datastore to resize.

Request Body schema: application/json
required
required
object (DatastoreFlavor)

Defines the configuration of a datastore flavor, which includes details about the virtual machine's resources like CPU, RAM, and disk size. It also specifies whether the flavor is deprecated and the type of VM.

nodeCount
string <int64>

The number of nodes in the datastore (database cluster).

Responses

Request samples

Content type
application/json
{
  • "flavor": {
    },
  • "nodeCount": "string"
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Infobases

List infobases

Returns a paginated list of infobases using cursor-based pagination.

Authorizations:
iam_token_project_scoped
query Parameters
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

clusterId
string

The ID of the cluster to filter infobases on.

Responses

Response samples

Content type
application/json
{
  • "infobases": [
    ],
  • "cursor": {
    }
}

Create infobase

Creates a new 1C infobase in the specified cluster and datastore.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (InfobaseSpec)

Defines the desired configuration of an infobase.

clusterId
required
string

The ID of the cluster where this infobase is hosted.

datastoreId
required
string

The ID of the datastore where this infobase stores its data.

name
required
string

The user-defined name of the infobase.

description
required
string

The user-defined description of the infobase.

webPublicationEnabled
boolean

Specifies whether web publication is enabled for this infobase. Defaults to true.

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "infobase": {
    }
}

Get infobase

Retrieves details of a specific infobase.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the infobase to retrieve.

Responses

Response samples

Content type
application/json
{
  • "infobase": {
    }
}

Delete infobase

Deletes the specified infobase.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the infobase to delete.

Responses

Response samples

Content type
application/json
{
  • "infobase": {
    }
}

Patch infobase

Enables partial updates to the infobase specification.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the infobase to patch.

Request Body schema: application/json
required

The new spec for the infobase.

clusterId
required
string

The ID of the cluster where this infobase is hosted.

datastoreId
required
string

The ID of the datastore where this infobase stores its data.

name
required
string

The user-defined name of the infobase.

description
required
string

The user-defined description of the infobase.

webPublicationEnabled
boolean

Specifies whether web publication is enabled for this infobase. Defaults to true.

Responses

Request samples

Content type
application/json
{
  • "clusterId": "string",
  • "datastoreId": "string",
  • "name": "string",
  • "description": "string",
  • "webPublicationEnabled": true
}

Response samples

Content type
application/json
{
  • "infobase": {
    }
}

Enable scheduled jobs in infobase

Allows scheduled jobs to run in the specified infobase.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the infobase to allow scheduled jobs in.

Request Body schema: application/json
required
infobaseUser
string

The infobase user name for modifying settings. Must be provided for non-empty infobases.

infobasePassword
string

The infobase user password for modifying settings. Must be provided for non-empty infobases.

Responses

Request samples

Content type
application/json
{
  • "infobaseUser": "string",
  • "infobasePassword": "string"
}

Response samples

Content type
application/json
{ }

Disable scheduled jobs in infobase

Prevents scheduled jobs from running in the specified infobase.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the infobase to deny scheduled jobs in.

Request Body schema: application/json
required
infobaseUser
string

The infobase user name for modifying settings. Must be provided for non-empty infobases.

infobasePassword
string

The infobase user password for modifying settings. Must be provided for non-empty infobases.

Responses

Request samples

Content type
application/json
{
  • "infobaseUser": "string",
  • "infobasePassword": "string"
}

Response samples

Content type
application/json
{ }

Allow user sessions in infobase

Enables new user sessions in the specified infobase.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the infobase to allow sessions in.

Request Body schema: application/json
required
infobaseUser
string

The infobase user name for modifying settings. Must be provided for non-empty infobases.

infobasePassword
string

The infobase user password for modifying settings. Must be provided for non-empty infobases.

Responses

Request samples

Content type
application/json
{
  • "infobaseUser": "string",
  • "infobasePassword": "string"
}

Response samples

Content type
application/json
{ }

Deny user sessions in infobase

Prevents new user sessions from being established in the specified infobase.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the infobase to deny sessions in.

Request Body schema: application/json
required
infobaseUser
string

The infobase user name for modifying settings. Must be provided for non-empty infobases.

infobasePassword
string

The infobase user password for modifying settings. Must be provided for non-empty infobases.

deniedMessage
string

A message to display to users when they attempt to login while sessions are blocked.

deniedParameter
string

A free-form text that can be used for various configuration purposes.

accessCode
string

Access code that allows session start despite session lock.

startsAt
string <date-time>

Optional time when the cluster will start blocking sessions.

endsAt
string <date-time>

Optional time when the cluster will stop blocking sessions.

Responses

Request samples

Content type
application/json
{
  • "infobaseUser": "string",
  • "infobasePassword": "string",
  • "deniedMessage": "string",
  • "deniedParameter": "string",
  • "accessCode": "string",
  • "startsAt": "2019-08-24T14:15:22Z",
  • "endsAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{ }

Transfer infobase

Transfers an infobase from one cluster to another while keeping the data in the same datastore.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the infobase to transfer.

Request Body schema: application/json
required
targetClusterId
required
string

The ID of the target cluster to transfer the infobase to.

Responses

Request samples

Content type
application/json
{
  • "targetClusterId": "string"
}

Response samples

Content type
application/json
{
  • "infobase": {
    }
}

Get infobase web-publication configuration

Retrieves the configuration used for infobase web-publication.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the infobase for which the web-publication config is requested.

Responses

Response samples

Content type
application/json
{
  • "vrdContents": "string"
}

Update infobase web-publication configuration

Updates the configuration used for infobase web publication.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the infobase for which the web-publication config needs to be updated.

Request Body schema: application/json
required
vrdContents
string (VRD file contents to be used with infobase web-publication. Pass an empty string to apply the default VRD file for infobase web-publication. Docs: https://its.1c.ru/db/v8325doc#bookmark:adm:ti000000379)

Responses

Request samples

Content type
application/json
{
  • "vrdContents": "string"
}

Response samples

Content type
application/json
{
  • "infobase": {
    }
}

Licenses

List activated licenses

Retrieves a paginated list of activated licenses on a specific cluster using cursor-based pagination.

Authorizations:
iam_token_project_scoped
path Parameters
clusterId
required
string

The ID of the cluster to list activated licenses for.

query Parameters
cursor.cursor
string <uint64>

A pointer to a specific record in the dataset, indicating the position to start returning rows from.

cursor.limit
string <uint64>

The maximum number of records to return in the response. This controls the page size for pagination.

Responses

Response samples

Content type
application/json
{
  • "entities": [
    ],
  • "cursor": {
    }
}

Activate license

Activates a license on the specific cluster

Authorizations:
iam_token_project_scoped
path Parameters
clusterId
required
string

The ID of the cluster where the license will be activated.

Request Body schema: application/json
required
object (LicenseDetails)

The license details used for license activation.

cliCommand
string

A CLI command to activate the license.

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    },
  • "cliCommand": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Retrieve activated license

Returns the details of a specific license activation.

Authorizations:
iam_token_project_scoped
path Parameters
id
required
string

The ID of the license activation to return.

Responses

Response samples

Content type
application/json
{
  • "activation": {
    },
  • "reason": "string"
}

Deactivate license

Deactivates a license on the specific cluster.

Authorizations:
iam_token_project_scoped
path Parameters
licenseId
required
string

The ID of the license activation.

Responses

Response samples

Content type
application/json
{ }

Service Catalog

Get global service config

Retrieves the global service configuration, including availability across regions and regional-specific settings.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

Get service endpoints

Retrieves a list of regional service endpoints.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "endpoints": [
    ]
}

Get supported regions

Retrieves the list of regions where the service is currently available.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "regions": [
    ]
}

Service Usage and Limits

Get service usage stats

Returns service usage statistics for the current project.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "clustersCount": "string",
  • "datastoresCount": "string",
  • "infobasesCount": "string",
  • "clusterProxyCount": "string",
  • "newComputeResourcesRestricted": true
}