Data Types


Gets information on a background job.

Requires a secret_* API key.

GET /v2/accounts/{accountId}/jobs/{jobType}/{jobId}
1curl "{accountId}/jobs/{jobType}/{jobId}" \
2 -H "Authorization: Bearer YOUR_API_KEY"
Response (200)
2 "accountId": "YOUR_ACCOUNT_ID",
3 "created": 1615680311115,
4 "error": {
5 "code": "error_code",
6 "message": "Error message."
7 },
8 "jobDocs": "",
9 "jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
10 "jobType": "ExampleJob",
11 "jobUrl": "",
12 "lastUpdated": 1615680311115,
13 "status": "Cancelled",
14 "summary": {
15 "deletions": [
16 "/file/to/delete.jpg"
17 ]
18 }

Your account ID.

This is visible on the settings page:

Example: "A623uY2"

Type: String

Length: 7

Job ID.


Type: String

Length: 26

Job type.

Type: String

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

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:

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: