Data Types

CancelJob

Cancels an in-progress background job.

Requires a secret_* API key.

DELETE /v2/accounts/{accountId}/jobs/{jobType}/{jobId}
cURL
1curl "https://api.bytescale.com/v2/accounts/{accountId}/jobs/{jobType}/{jobId}" \
2 -X DELETE \
3 -H "Authorization: Bearer YOUR_API_KEY"
Response (204)
1No response

None for this endpoint.

None for this endpoint.

Your account ID.

This is visible on the settings page:

https://www.bytescale.com/dashboard/settings

Example: "A623uY2"

Type: String

Length: 7

Job ID.

Example: "01ARZ3NDEKTSV4RRFFQ69G5FAV"

Type: String

Length: 26

Job type.

Type: String

Allowed Values: "AntivirusJob", "CopyFileBatchJob", "CopyFolderBatchJob", "DeleteFileBatchJob", "DeleteFolderBatchJob", "ProcessAudioJob", "ProcessImageJob", "ProcessVideoJob"

Add one of these Authorization header values to your request:

Option 1: prefix "Bearer " to your API key. The result is your Authorization header value.

Option 2: use HTTP basic authorization with apikey as your username and your API key as your password.

For advanced options, please see:

https://www.bytescale.com/docs/auth

Note: this endpoint requires a secret_* API key.

Type: String

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: