The brain of Akamai App Platform - A REST API service that manages Kubernetes teams, workloads, and services using Git as persistent storage.

• Node.js: v22.x (see .nvmrc)
• npm: v10.x+
• Git: For version control and values repository
• Running Akamai App Platform Core Server Akamai App Platform Core

# Clone the repository git clone https://github.com/linode/apl-api.git cd apl-api # Install dependencies npm install # Setup environment variables cp .env.sample .env # Edit .env with your configuration npm run dev

The API will be available at http://localhost:8080

npm run dev # Start development server with hot reload npm run build # Full production build npm run start # Start production server npm test # Run all tests

npm run lint # Check code style and types npm run lint:fix # Auto-fix linting issues npm run types # Type check only

npm run build:models # Generate TypeScript models from OpenAPI npm run build:spec # Build OpenAPI specification

• Git-as-Database: All configuration stored as YAML in Git repository
• OpenAPI-First: All endpoints auto-generated from src/openapi/*.yaml specs
• Multi-Tenant: Team isolation with RBAC authorization
• Real-time: WebSocket updates for live status monitoring

• JWT tokens with user identity and teams
• Headers required: Authorization, Auth-Group
• Mock users available for testing

• platformAdmin: Full system access
• teamAdmin: Manage own team resources
• teamMember: Limited team resource access

Mock different users:

GET http://localhost:8080/api/mock/0 # Mock user 0 GET http://localhost:8080/api/mock/1 # Mock user 1 

1. Define in OpenAPI (src/openapi/*.yaml):

paths: '/teams/{teamId}/services': get: operationId: getTeamServices parameters: - name: teamId in: path required: true

2. Implement Handler (src/api/v1/teams/{teamId}/services.ts):

export async function getTeamServices(req: OpenApiRequestExt): Promise<AplResponseObject> { // Implementation here }

3. Add Authorization (in OpenAPI spec):

x-aclSchema: Service components: schemas: Service: x-acl: platformAdmin: [read-any, create-any, update-any, delete-any] teamAdmin: [read, create, update, delete] teamMember: [read]

4. Generate Schema

npm run build:models 

5. (Optional) Regenerate Schema in Console

// in the console termininal: npm run gen:store 

All data operations go through OtomiStack class:

const stack = new OtomiStack() await stack.getTeamConfigService('team-id') await stack.createService('team-id', serviceData)

Every api deployment will result in a commit to the values repo with the author's email in the title.

npm test # All tests npm run test:pattern -- MyTest # Specific test

See CONTRIBUTING.md for detailed guidelines.

Licensed under Apache License, Version 2.0. See LICENSE.md.