API Overview

The Aplas API lets you read and write the same data you see in the app — indexes, applications, integrations, components, maps, files, and connectors — over HTTPS using JSON.

Base URL

Aplas is hosted in three regions. Use the URL that matches where your organization's data lives:

Each region is self-contained. An API key issued in the Australia region will not work against the Europe or US endpoints.

Your organization is provisioned in a single region. To check yours, open the Config dashboard in Aplas — the Data residency card shows your region and API endpoint.

Authentication

All requests require an API key, sent as a bearer token in the Authorization header:

curl https://api.au.aplas.com/api/v2/index \
  -H "Authorization: Bearer YOUR_API_KEY"

To create an API key, sign in to Aplas and open Config → API to generate a new key. Keys are scoped to the organization and region they were created in. Treat them like passwords — they grant full access to your data.

OpenAPI Specification

The full API is described by an OpenAPI 3.0 document, published at:

https://docs.aplas.com/openapi.yaml

Use this URL to:

• Import into Postman, Insomnia, or Stoplight
• Generate typed clients with openapi-generator or openapi-typescript
• Feed to LLM tooling for code generation

Download openapi.yaml

MCP for AI assistants

Aplas also exposes a Model Context Protocol server at the same regional hosts, under /mcp/v1:

https://api.au.aplas.com/mcp/v1
https://api.eu.aplas.com/mcp/v1
https://api.us.aplas.com/mcp/v1

This lets Claude, Cursor, GitHub Copilot, and other AI assistants read and write Aplas data using the same API key as a Bearer token. See AI Assistant Setup for client-specific configuration.

What's next

Browse the sidebar for operations grouped by resource — start with Indexes and Maps.