Server

Access to where Directus runs. Allows you to make sure your server has everything needed to run the platform, and check what kind of latency we're dealing with.

System Info

Provides detailed information about the project server, its schema, and its health.

Query Parameters

super_admin_token
integer

The first time you create a project, the provided token will be saved and required for subsequent project installs. It can also be found and configured in /config/__api.json on your server.

Response

Successful request

data
object
GET /server/info
Response Example
{
  "data": {
    "id": 1,
    "project_name": "Directus",
    "project_url": null,
    "project_color": null,
    "project_logo": null,
    "public_foreground": null,
    "public_background": null,
    "public_note": null,
    "auth_login_attempts": 25,
    "storage_asset_transform": "all",
    "storage_asset_presets": null,
    "basemaps": [],
    "module_bar": [],
    "custom_aspect_ratios": [],
    "theme_light_overrides": {},
    "theme_dark_overrides": {}
  }
}

Ping

Ping, pong. Ping.. pong.

GET /server/ping

Get GraphQL SDL

Retrieve the GraphQL SDL for the current project.

GET /server/specs/graphql

Get OpenAPI Specification

Retrieve the OpenAPI spec for the current project.

Response

Successful request

GET /server/specs/oas
Response Example
{}

Health

Shows you a general health status for the server and all connected (third party) services. By default, the endpoint only returns a status of ok, warn or error. By authenticating as an admin, it will return more in-depth information about the current health status of the system.

Response

Successful request

status
string

One of ok, warn, error.

releaseId
string

Directus version in use.

serviceId
string

Public URL of the current Directus instance.

checks
array

Array with the status of all individually connected services.

GET /server/health
Response Example
{
  "status": "warn",
  "releaseId": "10.0.0",
  "serviceId": "https://directus.example.com",
  "checks": []
}