HTTP API Reference

Browse the full HTTP API documentation. Use the sidebar to navigate to individual operations.

Actors

POST /resources/actors/{type}/{externalId} — Send message(s) to actor

Apps

PUT /resources/apps — Install app version

GET /resources/apps — Get all apps

GET /resources/apps/{appId} — Get app details

POST /resources/apps/{appId} — Activate or deactivate an app

GET /resources/apps/{appId}/files — Get all files provided by app

GET /resources/apps/{appId}/files/{path} — Get a file from an app

GET /resources/apps/{appId}/settings — Get current settings values for an app

PATCH /resources/apps/{appId}/settings — Update settings for an app using JSON Merge Patch semantics. Keys present with a value are set, keys present with null are cleared, keys not present are left unchanged.

GET /resources/apps/dev/connect — WebSocket endpoint for app development mode. Authentication is done via message (first message must be 'auth').

Audit

GET /audit — Query audit logs with filtering and pagination

GET /audit/{id} — Get a single audit log entry by ID

Clients

GET /resources/iam/clients — List all OAuth clients

GET /resources/iam/clients/{id} — Get a specified OAuth client

PUT /resources/iam/clients/{id} — Create or update an OAuth client

PATCH /resources/iam/clients/{id} — Update client properties (partial update)

DELETE /resources/iam/clients/{id} — Delete an OAuth client

PUT /resources/iam/clients/{id}/acl — Update client ACL (bulk replace)

PUT /resources/iam/clients/{id}/roles — Update client roles (bulk replace)

DELETE /resources/iam/clients/{id}/roles/{roleKey} — Remove a specific role from a client

GET /resources/iam/clients/{id}/sessions — Get all active sessions for a client

DELETE /resources/iam/clients/{id}/sessions/{sessionId} — Revoke a specific session for a client

POST /resources/iam/clients/{id}/secrets — Create a new secret

GET /resources/iam/clients/{id}/secrets — List all secrets

DELETE /resources/iam/clients/{id}/secrets/{secretId} — Revoke a secret

Components

GET /resources/components — Get all components

GET /resources/components/{idOrPrefix} — Get a component

POST /resources/components/{componentId} — Create or update a component

DELETE /resources/components/{componentId} — Delete a component

Events

GET /events — GET /events

Files

PUT /resources/files/{spaceKey}/{fileKey} — Create or update a file

GET /resources/files/{spaceKey}/{fileKey} — Download a file

DELETE /resources/files/{spaceKey}/{fileKey} — Delete a file

Graph

POST /resources/graph — Query the graph

GET /resources/graph — Get metadata about the graph

GET /resources/graph/{node} — Get metadata about a node type

Ingress

GET /resources/ingresses — Get all ingresses

GET /resources/ingresses/{ingressId} — Get an ingress

PUT /resources/ingresses/{ingressId} — Create or update an ingress

DELETE /resources/ingresses/{ingressId} — Delete an ingress

JobDefinitions

PUT /resources/job-definitions/{definitionId} — Create a new job

DELETE /resources/job-definitions/{definitionId} — Delete a job definition

GET /resources/job-definitions/{definitionId} — Get a job definition

GET /resources/job-definitions — Get all job definitions

Jobs

POST /resources/jobs — Schedule a new job

DELETE /resources/jobs/{jobId} — Delete a job

GET /resources/jobs/{jobId} — Get job status

GET /resources/jobs/statistics — Get job statistics

POST /resources/jobs/batch — Schedule jobs in batch

Me

GET /resources/me/profile — Get the current user's profile

POST /resources/me/profile — Update the current user's profile

POST /resources/me/password — Change the current user's password

POST /resources/me/email/change — Request to change email address (generates verification secret)

POST /resources/me/email/validate — Validate email verification

GET /resources/me/settings — Get current user's settings

POST /resources/me/settings — Update user's settings

GET /resources/me/pat — Get all Personal Access Tokens (PATs) for the current user

POST /resources/me/pat — Create a new Personal Access Token (PAT)

DELETE /resources/me/pat/{id} — Revoke a Personal Access Token (PAT)

Principals

GET /resources/iam/principals — List principals

GET /resources/iam/principals/{id} — Get a principal

PUT /resources/iam/principals/{id} — Create or update a principal

PATCH /resources/iam/principals/{id} — Update principal properties (partial update)

DELETE /resources/iam/principals/{id} — Delete a principal

POST /resources/iam/principals/{id}/password/reset — Reset a principal's password

POST /resources/iam/principals/{id}/suspend — Suspend a principal

POST /resources/iam/principals/{id}/reactivate — Reactivate a suspended principal

DELETE /resources/iam/principals/{id}/roles/{roleKey} — Remove a specific role from a principal

GET /resources/iam/principals/{id}/sessions — Get all active sessions for a principal

DELETE /resources/iam/principals/{id}/sessions/{sessionId} — Revoke a specific session for a principal

PUT /resources/iam/principals/{id}/acl — Update principal ACL (bulk replace)

PUT /resources/iam/principals/{id}/roles — Update principal roles (bulk replace)

Registry

GET /resources/registry — Get all registry values

POST /resources/registry — Set multiple values at once

GET /resources/registry/{key} — Get a value or list of all sub-values

POST /resources/registry/{key} — Set the value of a registry key

DELETE /resources/registry/{key} — Delete a registry key

Roles

GET /resources/iam/roles — List all roles with filtering, search, and cursor-based pagination

GET /resources/iam/roles/{roleKey} — Gets the specified role

PUT /resources/iam/roles/{roleKey} — Create or update a role

PATCH /resources/iam/roles/{roleKey} — Update role description (partial update)

DELETE /resources/iam/roles/{roleKey} — Delete a role

PUT /resources/iam/roles/{roleKey}/acl — Update role ACL (bulk replace)

Rules

GET /resources/rules — Get all rules

GET /resources/rules/{idOrPrefix} — Get a rule or all rules matching prefix based on the search type

POST /resources/rules/{ruleId} — Create or update a rule

DELETE /resources/rules/{ruleId} — Delete a rule

Sendings

POST /resources/sendings/email — Queue an email for delivery

GET /resources/sendings/{sendingId} — Get sending status and details

DELETE /resources/sendings/{sendingId} — Cancel a pending sending