Cloud Resource Manager API
Creates, reads, and updates metadata for Google Cloud Platform resource containers.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Creates, reads, and updates metadata for Google Cloud Platform resource containers.
Endpoints 33
effectiveTags
- GETReturn a list of effective tags for the given Google Cloud resource, as specified in `parent`.
/v3/effectiveTags?pageSize=0&pageToken=string&parent=stringReturn a list of effective tags for the given Google Cloud resource, as specified in parent.
folders
- GETLists the folders that are direct descendants of supplied parent resource
/v3/folders?pageSize=0&pageToken=string&parent=string&showDeleted=trueLists the folders that are direct descendants of supplied parent resource. list() provides a strongly consistent view of the folders underneath the specified… - POSTCreates a folder in the resource hierarchy
/v3/foldersCreates 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… - GETSearches for folders that match specific filter criteria
/v3/folders:search?pageSize=0&pageToken=string&query=stringSearches for folders that match specific filter criteria. search() provides an eventually consistent view of the folders a user has access to which meet the…
tagValues
- GETRetrieves a TagValue
/v3/:nameRetrieves a TagValue. This method will return PERMISSION_DENIED if the value does not exist or the user does not have permission to view it. - PATCHUpdates the attributes of the TagValue resource.
/v3/:name?updateMask=string&validateOnly=trueUpdates the attributes of the TagValue resource. - POSTGets the access control policy for a TagValue
/v3/:resource:getIamPolicyGets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the… - POSTSets the access control policy on a TagValue, replacing any existing policy
/v3/:resource:setIamPolicySets the access control policy on a TagValue, replacing any existing policy. The resource field should be the TagValue's resource name. For example:… - POSTReturns permissions that a caller has on the specified TagValue
/v3/:resource:testIamPermissionsReturns permissions that a caller has on the specified TagValue. The resource field should be the TagValue's resource name. For example: tagValues/1234. There… - GETLists all TagValues for a specific TagKey.
/v3/tagValues?pageSize=0&pageToken=string&parent=stringLists all TagValues for a specific TagKey. - POSTCreates a TagValue as a child of the specified TagKey
/v3/tagValues?validateOnly=trueCreates a TagValue as a child of the specified TagKey. If a another request with the same parameters is sent while the original request is in process the… - GETRetrieves a TagValue by its namespaced name
/v3/tagValues/namespaced?name=stringRetrieves a TagValue by its namespaced name. This method will return PERMISSION_DENIED if the value does not exist or the user does not have permission to…
tagValues.tagHolds
- DELETEDeletes a TagHold.
/v3/:name?validateOnly=trueDeletes a TagHold. - GETLists TagHolds under a TagValue.
/v3/:parent/tagHolds?filter=string&pageSize=0&pageToken=stringLists TagHolds under a TagValue. - POSTCreates a TagHold
/v3/:parent/tagHolds?validateOnly=trueCreates a TagHold. Returns ALREADY_EXISTS if a TagHold with the same resource and origin exists under the same TagValue.
projects
- POSTMoves a project to another place in your resource hierarchy, under a new resource parent
/v3/:name:moveMoves a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the… - POSTRestores the project identified by the specified `name` (for example, `projects/415104041262`)
/v3/:name:undeleteRestores the project identified by the specified name (for example, projects/415104041262). You can only use this method for a project that has a lifecycle… - GETLists projects that are direct children of the specified folder or organization resource
/v3/projects?pageSize=0&pageToken=string&parent=string&showDeleted=trueLists projects that are direct children of the specified folder or organization resource. list() provides a strongly consistent view of the projects… - POSTRequests that a new project be created
/v3/projectsRequests that a new project be created. The result is an Operation which can be used to track the creation process. This process usually takes a few seconds,… - GETSearches for projects on which the caller has the `resourcemanager.projects.get` permission and that match the…
/v3/projects:search?pageSize=0&pageToken=string&query=stringSearches for projects on which the caller has the resourcemanager.projects.get permission and that match the specified query. This method returns projects in…
organizations.boundaries
- GETLists Boundaries that are direct children of the specified organization or folder resource.
/v3/:parent/boundaries?pageSize=0&pageToken=stringLists Boundaries that are direct children of the specified organization or folder resource. - POSTCreates a Boundary under a parent Folder or Organization
/v3/:parent/boundaries?boundaryId=stringCreates a Boundary under a parent Folder or Organization. Creating a Boundary triggers the creation of a Management Project if one is not supplied.
projects.capabilityConfigs
- GETLists CapabilityConfigs that are direct children of the specified organization, folder or project resource.
/v3/:parent/capabilityConfigs?pageSize=0&pageToken=stringLists CapabilityConfigs that are direct children of the specified organization, folder or project resource. - POSTCreates a CapabilityConfig under a parent Organization, Folder or Project
/v3/:parent/capabilityConfigs?capabilityConfigId=stringCreates a CapabilityConfig under a parent Organization, Folder or Project. Creating a CapabilityConfig triggers the creation of a Management Project if one is…
liens
- GETLists all Liens applied to the `parent` resource
/v3/liens?pageSize=0&pageToken=string&parent=stringLists all Liens applied to the parent resource. Callers of this method will require permission on the parent resource. For example, a Lien with a parent of… - POSTCreates a Lien which applies to the resource denoted by the `parent` field
/v3/liensCreates a Lien which applies to the resource denoted by the parent field. Callers of this method will require permission on the parent resource. For example,…
organizations
- GETSearches organization resources that are visible to the user and satisfy the specified filter
/v3/organizations:search?pageSize=0&pageToken=string&query=stringSearches organization resources that are visible to the user and satisfy the specified filter. This method returns organizations in an unspecified order. New…
tagBindings
- GETLists the TagBindings for the given Google Cloud resource, as specified with `parent`
/v3/tagBindings?pageSize=0&pageToken=string&parent=stringLists the TagBindings for the given Google Cloud resource, as specified with parent. NOTE: The parent field is expected to be a full resource name:… - POSTCreates a TagBinding between a TagValue and a Google Cloud resource.
/v3/tagBindings?validateOnly=trueCreates a TagBinding between a TagValue and a Google Cloud resource.
tagKeys
- GETLists all TagKeys for a parent resource.
/v3/tagKeys?pageSize=0&pageToken=string&parent=stringLists all TagKeys for a parent resource. - POSTCreates a new TagKey
/v3/tagKeys?validateOnly=trueCreates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error.… - GETRetrieves a TagKey by its namespaced name
/v3/tagKeys/namespaced?name=stringRetrieves a TagKey by its namespaced name. This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.
v3
- GETReturns the semantics associated with the specified resource.
/v3:fetchResourceSemantics?fullResourceName=stringReturns the semantics associated with the specified resource.
API details
- Base URL
https://cloudresourcemanager.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter - Operations
- 33 operations on 22 pathsGET 17POST 14PATCH 1DELETE 1
- Main resources
- tagValues 8projects 5folders 3tagKeys 3tagValues.tagHolds 3liens 2organizations.boundaries 2projects.capabilityConfigs 2tagBindings 2effectiveTags 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v3 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud Resource Manager API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Resource Manager API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Return a list of effective tags for the given Google Cloud resource, as specified in `parent`.” (GET /v3/effectiveTags?pageSize=0&pageToken=string&parent=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud Resource Manager API?
Creates, reads, and updates metadata for Google Cloud Platform resource containers. It is listed under Developer tools and has 33 endpoints.
Who publishes the Cloud Resource Manager API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloud Resource Manager API?
Requests go to https://cloudresourcemanager.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud Resource Manager API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.
How many endpoints does the Cloud Resource Manager API have?
33 operations on 22 paths (17 GET, 14 POST, 1 PATCH, 1 DELETE). The largest groups are tagValues, projects, folders, tagKeys.
Is forking the Cloud Resource Manager API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.