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.

Responses

Successful request

data

object

integer

Unique identifier for the setting.

project_name

string

Name of the project, shown in the Data Studio.

project_url

string

The url of the project. Link to the (public) website that goes with this project.

project_color

string

The brand color of the project.

project_logo

string

The logo of the project. Many-to-one to files.

public_foreground

string

The foreground of the project. Many-to-one to files.

public_note

string

Note rendered on the public pages of the app.

auth_login_attempts

integer

Allowed authentication login attempts before the user's status is set to blocked.

auth_password_policy

string

Authentication password policy. What regex passwords must pass in order to be valid.

storage_asset_transform

string

If the transform endpoints are allowed to be used on the assets endpoint. One of all, none or presets.

storage_asset_presets

array

What preset keys exist in the assets endpoint.

custom_css

string

CSS rules to override the App's default styling.

storage_default_folder

string

Folder for uploaded files. Does not affect existing files.

basemaps

array

Custom tiles to overriding the Mapbox defaults.

mapbox_key

string

Mapbox Access Token.

module_bar

array

What modules are enabled/added globally.

project_descriptor

string

Descriptor of the project, shown in the Data Studio.

custom_aspect_ratios

array

Custom aspect ratios in the image editor.

public_favicon

string

Favicon for the Data Studio. Many-to-one to files.

default_appearance

string

One of auto, light, dark.

default_theme_light

string

Default theme to use in light mode.

default_theme_dark

string

Default theme to use in dark mode.

report_error_url

string

Link to the error report page. This is a template URL that has access to the following object

  {
    error: {
      name?: string;
      message?: string;
    };
    route: {
      fullPath: string;
      hash: string;
      name: string;
      path: string;
      query: string;
    };
    navigator: {
      language: string;
      userAgent: string;
    };
    user: {
      id?: string | number;
      first_name?: string;
      last_name?: string;
      title?: string;
      description?: string;
      location?: string;
      status?: string;
    };
    role: {
      id?: string;
      name?: string;
    };
  }

report_bug_url

string

Link to the bug report page.

report_feature_url

string

Link to the feature request page.

ai_openai_api_key

string

OpenAI API key used for AI features. Stored hashed.

ai_openai_allowed_models

array

List of OpenAI model IDs permitted for use in the AI assistant.

ai_anthropic_api_key

string

Anthropic API key used for AI features. Stored hashed.

ai_anthropic_allowed_models

array

List of Anthropic model IDs permitted for use in the AI assistant.

ai_google_api_key

string

Google AI API key used for AI features. Stored hashed.

ai_google_allowed_models

array

List of Google model IDs permitted for use in the AI assistant.

ai_system_prompt

string

Custom system prompt prepended to all AI assistant conversations.

ai_openai_compatible_name

string

Display name for a custom OpenAI-compatible provider.

ai_openai_compatible_base_url

string

Base URL for a custom OpenAI-compatible API endpoint.

ai_openai_compatible_api_key

string

API key for the custom OpenAI-compatible provider. Stored hashed.

ai_openai_compatible_headers

array

Additional HTTP headers to include when calling the custom OpenAI-compatible provider.

ai_openai_compatible_models

array

List of model definitions available from the custom OpenAI-compatible provider.

mcp_enabled

boolean

Whether the MCP (Model Context Protocol) endpoint is enabled.

mcp_allow_deletes

boolean

Whether MCP clients are permitted to perform delete operations.

mcp_prompts_collection

string

Collection used to store MCP prompt definitions.

mcp_system_prompt_enabled

boolean

Whether the custom MCP system prompt is enabled.

mcp_system_prompt

string

Custom system prompt injected into MCP sessions.

import { createDirectus, rest, serverInfo } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(serverInfo());

GET /server/info

GET /graphql/system

type Query {
	server_info: 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": {},
    "ai_openai_allowed_models": [],
    "ai_anthropic_allowed_models": [],
    "ai_google_allowed_models": [],
    "ai_openai_compatible_headers": [
      {}
    ],
    "ai_openai_compatible_models": [
      {}
    ]
  }
}

Ping

Ping, pong. Ping.. pong.

Responses

Successful request

import { createDirectus, rest, serverPing } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(serverPing());

GET /server/ping

POST /graphql/system

type Query {
	server_ping: String
}

Response Example

pong

Get GraphQL SDL

Retrieve the GraphQL SDL for the current project.

Responses

GraphQL SDL file.

import { createDirectus, rest, readGraphqlSdl } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(readGraphqlSdl(scope));

GET /server/specs/graphql

GET /graphql/system

type Query {
  server_specs_graphql(scope: graphql_sdl_scope): String
}

Get OpenAPI Specification

Retrieve the OpenAPI spec for the current project.

Responses

Successful request

import { createDirectus, rest, readOpenApiSpec } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(readOpenApiSpec());

GET /server/specs/oas

POST /graphql/system

type Query {
  server_specs_oas: String
}

Response Example

{}

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.

Responses

Successful request

status

string

One of ok, warn, error.

releaseId

string

Directus version in use. Only returned when authenticated as admin.

serviceId

string

Public URL of the current Directus instance. Only returned when authenticated as admin.

checks

object

Object keyed by service name (e.g. "pg:responseTime"), each containing an array of health check results for that service. Only returned when authenticated as admin.

import { createDirectus, rest, serverHealth } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(serverHealth());

GET /server/health

GET /graphql/system

type Query {
  server_health: JSON
}

Response Example

{
  "status": "warn",
  "releaseId": "10.0.0",
  "serviceId": "https://directus.example.com",
  "checks": {}
}