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 parameter type: string isVisualBuilderEnabled: default: true description: Visual Builder is enabled or not. type: boolean nodeCount: default: 2 description: The number of Nodes type: integer required: - displayName - compartmentId - nodeCount type: object VbInstanceSummaryCollection: description: Result of a VbInstance Summary request. Contains VbInstanceSummary items. properties: items: description: The collection of VbInstanceSummary objects. items: $ref: '#/components/schemas/VbInstanceSummary' type: array required: - items type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - STOPPED - STARTED - DELETED - IN_PROGRESS type: string entityType: description: The resource type the work request is affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata. type: string identifier: description: The identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier WorkRequestSummaryCollection: description: Result of a WorkRequest Summary request. Contains WorkRequestSummary items. properties: items: description: The collection of WorkRequestSummary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object ApplicationSummaryCollection: description: Result of listing VbInstance's applications. Contains ApplicationSummary items. properties: items: description: The collection of ApplicationSummary objects. items: $ref: '#/components/schemas/ApplicationSummary' type: array required: - items type: object WorkRequestErrorCollection: description: Result of a WorkRequest Error request. Contains list of WorkRequestError items. properties: items: description: List of objects containing errors related to a specific work request.. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object UpdateCustomEndpointDetails: 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 WorkRequestSummary: description: A description of work request status. properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request. enum: - CREATE_VB_INSTANCE - UPDATE_VB_INSTANCE - STOP_VB_INSTANCE - START_VB_INSTANCE - DELETE_VB_INSTANCE type: string percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted WorkRequestError: description: Errors related to a specific work request. properties: code: description: A short error code that defines the error, meant for programmatic parsing example: UnknownError type: string message: description: A human-readable error string. example: error validating payload type: string timestamp: description: The date and time the error occurred. example: '2017-07-21T16:11:29Z' format: date-time type: string required: - code - message - timestamp type: object VbInstanceSummary: description: Summary of the Vb Instance. properties: alternateCustomEndpoints: description: 'A list of alternate custom endpoints used for the vb instance URL. ' items: $ref: '#/components/schemas/CustomEndpointDetails' type: array compartmentId: description: Compartment Identifier. type: string consumptionModel: description: The entitlement used for billing purposes. enum: - UCM - GOV - VB4SAAS type: string customEndpoint: $ref: '#/components/schemas/CustomEndpointDetails' 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: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Vb Instance Identifier, can be renamed. 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 id: description: Unique identifier that is immutable on creation. type: string instanceUrl: description: The Vb Instance URL. type: string isVisualBuilderEnabled: description: Visual Builder is enabled or not. type: boolean lifecycleState: description: The current state of the Vb Instance. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string nodeCount: description: The number of Nodes type: integer stateMessage: description: An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the Vb Instance was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the VbInstance was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - displayName - compartmentId - instanceUrl - nodeCount - lifecycleState type: object WorkRequestLogEntry: description: Log entries related to a specific work request. properties: message: description: The description of an action that occurred. example: error validating payload type: string timestamp: description: The date and time the log entry occurred. example: '2017-07-21T16:11:29Z' format: date-time type: string required: - message - timestamp type: object WorkRequestLogEntryCollection: description: Result of a WorkRequest Log request. Contains list of WorkRequestLog items. properties: items: description: List of objects containing logs related to a specific work request.. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object VbInstance: description: Description of Vb Instance. properties: alternateCustomEndpoints: description: 'A list of alternate custom endpoints used for the vb instance URL. ' items: $ref: '#/components/schemas/CustomEndpointDetails' type: array compartmentId: description: Compartment Identifier. type: string consumptionModel: description: The entitlement used for billing purposes. enum: - UCM - GOV - VB4SAAS type: string customEndpoint: $ref: '#/components/schemas/CustomEndpointDetails' 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: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Vb Instance Identifier, can be renamed. 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 id: description: Unique identifier that is immutable on creation. type: string instanceUrl: description: The Vb Instance URL. type: string isVisualBuilderEnabled: description: Visual Builder is enabled or not. type: boolean lifecycleState: description: The current state of the vb instance. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string nodeCount: description: The number of Nodes type: integer stateMessage: description: An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the VbInstance was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the VbInstance was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - displayName - compartmentId - instanceUrl - nodeCount - lifecycleState type: object WorkRequest: description: A description of work request status. properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request. enum: - CREATE_VB_INSTANCE - UPDATE_VB_INSTANCE - STOP_VB_INSTANCE - START_VB_INSTANCE - DELETE_VB_INSTANCE type: string percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted parameters: PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page schema: type: string maxLength: 1024 minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string VbInstanceIdentifierPathParam: description: Unique Vb Instance identifier. in: path name: vbInstanceId required: true schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 LifecycleStateQueryParam: description: Life cycle state to query on. in: query name: lifecycleState schema: type: string enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder schema: type: string enum: - ASC - DESC default: ASC RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 DisplayNameQueryParam: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Example: `My new resource` ' in: query name: displayName schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string VbInstanceIdentifierQueryParam: description: The Vb Instance identifier to use to filter results in: query name: vbInstanceId schema: type: string responses: default: description: Unknown Error 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 content: application/json: schema: $ref: '#/components/schemas/Error' x-oracle-package: com.oracle.vb x-properties: 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: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object 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 systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object