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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
YugabyteDB

YugabyteDB Customer Tasks API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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 43 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

8 operations 8 paths 43 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
License
Polyform Free Trial License 1.0.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

YugabyteDB 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 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are UniverseDefinitionTaskParamsResp (37 properties), UserIntent (32 properties), NodeDetailsResp (29 properties), CustomerTaskData_3 (15 properties). Each schema is shown below with its type and property counts.

TaskPagedApiResponse
object
4 properties 4 required
CustomerTaskData
object
Customer task data
15 properties
FailedSubtasks
object
Failed Subtasks
1 property
SubtaskData
object
Detailed subtask data
7 properties
TaskPagedApiQuery
object
6 properties 6 required
YBPSuccess
object
2 properties
TaskApiFilter
object
7 properties 5 required
YBPTask
object
2 properties
PlacementInfo
object
1 property 1 required
UniverseDefinitionTaskParamsResp
object
37 properties 1 required
ExtraDependencies
object
Extra dependencies
1 property
DeviceInfo
object
Device information
7 properties
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties
CloudSpecificInfo
object
Node information reported by the cloud provider
14 properties
Region
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
Cluster
object
6 properties 2 required
UniverseResp
object
Universe-creation response
11 properties
PlacementAZ
object
7 properties
UniverseResourceDetails
object
11 properties
UserIntent
object
32 properties
AvailabilityZone
object
Availability zone (AZ) for a region
8 properties 1 required
CustomerTaskData_2
object
Customer task data
12 properties
PlacementCloud
object
4 properties
CommunicationPorts
object
Communication ports
11 properties
PlacementRegion
object
4 properties
YBPSuccess_2
object
2 properties
NodeDetailsResp
object
29 properties
TaskPagedApiResponse_2
object
4 properties 4 required
CustomerTaskData_3
object
Customer task data
15 properties
FailedSubtasks_2
object
Failed Subtasks
1 property
SubtaskData_2
object
Detailed subtask data
7 properties
TaskPagedApiQuery_2
object
6 properties 6 required
YBPSuccess_3
object
2 properties
TaskApiFilter_2
object
7 properties 5 required
YBPTask_2
object
2 properties
TaskPagedApiResponse_3
object
4 properties 4 required
CustomerTaskData_4
object
Customer task data
15 properties
FailedSubtasks_3
object
Failed Subtasks
1 property
SubtaskData_3
object
Detailed subtask data
7 properties
TaskPagedApiQuery_3
object
6 properties 6 required
YBPSuccess_4
object
2 properties
TaskApiFilter_3
object
7 properties 5 required
YBPTask_3
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
AE Profile APIs.io
YugabyteDB Accounts API
AE Profile APIs.io
YugabyteDB Alerts API
AE Profile APIs.io
YugabyteDB AllowLists API
AE Profile APIs.io
YugabyteDB Asynchronous Replication API
AE Profile APIs.io
YugabyteDB Audit API
AE Profile APIs.io
YugabyteDB Authentication API
AE Profile APIs.io
YugabyteDB Availability Zones API
AE Profile APIs.io
YugabyteDB Backup and Restore API
AE Profile APIs.io
YugabyteDB Backups API
AE Profile APIs.io
YugabyteDB Certificate Info API
AE Profile APIs.io
YugabyteDB Cloud providers API
AE Profile APIs.io
#Customer Tasks
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-customer-tasks-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
Provider
YugabyteDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yugabytedb-customer-tasks-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-customer-tasks-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of YugabyteDB 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.