Method: folders.create

Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder.

In order to succeed, the addition of this new Folder must not violate the Folder naming, height or fanout constraints.

  • The Folder's displayName must be distinct from all other Folder's that share its parent.
  • The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 4. Note, the full active + deleted Folder hierarchy is allowed to reach a height of 8; this provides additional headroom when moving folders that contain deleted folders.
  • The addition of the Folder must not cause the total number of Folders under its parent to exceed 100.

If the operation fails due to a folder constraint violation, a PreconditionFailure explaining the violation will be returned. If the failure occurs synchronously then the PreconditionFailure will be returned via the Status.details field and if it occurs asynchronously then the PreconditionFailure will be returned via the the Operation.error field.

The caller must have resourcemanager.folders.create permission on the identified parent.

HTTP request

POST https://cloudresourcemanager.googleapis.com/v2/folders

The URL uses Google API HTTP annotation syntax.

Query parameters

Parameters
parent

string

The resource name of the new Folder's parent. Must be of the form folders/{folder_id} or organizations/{org_id}.

Authorization requires the following Google IAM permission on the specified resource parent:

  • resourcemanager.folders.create

Request body

The request body contains an instance of Folder.

Response body

If successful, the response body contains a newly created instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudplatformfolders

For more information, see the Auth Guide.

Send feedback about...

Google Cloud Resource Manager
Google Cloud Resource Manager