All REST Endpoints
Data Dictionary
The operations from the Data Dictionary category.
- Get a database link
- Method: getPath:
/database/db_links/{owner},{db_link}
- Get a partition
- Method: getPath:
/database/objects/partitions/{table_owner},{table_name},{partition_name}
- Get a procedure that is defined in package
- Method: getPath:
/database/objects/packages/procedures/{object_id},{subprogram_id}
- Get a specific column
- Method: getPath:
/database/objects/columns/{owner},{table_name},{column_name}
- Get a specific foreign keys
- Method: getPath:
/database/objects/foreign_keys/{owner},{constraint_name}
- Get a specific function
- Method: getPath:
/database/objects/functions/{object_id}
- Get a specific index
- Method: getPath:
/database/objects/indexes/{owner},{index_name}
- Get a specific object
- Method: getPath:
/database/objects/{owner},{object_name}
- Get a specific table
- Method: getPath:
/database/objects/tables/{owner},{table_name}
- Get a synonym
- Method: getPath:
/database/objects/synonyms/{owner},{synonym_name}
- Get all arguments for functions and procedures
- Method: getPath:
/database/objects/arguments/
- Get all database links
- Method: getPath:
/database/db_links/
- Get all database objects
- Method: getPath:
/database/objects/
- Get all foreign keys
- Method: getPath:
/database/objects/foreign_keys/
- Get all functions
- Method: getPath:
/database/objects/functions/
- Get all indexes
- Method: getPath:
/database/objects/indexes/
- Get all materialized view logs
- Method: getPath:
/database/objects/materialized_view_logs/
- Get all object types
- Method: getPath:
/database/objects/types/
- Get all partitions in the database
- Method: getPath:
/database/objects/partitions/
- Get all procedures defined in package
- Method: getPath:
/database/objects/packages/procedures/
- Get all synonyms in the database
- Method: getPath:
/database/objects/synonyms/
- Get all table columns
- Method: getPath:
/database/objects/columns/
- Get all tables
- Method: getPath:
/database/objects/tables/
- Get an argument
- Method: getPath:
/database/objects/arguments/{object_id},{subprogram_id},{argument_name}
- Get an object type
- Method: getPath:
/database/objects/types/{owner},{type_name}
- Get information on a specific materialized view log
- Method: getPath:
/database/objects/materialized_view_logs/{log_owner},{log_table}
Fleet Patching and Provisioning/RHP - Manage Gold Images
You can create gold images and series to manage your deployments.
- Add a new image series
- Method: postPath:
/rhp-restapi/rhp/series/{seriesId}
- Add image to series
- Method: postPath:
/rhp-restapi/rhp/series/{seriesId}/images/{imageId}
- Delete image series
- Method: deletePath:
/rhp-restapi/rhp/series/{seriesId}
- Deletes the specified image name
- Method: deletePath:
/rhp-restapi/rhp/images/{imageId}
- Display the configuration of the specified image
- Method: getPath:
/rhp-restapi/rhp/images/{imageId}
- Get all the series
- Method: getPath:
/rhp-restapi/rhp/series
- Get image series
- Method: getPath:
/rhp-restapi/rhp/series/{seriesId}
- Lists all the gold images
- Method: getPath:
/rhp-restapi/rhp/images
- Lists all the gold images that matches the specified query parameters.
- Method: getPath:
/rhp-restapi/rhp/images/search
- Remove image from series
- Method: deletePath:
/rhp-restapi/rhp/series/{seriesId}/images/{imageId}
- Schedules an import image operation
- Method: postPath:
/rhp-restapi/rhp/images
- Search series matching certain parameters
- Method: getPath:
/rhp-restapi/rhp/series/search
- Subscribe a user to a series
- Method: postPath:
/rhp-restapi/rhp/series/{seriesId}/users/{userId}
- Unsubscribe a user from a series
- Method: deletePath:
/rhp-restapi/rhp/series/{seriesId}/users/{userId}
Fleet Patching and Provisioning/RHP - Manage Operation Results
You can verify the status and retrieve the output messages of any operation that creates a job to handle its scheduled execution like imaging, provisioning, upgrade and patching operations of software homes.
- Get all the jobs
- Method: getPath:
/rhp-restapi/rhp/jobs
- Get job details
- Method: getPath:
/rhp-restapi/rhp/jobs/{jobId}
- Get the job output and result
- Method: getPath:
/rhp-restapi/rhp/jobs/{jobId}/output
Fleet Patching and Provisioning/RHP - Patch Software homes
You can move from one provisioned copy of a gold image to a provisioned copy of a gold image that is at a higher patch level.
- Patch an Oracle Database Software home
- Method: patchPath:
/rhp-restapi/rhp/workingcopies/{workingCopyId}/databases
- Patch Grid Infrastructure Software home
- Method: patchPath:
/rhp-restapi/rhp/workingcopies/{workingCopyId}/gihome/{destWcId}
Fleet Patching and Provisioning/RHP - Patch Unmanaged Software Homes
You can move from one software home that is not a copy of a gold image to a provisioned copy of a gold image that is at a higher patch level than the first software home.
- Patch an unmanaged Oracle Database Software home
- Method: patchPath:
/rhp-restapi/rhp/databases
- Patch unmanaged Grid Infrastructure Software home
- Method: patchPath:
/rhp-restapi/rhp/gihome/{destWcId}
Fleet Patching and Provisioning/RHP - Provisioning Software homes
You can provision a working copy of a gold image.
- Create Oracle Database Software
- Method: postPath:
/rhp-restapi/rhp/workingcopies/{workingCopyId}/databases
- Create working copy
- Method: postPath:
/rhp-restapi/rhp/workingcopies
- Get all working copies
- Method: getPath:
/rhp-restapi/rhp/workingcopies
- Get working copies based on a certain image type
- Method: getPath:
/rhp-restapi/rhp/workingcopies/imagetypes/{imageType}
- Get working copy details
- Method: getPath:
/rhp-restapi/rhp/workingcopies/{workingCopyId}
- Search working copies
- Method: getPath:
/rhp-restapi/rhp/workingcopies/search
Fleet Patching and Provisioning/RHP - Upgrade Software homes
You can move from one provisioned copy of a gold image to a provisioned copy of a gold image that is at a higher version.
- Upgrade an Oracle Database Software home
- Method: putPath:
/rhp-restapi/rhp/workingcopies/{workingCopyId}/databases/{dbUniqueName}
- Upgrade Grid Infrastructure Software home
- Method: putPath:
/rhp-restapi/rhp/workingcopies/{workingCopyId}/gihome/{destWcId}
Fleet Patching and Provisioning/RHP - Upgrade Unmanaged Software Homes
You can move from one software home that is not a copy of a gold image to a provisioned copy of a gold image that is at a higher version level than the first software home.
- Upgrade an unmanaged Oracle Database Software home
- Method: putPath:
/rhp-restapi/rhp/databases/{dbUniqueName}
- Upgrade unmanaged Grid Infrastructure Software home
- Method: putPath:
/rhp-restapi/rhp/gihome/{destWcId}
General
The operations from the General category.
- Create a data pump job
- Method: postPath:
/database/datapump/jobs/
- Create an export data pump job
- Method: postPath:
/database/datapump/export
- Get a database component
- Method: getPath:
/database/components/{comp_id}
- Get a description of a specifc local listeners for this database
- Method: getPath:
/database/connections/{host_name},{port},{service_name}
- Get a description of all local listeners for this database
- Method: getPath:
/database/connections/
- Get a file for a specific data pump job
- Method: getPath:
/database/datapump/jobs/{owner_name},{job_name}/{filename}
- Get a specific data pump job
- Method: getPath:
/database/datapump/jobs/{owner_name},{job_name}/
- Get a specific database parameter
- Method: getPath:
/database/parameters/{name}
- Get a specific database users
- Method: getPath:
/database/security/users/{username}
- Get a tablespace
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/
- Get a tablespace segment
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/segments/{segment_name}
- Get all data pump jobs
- Method: getPath:
/database/datapump/jobs/
- Get all database components
- Method: getPath:
/database/components/
- Get all database parameters
- Method: getPath:
/database/parameters/
- Get all database users
- Method: getPath:
/database/security/users/
- Get all feature usage statistics
- Method: getPath:
/database/feature_usage/
- Get all tablespaces
- Method: getPath:
/database/storage/tablespaces/
- Get data file usage summary for a specific tablespace
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/datafiles_usage
- Get data files for a tablespace
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/datafiles/
- Get database status
- Method: getPath:
/database/status
- Get database version
- Method: getPath:
/database/version
- Get storage statistics
- Method: getPath:
/database/storage/bytes
- Get tablespace data file
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/datafiles/{file_id}/
- Get tablespace data file usage
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/datafiles/{file_id}/usage
- Get tablespace segments
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/segments/
- Get tablespace space usage history
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/history
- Get tablespace temporary file
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/tempfiles/{file_id}/
- Get tablespace temporary file usage
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/tempfiles/{file_id}/usage
- Get temporary file usage summary for a specific tablespace
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/tempfiles_usage
- Get temporary files for a tablespace
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/tempfiles/
- Get usage statistic for a feature
- Method: getPath:
/database/feature_usage/{dbid},{name}
Monitoring
The operations from the Monitoring category.
- Get a session
- Method: getPath:
/database/monitoring/sessions/{sid},{serial_number}/
- Get a session locks that is blocking other sessions
- Method: getPath:
/database/monitoring/session_locks/holding/{session_id},{lock_id1},{lock_id2}
- Get a specific lock that a session is waiting on
- Method: getPath:
/database/monitoring/session_locks/waiting/{session_id},{lock_id1},{lock_id2}
- Get a specific session lock record
- Method: getPath:
/database/monitoring/session_locks/{session_id},{lock_id1},{lock_id2}
- Get a specific session wait
- Method: getPath:
/database/monitoring/session_waits/{sid},{seq_number}
- Get a specific session wait class record
- Method: getPath:
/database/monitoring/session_wait_classes/{sid},{serial_number},{wait_class_number}
- Get all alerts
- Method: getPath:
/database/monitoring/alerts/
- Get all current sessions
- Method: getPath:
/database/monitoring/sessions/
- Get all locks held in the database
- Method: getPath:
/database/monitoring/session_locks/
- Get all locks that are blocking other sessions
- Method: getPath:
/database/monitoring/session_locks/holding/
- Get all locks that sessions are waiting on
- Method: getPath:
/database/monitoring/session_locks/waiting/
- Get all long running operations for a Session
- Method: getPath:
/database/monitoring/sessions/{sid},{serial_number}/long_running_operations
- Get all session limits
- Method: getPath:
/database/monitoring/session_limits
- Get all session wait class records
- Method: getPath:
/database/monitoring/session_wait_classes/
- Get all session waits
- Method: getPath:
/database/monitoring/session_waits/
- Get all wait class metrics
- Method: getPath:
/database/monitoring/wait_class_metrics
- Get an alert record
- Method: getPath:
/database/monitoring/alerts/{record_id}
- Get count of alerts by message level
- Method: getPath:
/database/monitoring/alerts_summaries/by_message_level
- Get count of alerts by message type
- Method: getPath:
/database/monitoring/alerts_summaries/by_message_type
- Get count of different session types
- Method: getPath:
/database/monitoring/session_summaries/by_type
- Get count of recent alerts by message level
- Method: getPath:
/database/monitoring/alerts_recent_summaries/by_message_level
- Get count of recent alerts by message type
- Method: getPath:
/database/monitoring/alerts_recent_summaries/by_message_type
- Get current active process for a session
- Method: getPath:
/database/monitoring/sessions/{sid},{serial_number}/process
- Get time totals for all registered wait classes
- Method: getPath:
/database/monitoring/wait_class_totals
- Get wait time summary from recent active session history records
- Method: getPath:
/database/monitoring/waits_recent
Performance
The operations from the Performance category.
- Get a specified sampled session activity in the database
- Method: getPath:
/database/performance/active_sessions_history/{sample_id}
- Get all sampled session activity in the database
- Method: getPath:
/database/performance/active_sessions_history/
- Get all SQL statements ordered by CPU time descending
- Method: getPath:
/database/performance/top_sql_statements/
- Get execution plan for an SQL Statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/plan
- Get historical statistics for an SQL statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/history
- Get information on a monitored statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/monitor/{sql_exec_id},{sql_exec_start}/
- Get monitoring statistics for an SQL Statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/monitor/
- Get parallel execution information for specific statement execution
- Method: getPath:
/database/performance/sql_statements/{sql_id}/monitor/{sql_exec_id},{sql_exec_start}/parallelism
- Get SQL statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/text
- Get SQL statistics for a specific session
- Method: getPath:
/database/performance/active_sessions_history_waits/{sid},{seq_number}/active_sql
- Get SQL statistics maximum values
- Method: getPath:
/database/performance/top_sql_statements/maximums
- Get statistics for all SQL statements
- Method: getPath:
/database/performance/sql_statements/
- Get statistics for an SQL statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/
- Get the last 10 wait events for each active session
- Method: getPath:
/database/performance/active_sessions_history_waits/
- Get the specified wait event for specific active session
- Method: getPath:
/database/performance/active_sessions_history_waits/{sid},{seq_number}/
Pluggable Database Lifecycle Management
The operations from the Pluggable Database Lifecycle Management category.
- Change the state of a PDB
- Method: postPath:
/database/pdbs/{pdb_name}/status
- Clone or Unplug operations for PDBs
- Method: postPath:
/database/pdbs/{pdb_name}/
- Create a PDB from PDB$SEED or XML
- Method: postPath:
/database/pdbs/
- Drop a PDB
- Method: deletePath:
/database/pdbs/{pdb_name}/
- Get a pluggable database
- Method: getPath:
/database/pdbs/{pdb_name}/
- Get all pluggable databases
- Method: getPath:
/database/pdbs/
- Return status information of a PDB
- Method: getPath:
/database/pdbs/{pdb_name}/status