Ping
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Allows checking the validity of API connection parameters.
URI
/api/v9/pingGET Test authentication
This is a dummy API request that, while requiring authentication like a normal request, does not return any personal data, nor have any effects. It can be used for checking the validity of API connection parameters. The API request returns just the current timestamp.
Syntax
GET /api/v9/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/v9/ping"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 19 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The response was successfully returned |
Example response
Response
{
"pong": 1766042367
}