Ping

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Allows checking the validity of API connection parameters.

URI
/api/v10/ping

Test authentication

A dummy API request that does not return any personal data and has no effect on the system resources. This API request returns only the current timestamp and can be used to check the validity of API connection parameters.

The API request requires authentication like other API requests.

Syntax
GET /api/v10/ping
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v10/ping"

Response headers

Header	Value	Description
`Content-Type`	`application/json`	The media type of the resource
`Content-Length`	`19`	The size of the response body in bytes

Response codes

Response code	Description
`200 OK`	The response was successfully returned

Example response

Response
{
  "pong": 1766042367
}

Purged resources

Version