Admin Tasks

Dgraph Alpha exposes various administrative endpoints over HTTP and GraphQL for operations like data export, cluster shutdown, and database management.

For security configuration including authentication, IP whitelisting, and token-based access control, see Admin Endpoint Security.

Admin Endpoints

Dgraph Alpha provides the following administrative endpoints:

HTTP Admin Endpoints

• /admin/config/cache_mb - Configure cache size
• /admin/draining - Drain connections from a node
• /admin/shutdown - Shutdown a single Alpha node
• /alter - Apply schema updates and drop predicates
• /login - Authenticate ACL users
• /health - health status
• /health?all - health status of all servers in the cluster

GraphQL ADmin Endpoints

• /admin - GraphQL endpoint for cluster management operations By default, the /admin endpoint is only accessible from the same machine as the Alpha server. For detailed information about endpoint security and authentication, see Admin Endpoint Security.

Admin Tasks

The following administrative tasks are available:

Data Management

• Export Database - Export data from Dgraph for backup, migration, or sharing
• Delete Database - Drop all data from the database

Cluster Management

• Check Cluster Health - Monitor cluster health using HTTP endpoints or GraphQL Admin API
• Shut Down Database - Perform a clean shutdown of a Dgraph node
• Upgrade Database - Safely upgrade Dgraph version and migrate data