database

Create task

Creates a task that checks for potential errors before starting a migration or upgrade for a Managed Database service by its {uuid}.

post/1.3/database/{uuid}/tasks

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/database/{uuid}/tasks
  • Auth: HTTP bearer

Path parameters

uuidstring uuid required

The unique identifier for the integration.

Example:01234567-89ab-cdef-0123-456789abcdef

Service UUID

Request body

target_versionstring

The target version for upgrade operations.

operationstring required

The operation to be performed.

Example request

{
  "operation": "dataset_import",
  "dataset_import": {
    "dataset_name": "customer-events"
  }
}

Response

Created

create_timestring date-time

The time when the service task was created

resultstring

Optional result message

result_codesobject[]

Optional list of result codes as key-value maps

ignore_dbsstring

Optional list of databases to ignore

operationstring

The operation being performed

successboolean

Indicates if the operation was successful

methodstring

Optional method used for the operation

source_pg_versionstring

Optional source PostgreSQL version

target_pg_versionstring

Optional target PostgreSQL version

idstring uuid

Optional identifier for the task

operation_typestring

The type of operation being performed.

Example response

{
  "create_time": "2022-10-04T12:21:42Z",
  "operation": "mysql_migration_check",
  "id": "9b39f10d-e356-437b-b907-d6d5574721b2",
  "result_codes": [],
  "result": "All pre-checks passed successfully, preferred migration method will be [Replication]",
  "success": true,
  "operation_type": "async"
}

Changes

No recorded changes to this operation across all 1 revision of this API.