YugabyteDB

YugabyteDB Universe actions API

The Universe actions API from YugabyteDB — 1 operation(s) for universe actions.

Documentation GitHub OpenAPI

Operations 1

POST /api/v1/customers/{cUUID}/universes/import Import a universe - deprecated #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/yugabytedb-universe-actions-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Yugabytedb Universe actions API
  version: v1
  contact:
    name: https://docs.yugabyte.com
  license:
    name: Polyform Free Trial License 1.0.0
    url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt
  termsOfService: TODO(chirag)
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  - x-split-from differs across the merged source definitions and was not carried
  description: 'Operations tagged Universe actions across 4 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-universes.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: Universe actions
paths:
  /api/v1/customers/{cUUID}/universes/import:
    post:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.19.3.0.</b></p>Do not use, this will be removed soon.
      operationId: importUniverse
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportUniverseFormData'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Import a universe - deprecated
      tags:
      - Universe actions
    servers:
    - url: /
components:
  schemas:
    ImportUniverseFormData:
      example:
        singleStep: true
        replicationFactor: 0
        instanceType: instanceType
        regionName: regionName
        providerType: unknown
        masterAddresses: masterAddresses
        universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        regionCode: regionCode
        cloudName: cloudName
        cloudProviderType: cloudProviderType
        zoneName: zoneName
        currentState: BEGIN
        universeName: universeName
        zoneCode: zoneCode
      properties:
        cloudName:
          type: string
        cloudProviderType:
          type: string
        currentState:
          enum:
          - BEGIN
          - IMPORTED_MASTERS
          - IMPORTED_TSERVERS
          - FINISHED
          type: string
        instanceType:
          type: string
        masterAddresses:
          type: string
        providerType:
          enum:
          - unknown
          - aws
          - gcp
          - azu
          - docker
          - onprem
          - kubernetes
          - local
          - other
          type: string
        regionCode:
          type: string
        regionName:
          type: string
        replicationFactor:
          format: int32
          type: integer
        singleStep:
          type: boolean
        universeName:
          type: string
        universeUUID:
          format: uuid
          type: string
        zoneCode:
          type: string
        zoneName:
          type: string
      required:
      - cloudName
      - cloudProviderType
      - currentState
      - instanceType
      - masterAddresses
      - providerType
      - regionCode
      - regionName
      - replicationFactor
      - singleStep
      - universeName
      - universeUUID
      - zoneCode
      - zoneName
      type: object
    ImportUniverseFormData_2:
      properties:
        cloudName:
          type: string
        cloudProviderType:
          type: string
        currentState:
          enum:
          - BEGIN
          - IMPORTED_MASTERS
          - IMPORTED_TSERVERS
          - FINISHED
          type: string
        instanceType:
          type: string
        masterAddresses:
          type: string
        providerType:
          enum:
          - unknown
          - aws
          - gcp
          - azu
          - docker
          - onprem
          - kubernetes
          - local
          - other
          type: string
        regionCode:
          type: string
        regionName:
          type: string
        replicationFactor:
          format: int32
          type: integer
        singleStep:
          type: boolean
        universeName:
          type: string
        universeUUID:
          format: uuid
          type: string
        zoneCode:
          type: string
        zoneName:
          type: string
      required:
      - cloudName
      - cloudProviderType
      - currentState
      - instanceType
      - masterAddresses
      - providerType
      - regionCode
      - regionName
      - replicationFactor
      - singleStep
      - universeName
      - universeUUID
      - zoneCode
      - zoneName
      type: object
    ImportUniverseFormData_3:
      example:
        singleStep: true
        replicationFactor: 0
        instanceType: instanceType
        regionName: regionName
        providerType: unknown
        masterAddresses: masterAddresses
        universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        regionCode: regionCode
        cloudName: cloudName
        cloudProviderType: cloudProviderType
        zoneName: zoneName
        currentState: BEGIN
        universeName: universeName
        zoneCode: zoneCode
      properties:
        cloudName:
          type: string
          example: example-cloudName
        cloudProviderType:
          type: string
          example: DEFAULT
        currentState:
          enum:
          - BEGIN
          - IMPORTED_MASTERS
          - IMPORTED_TSERVERS
          - FINISHED
          type: string
          example: BEGIN
        instanceType:
          type: string
          example: DEFAULT
        masterAddresses:
          type: string
          example: example-masterAddresses
        providerType:
          enum:
          - unknown
          - aws
          - gcp
          - azu
          - docker
          - onprem
          - kubernetes
          - local
          - other
          type: string
          example: unknown
        regionCode:
          type: string
          example: us-east-1
        regionName:
          type: string
          example: us-east-1
        replicationFactor:
          format: int32
          type: integer
          example: 100
        singleStep:
          type: boolean
          example: true
        universeName:
          type: string
          example: example-universeName
        universeUUID:
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        zoneCode:
          type: string
          example: us-east-1a
        zoneName:
          type: string
          example: us-east-1a
      required:
      - cloudName
      - cloudProviderType
      - currentState
      - instanceType
      - masterAddresses
      - providerType
      - regionCode
      - regionName
      - replicationFactor
      - singleStep
      - universeName
      - universeUUID
      - zoneCode
      - zoneName
      type: object
    ImportUniverseFormData_4:
      example:
        singleStep: true
        replicationFactor: 0
        instanceType: instanceType
        regionName: regionName
        providerType: unknown
        masterAddresses: masterAddresses
        universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        regionCode: regionCode
        cloudName: cloudName
        cloudProviderType: cloudProviderType
        zoneName: zoneName
        currentState: BEGIN
        universeName: universeName
        zoneCode: zoneCode
      properties:
        cloudName:
          type: string
          example: example-cloudName
        cloudProviderType:
          type: string
          example: DEFAULT
        currentState:
          enum:
          - BEGIN
          - IMPORTED_MASTERS
          - IMPORTED_TSERVERS
          - FINISHED
          type: string
          example: BEGIN
        instanceType:
          type: string
          example: DEFAULT
        masterAddresses:
          type: string
          example: example-masterAddresses
        providerType:
          enum:
          - unknown
          - aws
          - gcp
          - azu
          - docker
          - onprem
          - kubernetes
          - local
          - other
          type: string
          example: unknown
        regionCode:
          type: string
          example: us-east-1
        regionName:
          type: string
          example: us-east-1
        replicationFactor:
          format: int32
          type: integer
          example: 100
        singleStep:
          type: boolean
          example: true
        universeName:
          type: string
          example: example-universeName
        universeUUID:
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        zoneCode:
          type: string
          example: us-east-1a
        zoneName:
          type: string
          example: us-east-1a
      required:
      - cloudName
      - cloudProviderType
      - currentState
      - instanceType
      - masterAddresses
      - providerType
      - regionCode
      - regionName
      - replicationFactor
      - singleStep
      - universeName
      - universeUUID
      - zoneCode
      - zoneName
      type: object
  securitySchemes:
    apiKeyAuth:
      description: API token passed as header
      in: header
      name: X-AUTH-YW-API-TOKEN
      type: apiKey
externalDocs:
  description: About YugabyteDB Anywhere
  url: https://docs.yugabyte.com/latest/yugabyte-platform/
x-refined-from:
- openapi_2.yaml
- platform.swagger.json
- yugabytedb-anywhere-v1-full.yaml
- yugabytedb-anywhere-v1-universes.yaml