Skip to main content

Backup Plans

GET/api/v1/cdpbackup/plans/

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request

    • required
    • non-empty string
    • must be a valid API token
    example{{api_key}}
  • locationQuerystringrequired

    The geographic location for the backup plan.

    • Required
    • Must be a valid region identifier (e.g., us-central1)
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the backup plan request

example200
  • must be an integer
  • must be a valid HTTP status code (100-599)
dataarray
errorsobject
messagestring

Status message indicating the result of the backup plan operation

exampleSuccess
  • non-empty string
  • max length 100 characters
can_activate_backupboolean

Indicates whether the backup plan can be activated

exampletrue
  • must be a boolean
  • true when activation criteria are met