Oracle Database Data Pump API

High-speed data and metadata export/import operations

Operations 5

POST /database/datapump/export Oracle Database Create a Data Pump export job #
POST /database/datapump/import Oracle Database Create a Data Pump import job #
GET /database/datapump/jobs/ Oracle Database Get all Data Pump jobs #
GET /database/datapump/jobs/{owner_name},{job_name}/ Oracle Database Get a specific Data Pump job #
GET /database/datapump/jobs/{owner_name},{job_name}/{filename} Oracle Database Get a Data Pump job file #

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-data-pump-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-data-pump-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Oracle Database Oracle REST Data Services (ORDS) Data Pump 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: Data Pump
  description: High-speed data and metadata export/import operations
paths:
  /database/datapump/export:
    post:
      operationId: createExportJob
      summary: Oracle Database Create a Data Pump export job
      description: Creates a new Data Pump export job for data and metadata extraction.
      tags:
      - Data Pump
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataPumpExportRequest'
      responses:
        '201':
          description: Export job created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPumpJob'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/datapump/import:
    post:
      operationId: createImportJob
      summary: Oracle Database Create a Data Pump import job
      description: Creates a new Data Pump import job for data and metadata loading.
      tags:
      - Data Pump
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataPumpImportRequest'
      responses:
        '201':
          description: Import job created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPumpJob'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/datapump/jobs/:
    get:
      operationId: getDataPumpJobs
      summary: Oracle Database Get all Data Pump jobs
      description: Returns a list of all Data Pump jobs.
      tags:
      - Data Pump
      responses:
        '200':
          description: Jobs retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPumpJobList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /database/datapump/jobs/{owner_name},{job_name}/:
    get:
      operationId: getDataPumpJob
      summary: Oracle Database Get a specific Data Pump job
      description: Returns details about a specific Data Pump job.
      tags:
      - Data Pump
      parameters:
      - name: owner_name
        in: path
        required: true
        schema:
          type: string
      - name: job_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Job details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPumpJob'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /database/datapump/jobs/{owner_name},{job_name}/{filename}:
    get:
      operationId: getDataPumpJobFile
      summary: Oracle Database Get a Data Pump job file
      description: Returns the contents of a specific Data Pump job output file.
      tags:
      - Data Pump
      parameters:
      - name: owner_name
        in: path
        required: true
        schema:
          type: string
      - name: job_name
        in: path
        required: true
        schema:
          type: string
      - name: filename
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: File contents retrieved successfully
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    DataPumpImportRequest:
      type: object
      required:
      - job_name
      properties:
        job_name:
          type: string
        directory:
          type: string
        dumpfile:
          type: string
        schemas:
          type: array
          items:
            type: string
        remap_schema:
          type: string
    Error:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        type:
          type: string
    DataPumpJob:
      type: object
      properties:
        owner_name:
          type: string
        job_name:
          type: string
        operation:
          type: string
        job_mode:
          type: string
        state:
          type: string
        degree:
          type: integer
        attached_sessions:
          type: integer
    DataPumpExportRequest:
      type: object
      required:
      - job_name
      properties:
        job_name:
          type: string
        schemas:
          type: array
          items:
            type: string
        tables:
          type: array
          items:
            type: string
        directory:
          type: string
        dumpfile:
          type: string
        logfile:
          type: string
    DataPumpJobList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DataPumpJob'
  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'
    BadRequest:
      description: Bad request - invalid parameters or request body
      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/