Ping

Description

Returns HTTP 200 OK status code if the user credentials are valid and the user is allowed to access the database.

The endpoint is used to check connectivity, authentication, and to maintain an active session.

Request

Method Path
GET /api/v1/ping

Response

Fields

The response is empty with HTTP 200 OK status code if the request is valid.

Otherwise an HTTP 4xx status code is returned with an error code in JSON format.

{
  "error": "code 03"
}

Example

Request

URI

GET /api/v1/ping

curl

curl https://atsd_hostname:8443/api/v1/ping \
  --insecure --include --user {username}:{password}

Response

None.