Skip to main content

Check Connection

GET/api/v1/cdpbackup/{node_id}/cdp-agent/

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
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Location identifier used in the check connection request

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

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the connection check

example200
  • must be a valid HTTP status code (100-599)
  • typically 200 for a successful connection
dataobject
errorsobject
messagestring

Status message indicating the result of the connection check

exampleSuccess
  • must be a non-empty string
  • generally brief, such as 'Success' or an error description