POST
/
v1
/
projects
/
{project}
/
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>"
}

Path Parameters

project
string
required

The project id.

Query Parameters

target
string

Create the rollout and the stages up to the target stage. Format: environments/{environment} If unspecified, all stages are created. If set to "", no stages are created.

validateOnly
boolean

If set, validate the request and preview the rollout, but do not actually create it.

Body

application/json
plan
string
required

The plan that this rollout is based on. Format: projects/{project}/plans/{plan}

name
string

The resource name of the rollout. Format: projects/{project}/rollouts/{rollout}

stages
object[]

stages and thus tasks of the rollout.

Response

OK

plan
string
required

The plan that this rollout is based on. Format: projects/{project}/plans/{plan}

name
string

The resource name of the rollout. Format: projects/{project}/rollouts/{rollout}

title
string

The title of the rollout, inherited from the associated plan. This field is output only and cannot be directly set.

stages
object[]

stages and thus tasks of the rollout.

creator
string

Format: users/hello@world.com

createTime
string<date-time>
updateTime
string<date-time>
issue
string

The issue associated with the rollout. Could be empty. Format: projects/{project}/issues/{issue}