Oracle Database PDB Snapshots API

PDB snapshot carousel management

Operations 7

GET /database/snapshots/ Oracle Database Get all PDB snapshots #
POST /database/snapshots/ Oracle Database Create a PDB snapshot #
PUT /database/snapshots/ Oracle Database Configure automatic snapshots #
GET /database/snapshots/{snapshot_name} Oracle Database Get a specific snapshot #
POST /database/snapshots/{snapshot_name} Oracle Database Create a named PDB snapshot #
DELETE /database/snapshots/{snapshot_name} Oracle Database Delete a PDB snapshot #
GET /database/snapshot_mode Oracle Database Get snapshot mode #

Documentation

Specifications

Schemas & Data

Other Resources

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-pdb-snapshots-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.

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

OpenAPI Specification

oracle-database-pdb-snapshots-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Oracle Database Oracle REST Data Services (ORDS) PDB Snapshots 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: PDB Snapshots
  description: PDB snapshot carousel management
paths:
  /database/snapshots/:
    get:
      operationId: getSnapshots
      summary: Oracle Database Get all PDB snapshots
      description: Returns a list of all PDB snapshots.
      tags:
      - PDB Snapshots
      responses:
        '200':
          description: Snapshots retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotList'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createSnapshot
      summary: Oracle Database Create a PDB snapshot
      description: Creates a new snapshot of the current pluggable database state.
      tags:
      - PDB Snapshots
      responses:
        '201':
          description: Snapshot created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snapshot'
        '401':
          $ref: '#/components/responses/Unauthorized'
    put:
      operationId: configureAutoSnapshots
      summary: Oracle Database Configure automatic snapshots
      description: Configures automatic snapshot scheduling for the PDB.
      tags:
      - PDB Snapshots
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutoSnapshotConfig'
      responses:
        '200':
          description: Auto snapshot configuration updated successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/snapshots/{snapshot_name}:
    get:
      operationId: getSnapshot
      summary: Oracle Database Get a specific snapshot
      description: Returns details about a specific PDB snapshot.
      tags:
      - PDB Snapshots
      parameters:
      - name: snapshot_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Snapshot details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snapshot'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: createNamedSnapshot
      summary: Oracle Database Create a named PDB snapshot
      description: Creates a new snapshot with the specified name.
      tags:
      - PDB Snapshots
      parameters:
      - name: snapshot_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Named snapshot created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Snapshot'
        '401':
          $ref: '#/components/responses/Unauthorized'
    delete:
      operationId: deleteSnapshot
      summary: Oracle Database Delete a PDB snapshot
      description: Deletes the specified PDB snapshot.
      tags:
      - PDB Snapshots
      parameters:
      - name: snapshot_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Snapshot deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /database/snapshot_mode:
    get:
      operationId: getSnapshotMode
      summary: Oracle Database Get snapshot mode
      description: Returns the current snapshot mode configuration.
      tags:
      - PDB Snapshots
      responses:
        '200':
          description: Snapshot mode retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotMode'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        type:
          type: string
    AutoSnapshotConfig:
      type: object
      properties:
        auto_snapshot_enabled:
          type: boolean
        snapshot_interval_minutes:
          type: integer
        max_snapshots:
          type: integer
    SnapshotMode:
      type: object
      properties:
        snapshot_mode:
          type: string
    SnapshotList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Snapshot'
    Snapshot:
      type: object
      properties:
        snapshot_name:
          type: string
        snapshot_scn:
          type: integer
          format: int64
        creation_time:
          type: string
          format: date-time
        pdb_name:
          type: string
  responses:
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  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/