POST
/
v1
/
projects:search
{
  "projects": [
    {
      "issueLabels": [
        {
          "value": "<string>",
          "color": "<string>",
          "group": "<string>"
        }
      ],
      "forceIssueLabels": true,
      "allowModifyStatement": true,
      "autoResolveIssue": true,
      "enforceIssueTitle": true,
      "autoEnableBackup": true,
      "skipBackupErrors": true,
      "postgresDatabaseTenantMode": true,
      "allowSelfApproval": true,
      "executionRetryPolicy": {
        "maximumRetries": 123
      },
      "ciSamplingSize": 123,
      "parallelTasksPerRollout": 123,
      "labels": {}
    }
  ],
  "nextPageToken": "<string>"
}

Body

application/json
​
showDeleted
boolean

Show deleted projects if specified.

​
filter
string

Filter the project. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filters:

  • name: the project name, support "==" and ".matches()" operator.
  • resource_id: the project id, support "==" and ".matches()" operator.
  • exclude_default: if not include the default project, should be "true" or "false", support "==" operator.
  • state: check the State enum for the values, support "==" operator.
  • labels.{key}: the project label, support "==" and "in" operators.

For example: name = "project name" name.matches("project name") resource_id = "project id" resource_id.matches("project id") exclude_default == true state == "DELETED" labels.environment == "production" labels.tier == "critical" labels.environment in ["staging", "prod"] You can combine filter conditions like: name = "project name" && resource_id.matches("project id") name.matches("project name") || resource_id = "project id" labels.environment == "production" && labels.tier == "critical"

​
pageSize
integer

The maximum number of projects to return. The service may return fewer than this value. If unspecified, at most 10 projects will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

A page token, received from a previous SearchProjects call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchProjects must match the call that provided the page token.

Response

OK

​
projects
object[]

The projects from the specified request.

​
nextPageToken
string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.