Health (Infrastructure)

Endpoints to get health status about fulfillmenttools.

Health check

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Result of all tested dependencies for their health status

application/json

HealthResult

statusstring · enumRequired

HealthStatus

Possible values:

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Manual reroute configuration not found

application/json

get/api/health

HTTPcURLJavaScriptPython

GET /api/health HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "dependencies": [
    {
      "name": "database",
      "status": "UP"
    }
  ],
  "status": "UP"
}

Get status

get

Returns the platform status.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The status result

application/json

Status

statusstring · enumRequired

The current state of the API

Possible values:

get/api/status

HTTPcURLJavaScriptPython

GET /api/status HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The status result

{
  "status": "UP"
}