Skip to main content

Jobs & Server Info

Monitor background jobs and retrieve server information.

Running jobs​

Check the status of currently running operations (e.g., deployments):

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/runningJobs" \
  -H "Authorization: Bearer <your-token>"

Job history​

Browse completed jobs:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/jobs?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Example response:

{
  "content": [
    {
      "id": "d4e5f6a7-b8c9-0123-def4-567890123456",
      "type": "DEPLOYMENT",
      "status": "COMPLETED",
      "startedAt": "2026-02-23T10:00:00Z",
      "completedAt": "2026-02-23T10:00:15Z"
    }
  ],
  "size": 10,
  "number": 1,
  "totalPages": 1,
  "totalElements": 1,
  "last": true
}

Server information​

Retrieve information about the API Control Plane server:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/serverInfo" \
  -H "Authorization: Bearer <your-token>"

Login options​

Get available login options for the tenant:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/serverInfo/loginOptions" \
  -H "Authorization: Bearer <your-token>"

Spec types​

List supported specification types:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/serverInfo/specTypes" \
  -H "Authorization: Bearer <your-token>"

SaaS information​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/serverInfo/saasInfo" \
  -H "Authorization: Bearer <your-token>"

System messages​

Retrieve platform-wide announcements:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/systemMessages" \
  -H "Authorization: Bearer <your-token>"