Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 1.94 KB

status.md

File metadata and controls

70 lines (50 loc) · 1.94 KB

Status endpoints

Get version

Retrieves version information.

Request property Spec
Action GET /version
SID header Not required.
Body model no body
Scala object GetVersion

Use this endpoint to check if the API is up.

Status Response body spec
200 Version

Get healthcheck

Retrieves the operational status.

Request property Spec
Action GET /healthcheck
SID header Not required.
Body model no body
Scala object HealthCheck

Use this endpoint to check if the API is up and if not, what parts are not right.

Status Response body spec
200 Healthcheck summary

Get features

Retrieves the current feature flag settings.

Request property Spec
Action GET /features
SID header Must be a partner key.
Body model no body
Scala object GetFeatures
Status Response body spec
200 Features
401 Invalid credentials; if the SID header is not a partner key

Update feature

Updates the specified feature flag settings.

Request property Spec
Action POST /features
SID header Must be a partner key.
Body model Features;
Scala object UpdateFeatures
Status Response body spec
200 no body
401 Invalid credentials; if the SID header is not a partner key
400 Bad request