GetJob

Gets information on a background job.

Requires a secret_* API key.

1curl "https://api.bytescale.com/v2/accounts/{accountId}/jobs/{jobType}/{jobId}" \
2     -H "Authorization: Bearer YOUR_API_KEY"

1{
2  "accountId": "YOUR_ACCOUNT_ID",
3  "created": 1615680311115,
4  "error": {
5    "code": "error_code",
6    "message": "Error message."
7  },
8  "jobDocs": "https://www.bytescale.com/docs/job-api/GetJob",
9  "jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
10  "jobType": "ExampleJob",
11  "jobUrl": "https://api.bytescale.com/v2/accounts/FW25aki/jobs/ExampleJob/01ARZ3NDEKTSV4RRFFQ69G5FAV",
12  "lastUpdated": 1615680311115,
13  "status": "Cancelled",
14  "summary": {
15    "deletions": [
16      "/file/to/delete.jpg"
17    ]
18  }
19}

Response Body

See full details

URL Parameters

accountId

Your account ID.

This is visible on the settings page:

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

Example: A623uY2

Type: String

Length: 7

In: Path

Required: Yes

jobId

Job ID.

Example: 01ARZ3NDEKTSV4RRFFQ69G5FAV

Type: String

Length: 26

In: Path

Required: Yes

jobType

Job type.

Type: String

Allowed Values: "CopyFileBatchJob", "CopyFolderBatchJob", "DeleteFileBatchJob", "DeleteFolderBatchJob", "ProcessFileJob"

In: Path

Required: Yes

Request Headers

Authorization

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, specifying apikey as your username, and your API key as your password.

Note: this endpoint requires a secret_* API key.

Type: String

In: Header

Required: Yes

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:

Chrome

Download

Firefox

Download

Opera

Download

Safari

Download
(macOS only)

Internet Explorer

Download
(Windows only)

Microsoft Edge

Download
(Windows only)