Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB Customer Tasks API

The Customer Tasks API from YugabyteDB — 8 operation(s) for customer tasks.

YugabyteDB Customer Tasks API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customer Tasks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 8 operations across 8 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.

8 operations 8 paths 16 schemas 4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Customer Tasks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization header.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Customer Tasks 8
GET
/api/v1/customers/{cUUID}/tasks/{tUUID}
YugabyteDB Anywhere Get a Task's Status
taskStatus 2 params → 200
POST
/api/v1/customers/{cUUID}/tasks/{tUUID}/abort
YugabyteDB Anywhere Abort a Task
abortTask 3 params → 200
GET
/api/v1/customers/{cUUID}/tasks/{tUUID}/faileddeprecated
YugabyteDB Anywhere Fetch Failed Subtasks - Deprecated
failedSubtasks 2 params → 200
GET
/api/v1/customers/{cUUID}/tasks/{tUUID}/failed_subtasks
YugabyteDB Anywhere Get a List of Task's Failed Subtasks
listFailedSubtasks 2 params → 200
POST
/api/v1/customers/{cUUID}/tasks/{tUUID}/retry
YugabyteDB Anywhere Retry a Universe or Provider Task
retryTask 3 params → 200
POST
/api/v1/customers/{cUUID}/tasks/{tUUID}/rollback
YugabyteDB Anywhere Rollback a Universe or Provider Task
rollbackTask 3 params → 200
GET
/api/v1/customers/{cUUID}/tasks_list
YugabyteDB Anywhere List Task
tasksList 2 params → 200
POST
/api/v1/customers/{cUUID}/tasks_list/page
YugabyteDB Anywhere List Tasks (paginated)
listTasksV2 2 params body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CustomerTaskData (15 properties), CustomerTaskData_2 (15 properties), TaskApiFilter (7 properties), SubtaskData_2 (7 properties). Each schema is shown below with its type and property counts.

TaskPagedApiQuery
object
6 properties 6 required
TaskApiFilter
object
7 properties 5 required
CustomerTaskData
object
Customer task data
15 properties
TaskPagedApiResponse
object
4 properties 4 required
FailedSubtasks
object
Failed Subtasks
1 property
YBPSuccess
object
2 properties
SubtaskData
object
Detailed subtask data
7 properties
YBPTask
object
2 properties
TaskPagedApiQuery_2
object
6 properties 6 required
TaskApiFilter_2
object
7 properties 5 required
CustomerTaskData_2
object
Customer task data
15 properties
TaskPagedApiResponse_2
object
4 properties 4 required
FailedSubtasks_2
object
Failed Subtasks
1 property
YBPSuccess_2
object
2 properties
SubtaskData_2
object
Detailed subtask data
7 properties
YBPTask_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-customer-tasks-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API