/status

Status

GET https://api-org.synap.ac/status

This method allows you to test if your connection is configured properly

Headers

Name	Type	Description
x-api-key	string	Your API usage token.
x-syn-org-id	string	Your organisation's identifier on Synap
x-syn-org-secret	string	Your organisation's secret key, used to authorise each request

200

{ "status": "healthy", "timestamp": string}

401

{  "code": 401, "error": "Unauthorised request." }

404 Your organisation identifier does not exist on our system

{ "code": 404, "error": "Object not found."}

Examples

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."
}