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>"
          }
        }
      ]
    }
  ],
  "creator": "<string>",
  "createTime": "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

Response

200
application/json

OK

The response is of type object.

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>"
          }
        }
      ]
    }
  ],
  "creator": "<string>",
  "createTime": "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

Response

200
application/json

OK

The response is of type object.