Preswald Logopreswald

REST API Reference

Complete reference for the Preswald REST API endpoints.

Endpoints

Authentication

All API requests require authentication using your API key in the Authorization header:

Authorization: Bearer your-api-key-here

Base URL: https://api.preswald.com/v1

Apps

Create App

POST
/apps

Request Body:

{
  "title": "My Dashboard",
  "description": "Sales analytics dashboard",
  "theme": "light",
  "public": false
}

Response:

{
  "id": "app_123456",
  "title": "My Dashboard",
  "description": "Sales analytics dashboard",
  "theme": "light",
  "public": false,
  "created_at": "2023-06-01T12:00:00Z",
  "updated_at": "2023-06-01T12:00:00Z"
}

List Apps

GET
/apps

Query Parameters:

  • limit - Number of apps to return (default: 20)
  • offset - Number of apps to skip (default: 0)
  • public - Filter by public/private apps

Delete App

DELETE
/apps/{app_id}

Deployments

Deploy App

POST
/apps/{app_id}/deploy

Request Body:

{
  "name": "my-dashboard",
  "custom_domain": "dashboard.mycompany.com",
  "environment": "production"
}

Data Sources

Manage data connections and sources for your applications.

Create Data Source

POST
/data-sources

Users

Manage user accounts and permissions.

Webhooks

Set up webhooks to receive notifications about events in your Preswald account.