Aplas API ReferenceAPI Overview
REST API for programmatic access to Aplas indexes, maps, files, and connectors.
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.
This is the legacy API — it describes the v1 data model. It stays available for organizations created before the v2 rollout, and those organizations should keep using it. Organizations on the v2 data model use API v3 instead, which exposes workspaces, asset types, assets, relations and views. An API key works with exactly one of the two: a key for a v2 organization is rejected here with a message naming v3, and vice versa.
Base URL
Aplas is hosted in three regions. Use the URL that matches where your organization's data lives:
| Region | Base URL |
|---|---|
| Australia | https://api.au.aplas.com/api/v2 |
| Europe | https://api.eu.aplas.com/api/v2 |
| United States | https://api.us.aplas.com/api/v2 |
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.yamlUse 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
MCP for AI assistants
Aplas exposes a Model Context Protocol server, letting Claude, Cursor, GitHub Copilot and other AI assistants read and write your data using an API key.
It serves organizations on the v2 data model only. A key belonging to an organization on this legacy API is refused, with a message saying so. If you would like an assistant connected to your estate, that is one of the things moving to v2 gives you — talk to us about it.
See Connecting AI assistants for what it can do, and the v3 API overview for the API it is built on.
What's next
Browse the sidebar for operations grouped by resource — start with Indexes and Maps.