Object Storage Jobs

Jobs allow you to migrate data from external S3-compatible storage services to your UpCloud Managed Object Storage.

Job States

State	Description
`pending`	Job is queued and waiting to start
`running`	Job is currently in progress
`completed`	Job finished successfully
`failed`	Job encountered an error
`cancelled`	Job was cancelled by user

GET/1.3/object-storage-2/{service_uuid}/jobs

List jobs

Returns a list of data migration jobs for the object storage service.

Request

GET

/1.3/object-storage-2/{service_uuid}/jobs

curl -X GET https://api.upcloud.com/1.3/object-storage-2/0ab2f83f-03f3-4c48-9a38-0a3e89c6d024/jobs \
  -u your_username:your_password

GET/1.3/object-storage-2/{service_uuid}/jobs/{job_uuid}

Get job details

Returns job details by given {service_uuid} and {job_uuid}.

Request

GET

/1.3/object-storage-2/{service_uuid}/jobs/{job_uuid}

curl -X GET https://api.upcloud.com/1.3/object-storage-2/0ab2f83f-03f3-4c48-9a38-0a3e89c6d024/jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -u your_username:your_password

POST/1.3/object-storage-2/{service_uuid}/jobs

Create job

Creates a new data migration job.

Attributes

Name
name
Type
string
Description
The name of the job.
Name
type
Type
string
Description
Job type. Currently only data-migration is supported.
Name
source
Type
object
Description
Source configuration for the migration.
Name
target
Type
object
Description
Target configuration for the migration.

Source Attributes

Name
endpoint
Type
string
Description
S3-compatible endpoint URL.
Name
region
Type
string
Description
Source region.
Name
bucket
Type
string
Description
Source bucket name.
Name
access_key_id
Type
string
Description
Access key ID for the source.
Name
secret_access_key
Type
string
Description
Secret access key for the source.
Name
prefix
Type
string
Description
Optional prefix to filter objects.

Target Attributes

Name
bucket
Type
string
Description
Target bucket name in your Object Storage service.
Name
prefix
Type
string
Description
Optional prefix to add to migrated objects.

Request

POST

/1.3/object-storage-2/{service_uuid}/jobs

curl -X POST https://api.upcloud.com/1.3/object-storage-2/0ab2f83f-03f3-4c48-9a38-0a3e89c6d024/jobs \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "name": "aws-migration",
    "type": "data-migration",
    "source": {
      "endpoint": "s3.amazonaws.com",
      "region": "us-east-1",
      "bucket": "my-aws-bucket",
      "access_key_id": "AKIAIOSFODNN7EXAMPLE",
      "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    },
    "target": {
      "bucket": "my-upcloud-bucket"
    }
  }'

DELETE/1.3/object-storage-2/{service_uuid}/jobs/{job_uuid}

Cancel job

Cancels a running or pending job.

Request

DELETE

/1.3/object-storage-2/{service_uuid}/jobs/{job_uuid}

curl -X DELETE https://api.upcloud.com/1.3/object-storage-2/0ab2f83f-03f3-4c48-9a38-0a3e89c6d024/jobs/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -u your_username:your_password