Oracle Postgresql API
The postgresql API from Oracle — 26 operation(s) for postgresql.
Oracle Postgresql API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include PostgreSQL. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 36 operations across 26 paths, and defines 70 schemas. It is described by OpenAPI 3.2.0, at version 20220915.
Requests are made against a single base URL, https://127.0.0.1/20220915.
36 operations
26 paths
70 schemas
3 DELETE15 GET1 PATCH13 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 36
Across 26 paths, the API surfaces 36 operations — 3 DELETE, 15 GET, 1 PATCH, 13 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
postgresql 36
GET
/backups
Gets a list of all backups in a compartment
POST
/backups
Creates a new backup.
DELETE
/backups/{backupId}
Delete a backup.
GET
/backups/{backupId}
Get Backup
PUT
/backups/{backupId}
Update the backup identified by the ID.
POST
/backups/{backupId}/actions/changeCompartment
Moves a backup into a different compartment.
POST
/backups/{backupId}/actions/copy
Backup Copy Request to copy back up in remote region
GET
/configurations
Gets a list of all configurations in a compartment.
POST
/configurations
Creates a new configuration.
DELETE
/configurations/{configurationId}
Delete a configuration.
GET
/configurations/{configurationId}
Get a configuration.
PUT
/configurations/{configurationId}
Updates the display name or description of a configuration.
POST
/configurations/{configurationId}/actions/changeCompartment
Moves a configuration into a different compartment.
GET
/dbSystems
Gets a list of all database systems in a compartment.
POST
/dbSystems
Creates a new database system.
DELETE
/dbSystems/{dbSystemId}
Delete a database system.
GET
/dbSystems/{dbSystemId}
Get DbSystem
PATCH
/dbSystems/{dbSystemId}
Modifies the database system.
PUT
/dbSystems/{dbSystemId}
Update the database system identified by the ID.
POST
/dbSystems/{dbSystemId}/actions/changeCompartment
Moves a database system into a different compartment.
POST
/dbSystems/{dbSystemId}/actions/failover
Runs the manual failover operation.
POST
/dbSystems/{dbSystemId}/actions/resetMasterUserPassword
Resets the database system's master password.
POST
/dbSystems/{dbSystemId}/actions/restartDbInstance
Restarts the database instance node.
POST
/dbSystems/{dbSystemId}/actions/restore
Restore the database system.
POST
/dbSystems/{dbSystemId}/actions/start
Start the DB System.
POST
/dbSystems/{dbSystemId}/actions/stop
Stop the DB System.
GET
/dbSystems/{dbSystemId}/connectionDetails
Get database system connection details.
PUT
/dbSystems/{dbSystemId}/dbinstances/{dbInstanceId}
Updates the database instance node.
GET
/dbSystems/{dbSystemId}/primaryDbInstance
Get the primary database instance node details.
GET
/defaultConfigurations
Gets a list of all default configurations.
GET
/defaultConfigurations/{defaultConfigurationId}
Get default configuration.
GET
/shapes
Gets a list of all possible database system shapes.
GET
/workRequests
List work requests
GET
/workRequests/{workRequestId}
Get work request status
GET
/workRequests/{workRequestId}/errors
List work request errors
GET
/workRequests/{workRequestId}/logs
List work request logs
Schemas 70
The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are DbSystem (24 properties), Backup (21 properties), Configuration (19 properties), CreateDbSystemDetails (18 properties). Each schema is shown below with its type and property counts.
ShapeMemoryOptions
object
Options for the the shape memory
5 properties
5 required
UpdateBackupDetails
object
The backup information to be updated.
5 properties
Configuration
object
PostgreSQL configuration for a database system.
19 properties
13 required
UpdateStorageDetailsParams
object
Storage details of the database system.
1 property
DbInstanceEndpoint
object
The database instance node endpoint information.
2 properties
2 required
WorkRequestSummary
object
A summary of the status of a work request.
9 properties
7 required
CreateDbInstanceDetails
object
Information about the new database instance node.
3 properties
ShapeOcpuOptions
object
Options for the the shape OCPU
2 properties
2 required
ConfigurationCollection
object
Results of a configuration search. Contains the ConfigurationSummary items and other information, such as metadata.
1 property
1 required
CreateDbSystemDetails
object
The information about new database system.
18 properties
6 required
DbSystemDetails
object
Information about the database system associated with a backup.
3 properties
2 required
FailoverDbSystemDetails
object
Database system failover information.
2 properties
Endpoint
object
Information about the database instance node endpoint.
3 properties
2 required
Backup
object
Database system backup information.
21 properties
9 required
BackupCopyPolicy
object
Backup copy details
3 properties
1 required
WorkRequestSummaryCollection
object
Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
1 property
1 required
BackupPolicy
object
PostgreSQL database system backup policy.
3 properties
DbSystemCollection
object
Results of a database system search. Contains both DbSystemSummary items and other information, such as metadata.
1 property
1 required
ShapeCollection
object
The list of shapes that can be used to create a database system.
1 property
1 required
PrimaryDbInstanceDetails
object
The primary database instance node details.
1 property
1 required
WorkRequestErrorCollection
object
Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
1 property
1 required
WorkRequestError
object
An error encountered while executing a work request.
3 properties
3 required
DefaultConfigParams
object
Default database configuration.
7 properties
7 required
ManagementPolicy
object
PostgreSQL database system management policy.
2 properties
2 required
StorageDetails
object
Storage details of the database system.
3 properties
2 required
Credentials
object
Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such a…
2 properties
2 required
ChangeBackupCompartmentDetails
object
The information used to move a backup to a different compartment.
1 property
1 required
BackupCopyDetails
object
Backup Copy details
3 properties
2 required
DefaultConfigurationDetails
object
List of default configuration values for databases.
1 property
1 required
PasswordDetails
object
Details for the database system password. Password can be passed as VaultSecretPasswordDetails or PlainTextPasswordDetails.
1 property
1 required
ConfigurationDetails
object
List of configuration details.
1 property
1 required
CreateConfigurationDetails
object
The information to create a new configuration.
13 properties
4 required
BackupCollection
object
Results of a backup search. Contains the BackupSummary items and other information, such as metadata.
1 property
1 required
UpdateDbSystemDbInstanceDetails
object
Database instance node update parameters.
2 properties
SourceBackupDetails
object
Information about the Source Backup associated with a backup.
2 properties
2 required
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties
2 required
ShapeSummary
object
Summary of the database system shape.
7 properties
3 required
ManagementPolicyDetails
object
PostgreSQL database system management policy update details.
2 properties
UpdateDbSystemDetails
object
The information to be updated.
11 properties
RestartDbInstanceInDbSystemDetails
object
Database instance node restart parameters.
2 properties
2 required
DefaultConfigurationCollection
object
Results of a configuration search. Contains the ConfigurationSummary items and other information, such as metadata.
1 property
1 required
WorkRequest
object
An asynchronous work request.
9 properties
7 required
UpdateConfigurationDetails
object
The information to update a configuration.
5 properties
ChangeConfigurationCompartmentDetails
object
The information to move a configuration to a different compartment.
1 property
1 required
CreateBackupDetails
object
The information to create a new backup.
7 properties
3 required
ConfigurationSummary
object
Summary of the configuration.
16 properties
11 required
StartDbSystemDetails
object
DB System start parameters to update ocpu, memory, shape and configuration.
4 properties
RestoreDbSystemDetails
object
Backup details to restore the database system.
2 properties
1 required
PatchDbSystemDetails
object
For adding read replica database instances, the operation is INSERT and value object to specify is /definitions/CreateDbInstanceDetails. For removing read repl…
1 property
BackupSummary
object
Summary information for a backup.
16 properties
7 required
DefaultConfigurationSummary
object
Summary of the configuration.
11 properties
9 required
WorkRequestResource
object
A resource created or operated on by a work request.
5 properties
3 required
ConfigOverrides
object
Configuration overrides for a PostgreSQL instance.
2 properties
2 required
UpdateDbConfigParams
object
Configuration for the PostgreSQL database instance.
2 properties
1 required
NetworkDetails
object
Network details for the database system.
4 properties
1 required
ConfigParams
object
Database configuration.
8 properties
7 required
DbSystem
object
Information about a database system.
24 properties
13 required
UpdateNetworkDetails
object
Network details for the database system.
2 properties
ResetMasterUserPasswordDetails
object
Password detail that will be used to reset the database system's master user. These details are not visible on any subsequent operation, such as GET /dbSystems…
1 property
1 required
WorkRequestLogEntryCollection
object
Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
1 property
1 required
ConnectionDetails
object
Database system connection information. Used to connect to PostgreSQL instance(s).
4 properties
3 required
ChangeDbSystemCompartmentDetails
object
Change database system compartment operation details.
1 property
1 required
DbSystemSummary
object
Summary information about a database system.
17 properties
12 required
SourceDetails
object
The source of the database system.
1 property
1 required
Error
object
Error Information.
2 properties
2 required
BackupCopyStatusDetails
object
Backup Copy Status details
4 properties
1 required
DefaultConfiguration
object
Default configurations for PostgreSQL database systems.
13 properties
10 required
DbConfigurationOverrideCollection
object
Configuration overrides for a PostgreSQL instance.
1 property
1 required
DbInstance
object
Information about a database instance node.
8 properties
4 required
PatchInstruction
object
A single instruction to be included as part of Patch request content.
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
#PostgreSQL
Where this information came from
This is an independent, third-party profile of Oracle Postgresql API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.