Skip to content
impulseDOCS
Get Started

Platform API

The Platform API lets you operate Impulse services programmatically — one project-scoped surface covering projects, organization security, and the API-backed services.

Authentication

Section titled “Authentication”

Bearer tokens from My Impulse → Security → API Access (details):

Authorization: Bearer YOUR_IMPULSE_API_TOKEN

Reference

Section titled “Reference”

Generated from the canonical OpenAPI contracts:

  • Postgres API 1.0 — operations, backups, migrations, extensions, pooling, replicas, diagnostics, versions
  • Objects API 1.0 — buckets, objects, scoped keys, versioning, signed transfer, usage, rotation
  • Auth API 1.0 — health, usage, users, roles, sessions, audit, credential rotation
  • Search API 1.0 — indexes, documents, scoped search credentials

Cache, Realtime, Secrets, Messaging, and Mail land on this API as their 1.0 contracts publish.

Postman

Section titled “Postman”

Prefer Postman? The same contracts are published as a runnable collection at api-docs-dev.impulsehosting.com — the API Lifecycle home for the development Platform API.

Safety

Section titled “Safety”

Endpoints described as destructive can rotate credentials, restore data, delete resources, revoke sessions, or change runtime state. Use isolated dev services while you integrate, and read the request description before sending.