YugabyteDB
YugabyteDB Customer Tasks API

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

openapi: 3.1.0
info:
  title: YugabyteDB Aeon REST Access Keys Customer Tasks API
  description: The YugabyteDB Aeon REST API provides programmatic access to YugabyteDB's fully managed cloud database service. Developers and operators can use it to deploy and manage database clusters, configure read replicas, schedule and execute on-demand backups and restores, manage IP allow lists, and set up monitoring and alerts. Authentication is performed using API keys passed as bearer tokens in the Authorization header. All paths are scoped to an account and project, which can be obtained from the YugabyteDB Aeon UI profile page.
  version: v1
  contact:
    name: Yugabyte Support
    url: https://support.yugabyte.com
  termsOfService: https://www.yugabyte.com/yugabytedb-managed-service-terms/
  x-generated-from: documentation
  x-source-url: https://api-docs.yugabyte.com/docs/managed-apis/
  x-last-validated: '2026-05-03'
servers:
- url: https://cloud.yugabyte.com/api/public/v1
  description: YugabyteDB Aeon Production Server
security:
- bearerAuth: []
tags:
- name: Customer Tasks
paths:
  /api/v1/customers/{cUUID}/tasks/{tUUID}:
    get:
      operationId: taskStatus
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: tUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
              examples:
                TaskStatus200Example:
                  summary: Default taskStatus 200 response
                  x-microcks-default: true
                  value: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get a Task's Status
      tags:
      - Customer Tasks
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/tasks/{tUUID}/abort:
    post:
      description: Aborts a running task
      operationId: abortTask
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: tUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
              examples:
                AbortTask200Example:
                  summary: Default abortTask 200 response
                  x-microcks-default: true
                  value:
                    success: true
                    message: message
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Abort a Task
      tags:
      - Customer Tasks
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/tasks/{tUUID}/failed:
    get:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.19.1.0.</b></p>Use /api/v1/customers/{cUUID}/tasks/{tUUID}/failed_subtasks instead.
      operationId: failedSubtasks
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: tUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  properties: {}
                  type: object
                type: object
              examples:
                FailedSubtasks200Example:
                  summary: Default failedSubtasks 200 response
                  x-microcks-default: true
                  value: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Fetch Failed Subtasks - Deprecated
      tags:
      - Customer Tasks
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/tasks/{tUUID}/failed_subtasks:
    get:
      operationId: listFailedSubtasks
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: tUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedSubtasks'
              examples:
                ListFailedSubtasks200Example:
                  summary: Default listFailedSubtasks 200 response
                  x-microcks-default: true
                  value:
                    failedSubTasks:
                    - errorString: errorString
                      creationTime: 2022-12-12 13:07:18+00:00
                      subTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      subTaskType: subTaskType
                      errorCode: UNKNOWN_ERROR
                      subTaskGroupType: subTaskGroupType
                      subTaskState: subTaskState
                    - errorString: errorString
                      creationTime: 2022-12-12 13:07:18+00:00
                      subTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      subTaskType: subTaskType
                      errorCode: UNKNOWN_ERROR
                      subTaskGroupType: subTaskGroupType
                      subTaskState: subTaskState
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get a List of Task's Failed Subtasks
      tags:
      - Customer Tasks
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/tasks/{tUUID}/retry:
    post:
      description: Retry a Universe or Provider task.
      operationId: retryTask
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: tUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                RetryTask200Example:
                  summary: Default retryTask 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Retry a Universe or Provider Task
      tags:
      - Customer Tasks
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/tasks/{tUUID}/rollback:
    post:
      description: Rollback a Universe or Provider task.
      operationId: rollbackTask
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: tUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                RollbackTask200Example:
                  summary: Default rollbackTask 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Rollback a Universe or Provider Task
      tags:
      - Customer Tasks
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/tasks_list:
    get:
      operationId: tasksList
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: uUUID
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CustomerTaskData'
                type: array
              examples:
                TasksList200Example:
                  summary: Default tasksList 200 response
                  x-microcks-default: true
                  value:
                  - retryable: true
                    abortable: true
                    typeName: Software Upgrade
                    percentComplete: 100
                    title: 'Deleted Universe : test-universe'
                    type: Delete
                    targetUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    target: Universe
                    completionTime: 2022-12-12 13:07:18+00:00
                    createTime: 2022-12-12 13:07:18+00:00
                    canRollback: true
                    correlationId: correlationId
                    userEmail: userEmail
                    id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    status: Complete
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List Task
      tags:
      - Customer Tasks
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/tasks_list/page:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: listTasksV2
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskPagedApiQuery'
            examples:
              ListTasksV2RequestExample:
                summary: Default listTasksV2 request
                x-microcks-default: true
                value:
                  filter:
                    targetUUIDList:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    targetList:
                    - Universe
                    - Universe
                    dateRangeEnd: '2022-12-12T13:07:18+00:00'
                    typeList:
                    - Create
                    - Create
                    typeNameList:
                    - typeNameList
                    - typeNameList
                    dateRangeStart: '2022-12-12T13:07:18+00:00'
                    status:
                    - Created
                    - Created
                  offset: 6
                  needTotalCount: true
                  limit: 0
                  sortBy: createTime
                  direction: ASC
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskPagedApiResponse'
              examples:
                ListTasksV2200Example:
                  summary: Default listTasksV2 200 response
                  x-microcks-default: true
                  value:
                    entities:
                    - retryable: true
                      abortable: true
                      typeName: Software Upgrade
                      percentComplete: 100
                      title: 'Deleted Universe : test-universe'
                      type: Delete
                      targetUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      target: Universe
                      completionTime: 2022-12-12 13:07:18+00:00
                      createTime: 2022-12-12 13:07:18+00:00
                      canRollback: true
                      correlationId: correlationId
                      userEmail: userEmail
                      id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      status: Complete
                    - retryable: true
                      abortable: true
                      typeName: Software Upgrade
                      percentComplete: 100
                      title: 'Deleted Universe : test-universe'
                      type: Delete
                      targetUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      target: Universe
                      completionTime: 2022-12-12 13:07:18+00:00
                      createTime: 2022-12-12 13:07:18+00:00
                      canRollback: true
                      correlationId: correlationId
                      userEmail: userEmail
                      id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      status: Complete
                    hasPrev: true
                    hasNext: true
                    totalCount: 0
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List Tasks (paginated)
      tags:
      - Customer Tasks
      x-codegen-request-body-name: PageTasksRequest
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    TaskPagedApiQuery:
      example:
        filter:
          targetUUIDList:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          targetList:
          - Universe
          - Universe
          dateRangeEnd: 2022-12-12 13:07:18+00:00
          typeList:
          - Create
          - Create
          typeNameList:
          - typeNameList
          - typeNameList
          dateRangeStart: 2022-12-12 13:07:18+00:00
          status:
          - Created
          - Created
        offset: 6
        needTotalCount: true
        limit: 0
        sortBy: createTime
        direction: ASC
      properties:
        direction:
          enum:
          - ASC
          - DESC
          type: string
          example: ASC
        filter:
          $ref: '#/components/schemas/TaskApiFilter'
        limit:
          format: int32
          type: integer
          example: 10
        needTotalCount:
          type: boolean
          example: true
        offset:
          format: int32
          type: integer
          example: 100
        sortBy:
          enum:
          - createTime
          type: string
          example: createTime
      required:
      - direction
      - filter
      - limit
      - needTotalCount
      - offset
      - sortBy
      type: object
    TaskApiFilter:
      example:
        targetUUIDList:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        targetList:
        - Universe
        - Universe
        dateRangeEnd: 2022-12-12 13:07:18+00:00
        typeList:
        - Create
        - Create
        typeNameList:
        - typeNameList
        - typeNameList
        dateRangeStart: 2022-12-12 13:07:18+00:00
        status:
        - Created
        - Created
      properties:
        dateRangeEnd:
          description: The end date to filter paged query.
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          type: string
        dateRangeStart:
          description: The start date to filter paged query.
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          type: string
        status:
          items:
            enum:
            - Created
            - Initializing
            - Running
            - Success
            - Failure
            - Unknown
            - Abort
            - Aborted
            type: string
          type: array
          uniqueItems: true
          example:
          - Created
        targetList:
          items:
            enum:
            - Universe
            - Cluster
            - Table
            - Provider
            - Node
            - Backup
            - Schedule
            - CustomerConfiguration
            - KMSConfiguration
            - XClusterConfig
            - DrConfig
            - UniverseKey
            - MasterKey
            - NodeAgent
            - Yba
            - User
            type: string
          type: array
          uniqueItems: true
          example:
          - Universe
        targetUUIDList:
          items:
            format: uuid
            type: string
          type: array
          uniqueItems: true
          example:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        typeList:
          items:
            enum:
            - Create
            - Pause
            - Resume
            - Update
            - Delete
            - Stop
            - Start
            - Restart
            - Remove
            - Add
            - Release
            - Reboot
            - HardReboot
            - Replace
            - Edit
            - Sync
            - LdapSync
            - RestartUniverse
            - SoftwareUpgrade
            - SoftwareUpgradeYB
            - FinalizeUpgrade
            - RollbackUpgrade
            - GFlagsUpgrade
            - KubernetesOverridesUpgrade
            - EditKubernetesUniverse
            - CertsRotate
            - TlsToggle
            - VMImageUpgrade
            - SystemdUpgrade
            - RebootUniverse
            - UpgradeSoftware
            - UpgradeVMImage
            - ResizeNode
            - UpdateCert
            - UpdateDiskSize
            - UpgradeGflags
            - UpdateLoadBalancerConfig
            - BulkImportData
            - Backup
            - Restore
            - CreatePitrConfig
            - UpdatePitrConfig
            - DeletePitrConfig
            - RestoreSnapshotSchedule
            - SetEncryptionKey
            - EnableEncryptionAtRest
            - SetActiveUniverseKeys
            - RotateEncryptionKey
            - DisableEncryptionAtRest
            - StartMaster
            - CreateAlertDefinitions
            - ManageAlertDefinitions
            - ExternalScript
            - CreateXClusterConfig
            - EditXClusterConfig
            - DeleteXClusterConfig
            - SyncXClusterConfig
            - Failover
            - Switchover
            - SwitchoverRollback
            - PrecheckNode
            - Abort
            - CreateSupportBundle
            - CreateTableSpaces
            - ThirdpartySoftwareUpgrade
            - ModifyAuditLoggingConfig
            - ModifyQueryLoggingConfig
            - ModifyMetricsExportConfig
            - RotateAccessKey
            - CreateAndRotateAccessKey
            - RunApiTriggeredHooks
            - InstallYbcSoftware
            - InstallYbcSoftwareOnK8s
            - UpgradeUniverseYbc
            - DisableYbc
            - UpgradeYbcGFlags
            - UpgradeKubernetesYbcGFlags
            - UpdateYbcThrottleFlags
            - UpdateK8sYbcThrottleFlags
            - ConfigureDBApis
            - ConfigureDBApisKubernetes
            - CreateImageBundle
            - ReprovisionNode
            - Install
            - ProvisionUniverseNodes
            - MasterFailover
            - UpdateProxyConfig
            - SyncMasterAddresses
            - CreateYbaBackup
            - RestoreYbaBackup
            - RestoreContinuousBackup
            - EnableNodeAgent
            - Decommission
            - CloneNamespace
            - UpdateOOMServiceState
            - SendUserNotification
            - ImportUniverse
            - MigrateUniverse
            - KubernetesToggleImmutableYbc
            - OperatorImport
            type: string
          type: array
          uniqueItems: true
          example:
          - Create
        typeNameList:
          items:
            type: string
          type: array
          uniqueItems: true
          example:
          - example-typeNameList
      required:
      - status
      - targetList
      - targetUUIDList
      - typeList
      - typeNameList
      type: object
    CustomerTaskData:
      description: Customer task data
      example:
        retryable: true
        abortable: true
        typeName: Software Upgrade
        percentComplete: 100
        title: 'Deleted Universe : test-universe'
        type: Delete
        targetUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        target: Universe
        completionTime: 2022-12-12 13:07:18+00:00
        createTime: 2022-12-12 13:07:18+00:00
        canRollback: true
        correlationId: correlationId
        userEmail: userEmail
        id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        status: Complete
      properties:
        abortable:
          description: Customer task abortable
          type: boolean
          example: true
        canRollback:
          description: Whether the Customer task can be rolled back
          type: boolean
          example: true
        completionTime:
          description: Customer task completion time
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          type: string
        correlationId:
          description: Correlation id
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        createTime:
          description: Customer task creation time
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          type: string
        id:
          description: Customer task UUID
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        percentComplete:
          description: Customer task percentage completed
          example: 100
          format: int32
          type: integer
        retryable:
          description: Customer task retryable
          type: boolean
          example: true
        status:
          description: Customer task status
          example: Complete
          type: string
        target:
          description: Customer task target
          example: Universe
          type: string
        targetUUID:
          description: Customer task target UUID
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        title:
          description: Customer task title
          example: 'Deleted Universe : test-universe'
          type: string
        type:
          description: Customer task type
          example: Delete
          type: string
        typeName:
          description: Customer task type name
          example: Software Upgrade
          type: string
        userEmail:
          description: Customer Email
          readOnly: true
          type: string
          example: admin@example.com
      type: object
    TaskPagedApiResponse:
      example:
        entities:
        - retryable: true
          abortable: true
          typeName: Software Upgrade
          percentComplete: 100
          title: 'Deleted Universe : test-universe'
          type: Delete
          targetUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          target: Universe
          completionTime: 2022-12-12 13:07:18+00:00
          createTime: 2022-12-12 13:07:18+00:00
          canRollback: true
          correlationId: correlationId
          userEmail: userEmail
          id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: Complete
        - retryable: true
          abortable: true
          typeName: Software Upgrade
          percentComplete: 100
          title: 'Deleted Universe : test-universe'
          type: Delete
          targetUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          target: Universe
          completionTime: 2022-12-12 13:07:18+00:00
          createTime: 2022-12-12 13:07:18+00:00
          canRollback: true
          correlationId: correlationId
          userEmail: userEmail
          id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: Complete
        hasPrev: true
        hasNext: true
        totalCount: 0
      properties:
        entities:
          items:
            $ref: '#/components/schemas/CustomerTaskData'
          type: array
          example:
          - retryable: true
            abortable: true
            typeName: Software Upgrade
            percentComplete: 100
            title: 'Deleted Universe : test-universe'
            type: Delete
            targetUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            target: Universe
            completionTime: '2022-12-12T13:07:18+00:00'
            createTime: '2022-12-12T13:07:18+00:00'
            canRollback: true
            correlationId: correlationId
            userEmail: userEmail
            id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            status: Complete
        hasNext:
          type: boolean
          example: true
        hasPrev:
          type: boolean
          example: true
        totalCount:
          format: int32
          type: integer
          example: 10
      required:
      - entities
      - hasNext
      - hasPrev
      - totalCount
      type: object
    FailedSubtasks:
      description: Failed Subtasks
      example:
        failedSubTasks:
        - errorString: errorString
          creationTime: 2022-12-12 13:07:18+00:00
          subTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          subTaskType: subTaskType
          errorCode: UNKNOWN_ERROR
          subTaskGroupType: subTaskGroupType
          subTaskState: subTaskState
        - errorString: errorString
          creationTime: 2022-12-12 13:07:18+00:00
          subTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          subTaskType: subTaskType
          errorCode: UNKNOWN_ERROR
          subTaskGroupType: subTaskGroupType
          subTaskState: subTaskState
      properties:
        failedSubTasks:
          description: List of failed subtasks
          items:
            $ref: '#/components/schemas/SubtaskData'
          type: array
          example:
          - errorString: errorString
            creationTime: '2022-12-12T13:07:18+00:00'
            subTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            subTaskType: subTaskType
            errorCode: UNKNOWN_ERROR
            subTaskGroupType: subTaskGroupType
            subTaskState: subTaskState
      type: object
    YBPSuccess:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    SubtaskData:
      description: Detailed subtask data
      example:
        errorString: errorString
        creationTime: 2022-12-12 13:07:18+00:00
        subTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        subTaskType: subTaskType
        errorCode: UNKNOWN_ERROR
        subTaskGroupType: subTaskGroupType
        subTaskState: subTaskState
      properties:
        creationTime:
          description: Creation time (unix timestamp) of the task
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          type: string
        errorCode:
          description: 'WARNING: This is a preview API that could change. Subtask error code'
          enum:
          - UNKNOWN_ERROR
          - INTERNAL_ERROR
          - PLATFORM_SHUTDOWN
          - PLATFORM_RESTARTED
          - INSTALLATION_ERROR
          - SERVICE_START_ERROR
          - CONNECTION_ERROR
          - TIMED_OUT
          type: string
          example: UNKNOWN_ERROR
        errorString:
          description: Failed SubTask Error message
          type: string
          example: example-errorString
        subTaskGroupType:
          description: Failed SubTask Group Type
          type: string
          example: DEFAULT
        subTaskState:
          description: Failed SubTask State
          type: string
          example: ACTIVE
        subTaskType:
          description: Failed SubTask Type
          type: string
          example: DEFAULT
        subTaskUUID:
          description: Failed SubTask UUID
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    YBPTask:
      example:
        taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        resourceUUID:
          description: UUID of the resource being modified by the task
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        taskUUID:
          description: Task UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    TaskPagedApiQuery_2:
      example:
        filter:
          targetUUIDList:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          targetList:
          - Universe
          - Universe
          dateRangeEnd: 2022-12-12 13:07:18+00:00
          typeList:
          - Create
          - Create
          typeNameList:
          - typeNameList
          - typeNameList
          dateRangeStart: 2022-12-12 13:07:18+00:00
          status:
          - Created
          - Created
        offset: 6
        needTotalCount: true
        limit: 0
        sortBy: createTime
        direction: ASC
      properties:
        direction:
          enum:
          - ASC
          - DESC
          type: string
        filter:
          $ref: '#/components/schemas/TaskApiFilter_2'
        limit:
          format: int32
          type: integer
        needTotalCount:
          type: boolean
        offset:
          format: int32
          type: integer
        sortBy:
          enum:
          - createTime
          type: string
      required:
      - direction
      - filter
      - limit
      - needTotalCount
      - offset
      - sortBy
      type: object
    TaskApiFilter_2:
      example:
        targetUUIDList:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        targetList:
        - Universe
        - Universe
        dateRangeEnd: 2022-12-12 13:07:18+00:00
        typeList:
        - Create
        - Create
        typeNameList:
        - typeNameList
        - typeNameList
        dateRangeStart: 2022-12-12 13:07:18+00:00
        status:
        - Created
        - Created
      properties:
        dateRangeEnd:
          description: The end date to filter paged query.
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          type: string
        dateRangeStart:
          description: The start date to filter paged query.
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          type: string
        stat

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-customer-tasks-api-openapi.yml
YugabyteDB Customer Tasks API

Documentation

Specifications

Other Resources

OpenAPI Specification
