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 app settings

PATCH /resources/apps/{appId}/settings — Update app settings

GET /resources/apps/dev/connect — Connect to app development WebSocket

Audit

GET /audit — Query audit logs

GET /audit/{id} — Get audit log entry

Clients

GET /resources/iam/clients — List OAuth clients

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

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

PATCH /resources/iam/clients/{id} — Update client properties

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

PUT /resources/iam/clients/{id}/acl — Update client ACL

PUT /resources/iam/clients/{id}/roles — Update client roles

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

GET /resources/iam/clients/{id}/sessions — Get client sessions

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

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

GET /resources/iam/clients/{id}/secrets — List 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 graph metadata

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

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 user profile

POST /resources/me/profile — Update user profile

POST /resources/me/password — Change user password

POST /resources/me/email/change — Request email change

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

GET /resources/me/settings — Get user settings

POST /resources/me/settings — Update user settings

GET /resources/me/pat — List personal access tokens

POST /resources/me/pat — Create personal access token

DELETE /resources/me/pat/{id} — Revoke personal access token

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

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

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

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

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

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

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

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

PUT /resources/iam/principals/{id}/acl — Update principal ACL

PUT /resources/iam/principals/{id}/roles — Update principal roles

Registry

GET /resources/registry — Get all registry values

POST /resources/registry — Set multiple values at once

GET /resources/registry/{key} — Get registry value

POST /resources/registry/{key} — Set registry value

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

Roles

GET /resources/iam/roles — List roles

GET /resources/iam/roles/{roleKey} — Get role

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

PATCH /resources/iam/roles/{roleKey} — Update role

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

PUT /resources/iam/roles/{roleKey}/acl — Update role ACL

Rules

GET /resources/rules — Get all rules

GET /resources/rules/{idOrPrefix} — Get rule

PUT /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