How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ControlUp Jobs API

The Jobs API from ControlUp — 8 operation(s) for jobs.

ControlUp Jobs API is one of 61 APIs that ControlUp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 8 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.controlup.com/daas-iq/v1.

8 operations 8 paths 12 schemas 6 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.controlup.com/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

ControlUp Jobs API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the cookie as user_dex_token (CookieAuth).

  • BearerAuth — API Key Authentication (Recommended) [Learn how to create an API key](https://api.controlup.io/reference/how-to-create-api-keys).
  • CookieAuth — Cookie Authentication (Browser use) ⚠️ The 'Authorize' button cannot set cookies due to browser security. To authenticate in browser: 1. Login via DEX authenti…

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 6 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 8
GET
/jobs/{jobId}
Get a job by ID
GetJob 1 param → 200400401402403404500503
GET
/jobs/{jobId}/parameters
Get job parameters
GetJobParameters 1 param → 200204400401402403404500
GET
/jobs
Get jobs
GetJobs 5 params → 200400401402403500503
GET
/jobs/{jobId}/status
Get job status
GetJobStatus 1 param → 200400401402403404500503
POST
/jobs/{jobId}/cancel
Cancel a job
CancelJob 1 param → 200400401402403404500503
POST
/jobs/{jobId}/retry
Retry a failed job
RetryJob 1 param → 201400401402403404409500
GET
/jobs/{jobId}/logs
Get job logs
GetJobLogs 3 params → 200400401402403404500503
GET
/jobs/{jobId}/logs/transcript
Get job logs transcript
GetJobLogsTranscript 2 params → 200400401402403404500503

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are JobDto (21 properties), JobPartialDto (20 properties), JobStatusDto (8 properties), JobCreatedDto (7 properties). Each schema is shown below with its type and property counts.

JobLogDto
object
Represents a user-facing log entry for a background job.
5 properties 4 required
JobInitiationType
string
Indicates how a job was initiated - by a user action or by a system scheduler. Used to filter job lists in UI and apply different retention policies.
JobCancellationResponseDto
object
Response returned when cancellation of a job has been requested.
2 properties 2 required
JobCreatedDto
object
Lightweight response returned when a job is created. Contains only essential information needed to track the job. Use the statusUrl to poll for updates and job…
7 properties 7 required
JobDto
object
Represents a background job response with status, progress, metadata, and errors. Extends ControlUp.Foundry.Api.Dtos.Jobs.JobPartialDto with the error messages…
21 properties 11 required
JobType
string
Defines the types of background jobs supported by the system. Each job type is processed by a specific worker and has its own parameter structure.
ErrorResponse
object
Standard error body the API returns when a request fails validation or cannot be completed. Follows RFC 7807 Problem Details with additional errors and traceId…
7 properties 3 required
JobLogSeverity
string
Severity levels for job log entries. Determines how the log is displayed in the UI (color, icon, filtering).
JobStatusDto
object
Lightweight job status for polling (optimized for frequent requests). Contains only fields that change during execution. Use this for status polling every 2-5…
8 properties 7 required
JobPartialDto
object
Partial job information for list views (optimized for bulk queries). Contains identifying metadata and timestamps, but excludes parameters and errors. Use this…
20 properties 10 required
JobPartialDtoPagedResultDto
object
Generic paginated response wrapper for API endpoints. Supports traditional page-based navigation with forward/backward capability.
6 properties 5 required
JobStatus
string
Generic status enum for all background jobs. Represents the lifecycle states common to all job types.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

controlup-jobs-api-openapi.yml Raw ↑

Other APIs ControlUp publishes across the network.

ControlUp MCP Server
ControlUp Alerts API
ControlUp Alerts - Devices API
ControlUp Applications API
ControlUp Audit Log API
ControlUp Cloud providers API
ControlUp Dal API
ControlUp Data API
ControlUp Devices API
ControlUp Dynamic Query API API
ControlUp Events API
ControlUp Features API
Where this information came from

This is an independent, third-party profile of ControlUp Jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.