Get a list of jobs

  • Updated on Jul 10, 2025
  • Published on Jul 10, 2025
  • 1 minute(s) read
Prev Next
Get
/jobs

Retrieves a paginated list of jobs, optionally filtered by criteria such as batch, name, or status, and sorted by created or completed date.

Security
API Key: WasabiAuth
Header parameter namex-amz-access-key

Wasabi access key for authenticating requests. A valid Wasabi User access key is required for API calls.

API Key: WasabiSecretAuth
Header parameter namex-amz-secret-key

Wasabi secret key for authenticating requests. A valid Wasabi User secret key is required along with the access key.

Query parameters
pageNumber
integer

The page number to retrieve (default is 1).

Minimum1
pageSize
integer

The number of jobs to return per page (default is 25).

Minimum1
Maximum100
Default100
batch
string

Filters jobs by the batch identifier.

status
string

Filters jobs by status.

Valid values[ "submitted", "preflight", "in_progress", "completed", "failed", "cancelled" ]
name
string

Filters jobs by the name identifier.

sortBy
string

Sorts the results by the specified field.

Valid values[ "Created" ]
sortOrder
string

Specifies the sort direction: ascending (Asc) or descending (Desc). Default is Asc.

Valid values[ "Asc", "Desc" ]
Responses
200

Job details retrieved successfully

Expand All
object
Records
Array of object (JobList)
object
Id
string

Unique ID for the job

Example67345137bcb6dce44b35a6a6281711e7
Name
string

Name of the job

ExampleMyJobName
Source
object
Endpoint
string

S3 endpoint URL

Examples3.us-west-1.wasabisys.com
Bucket
string

Source bucket name

Examplewasabifs-chm
Region
string

S3 region

Exampleus-west-1
ObjectKey
string

Object key or path to the file

ExampleMP4/Commercial.mp4
Provider
string

Storage provider, e.g., wasabi, OBS, IBM

UserId
string

User who submitted the job (e.g., an ARN)

Example10000
Created
string (date-time)

Timestamp when the job was created

Example2024-11-13T07:11:51.658Z
Completed
string (date-time)

Timestamp when the job was completed

Example2024-11-13T07:11:51.658Z
Priority
integer

Job priority (1-10). example: 5

Batch
string

Optional batch identifier for grouping jobs

Examplebatch_2024_11_21
Status
string

Current status of the job

Valid values[ "submitted", "preflight", "in_progress", "completed", "failed", "cancelled" ]
Examplesubmitted
Destination
object
Bucket
string

Destination bucket name

Exampleairstream-output-2
Region
string

S3 region

Exampleus-west-1
Pagination
object
TotalRecords
integer

Total number of jobs available.

Minimum0
PageNumber
integer

Current page number.

PageSize
integer

Number of jobs per page.

401

Unauthorized

object
Error
string

Error message explaining what went wrong

ExampleAn unexpected error occurred while processing the job.
ErrorCode
string

Error code for troubleshooting

ExampleINTERNAL_ERROR
404

Invalid request (e.g., invalid filter criteria).

object
Error
string

Error message explaining what went wrong

ExampleAn unexpected error occurred while processing the job.
ErrorCode
string

Error code for troubleshooting

ExampleINTERNAL_ERROR
500

Internal Server Error

object
Error
string

Error message explaining what went wrong

ExampleAn unexpected error occurred while processing the job.
ErrorCode
string

Error code for troubleshooting

ExampleINTERNAL_ERROR