{ "kind": "discovery#restDescription", "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/F20Fq1R-EfWlPIiQW_XhJNP4UeM\"", "discoveryVersion": "v1", "id": "cloudresourcemanager:v1beta1", "name": "cloudresourcemanager", "version": "v1beta1", "revision": "20150711", "title": "Google Cloud Resource Manager API", "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating of project metadata.", "ownerDomain": "google.com", "ownerName": "Google", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "documentationLink": "https://cloud.google.com/resource-manager", "protocol": "rest", "baseUrl": "https://cloudresourcemanager.googleapis.com/", "basePath": "", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "servicePath": "", "batchPath": "batch", "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "bearer_token": { "type": "string", "description": "OAuth bearer token.", "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "pp": { "type": "boolean", "description": "Pretty-print response.", "default": "true", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" } } } }, "schemas": { "Project": { "id": "Project", "type": "object", "description": "A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.", "properties": { "projectNumber": { "type": "string", "description": "The number uniquely identifying the project. Example: 415104041262 Read-only.", "format": "int64" }, "projectId": { "type": "string", "description": "The unique, user-assigned ID of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation." }, "lifecycleState": { "type": "string", "description": "The project lifecycle state. Read-only.", "enum": [ "LIFECYCLE_STATE_UNSPECIFIED", "ACTIVE", "DELETE_REQUESTED", "DELETE_IN_PROGRESS" ] }, "name": { "type": "string", "description": "The user-assigned name of the project. This field is optional and can remain unset. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write." }, "createTime": { "type": "string", "description": "Creation time. Read-only." }, "labels": { "type": "object", "description": "The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: \"environment\" : \"dev\" Read-write.", "additionalProperties": { "type": "string" } } } }, "ListProjectsResponse": { "id": "ListProjectsResponse", "type": "object", "description": "A page of the response received from the [ListProjects][google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects] method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.", "properties": { "projects": { "type": "array", "description": "The list of projects that matched the list filter. This list can be paginated.", "items": { "$ref": "Project" } }, "nextPageToken": { "type": "string", "description": "Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. Note: pagination is not yet supported; the server will not set this field." } } }, "Empty": { "id": "Empty", "type": "object", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`." } }, "resources": { "projects": { "methods": { "create": { "id": "cloudresourcemanager.projects.create", "path": "v1beta1/projects", "httpMethod": "POST", "description": "Creates a project resource. Initially, the project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the project. Several APIs are activated automatically for the project, including Google Cloud Storage.", "request": { "$ref": "Project" }, "response": { "$ref": "Project" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "cloudresourcemanager.projects.list", "path": "v1beta1/projects", "httpMethod": "GET", "description": "Lists projects that are visible to the user and satisfy the specified filter. This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list.", "parameters": { "pageToken": { "type": "string", "description": "A pagination token returned from a previous call to ListProject that indicates from where listing should continue. Note: pagination is not yet supported; the server ignores this field. Optional.", "location": "query" }, "pageSize": { "type": "integer", "description": "The maximum number of Projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default. Note: pagination is not yet supported; the server ignores this field. Optional.", "format": "int32", "location": "query" }, "filter": { "type": "string", "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + labels.key where *key* is the name of a label Some examples of using labels as filters: |Filter|Description| |------|-----------| |name:*|The project has a name.| |name:Howl|The project's name is `Howl` or `howl`.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project has the label `color`.| |labels.color:red|The project's label `color` has the value `red`.| |labels.color:red label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`. Optional.", "location": "query" } }, "response": { "$ref": "ListProjectsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "id": "cloudresourcemanager.projects.get", "path": "v1beta1/projects/{projectId}", "httpMethod": "GET", "description": "Retrieves the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this project.", "parameters": { "projectId": { "type": "string", "description": "The project ID (for example, `my-project-123`). Required.", "required": true, "location": "path" } }, "parameterOrder": [ "projectId" ], "response": { "$ref": "Project" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "update": { "id": "cloudresourcemanager.projects.update", "path": "v1beta1/projects/{projectId}", "httpMethod": "PUT", "description": "Updates the attributes of the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this project.", "parameters": { "projectId": { "type": "string", "description": "The project ID (for example, `my-project-123`). Required.", "required": true, "location": "path" } }, "parameterOrder": [ "projectId" ], "request": { "$ref": "Project" }, "response": { "$ref": "Project" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "id": "cloudresourcemanager.projects.delete", "path": "v1beta1/projects/{projectId}", "httpMethod": "DELETE", "description": "Marks the project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the project if the following criteria are met: + The project does not have a billing account associated with it. + The project has a lifecycle state of [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE]. This method changes the project's lifecycle state from [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject], and the project remains visible to [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject] and [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects] methods. The caller must have modify permissions for this project.", "parameters": { "projectId": { "type": "string", "description": "The project ID (for example, `foo-bar-123`). Required.", "required": true, "location": "path" } }, "parameterOrder": [ "projectId" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "undelete": { "id": "cloudresourcemanager.projects.undelete", "path": "v1beta1/projects/{projectId}:undelete", "httpMethod": "POST", "description": "Restores the project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a project that has a lifecycle state of [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS], the project cannot be restored. The caller must have modify permissions for this project.", "parameters": { "projectId": { "type": "string", "description": "The project ID (for example, `foo-bar-123`). Required.", "required": true, "location": "path" } }, "parameterOrder": [ "projectId" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }