Skip to main content

Configure DB Backup

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

Path parameters

  • node_idPathstringrequired

    Path parameter node_id.

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
    • must be a valid API token
    example{{api_key}}
  • locationQuerystringrequired

    Specifies the backup target location.

    • non-empty string
    • must be a valid URI or path
    example{{location}}

Request body

application/json

object
db_usernamestring

Database username for backup configuration

exampleadmin
  • must be a non-empty string
  • may contain only alphanumeric characters and underscores
  • maximum length of 64 characters
db_passwordstring

Database password used for backup configuration

exampleadmin@1234
  • must be a non-empty string
  • minimum length of 8 characters

Responses

200Successful response
object
codeinteger

HTTP status code of the Configure DB Backup response

example200
  • integer
  • valid HTTP status code
datastring

Result message for the DB backup configuration request.

exampleDatabase settings has been updated successfully.
  • must be a non-empty string
  • maximum length 255 characters
errorsobject
messagestring

Status message indicating the result of the backup configuration request.

exampleSuccess
  • Must be a non-empty string
  • Maximum length of 255 characters