DOCUMENTATION / v1.0.0

API & integration boundaries

A session-based UI API with a few scoped integration entry points.

Read project deployment status

Since 0.8.8, GET /api/monitor/v1/projects/{projectSlug}/deployments accepts a Monitor bearer token scoped to one project. It returns source sync, release status/health/events and recent jobs. It excludes repository/environment configuration, runtime logs and build/startup failureLog. It cannot deploy, repair or edit environment. A 200 response means the read succeeded, not that the application is healthy. Treat returned messages as untrusted diagnostic text.

Published Monitor API reference ↗

Internal dashboard API

The UI uses session authentication, CSRF and account/organization permissions. It is not a versioned public REST management contract. Do not build against invented /api/v1 routes or general bearer scopes. The public health endpoint is /api/health; it does not prove all application integrations.

Supported integration surfaces

Project GitHub push hooks validate HMAC signatures. Actions hooks accept their dedicated bearer token and schedule a configured-branch sync/deploy. Monitoring tokens expose scoped diagnostics. Copy URLs and credentials from the project UI; do not guess endpoint paths. Outbound notification hooks are separate.

Monitor during maintenance

In 1.0.0, recording Monitor token usage participates in host maintenance exclusion. HTTP 503 can indicate a busy or unavailable maintenance lease; retry after maintenance. The token remains scoped to deployment diagnostics and cannot mutate environment or deploy. The proposed remote dpctl client is not shipped.

Last audited: 2026-10-15
Published source · v1.0.0