Oracle

Oracle Vb Instance API

The vbInstance API from Oracle — 10 operation(s) for vbinstance.

GitHub OpenAPI

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-vbinstance-api-openapi.yml

OpenAPI Specification

oracle-vbinstance-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'Oracle Visual Builder enables developers to quickly build web and mobile applications. With a visual development environment that makes it easy to connect to Oracle data and third-party REST services, developers can build modern, consumer-grade applications in a fraction of the time it would take in other tools.

    The Visual Builder Instance Management API allows users to create and manage a Visual Builder instance.

    '
  title: Visual Builder Vb Instance API
  version: '20210601'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/c14601888837a0732ce02b8ad7b1fd941cab60ec5a1de80323783260478bd597.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Visual Builder API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/c14601888837a0732ce02b8ad7b1fd941cab60ec5a1de80323783260478bd597.yaml
    what: the harvested document for Visual Builder API
servers:
- url: https://127.0.0.1/20210601
tags:
- name: vbInstance
paths:
  /vbInstances:
    get:
      description: 'Returns a list of Vb Instances.

        '
      operationId: ListVbInstances
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: An object containing a list of VbInstanceSummary objects.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain

                '
              schema:
                type: string
            opc-previous-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results have been previously returned

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VbInstanceSummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all Vb Instances in a compartment
      tags:
      - vbInstance
      x-obmcs-client-retries-enabled: true
    post:
      description: 'Creates a new Vb Instance.

        '
      operationId: CreateVbInstance
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Vb Instance will be created.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request.

                You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new Vb Instance
      tags:
      - vbInstance
      x-related-resource: '#/definitions/VbInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVbInstanceDetails'
        description: Details for the new Vb Instance.
        required: true
  /vbInstances/{vbInstanceId}:
    delete:
      description: Deletes an Vb Instance resource by identifier.
      operationId: DeleteVbInstance
      parameters:
      - $ref: '#/components/parameters/VbInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Vb Instance will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request.

                You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a provisioned Vb Instance
      tags:
      - vbInstance
      x-related-resource: '#/definitions/VbInstance'
    get:
      description: Gets a VbInstance by identifier
      operationId: GetVbInstance
      parameters:
      - $ref: '#/components/parameters/VbInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the VbInstance with the given id
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VbInstance'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get Vb Instance
      tags:
      - vbInstance
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates the Vb Instance.
      operationId: UpdateVbInstance
      parameters:
      - $ref: '#/components/parameters/VbInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The VbInstance will be updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request.

                You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the Vb Instance identified by the id
      tags:
      - vbInstance
      x-related-resource: '#/definitions/VbInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVbInstanceDetails'
        description: The information to be updated.
        required: true
  /vbInstances/{vbInstanceId}/actions/applications:
    post:
      description: Summarizes the applications for a vb instance.
      operationId: RequestSummarizedApplications
      parameters:
      - $ref: '#/components/parameters/VbInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: An object containing a list of ApplicationSummary objects.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Summarizes the applications for a vb instance
      tags:
      - vbInstance
      x-related-resource: '#/definitions/ApplicationSummaryCollection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestSummarizedApplicationsDetails'
        description: The parameter holding information to request the summarized applications for a Vb instance
        required: true
  /vbInstances/{vbInstanceId}/actions/changeCompartment:
    post:
      description: 'Change the compartment for an vb instance

        '
      operationId: ChangeVbInstanceCompartment
      parameters:
      - $ref: '#/components/parameters/VbInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The Vb instance will be moved.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request.

                You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Change the compartment for an vb instance
      tags:
      - vbInstance
      x-related-resource: '#/definitions/VbInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeVbInstanceCompartmentDetails'
        description: Details for the update vb instance
        required: true
  /vbInstances/{vbInstanceId}/actions/start:
    post:
      description: 'Start an vb instance that was previously in an INACTIVE state. If the previous state is not

        INACTIVE, then the state of the vbInstance will not be changed and a 409 response returned.

        '
      operationId: StartVbInstance
      parameters:
      - $ref: '#/components/parameters/VbInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The Vb instance will be started.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request.

                You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Start an vb instance that was previously in an INACTIVE state
      tags:
      - vbInstance
      x-related-resource: '#/definitions/VbInstance'
  /vbInstances/{vbInstanceId}/actions/stop:
    post:
      description: 'Stop an vb instance that was previously in an ACTIVE state. If the previous state is not

        ACTIVE, then the state of the vbInstance will not be changed and a 409 response returned.

        '
      operationId: StopVbInstance
      parameters:
      - $ref: '#/components/parameters/VbInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The Vb instance will be stopped.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request.

                You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Stop an vb instance that was previously in an ACTIVE state
      tags:
      - vbInstance
      x-related-resource: '#/definitions/VbInstance'
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/VbInstanceIdentifierQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain

                '
              schema:
                type: string
            opc-previous-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results have been previously returned

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestSummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List Work Requests
      tags:
      - vbInstance
      x-obmcs-client-retries-enabled: true
  /workRequests/{workRequestId}:
    get:
      description: Gets the status of the work request with the given ID.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The detail of the work request.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
            retry-after:
              description: some decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: number
                format: float
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get Work Request Status
      tags:
      - vbInstance
      x-obmcs-client-retries-enabled: true
  /workRequests/{workRequestId}/errors:
    get:
      description: Get the errors of a work request.
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      responses:
        200:
          description: The list of errors for the work request.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain

                '
              schema:
                type: string
            opc-previous-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results have been previously returned

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestErrorCollection'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get work request errors.
      tags:
      - vbInstance
      x-obmcs-client-retries-enabled: true
  /workRequests/{workRequestId}/logs:
    get:
      description: Get the logs of a work request.
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      responses:
        200:
          description: The list of logs for the work request.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain

                '
              schema:
                type: string
            opc-previous-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results have been previously returned

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestLogEntryCollection'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get work request logs.
      tags:
      - vbInstance
      x-obmcs-client-retries-enabled: true
components:
  schemas:
    CustomEndpointDetails:
      description: Details for a custom endpoint for the vb instance.
      properties:
        certificateSecretId:
          description: 'Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.

            '
          type: string
        certificateSecretVersion:
          description: 'The secret version used for the certificate-secret-id (if certificate-secret-id is specified).

            '
          type: integer
        hostname:
          description: A custom hostname to be used for the vb instance URL, in FQDN format.
          type: string
      required:
      - hostname
      type: object
    UpdateVbInstanceDetails:
      description: Information about updating a VbInstance.
      properties:
        alternateCustomEndpoints:
          description: 'A list of alternate custom endpoints to be used for the vb instance URL

            (contact Oracle for alternateCustomEndpoints availability for a specific instance).

            '
          items:
            $ref: '#/components/schemas/UpdateCustomEndpointDetails'
          type: array
        customEndpoint:
          $ref: '#/components/schemas/UpdateCustomEndpointDetails'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are

                supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped

              to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of predefined tag keys. These predefined keys are scoped to

            namespaces.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        displayName:
          description: Vb Instance Identifier.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name,

            type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        idcsOpenId:
          description: Encrypted IDCS Open ID token. This is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter
          type: string
        isVisualBuilderEnabled:
          default: true
          description: Enable Visual Builder. If Visual Builder is enabled alredy, then it cannot be disabled.
          type: boolean
        nodeCount:
          default: 2
          description: The number of Nodes
          type: integer
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    ChangeVbInstanceCompartmentDetails:
      description: Compartment the VbInstance will be moved to
      properties:
        compartmentId:
          description: Compartment Identifier.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    ApplicationSummary:
      description: Summary of the Vb Instance's applications.
      properties:
        id:
          description: Unique identifier of the application.
          type: string
        projectId:
          description: Project identifier.
          type: string
        state:
          description: Represents the deployment state of the application.
          enum:
          - STAGE
          - LIVE
          type: string
        version:
          description: Version of deployed application.
          type: string
      required:
      - id
      - projectId
      - version
      - state
      type: object
    RequestSummarizedApplicationsDetails:
      description: The information to summarize the applications.
      properties:
        idcsOpenId:
          description: Encrypted IDCS Open ID token. This is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required parameter
          type: string
      type: object
    CreateCustomEndpointDetails:
      description: Details for a custom endpoint for the vb instance (update).
      properties:
        certificateSecretId:
          description: 'Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname.

            All certificates should be stored in a single base64 encoded secret

            Note the update will fail if this is not a valid certificate.

            '
          type: string
        hostname:
          description: A custom hostname to be used for the vb instance URL, in FQDN format.
          type: string
      required:
      - hostname
      type: object
    CreateVbInstanceDetails:
      description: The information about new VbInstance.
      properties:
        alternateCustomEndpoints:
          description: 'A list of alternate custom endpoints to be used for the vb instance URL

            (contact Oracle for alternateCustomEndpoints availability for a specific instance).

            '
          items:
            $ref: '#/components/schemas/CreateCustomEndpointDetails'
          type: array
        compartmentId:
          description: Compartment Identifier.
          maxLength: 255
          minLength: 1
          type: string
        consumptionModel:
          description: Optional parameter specifying which entitlement to use for billing purposes. Only required if the account possesses more than one entitlement.
          enum:
          - UCM
          - GOV
          - VB4SAAS
          type: string
        customEndpoint:
          $ref: '#/components/schemas/CreateCustomEndpointDetails'
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are

                supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped

              to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of predefined tag keys. These predefined keys are scoped to

            namespaces.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        displayName:
          description: Vb Instance Identifier.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name,

            type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        idcsOpenId:
          description: Encrypted IDCS Open ID token. This is required for pre-UCPIS cloud accounts, but not UCPIS, hence not a required 

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-vbinstance-api-openapi.yml