Get started
Yandex Resource Manager

Resource Manager API, REST: Folder methods

Written by

A set of methods for managing Folder resources.

JSON Representation

{
  "id": "string",
  "cloudId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "status": "string"
}
Field Description
id string

ID of the folder.
cloudId string

ID of the cloud that the folder belongs to.
createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
name string

Name of the folder. The name is unique within the cloud. 3-63 characters long.
description string

Description of the folder. 0-256 characters long.
labels object

Resource labels as key:value pairs. Maximum of 64 per resource.
status string

Status of the folder.

  • ACTIVE: The folder is active.
  • DELETING: The folder is being deleted.
  • PENDING_DELETION: Stopping folder resources and waiting for the deletion start timestamp.

Methods

Method Description
create Creates a folder in the specified cloud.
delete Deletes the specified folder.
get Returns the specified Folder resource.
list Retrieves the list of Folder resources in the specified cloud.
listAccessBindings Lists access bindings for the specified folder.
listOperations Lists operations for the specified folder.
setAccessBindings Sets access bindings for the specified folder.
update Updates the specified folder.
updateAccessBindings Updates access bindings for the specified folder.
In this article: