Skip to main content

Backup Status

GET/api/v1/cdpbackup/{node_id}/status/

Path parameters

  • node_idPathstringrequired

    Path parameter node_id.

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used to authenticate the backup status request

    • required
    • non-empty string
    • alphanumeric characters
    example{{api_key}}
  • locationQuerystringoptional

    Specifies the location for which to retrieve backup status.

    • non-empty string
    • must be a valid location identifier
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code for backup operation

example200
  • integer
  • must be a valid HTTP status code
dataarray
errorsobject
messagestring

Status message indicating the result of the backup operation

exampleSuccess
  • must be a non-empty string