Skip to main content
PATCH
/
v1
/
projects
/
{project}
/
plans
/
{plan}
cURL
curl --request PATCH \
  --url https://api.example.com/v1/projects/{project}/plans/{plan} \
  --header 'Content-Type: application/json' \
  --data '
{
  "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>"
        ]
      }
    ]
  }
}
'
{
  "name": "<string>",
  "state": "STATE_UNSPECIFIED",
  "issue": "<string>",
  "rollout": "<string>",
  "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>"
      }
    }
  ],
  "creator": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z",
  "planCheckRunStatusCount": {},
  "deployment": {
    "environments": [
      "<string>"
    ],
    "databaseGroupMappings": [
      {
        "databaseGroup": "<string>",
        "databases": [
          "<string>"
        ]
      }
    ]
  }
}

Path Parameters

​
project
string
required

The project id.

​
plan
string
required

The plan id.

Query Parameters

​
updateMask
string<field-mask>

The list of fields to update.

​
allowMissing
boolean

If set to true, and the plan is not found, a new plan will be created. In this situation, update_mask is ignored.

Body

application/json
​
name
string

The name of the plan. plan is a system generated ID. Format: projects/{project}/plans/{plan}

​
state
enum<string>

The state of the plan.

Available options:
STATE_UNSPECIFIED,
ACTIVE,
DELETED
​
title
string

The title of the plan.

​
description
string

The description of the plan.

​
specs
object[]

The deployment specs for the plan.

​
deployment
object

Response

OK

​
name
string

The name of the plan. plan is a system generated ID. Format: projects/{project}/plans/{plan}

​
state
enum<string>

The state of the plan.

Available options:
STATE_UNSPECIFIED,
ACTIVE,
DELETED
​
issue
string

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

​
rollout
string

The rollout associated with the plan. Can be empty. Format: projects/{project}/rollouts/{rollout}

​
title
string

The title of the plan.

​
description
string

The description of the plan.

​
specs
object[]

The deployment specs for the plan.

​
creator
string

Format: users/[email protected]

​
createTime
string<date-time>
​
updateTime
string<date-time>
​
planCheckRunStatusCount
object

The status count of the latest plan check runs. Keys are:

  • SUCCESS
  • WARNING
  • ERROR
  • RUNNING
​
deployment
object