Reference
Control-plane API
The Owlpane control-plane API is served at https://api.owlpane.com. It manages organizations, projects, membership, tokens, billing, and enterprise identity — separate from the telemetry ingest gateway (ingest.owlpane.com), which only accepts telemetry.
Authentication
| Caller | Credential |
|---|---|
| Console / browser | Signed-in console session; state-changing requests also carry the session CSRF token. |
| Automation (scripts, agents) | Organization API token (owl_pat_…) sent as Authorization: Bearer owl_pat_…. |
Ingest keys (owl_ing_…) authorize telemetry ingest only and cannot call the control plane. Create and revoke API tokens with the endpoints below or from the console.
Organizations and projects
| Method | Path | Purpose |
|---|---|---|
POST | /v1/orgs | Create an organization. |
PATCH | /v1/orgs/:orgId | Update an organization (name, plan). |
GET | /v1/orgs/:orgId/projects | List the organization's projects. |
POST | /v1/orgs/:orgId/projects | Create a project; the plaintext ingest key is returned once. |
PATCH | /v1/orgs/:orgId/projects/:projectId | Update a project. |
Members and invites
| Method | Path | Purpose |
|---|---|---|
GET | /v1/orgs/:orgId/members | List organization members. |
PATCH | /v1/orgs/:orgId/members/:userId | Change a member's role. |
DELETE | /v1/orgs/:orgId/members/:userId | Remove a member. |
POST | /v1/orgs/:orgId/invites | Invite someone to the organization. |
POST | /v1/invites/:token/accept | Accept an invite. |
API tokens
| Method | Path | Purpose |
|---|---|---|
GET | /v1/orgs/:orgId/api-tokens | List API tokens. |
POST | /v1/orgs/:orgId/api-tokens | Create an API token; the token value is returned once. |
DELETE | /v1/orgs/:orgId/api-tokens/:tokenId | Revoke an API token. |
Billing
| Method | Path | Purpose |
|---|---|---|
GET | /v1/orgs/:orgId/billing | Billing status. |
POST | /v1/orgs/:orgId/billing/checkout | Start a checkout session. |
POST | /v1/orgs/:orgId/billing/portal | Open the billing portal. |
PUT | /v1/orgs/:orgId/billing/currency | Set the billing currency. |
GET | /v1/orgs/:orgId/billing/invoices | List invoices. |
PUT | /v1/orgs/:orgId/billing/spend-cap | Set the spend cap. |
SCIM
SCIM 2.0 provisioning for users. Authenticate with a per-organization SCIM bearer token.
| Method | Path | Purpose |
|---|---|---|
GET | /v1/scim/v2/Users | List users, optionally filtered with userName eq "…". |
POST | /v1/scim/v2/Users | Provision a user into the organization. |
PATCH | /v1/scim/v2/Users/:id | Update a user; deactivating removes their membership. |
SAML
| Method | Path | Purpose |
|---|---|---|
GET | /v1/auth/saml/config | Public SAML configuration. |
GET | /v1/auth/saml/metadata | Service-provider metadata XML. |
GET | /v1/auth/saml/start | Begin SAML sign-in. |
POST | /v1/auth/saml/acs | SAML assertion consumer service. |
OIDC
| Method | Path | Purpose |
|---|---|---|
GET | /v1/auth/oidc/config | Public OIDC configuration. |
GET | /v1/auth/oidc/start | Begin OIDC sign-in. |
GET | /v1/auth/oidc/callback | OIDC redirect callback. |
Device fleets (Beta)
| Method | Path | Purpose |
|---|---|---|
GET | /v1/orgs/:orgId/device-fleets | List device fleets. |
POST | /v1/orgs/:orgId/device-fleets | Create a device fleet. |
GET | /v1/orgs/:orgId/device-fleets/:fleetId | Get a fleet. |
GET | /v1/orgs/:orgId/device-fleets/:fleetId/devices | List a fleet's devices. |
POST | /v1/orgs/:orgId/device-fleets/:fleetId/devices | Register a device. |
Related
Last updated