Server
System Info
Provides detailed information about the project server, its schema, and its health.
Query Parameters
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.
GET /server/info
{
"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": {}
}
}
GET /server/ping
GET /server/specs/graphql
Get OpenAPI Specification
Retrieve the OpenAPI spec for the current project.
Response
Successful request
GET /server/specs/oas
{}
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
One of ok, warn, error.
Directus version in use.
Public URL of the current Directus instance.
Array with the status of all individually connected services.
GET /server/health
{
"status": "warn",
"releaseId": "10.0.0",
"serviceId": "https://directus.example.com",
"checks": []
}