API Reference

GET /apps

List all your apps

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.hallway.com/v1/apps

GET /apps/:id

Get a specific app

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.hallway.com/v1/apps/app_123

POST /apps

Create a new app

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-app", "description": "My new app"}' \
  https://api.hallway.com/v1/apps

PUT /apps/:id

Update an app

curl -X PUT \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"description": "Updated description"}' \
  https://api.hallway.com/v1/apps/app_123

DELETE /apps/:id

Delete an app

curl -X DELETE \
  -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.hallway.com/v1/apps/app_123

GET /apps/:id/deployments

List deployments for an app

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.hallway.com/v1/apps/app_123/deployments

POST /apps/:id/deploy

Deploy an app

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"environment": "production"}' \
  https://api.hallway.com/v1/apps/app_123/deploy

Installation

npm install @hallway/sdk

Usage

import { HallwayClient } from '@hallway/sdk';

const client = new HallwayClient({
  apiKey: 'YOUR_API_KEY'
});

// List apps
const apps = await client.apps.list();

// Get an app
const app = await client.apps.get('app_123');

// Create an app
const newApp = await client.apps.create({
  name: 'my-app',
  description: 'My new app'
});

// Deploy an app
await client.apps.deploy('app_123', {
  environment: 'production'
});