/status

get
Status

https://api-org.synap.ac/status
This method allows you to test if your connection is configured properly
Request
Response
Request
Headers
x-api-key
required
string
Your API usage token.
x-syn-org-id
required
string
Your organisation's identifier on Synap
x-syn-org-secret
required
string
Your organisation's secret key, used to authorise each request
Response
200: OK
{ "status": "healthy", "timestamp": string}
401: Unauthorized
{ "code": 401, "error": "Unauthorised request." }
404: Not Found
Your organisation identifier does not exist on our system
{ "code": 404, "error": "Object not found."}

Examples

cURL Request
Response
cURL Request
curl --request GET \
--url https://api-org.synap.ac/status \
--header 'x-syn-org-id: org123test' \
--header 'x-syn-org-secret: secret123test' \
--header 'x-api-key: test123api' \
Response
200 OK
{
"status": "healthy",
"timestamp": "2020-03-30T10:05:16.754Z"
}
--
403 Forbidden
{
"code": 403,
"error": "Unauthorised request."
}
--
404 Not Found
{
"code": 404,
"error": "Object not found."
}