Submit a new job

Prev Next
Post
/jobs

Submit a job with specified configuration and settings.

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.

Body parameters

Job details for processing

Expand All
object
Name
string Required

Name of the job

Min length1
Max length256
Pattern^.*\S.*$
ExampleMyJobName
Priority
integer Required

Job priority (1-10)

Minimum1
Maximum10
Example5
Services
object Required

Services and their configurations

Batch
string

Optional batch identifier for grouping jobs

Max length256
Examplebatch_2024_11_21
Destination
object Required
Bucket
string Required

Destination bucket name

Exampleairstream-output-2
Region
string Required

S3 region

Exampleus-west-1
Source
object Required
AccessKey
string

Access key for source (not entered if provider is wasabi)

Endpoint
string

S3 endpoint URL

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

Source bucket name

Examplewasabifs-chm
Region
string

S3 region

Exampleus-west-1
SecretKey
string

Secret key for source (not entered if provider is wasabi)

ObjectKey
string Required

Object key or path to the file

ExampleMP4/Commercial.mp4
Responses
200

Job submission successful

Expand All
object
Job
object (Job)
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

Services
object

Services and their configurations

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
400

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