Skip to main content
POST
/
v1
/
projects
/
{project}
:previewRollout
cURL
curl --request POST \
  --url https://api.example.com/v1/projects/{project}:previewRollout \
  --header 'Content-Type: application/json' \
  --data '
{
  "project": "<string>",
  "plan": {
    "name": "<string>",
    "state": "STATE_UNSPECIFIED",
    "title": "<string>",
    "description": "<string>",
    "specs": [
      {
        "id": "<string>",
        "createDatabaseConfig": {
          "target": "<string>",
          "database": "<string>",
          "table": "<string>",
          "characterSet": "<string>",
          "collation": "<string>",
          "cluster": "<string>",
          "owner": "<string>",
          "environment": "<string>"
        },
        "changeDatabaseConfig": {
          "targets": [
            "<string>"
          ],
          "sheet": "<string>",
          "release": "<string>",
          "type": "DATABASE_CHANGE_TYPE_UNSPECIFIED",
          "ghostFlags": {},
          "enablePriorBackup": true,
          "enableGhost": true
        },
        "exportDataConfig": {
          "targets": [
            "<string>"
          ],
          "sheet": "<string>",
          "format": "FORMAT_UNSPECIFIED",
          "password": "<string>"
        }
      }
    ],
    "deployment": {
      "environments": [
        "<string>"
      ],
      "databaseGroupMappings": [
        {
          "databaseGroup": "<string>",
          "databases": [
            "<string>"
          ]
        }
      ]
    }
  }
}
'
{
  "plan": "<string>",
  "name": "<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>"
          },
          "databaseUpdate": {
            "sheet": "<string>",
            "schemaVersion": "<string>",
            "databaseChangeType": "DATABASE_CHANGE_TYPE_UNSPECIFIED"
          },
          "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.

Body

application/json
​
project
string
required

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

​
plan
object

The plan used to preview 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/[email protected]

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

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