Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
© 2022 Yandex.Cloud LLC
Yandex Resource Manager
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Cloud
      • Creating a cloud
      • Rename a cloud
      • Deleting a cloud
      • Canceling cloud deletion
      • Setting up access rights
      • Retrieving a cloud ID
      • Switch clouds
      • Changing an organization for a cloud
      • Cloud incident notifications
    • Folders
      • Creating a folder
      • Updating a folder
      • Deleting a folder
      • How to set up access rights
      • Getting the folder ID
      • Folder incident notifications
  • Concepts
    • Hierarchy of Yandex Cloud resources
    • Notifications from Yandex Cloud
    • Quotas and limits
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • CloudService
      • FolderService
      • OperationService
    • REST
      • Overview
      • Cloud
        • Overview
        • create
        • get
        • list
        • listAccessBindings
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
      • Folder
        • Overview
        • create
        • delete
        • get
        • list
        • listAccessBindings
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
  • Questions and answers
  1. API reference
  2. REST
  3. Folder
  4. Overview

Folder

Written by
Yandex Cloud
  • JSON Representation
  • Methods

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.

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.

Was the article helpful?

Language / Region
© 2022 Yandex.Cloud LLC
In this article:
  • JSON Representation
  • Methods