Method get

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 in RFC3339 text format.

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.