How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yugabyte Customer Tasks API

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

Yugabyte Customer Tasks API is one of 82 APIs that Yugabyte 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 8 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

8 operations 8 paths 8 schemas 4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
https://docs.yugabyte.com
Terms of Service
Resource Areas
1

Authentication & Security 1

Yugabyte Customer Tasks API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

  • apiKeyAuth — API token passed as 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}
Get a task's status
taskStatus 2 params → 200
POST
/api/v1/customers/{cUUID}/tasks/{tUUID}/abort
Abort a task
abortTask 3 params → 200
GET
/api/v1/customers/{cUUID}/tasks/{tUUID}/faileddeprecated
Fetch failed subtasks - deprecated
failedSubtasks 2 params → 200
GET
/api/v1/customers/{cUUID}/tasks/{tUUID}/failed_subtasks
Get a list of task's failed subtasks
listFailedSubtasks 2 params → 200
POST
/api/v1/customers/{cUUID}/tasks/{tUUID}/retry
Retry a Universe or Provider task
retryTask 3 params → 200
POST
/api/v1/customers/{cUUID}/tasks/{tUUID}/rollback
Rollback a Universe or Provider task
rollbackTask 3 params → 200
GET
/api/v1/customers/{cUUID}/tasks_list
List task
tasksList 2 params → 200
POST
/api/v1/customers/{cUUID}/tasks_list/page
List Tasks (paginated)
listTasksV2 2 params body → 200

Schemas 8

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

YBPTask
object
2 properties
TaskPagedApiResponse
object
4 properties 4 required
FailedSubtasks
object
Failed Subtasks
1 property
CustomerTaskData
object
Customer task data
15 properties
YBPSuccess
object
2 properties
SubtaskData
object
Detailed subtask data
7 properties
TaskPagedApiQuery
object
6 properties 6 required
TaskApiFilter
object
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Yugabyte publishes across the network.

YugabyteDB Aeon REST API
Yugabyte Backup Info API
Yugabyte Cluster API
Yugabyte Cluster Info API
Yugabyte Pitr Info API
Yugabyte Restore Info API
Yugabyte Voyager Info API
Yugabyte Voyager Metrics API
Yugabyte Xcluster Metrics API
Yugabyte Xcluster Namespace Details API
Yugabyte Access Keys API
Yugabyte Accounts API
Where this information came from

This is an independent, third-party profile of Yugabyte Customer Tasks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.