Arango logo

The Arango Control Plane (ACP) service

Orchestrate the Contextual Data Platform with the Arango Control Plane to install, manage, and run services in your Kubernetes cluster

Overview

The Arango Control Plane (ACP) is the main entry point for installing, running, and managing services in the Contextual Data Platform. You can deploy services, group AutoGraph and AutoRAG work into projects, and manage the secrets profiles used by services:

  • Services: install, upgrade, uninstall, get status, and list installed services. Each service type has its own URL path prefix but shares a common request and response structure. See Services.
  • Projects: organize AutoGraph and AutoRAG work by grouping related services and keeping data separate. See Projects.
  • Secrets: create and manage secret profiles used by services (for example, LLM API keys). See Secrets Manager.

The ACP service is started by default and is available at https://<EXTERNAL_ENDPOINT>:8529/_platform/acp. All operations are performed over HTTP.

Getting started

Obtaining a Bearer token

Before you can authenticate with the ACP service, you need to obtain a Bearer token. You can generate this token using the ArangoDB authentication API:

POST https://<EXTERNAL_ENDPOINT>:8529/_open/auth
curl -X POST https://<EXTERNAL_ENDPOINT>:8529/_open/auth \
  -d '{"username": "your-username", "password": "your-password"}'

This returns a user JWT token (not a superuser token) that you can use as your Bearer token. For more details about ArangoDB authentication and JWT tokens, see the ArangoDB Authentication documentation.

Health check

To verify that the ACP service is running, call the health check endpoint. Like every other ACP request, it requires a valid Bearer token.

Services

The ACP installs every service from a Helm chart and gives it a serviceId. You use this ID for all follow-up operations, such as checking the status, changing the configuration, and uninstalling the service.

The following service types can be deployed through dedicated endpoints:

  • Graph Analytics
  • Importer and AutoRAG
  • GraphRAG (legacy all-in-one service, superseded by AutoGraph)
  • AutoGraph
  • LLM Host
  • Notebook
  • User-Defined Services (UDS), see Deploy a new service via API

There is also a generic endpoint that accepts any Helm chart service name, so you are not limited to the service types listed above.

All requests for creating a service have the same structure: the parameters of the individual service go into an env object, with optional labels for tagging and filtering, and an optional profiles key for selecting resource profiles such as gpu. For the field-level description and the format of each operation, see Services in the API reference.

Projects

Projects help you organize AutoGraph, Importer, and AutoRAG deployments by grouping related services and keeping your data separate. When the Importer service creates ArangoDB collections (such as documents, chunks, entities, relationships, and communities), it uses your project name as a prefix. For example, a project named docs will have collections like docs_Documents, docs_Chunks, and so on.

Projects are required for the following services:

  • Importer
  • AutoRAG
  • AutoGraph

Once a project exists, you can reference it in service deployments using the project_name field:

{
  "env": {
    "project_name": "docs"
  }
}
Deleting a project removes only the project record. The services, collections, and knowledge graphs it referenced remain and have to be deleted separately. See Delete a Project in the API reference.

For the endpoints to create, retrieve, list, and delete projects, see Projects in the API reference.

Secrets

For managing secret profiles via ACP, see the Secrets Manager documentation.

Files

For managing files via ACP, see the File Manager documentation.

API reference

For the endpoints exposed by the ACP service, see the Arango Control Plane HTTP API.

For the generated API documentation, see the Arango Control Plane service API Reference .