Oracle Database

Oracle Database Database Homes API

Manage Oracle Database Home directories

GitHub OpenAPI

Operations 4

GET /dbHomes Oracle Database List Database Homes #
POST /dbHomes Oracle Database Create a Database Home #
GET /dbHomes/{dbHomeId} Oracle Database Get a Database Home #
DELETE /dbHomes/{dbHomeId} Oracle Database Delete a Database Home #

Documentation

📖
Documentation
https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/latest/
📖
Documentation
https://docs.oracle.com/iaas/Content/Database/home.htm
📖
APIReference
https://docs.oracle.com/iaas/api/#/en/database/20160918/
📖
Documentation
https://docs.oracle.com/en/database/oracle/simple-oracle-document-access/

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-database/refs/heads/main/json-schema/oracle-database-table.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-database/refs/heads/main/json-schema/oracle-database-pluggable-database.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-database/refs/heads/main/json-schema/oracle-database-autonomous-database.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-database/refs/heads/main/json-schema/oracle-database-document.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/oracle-database/refs/heads/main/json-schema/oracle-database-collection.json

Other Resources

🔗
Swagger
https://example.oracle.com/ords/metadata-catalog/
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/oracle-database/refs/heads/main/json-ld/oracle-database-context.jsonld
🔗
SDKs
https://docs.oracle.com/iaas/Content/API/Concepts/sdks.htm
🔗
REST API
https://docs.oracle.com/en/database/oracle/simple-oracle-document-access/rest/
🔗
Java API
https://docs.oracle.com/en/database/oracle/simple-oracle-document-access/java/

Work with this as data

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

MCP server

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

https://apis.io/mcp

Tools for apis

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

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/oracle-database-database-homes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

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

Get an API key

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

GitHub Google LinkedIn

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

OpenAPI Specification

oracle-database-database-homes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Oracle Database Oracle Cloud Infrastructure Database Database Homes API
  description: API for managing Oracle Database services in Oracle Cloud Infrastructure (OCI). Provides management of DB Systems, Autonomous Databases, Exadata infrastructure, database backups, Data Guard associations, database homes, and related cloud database resources.
  version: '20160918'
  contact:
    name: Oracle Cloud Support
    url: https://support.oracle.com
    email: cloud-support@oracle.com
  license:
    name: Oracle Cloud Infrastructure Terms
    url: https://www.oracle.com/cloud/free/oci-terms.html
  termsOfService: https://www.oracle.com/legal/terms.html
servers:
- url: https://database.{region}.oraclecloud.com/20160918
  description: OCI Database Service Regional Endpoint
  variables:
    region:
      default: us-ashburn-1
      description: OCI region identifier
      enum:
      - us-ashburn-1
      - us-phoenix-1
      - eu-frankfurt-1
      - uk-london-1
      - ap-tokyo-1
      - ap-mumbai-1
      - ca-toronto-1
      - ap-sydney-1
      - sa-saopaulo-1
      - ap-seoul-1
security:
- ociSignature: []
tags:
- name: Database Homes
  description: Manage Oracle Database Home directories
paths:
  /dbHomes:
    get:
      operationId: listDbHomes
      summary: Oracle Database List Database Homes
      description: Returns a list of Database Homes in the specified compartment.
      tags:
      - Database Homes
      parameters:
      - $ref: '#/components/parameters/compartmentIdParam'
      - name: dbSystemId
        in: query
        schema:
          type: string
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/pageParam'
      responses:
        '200':
          description: Database Homes listed successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DbHomeSummary'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createDbHome
      summary: Oracle Database Create a Database Home
      description: Creates a new Database Home in the specified DB System.
      tags:
      - Database Homes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDbHomeDetails'
      responses:
        '200':
          description: Database Home creation initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DbHome'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /dbHomes/{dbHomeId}:
    get:
      operationId: getDbHome
      summary: Oracle Database Get a Database Home
      description: Returns details about the specified Database Home.
      tags:
      - Database Homes
      parameters:
      - name: dbHomeId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Database Home details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DbHome'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteDbHome
      summary: Oracle Database Delete a Database Home
      description: Deletes the specified Database Home.
      tags:
      - Database Homes
      parameters:
      - name: dbHomeId
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ifMatchParam'
      responses:
        '202':
          description: Deletion accepted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    DbHome:
      type: object
      properties:
        id:
          type: string
        compartmentId:
          type: string
        displayName:
          type: string
        dbSystemId:
          type: string
        dbVersion:
          type: string
        lifecycleState:
          type: string
        timeCreated:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    CreateDatabaseDetails:
      type: object
      required:
      - dbHomeId
      - dbName
      - adminPassword
      properties:
        dbHomeId:
          type: string
        dbName:
          type: string
        adminPassword:
          type: string
          format: password
        characterSet:
          type: string
        ncharacterSet:
          type: string
        pdbName:
          type: string
    DbHomeSummary:
      type: object
      properties:
        id:
          type: string
        compartmentId:
          type: string
        displayName:
          type: string
        dbVersion:
          type: string
        lifecycleState:
          type: string
    CreateDbHomeDetails:
      type: object
      required:
      - dbVersion
      properties:
        dbVersion:
          type: string
        displayName:
          type: string
        database:
          $ref: '#/components/schemas/CreateDatabaseDetails'
  parameters:
    compartmentIdParam:
      name: compartmentId
      in: query
      required: true
      description: The OCID of the compartment
      schema:
        type: string
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        minimum: 1
        maximum: 1000
    pageParam:
      name: page
      in: query
      description: Pagination token from a previous response
      schema:
        type: string
    ifMatchParam:
      name: if-match
      in: header
      description: ETag value for optimistic concurrency control
      schema:
        type: string
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI request signature authentication using API signing keys
externalDocs:
  description: OCI Database Service API Documentation
  url: https://docs.oracle.com/iaas/api/#/en/database/20160918/