Data Types

GetJob

Gets information on a background job.

Requires a secret_* API key.

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

Response Body

URL Parameters

accountId

Your account ID.

This is visible on the settings page:

https://upload.io/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"

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: