How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Vb Instance API

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

Oracle Vb Instance API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include vbInstance. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 13 operations across 10 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 20210601.

Requests are made against a single base URL, https://127.0.0.1/20210601.

13 operations 10 paths 21 schemas 1 DELETE6 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20210601
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 1 DELETE, 6 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

vbInstance 13
GET
/vbInstances
Gets a list of all Vb Instances in a compartment
ListVbInstances 8 params → 200400401404429500default
POST
/vbInstances
Creates a new Vb Instance
CreateVbInstance 2 params body → 202400401404409429500default
DELETE
/vbInstances/{vbInstanceId}
Delete a provisioned Vb Instance
DeleteVbInstance 3 params → 202400401404412429500default
GET
/vbInstances/{vbInstanceId}
Get Vb Instance
GetVbInstance 2 params → 200400401404429500default
PUT
/vbInstances/{vbInstanceId}
Update the Vb Instance identified by the id
UpdateVbInstance 3 params body → 202400401404412429500default
POST
/vbInstances/{vbInstanceId}/actions/applications
Summarizes the applications for a vb instance
RequestSummarizedApplications 4 params body → 200400401404409412429500
POST
/vbInstances/{vbInstanceId}/actions/changeCompartment
Change the compartment for an vb instance
ChangeVbInstanceCompartment 4 params body → 202400401404409412429500
POST
/vbInstances/{vbInstanceId}/actions/start
Start an vb instance that was previously in an INACTIVE state
StartVbInstance 4 params → 202400401404409412429500
POST
/vbInstances/{vbInstanceId}/actions/stop
Stop an vb instance that was previously in an ACTIVE state
StopVbInstance 4 params → 202400401404409412429500
GET
/workRequests
List Work Requests
ListWorkRequests 5 params → 200400401404429500default
GET
/workRequests/{workRequestId}
Get Work Request Status
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
Get work request errors.
ListWorkRequestErrors 5 params → 200401404429500default
GET
/workRequests/{workRequestId}/logs
Get work request logs.
ListWorkRequestLogs 5 params → 200401404429500default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are VbInstance (16 properties), VbInstanceSummary (16 properties), CreateVbInstanceDetails (10 properties), WorkRequestSummary (9 properties). Each schema is shown below with its type and property counts.

WorkRequestErrorCollection
object
Result of a WorkRequest Error request. Contains list of WorkRequestError items.
1 property 1 required
WorkRequestError
object
Errors related to a specific work request.
3 properties 3 required
VbInstance
object
Description of Vb Instance.
16 properties 6 required
WorkRequestSummary
object
A description of work request status.
9 properties 7 required
WorkRequest
object
A description of work request status.
9 properties 7 required
WorkRequestLogEntryCollection
object
Result of a WorkRequest Log request. Contains list of WorkRequestLog items.
1 property 1 required
CreateCustomEndpointDetails
object
Details for a custom endpoint for the vb instance (update).
2 properties 1 required
UpdateCustomEndpointDetails
object
Details for a custom endpoint for the vb instance (update).
2 properties 1 required
ChangeVbInstanceCompartmentDetails
object
Compartment the VbInstance will be moved to
1 property 1 required
ApplicationSummaryCollection
object
Result of listing VbInstance's applications. Contains ApplicationSummary items.
1 property 1 required
RequestSummarizedApplicationsDetails
object
The information to summarize the applications.
1 property
Error
object
Error Information.
2 properties 2 required
CustomEndpointDetails
object
Details for a custom endpoint for the vb instance.
3 properties 1 required
UpdateVbInstanceDetails
object
Information about updating a VbInstance.
8 properties
CreateVbInstanceDetails
object
The information about new VbInstance.
10 properties 3 required
WorkRequestLogEntry
object
Log entries related to a specific work request.
2 properties 2 required
WorkRequestSummaryCollection
object
Result of a WorkRequest Summary request. Contains WorkRequestSummary items.
1 property 1 required
VbInstanceSummaryCollection
object
Result of a VbInstance Summary request. Contains VbInstanceSummary items.
1 property 1 required
VbInstanceSummary
object
Summary of the Vb Instance.
16 properties 6 required
WorkRequestResource
object
A resource created or operated on by a work request.
4 properties 3 required
ApplicationSummary
object
Summary of the Vb Instance's applications.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-vbinstance-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Vb Instance API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.