Skip to main content
GET
/
v1
/
projects
/
{project}
/
plans
cURL
curl --request GET \
  --url https://api.example.com/v1/projects/{project}/plans
{
  "plans": [
    {
      "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>"
            ]
          }
        ]
      }
    }
  ],
  "nextPageToken": "<string>"
}

Path Parameters

​
project
string
required

The project id.

Query Parameters

​
pageSize
integer<int32>

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

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

Response

OK

​
plans
object[]

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