GET
/
v1
/
projects
/
{project}
/
rollouts
{
  "rollouts": [
    {
      "name": "<string>",
      "plan": "<string>",
      "title": "<string>",
      "stages": [
        {
          "name": "<string>",
          "id": "<string>",
          "environment": "<string>",
          "tasks": [
            {
              "name": "<string>",
              "specId": "<string>",
              "status": "STATUS_UNSPECIFIED",
              "skippedReason": "<string>",
              "type": "TYPE_UNSPECIFIED",
              "target": "<string>",
              "databaseCreate": {
                "project": "<string>",
                "database": "<string>",
                "table": "<string>",
                "sheet": "<string>",
                "characterSet": "<string>",
                "collation": "<string>",
                "environment": "<string>"
              },
              "databaseSchemaUpdate": {
                "sheet": "<string>",
                "schemaVersion": "<string>"
              },
              "databaseDataUpdate": {
                "sheet": "<string>",
                "schemaVersion": "<string>"
              },
              "databaseDataExport": {
                "target": "<string>",
                "sheet": "<string>",
                "format": "FORMAT_UNSPECIFIED",
                "password": "<string>"
              },
              "updateTime": "2023-11-07T05:31:56Z",
              "runTime": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ],
      "creator": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "updateTime": "2023-11-07T05:31:56Z",
      "issue": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Path Parameters

​
project
string
required

The project id.

Query Parameters

​
pageSize
integer

The maximum number of rollouts to return. The service may return fewer than this value. If unspecified, at most 10 rollouts 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 ListRollouts call. Provide this to retrieve the subsequent page.

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

​
filter
string

Filter is used to filter rollouts returned in the list. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec

Supported filters:

  • creator: the rollout creator full name in "users/{email or id}" format, support "==" operator.
  • update_time: rollout update time in "2006-01-02T15:04:05Z07:00" format, support ">=" or "<=" operator.
  • task_type: the task type, support "==" and "in" operators, check the Task.Type enum for the values.

For example: creator == "users/ed@bytebase.com" && update_time >= "2025-01-02T15:04:05Z07:00" task_type == "DATABASE_SCHEMA_UPDATE" task_type in ["DATABASE_SCHEMA_UPDATE", "DATABASE_DATA_UPDATE"]

Response

OK

​
rollouts
object[]

The rollouts 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.