Skip to main content

API Overview

Appliku exposes a REST API that powers the web dashboard, the CLI, and the Python SDK. You can use the same API to build your own integrations and automation.

Base URL

https://api.appliku.com

All API endpoints are served over HTTPS.

Authentication

API requests are authenticated using Bearer tokens. Include your API token in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
https://api.appliku.com/api/v1/teams/

Generating an API Token

  1. Log into the Appliku dashboard
  2. Go to Account Settings
  3. Navigate to the API Tokens section
  4. Click Generate New Token
  5. Copy the token and store it securely
warning

API tokens provide full access to your account. Treat them like passwords: do not commit them to version control or share them in public channels.

OpenAPI Schema

The complete API specification is available as an OpenAPI (Swagger) schema:

https://api.appliku.com/api/schema/

You can use this schema to:

  • Explore all available endpoints and their parameters
  • Generate API clients in any language using tools like openapi-generator
  • Import into API tools like Postman or Insomnia for interactive testing

API Structure

The API is organized around resources that map to the main concepts in Appliku:

ResourceEndpoint PrefixDescription
Teams/api/v1/teams/Team management
Applications/api/v1/team/{team_path}/apps/Application CRUD and configuration
Servers/api/v1/team/{team_path}/servers/Server management
Databases/api/v1/team/{team_path}/databases/Database provisioning
Deployments/api/v1/team/{team_path}/deployments/Deployment management
note

Most API endpoints are scoped to a team via the {team_path} URL parameter. You need to know your team's path to make requests.

Rate Limiting

The API applies rate limiting to prevent abuse. If you exceed the rate limit, you will receive a 429 Too Many Requests response with a Retry-After header indicating how many seconds to wait before retrying.

Using the CLI and SDK

The Appliku CLI and Python SDK are the easiest ways to interact with the API programmatically. They handle authentication, pagination, error handling, and retries automatically.

# Install the CLI/SDK
pip install appliku

# Authenticate
appliku auth login

# List applications
appliku apps list

See CLI & SDK for more details.