Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Resource Manager
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Cloud
      • Creating a cloud
      • Rename a cloud
      • Setting up access rights
      • Switch clouds
    • Folders
      • Creating a folder
      • Updating a folder
      • How to set up access rights
      • Getting the folder ID
  • Concepts
    • Hierarchy of Yandex.Cloud resources
    • Quotas and limits
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • CloudService
      • FolderService
      • OperationService
    • REST
      • Overview
      • Cloud
        • Overview
        • 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. get

Method get

  • HTTP request
  • Path parameters
  • Response

Returns the specified Folder resource.

To get the list of available Folder resources, make a list request.

HTTP request

GET https://resource-manager.api.cloud.yandex.net/resource-manager/v1/folders/{folderId}

Path parameters

Parameter Description
folderId Required. ID of the Folder resource to return. To get the folder ID, use a list request. The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

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

A Folder resource. For more information, see Folder.

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. Мaximum of 64 per resource.

status string

Status of the folder.

  • ACTIVE: The folder is active.
  • DELETING: The folder is being deleted.
In this article:
  • HTTP request
  • Path parameters
  • Response
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC