logo

Jobs

Endpoints related to managing long-running tasks, known as jobs, on Cycle.

List Jobs

Requires the apionly-jobs-view permission.

SecuritybearerAuth and hubAuth
Request
query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Value: "creators"
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of Jobs.

default

General error response from the platform

get/v1/jobs
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Get Job

Requires the apionly-jobs-view permission.

SecuritybearerAuth and hubAuth
Request
path Parameters
jobId
required
string

The ID for the given Job.

Responses
200

A Job resources.

default

General error response from the platform

get/v1/jobs/{jobId}
Response samples
application/json
{
  • "data": {
    }
}

List Latest Jobs

Requires the apionly-jobs-view permission.

SecuritybearerAuth and hubAuth
Responses
200

Returns a list of Jobs.

default

General error response from the platform

get/v1/jobs/latest
Response samples
application/json
{
  • "data": [
    ]
}
➔ Next to Monitoring