Oracle Partitioning General API
Services related to the Oracle database instance.
Services related to the Oracle database instance.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/oracle-partitioning-general-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
description: '<p>Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API. Depending on the database version and configuration, ORDS database APIs provide services such as manage pluggable databases, export data, and review database performance.</p><p>To install and configure Oracle REST Data Services refer to the <a href=https://docs.oracle.com/pls/topic/lookup?ctx=ords-latest&id=ORDIG> Oracle® REST Data Services Installation and Configuration Guide</a>.</p>
<p>An OpenAPI V3 document that describes the available ORDS database API services can be retrieved from a running ORDS instance. The API document can be imported into compatible development tools and invoked from there. The URL to retrieve the API document depends on the your configuration. <p><p>The pattern for the API document URL is: </p>
<code>https://<server>/<context root>/<my database>/<my schema>/_/db-api/stable/<service path> </code>
<p>Where, the <code><my database></code> and <code><my schema></code> variables can be optional, depending on the ORDS configuration and the service invoked.'
version: 2026.03.26
title: Oracle REST Data Services General API
contact:
name: Oracle REST Data Services
url: https://www.oracle.com/database/technologies/appdev/rest.html
x-summary: Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API.
tags:
- name: General
description: Services related to the Oracle database instance.
paths:
/database/components/:
get:
tags:
- General
summary: Get all database components
description: Returns information about the components loaded into the database from DBA_REGISTRY view. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: All database components loaded into the database.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseComponents'
x-internal-id: database-components--get
x-filename-id: database-components-get
/database/components/{comp_id}:
get:
tags:
- General
summary: Get a database component
description: Returns information about the specified component loaded into the database from DBA_REGISTRY view. A client requires SQL Administrator role to invoke this service.
parameters:
- name: comp_id
in: path
description: Identifier of the component.
required: true
schema:
type: string
responses:
'200':
description: Information about the specified component.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseComponentsItem'
x-internal-id: database-components-{comp_id}-get
x-filename-id: database-components-comp_id-get
/database/connections/:
get:
tags:
- General
summary: Get a description of all local listeners for this database
description: Returns LOCAL LISTENER and SERVICE NAME records from GV$LISTENER_NETWORK for this database. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: All the local listeners for this database.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseConnections'
x-internal-id: database-connections--get
x-filename-id: database-connections-get
/database/connections/{host_name},{port},{service_name}:
get:
tags:
- General
summary: Get a description of a specific local listener for this database
description: Returns LOCAL LISTENER and SERVICE NAME information from GV$LISTENER_NETWORK for a specific host, port, and service combination. A client requires SQL Administrator role to invoke this service.
parameters:
- name: host_name
in: path
description: Name of the host.
required: true
schema:
type: string
- name: port
in: path
description: Port number being listened on.
required: true
schema:
type: number
- name: service_name
in: path
description: Name of the service.
required: true
schema:
type: string
responses:
'200':
description: Information on a specific listener and service.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseConnectionsItem'
x-internal-id: database-connections-{host_name},{port},{service_name}-get
x-filename-id: database-connections-host_name-port-service_name-get
/database/datapump/jobs/:
post:
tags:
- General
summary: Create a data pump job
description: Create a Data Pump job with the specified parameters and start it. Refer to Oracle Data Pump documentation for a more detailed explanation of parameters. A client requires SQL Administrator or SQL Developer role to invoke this service.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- operation
properties:
operation:
type: string
description: Specify the Data Pump job operation.
enum:
- EXPORT
- IMPORT
credential_name:
type: string
description: Specify the name of the credential, owned by the database user, to be used to import from object storage or export to object storage.
datapump_dir:
type: string
description: Specify the database directory to use.
default: DATA_PUMP_DIR
filter:
type: string
description: The filter to apply to identify database objects for export. This an export convenience for simple lists in metadata filter parameters, carried over from 19.1 implementation.
job_mode:
type: string
description: Specify the Data Pump job mode.
default: SCHEMA
enum:
- FULL
- SCHEMA
- TABLE
- TABLESPACE
file_name:
type: string
description: The file name pattern to use for Data Pump import. Required when operation is IMPORT or when credential_name is specified. For EXPORT the file_name will default to a pattern with a timestamp in the name. When credential_name is specified the file_name must be a URI format for an Oracle Object Store location.
threads:
type: integer
description: The maximum number of worker processes that can be used for the job. Set this parameter to adjust the amount of resources used for a job.
remap_schemas:
type: array
description: Used to define Remap Schema parameters for an import job. Only applicable for IMPORT.
items:
type: object
required:
- source
- target
properties:
source:
type: string
description: Source schema to remap from.
target:
type: string
description: Target schema to remap to.
name_expressions:
type: array
description: Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.
items:
type: object
required:
- expression
properties:
expression:
type: string
description: An SQL clause to be used as a Name Expression filter.
schema_expressions:
type: array
description: Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.
items:
type: object
required:
- expression
properties:
expression:
type: string
description: An SQL clause to be used as a Schema Expression filter.
tablespace_expressions:
type: array
description: Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.
items:
type: object
required:
- expression
properties:
expression:
type: string
description: An SQL clause to be used as a Tablespace Expression filter.
keep_master:
type: integer
description: The maximum number of worker processes that can be used for the job. Set this parameter to adjust the amount of resources used for a job.
default: 1
enum:
- 0
- 1
examples:
export_hr:
summary: Export the HR schema.
value:
operation: EXPORT
schema_expressions:
- expression: IN ( 'HR' )
import_hr_to_blake:
summary: Import the HR schema and map it to the BLAKE schema.
value:
operation: IMPORT
job_mode: FULL
file_name: EXPDAT%U2019-03-25-12_55_03.DMP
remap_schemas:
- source: HR
target: BLAKE
responses:
'201':
description: Details of the Data Pump job that has been successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/DataPumpJobsItem'
x-internal-id: database-datapump-jobs--post
x-filename-id: database-datapump-jobs-post
/database/feature_usage/:
get:
tags:
- General
summary: Get all feature usage statistics
description: See what features are used in the database. Returns records from DBA_FEATURE_USAGE_STATISTICS. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Feature Usage records from DBA_FEATURE_USAGE_STATISTICS.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseFeatureUsage'
x-internal-id: database-feature_usage--get
x-filename-id: database-feature_usage-get
/database/feature_usage/{dbid},{name}:
get:
tags:
- General
summary: Get usage statistic for a feature
description: Returns records from DBA_FEATURE_USAGE_STATISTICS for a specific feature. A client requires SQL Administrator role to invoke this service.
parameters:
- name: dbid
in: path
description: Database identifier as found in GV$DATABASE.
required: true
schema:
type: number
- name: name
in: path
description: Name of the feature.
required: true
schema:
type: string
responses:
'200':
description: Information on the usage statistics for a specific feature.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseFeatureUsageItem'
x-internal-id: database-feature_usage-{dbid},{name}-get
x-filename-id: database-feature_usage-dbid-name-get
/database/parameters/:
get:
tags:
- General
summary: Get all database parameters
description: Return records from GV$SYSTEM_PARAMETER. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all database parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseParameters'
x-internal-id: database-parameters--get
x-filename-id: database-parameters-get
/database/parameters/{name}:
get:
tags:
- General
summary: Get a specific database parameter
description: Returns the corresponding record from GV$SYSTEM_PARAMETER. A client requires SQL Administrator role to invoke this service.
parameters:
- name: name
in: path
description: Name of the parameter.
required: true
schema:
type: string
responses:
'200':
description: Information on a specific database parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseParametersItem'
x-internal-id: database-parameters-{name}-get
x-filename-id: database-parameters-name-get
/database/security/users/:
get:
tags:
- General
summary: Get all database users
description: Returns records from DBA_USERS or ALL_USERS view depending on the role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all users in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseUsers'
x-internal-id: database-security-users--get
x-filename-id: database-security-users-get
/database/security/users/{username}:
get:
tags:
- General
summary: Get a specific database user
description: Returns the corresponding record from DBA_USERS or ALL_USERS view depending on the role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
parameters:
- name: username
in: path
description: Identifier for the user.
required: true
schema:
type: string
responses:
'200':
description: Information on the specified user.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseUsersItem'
x-internal-id: database-security-users-{username}-get
x-filename-id: database-security-users-username-get
/database/sessionless-transactions/:
post:
tags:
- General
summary: Start a sessionless transaction
description: Start a new sessionless transaction.
responses:
'200':
description: Transaction started successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponse'
example:
gtrid: de9b1f488f4244e39580987547d63e8d
status: Start transaction
'400':
description: Sessionless transactions are not supported
x-internal-id: database-sessionless-transactions--post
x-filename-id: database-sessionless-transactions-post
/database/sessionless-transactions/{sessionlessTransactionID}:
put:
tags:
- General
summary: Commit a sessionless transaction
description: Commit a sessionless transaction with the specified ID.
parameters:
- name: sessionlessTransactionID
in: path
required: true
schema:
type: string
responses:
'200':
description: Transaction committed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponse'
example:
gtrid: de9b1f488f4244e39580987547d63e8d
status: Committed
'400':
description: Sessionless transactions are not supported or the transaction does not exist
x-internal-id: database-sessionless-transactions-{sessionlessTransactionID}-put
x-filename-id: database-sessionless-transactions-sessionlesstransactionid-put
delete:
tags:
- General
summary: Rollback a sessionless transaction
description: Rollback a sessionless transaction with the specified ID.
parameters:
- name: sessionlessTransactionID
in: path
required: true
schema:
type: string
responses:
'200':
description: Transaction rolled back successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponse'
example:
gtrid: de9b1f488f4244e39580987547d63e8d
status: Rolled Back
'400':
description: Sessionless transactions are not supported or the transaction does not exist
x-internal-id: database-sessionless-transactions-{sessionlessTransactionID}-delete
x-filename-id: database-sessionless-transactions-sessionlesstransactionid-delete
/database/status:
get:
tags:
- General
summary: Get database status
description: Returns records from GV$INSTANCE and GV$DATABASE. A client requires SQL Administrator role to invoke this service.
responses:
'200':
description: Description of the database state.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseStatusItem'
x-internal-id: database-status-get
x-filename-id: database-status-get
/database/storage/bytes:
get:
tags:
- General
summary: Get storage statistics
description: Returns info on bytes allocated for storage and how much is used. Using DBA_DATA_FILES data to calculate the total bytes allocated for storage along with DBA_TABLESPACE_USAGE_METRICS and DBA_TABLESPACES data to calculate the used bytes. A client requires SQL Administrator role to invoke this service.
responses:
'200':
description: Total bytes across all the data files and how much is used.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseStorageBytesItem'
x-internal-id: database-storage-bytes-get
x-filename-id: database-storage-bytes-get
/database/storage/tablespaces/:
get:
tags:
- General
summary: Get all tablespaces storage data
description: Returns records from DBA_TABLESPACES along with data usage information from DBA_TABLESPACE_USAGE_METRICS. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all tablespaces in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaces'
x-internal-id: database-storage-tablespaces--get
x-filename-id: database-storage-tablespaces-get
/database/storage/tablespaces/{tablespace_name}/:
get:
tags:
- General
summary: Get storage for a specific tablespace
description: Returns data from DBA_TABLESPACES along with data usage information from DBA_TABLESPACE_USAGE_METRICS for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
responses:
'200':
description: Tablespace information, including data usage, is returned. The response structure may vary depending on the database.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespacesItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}--get
x-filename-id: database-storage-tablespaces-tablespace_name-get
/database/storage/tablespaces/{tablespace_name}/datafiles_usage:
get:
tags:
- General
summary: Get data file usage summary for a specific tablespace
description: Returns GV$DATAFILE and DBA_DATA_FILES records for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
responses:
'200':
description: Tablespace data file usage.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafilesUsageItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-datafiles_usage-get
x-filename-id: database-storage-tablespaces-tablespace_name-datafiles_usage-get
/database/storage/tablespaces/{tablespace_name}/datafiles/:
get:
tags:
- General
summary: Get data files for a tablespace
description: Returns records from DBA_DATA_FILES for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all data files for a specific tablespace.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafiles'
x-internal-id: database-storage-tablespaces-{tablespace_name}-datafiles--get
x-filename-id: database-storage-tablespaces-tablespace_name-datafiles-get
/database/storage/tablespaces/{tablespace_name}/datafiles/{file_id}/:
get:
tags:
- General
summary: Get tablespace data file
description: Returns data from DBA_DATA_FILES for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- name: file_id
in: path
description: File identifier.
required: true
schema:
type: string
responses:
'200':
description: Information about the specified data file.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafilesItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-datafiles-{file_id}--get
x-filename-id: database-storage-tablespaces-tablespace_name-datafiles-file_id-get
/database/storage/tablespaces/{tablespace_name}/datafiles/{file_id}/usage:
get:
tags:
- General
summary: Get tablespace data file usage
description: Returns GV$DATAFILE and DBA_DATA_FILES records for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- name: file_id
in: path
description: File identifier.
required: true
schema:
type: string
responses:
'200':
description: Description of the space usage for the tablespace data file.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafileUsageItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-datafiles-{file_id}-usage-get
x-filename-id: database-storage-tablespaces-tablespace_name-datafiles-file_id-usage-get
/database/storage/tablespaces/{tablespace_name}/history:
get:
tags:
- General
summary: Get tablespace space usage history
description: Oracle Diagnostic Pack licence is required for this service. Returns DBA_HIST_TBSPC_SPACE_USAGE records where tablespace size has changed. These records are historical tablespace usage statistics. Recent changes in tablespace storage or usage will not appear until a snapshot is created. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
responses:
'200':
description: Tablespace space usage history for the specified tablespace.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceHistoryItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-history-get
x-filename-id: database-storage-tablespaces-tablespace_name-history-get
/database/storage/tablespaces/{tablespace_name}/segments/:
get:
tags:
- General
summary: Get tablespace segments
description: Returns records from DBA_SEGMENTS for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Collection of records from DBA_SEGMENTS for the specified tablespace.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceSegments'
x-internal-id: database-storage-tablespaces-{tablespace_name}-segments--get
x-filename-id: database-storage-tablespaces-tablespace_name-segments-get
/database/storage/tablespaces/{tablespace_name}/segments/{segment_name}:
get:
tags:
- General
summary: Get a tablespace segment
description: Returns data from DBA_SEGMENTS for a specific tablespace and segment. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- name: segment_name
in: path
description: Name of the segment.
required: true
schema:
type: string
responses:
'200':
description: A specific record from DBA_SEGMENTS for the tablespace and segment name.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceSegmentsItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-segments-{segment_name}-get
x-filename-id: database-storage-tablespaces-tablespace_name-segments-segment_name-get
/database/storage/tablespaces/{tablespace_name}/tempfiles_usage:
get:
tags:
- General
summary: Get temporary file usage summary for a specific tablespace
description: Returns records from GV$TEMPFILE and DBA_TEMP_FILES for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
responses:
'200':
description: Summary information of all temporary files used by the tablespace.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafilesUsageItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-tempfiles_usage-get
x-filename-id: database-storage-tablespaces-tablespace_name-tempfiles_usage-get
/database/storage/tablespaces/{tablespace_name}/tempfiles/:
get:
tags:
- General
summary: Get temporary files for a tablespace
description: Returns records from DBA_TEMP_FILES for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all temporary files used by the specified tablespace.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceTempfiles'
x-internal-id: database-storage-tablespaces-{tablespace_name}-tempfiles--get
x-filename-id: database-storage-tablespaces-tablespace_name-tempfiles-get
/database/storage/tablespaces/{tablespace_name}/tempfiles/{file_id}/:
get:
tags:
- General
summary: Get tablespace temporary file
description: Returns data from DBA_TEMP_FILES for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- name: file_id
in: path
description: File identifier.
required: true
schema:
type: string
responses:
'200':
description: Information about the specified temporary file.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceTempfilesItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-tempfiles-{file_id}--get
x-filename-id: database-storage-tablespaces-tablespace_name-tempfiles-file_id-get
/database/storage/tablespaces/{tablespace_name}/tempfiles/{file_id}/usage:
get:
tags:
- General
summary: Get tablespace temporary file usage
description: Returns GV$DATAFILE and DBA_TEMP_FILES records for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- name: file_id
in: path
description: File identifier.
required: true
schema:
type: string
responses:
'200':
description: Usage information about the temporary file.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafileUsageItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-tempfiles-{file_id}-usage-get
x-filename-id: database-storage-tablespaces-tablespace_name-tempfiles-file_id-usage-get
/database/version
# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-partitioning/refs/heads/main/openapi/oracle-partitioning-general-api-openapi.yml