Get Service

Authentication#

This endpoint does not require an API key.

Responses#

200#

Success

application/json

Full schema:

{
  "type": "object",
  "properties": {
    "success": {
      "const": true
    },
    "data": {
      "type": "object",
      "properties": {
        "service": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "product": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "build_available": {
          "type": "boolean"
        },
        "registered_providers": {
          "type": "integer"
        },
        "endpoint": {
          "const": "/v1/query"
        }
      },
      "additionalProperties": true
    }
  },
  "required": [
    "success",
    "data"
  ],
  "additionalProperties": false
}

400#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

401#

Standard error. Inspect error.code, details and request_id.

• WWW-Authenticate: Bearer authentication challenge; invalid or expired keys use invalid_token.

application/json

See the Error schema and error handling guide.

402#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

403#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

404#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

408#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

409#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

413#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

422#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

429#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

500#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

502#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

503#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.

504#

Standard error. Inspect error.code, details and request_id.

application/json

See the Error schema and error handling guide.