Oracle Database

Oracle Database General API

Core database instance status, version, and configuration services

Documentation GitHub OpenAPI

Operations 14

GET /database/status Oracle Database Get database status #

GET /database/version Oracle Database Get database version #

GET /database/components/ Oracle Database Get all database components #

GET /database/parameters/ Oracle Database Get all database parameters #

GET /database/parameters/{name} Oracle Database Get a specific database parameter #

GET /database/security/users/ Oracle Database Get all database users #

GET /database/storage/bytes Oracle Database Get storage usage in bytes #

GET /database/storage/tablespaces/ Oracle Database Get all tablespaces storage information #

GET /database/storage/tablespaces/{tablespace_name}/ Oracle Database Get tablespace details #

GET /database/storage/tablespaces/{tablespace_name}/datafiles/ Oracle Database Get tablespace datafiles #

GET /database/feature_usage/ Oracle Database Get feature usage statistics #

POST /database/sessionless-transactions/ Oracle Database Start a sessionless transaction #

PUT /database/sessionless-transactions/{sessionlessTransactionID} Oracle Database Commit a sessionless transaction #

DELETE /database/sessionless-transactions/{sessionlessTransactionID} Oracle Database Rollback a sessionless transaction #

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-general-api"

All apis

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

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

Get an API key

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

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Oracle Database Oracle REST Data Services (ORDS) General API
  description: RESTful API for Oracle Database management, monitoring, and data access through Oracle REST Data Services. Provides 300+ endpoints across 17 categories including database administration, performance monitoring, Data Guard management, Data Pump operations, pluggable database lifecycle, APEX management, RDF graph operations, and transactional event queues.
  version: 25.4.0
  contact:
    name: Oracle Support
    url: https://support.oracle.com
    email: support@oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/downloads/licenses/standard-license.html
  termsOfService: https://www.oracle.com/legal/terms.html
servers:
- url: https://{host}:{port}/ords
  description: ORDS Server
  variables:
    host:
      default: localhost
      description: ORDS server hostname
    port:
      default: '8443'
      description: ORDS server port
security:
- oauth2: []
- basicAuth: []
tags:
- name: General
  description: Core database instance status, version, and configuration services
paths:
  /database/status:
    get:
      operationId: getDatabaseStatus
      summary: Oracle Database Get database status
      description: Returns the current status of the Oracle Database instance.
      tags:
      - General
      responses:
        '200':
          description: Database status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/version:
    get:
      operationId: getDatabaseVersion
      summary: Oracle Database Get database version
      description: Returns the version information of the Oracle Database instance.
      tags:
      - General
      responses:
        '200':
          description: Database version retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseVersion'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/components/:
    get:
      operationId: getDatabaseComponents
      summary: Oracle Database Get all database components
      description: Returns a list of all installed database components and their status.
      tags:
      - General
      responses:
        '200':
          description: Components retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/parameters/:
    get:
      operationId: getDatabaseParameters
      summary: Oracle Database Get all database parameters
      description: Returns all database initialization parameters and their current values.
      tags:
      - General
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          description: Parameters retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParameterList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/parameters/{name}:
    get:
      operationId: getDatabaseParameter
      summary: Oracle Database Get a specific database parameter
      description: Returns the value and metadata for a specific database parameter.
      tags:
      - General
      parameters:
      - name: name
        in: path
        required: true
        description: The name of the database parameter
        schema:
          type: string
      responses:
        '200':
          description: Parameter retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseParameter'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /database/security/users/:
    get:
      operationId: getDatabaseUsers
      summary: Oracle Database Get all database users
      description: Returns a list of all database users and their properties.
      tags:
      - General
      responses:
        '200':
          description: Users retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/storage/bytes:
    get:
      operationId: getStorageBytes
      summary: Oracle Database Get storage usage in bytes
      description: Returns the total storage usage of the database in bytes.
      tags:
      - General
      responses:
        '200':
          description: Storage information retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorageInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/storage/tablespaces/:
    get:
      operationId: getTablespaces
      summary: Oracle Database Get all tablespaces storage information
      description: Returns storage information for all tablespaces.
      tags:
      - General
      responses:
        '200':
          description: Tablespace storage information retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TablespaceList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/storage/tablespaces/{tablespace_name}/:
    get:
      operationId: getTablespace
      summary: Oracle Database Get tablespace details
      description: Returns detailed storage information for a specific tablespace.
      tags:
      - General
      parameters:
      - name: tablespace_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Tablespace details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tablespace'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /database/storage/tablespaces/{tablespace_name}/datafiles/:
    get:
      operationId: getDatafiles
      summary: Oracle Database Get tablespace datafiles
      description: Returns datafiles associated with a specific tablespace.
      tags:
      - General
      parameters:
      - name: tablespace_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Datafiles retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatafileList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/feature_usage/:
    get:
      operationId: getFeatureUsage
      summary: Oracle Database Get feature usage statistics
      description: Returns usage statistics for database features.
      tags:
      - General
      responses:
        '200':
          description: Feature usage retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureUsageList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/sessionless-transactions/:
    post:
      operationId: startSessionlessTransaction
      summary: Oracle Database Start a sessionless transaction
      description: Starts a new sessionless transaction and returns its identifier.
      tags:
      - General
      responses:
        '201':
          description: Transaction started successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionlessTransaction'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/sessionless-transactions/{sessionlessTransactionID}:
    put:
      operationId: commitSessionlessTransaction
      summary: Oracle Database Commit a sessionless transaction
      description: Commits the specified sessionless transaction.
      tags:
      - General
      parameters:
      - name: sessionlessTransactionID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Transaction committed successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: rollbackSessionlessTransaction
      summary: Oracle Database Rollback a sessionless transaction
      description: Rolls back the specified sessionless transaction.
      tags:
      - General
      parameters:
      - name: sessionlessTransactionID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Transaction rolled back successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        type:
          type: string
    Tablespace:
      type: object
      properties:
        tablespace_name:
          type: string
        status:
          type: string
        contents:
          type: string
        block_size:
          type: integer
        allocated_bytes:
          type: integer
          format: int64
        used_bytes:
          type: integer
          format: int64
        free_bytes:
          type: integer
          format: int64
    StorageInfo:
      type: object
      properties:
        total_bytes:
          type: integer
          format: int64
        used_bytes:
          type: integer
          format: int64
        free_bytes:
          type: integer
          format: int64
    ParameterList:
      allOf:
      - $ref: '#/components/schemas/PaginatedResponse'
      - type: object
        properties:
          items:
            type: array
            items:
              $ref: '#/components/schemas/DatabaseParameter'
    TablespaceList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Tablespace'
    UserList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              username:
                type: string
              account_status:
                type: string
              default_tablespace:
                type: string
              created:
                type: string
                format: date-time
    Link:
      type: object
      properties:
        rel:
          type: string
        href:
          type: string
          format: uri
    FeatureUsageList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              currently_used:
                type: boolean
              first_usage_date:
                type: string
                format: date-time
              last_usage_date:
                type: string
                format: date-time
    SessionlessTransaction:
      type: object
      properties:
        sessionlessTransactionID:
          type: string
    PaginatedResponse:
      type: object
      properties:
        items:
          type: array
          items: {}
        hasMore:
          type: boolean
        limit:
          type: integer
        offset:
          type: integer
        count:
          type: integer
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    DatabaseStatus:
      type: object
      properties:
        status:
          type: string
          enum:
          - OPEN
          - MOUNTED
          - STARTED
        instance_name:
          type: string
        host_name:
          type: string
        database_role:
          type: string
        open_mode:
          type: string
    ComponentList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              comp_id:
                type: string
              comp_name:
                type: string
              version:
                type: string
              status:
                type: string
    DatafileList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              file_name:
                type: string
              file_id:
                type: integer
              tablespace_name:
                type: string
              bytes:
                type: integer
                format: int64
              status:
                type: string
    DatabaseVersion:
      type: object
      properties:
        version:
          type: string
        version_full:
          type: string
        banner:
          type: string
    DatabaseParameter:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
        display_value:
          type: string
        isdefault:
          type: string
        ismodified:
          type: string
        type:
          type: string
        description:
          type: string
  responses:
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        minimum: 1
        default: 25
    offsetParam:
      name: offset
      in: query
      description: Number of items to skip before returning results
      schema:
        type: integer
        minimum: 0
        default: 0
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /ords/{schema}/oauth/token
          scopes: {}
        authorizationCode:
          authorizationUrl: /ords/{schema}/oauth/auth
          tokenUrl: /ords/{schema}/oauth/token
          scopes: {}
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: ORDS REST API Documentation
  url: https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/25.4/orrst/

Oracle Database General API

Operations 14

Documentation

Specifications

Schemas & Data

Other Resources