Skip to main content

Activate Backup

PUT/api/v1/cdpbackup/activate/{node_id}/

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 for authentication

    • required
    • must be a valid API key
    example{{api_key}}
  • locationQuerystringoptional

    Specifies the target location for activating the backup.

    • Must be a non-empty string representing a valid location identifier
    • Maximum length of 256 characters
    example{{location}}

Request body

application/json

object
plan_idinteger

Identifier of the backup plan to activate.

example1
  • required
  • must be a positive integer
typestring

Specifies the backup activation schedule type.

exampleHOURLY
  • Must be a non-empty string
  • Allowed values: HOURLY, DAILY, WEEKLY
exclude_file_folderstring

Path or pattern of files/folders to exclude from the backup

example
  • Optional; empty string means no exclusions
  • If provided, must be a valid filesystem path
backup_nowboolean

Flag to trigger an immediate backup when true.

exampletrue
  • required
  • must be a boolean
compression_typestring

Specifies the compression algorithm to use for the backup.

exampleZLib
  • must be a supported compression type (e.g., ZLib, GZip)
  • cannot be empty
is_encryption_requiredboolean

Indicates whether encryption is required for the backup activation.

examplefalse
  • must be a boolean
  • required field
compression_levelstring

Specifies the desired compression intensity for the backup operation.

exampleLow
  • Must be one of "Low", "Medium", or "High"
hoursOfDaystring

Hours of the day when the backup should run, expressed as a comma-separated list of 0-23 values

example0,6,12,18
  • must be a comma-separated list of integers
  • each integer must be between 0 and 23
startingMinuteinteger

Minute of the hour when backup activation should start

example38
  • must be an integer between 0 and 59
db_enabledstring

Indicates whether the database backup should be enabled

example
  • must be "true" or "false"
db_usernamestring

Database username for authentication

example
  • must be a non-empty string
  • allowed characters: letters, numbers, underscore
db_passwordstring

Database password used for backup activation

example
  • must be a string
  • maximum length 255 characters

Responses

200Successful response
object
codeinteger

HTTP status code returned by the Activate Backup operation

example200
  • integer between 100 and 599
  • 200 indicates success
dataobject
errorsobject
messagestring

Human-readable status message confirming activation of backup.

exampleYour backups will begin shortly.
  • must be a non-empty string
  • maximum length of 200 characters