How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Distributed Db Service API

The DistributedDbService API from Oracle — 18 operation(s) for distributeddbservice.

Oracle Distributed Db Service API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DistributedDbService. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 22 operations across 18 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 20250101.

Requests are made against a single base URL, https://127.0.0.1/20250101.

22 operations 18 paths 26 schemas 1 DELETE3 GET1 PATCH16 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20250101
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 22

Across 18 paths, the API surfaces 22 operations — 1 DELETE, 3 GET, 1 PATCH, 16 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

DistributedDbService 22
GET
/distributedDatabases
List of Globally distributed databases.
ListDistributedDatabases 11 params → 200400401404429500default
POST
/distributedDatabases
Create a Globally distributed database.
CreateDistributedDatabase 2 params body → 201400401404409412429500
DELETE
/distributedDatabases/{distributedDatabaseId}
Terminate the Globally distributed database identified by the identifier.
DeleteDistributedDatabase 5 params → 202400401404409412429500
GET
/distributedDatabases/{distributedDatabaseId}
Gets the details of the Globally distributed database.
GetDistributedDatabase 4 params → 200400401404429500default
PATCH
/distributedDatabases/{distributedDatabaseId}
Patch the configuration of Globally distributed database.
PatchDistributedDatabase 4 params body → 202401404409412429500
PUT
/distributedDatabases/{distributedDatabaseId}
Updates the configuration of the Globally distributed database.
UpdateDistributedDatabase 3 params body → 200400401404412429500default
POST
/distributedDatabases/{distributedDatabaseId}/actions/addGdsControlNode
Add new Global database services control(GDS CTL) node for the Globally distributed database.
AddDistributedDatabaseGdsControlNode 4 params body → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/changeCompartment
ChangeDistributedDatabaseCompartment
ChangeDistributedDatabaseCompartment 4 params body → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/changeDbBackupConfig
Change the DbBackupConfig details for the Globally distributed database.
ChangeDistributedDbBackupConfig 4 params body → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/configureGsms
Configure GSMs for the Globally distributed database.
ConfigureDistributedDatabaseGsms 4 params body → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/configureSharding
Configure sharding for the Globally distributed database.
ConfigureDistributedDatabaseSharding 5 params → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/downloadGsmCertificateSigningRequest
Download the common certificate signing request for global service manager(GSM) instances of Globally distributed database.
DownloadDistributedDatabaseGsmCertificateSigningRequest 4 params → 200400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/generateGsmCertificateSigningRequest
Generate the certificate signing request for global service manager(GSM) instances of the Globally distributed database.
GenerateDistributedDatabaseGsmCertificateSigningRequest 5 params → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/generateWallet
Generate the wallet associated with Globally distributed database.
GenerateDistributedDatabaseWallet 4 params body → 200400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/moveReplicationUnit
Move the replication units for RAFT based globally distributed database.
MoveDistributedDatabaseReplicationUnit 4 params body → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/recreateFailedResource
Recreate the failed resource for the Globally Distributed Database.
RecreateFailedDistributedDatabaseResource 6 params → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/rotateDbPasswords
Rotate passwords for different components of the Globally distributed database.
RotateDistributedDatabasePasswords 4 params → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/startDatabase
Start Globally distributed database.
StartDistributedDatabase 4 params → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/stopDatabase
Stop Globally distributed database.
StopDistributedDatabase 4 params → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/uploadSignedCertificateAndGenerateWallet
Upload the CA signed certificate for new GSM compute instances of the Globally distributed database.
UploadDistributedDatabaseSignedCertificateAndGenerateWallet 4 params body → 202400401404409412429500
POST
/distributedDatabases/{distributedDatabaseId}/actions/validateNetwork
Validate the network connectivity for the globally distributed database.
ValidateDistributedDatabaseNetwork 7 params → 202400401404409412429500
GET
/distributedDatabases/{distributedDatabaseId}/raftMetrics
Operation to retrieve RAFT metrics for the Globally distributed database.
GetDistributedDatabaseRaftMetric 2 params → 200400401404429500default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are DistributedDatabase (34 properties), DistributedDatabaseSummary (27 properties), CreateDistributedDatabaseDetails (24 properties), DistributedDatabaseGsm (10 properties). Each schema is shown below with its type and property counts.

DistributedDbConnectionString
object
Details of Globally distributed database connection String.
1 property 1 required
DistributedDbBackupConfig
object
Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an admi…
10 properties
DistributedDatabaseSummary
object
Globally distributed database.
27 properties 17 required
DistributedDatabaseRaftMetric
object
Raft metrics for shards and catalog for the Globally distributed database.
2 properties 1 required
CreateDistributedDatabaseCatalogDetails
object
Details of the Globally distributed database catalog.
1 property 1 required
ChangeDistributedDatabaseCompartmentDetails
object
The configuration details for moving the resource for Globally distributed database to other compartment.
1 property 1 required
AddDistributedDatabaseGdsControlNodeDetails
object
Details required to create a new Global database services control(GDS CTL) compute node.
2 properties 1 required
CreateDistributedDatabaseDetails
object
Details required for creation of the Globally distributed database.
24 properties 14 required
GenerateDistributedDatabaseWalletDetails
object
Details to create and download an Globally distributed database wallet.
1 property 1 required
MoveDistributedDatabaseReplicationUnitDetails
object
The details for moving replication units from source shard to destination shard for the Globally distributed database.
3 properties 1 required
DistributedDbMetadata
object
Additional metadata related to Globally distributed database resources.
1 property
PatchDistributedDatabaseDetails
object
Provide PatchInstuction(s) in items array. All instructions in items have to be of same type. All instructions in items have to either PatchInsertInstruction t…
1 property
DistributedDbGsmImage
object
The Global service manager image details
2 properties 2 required
DistributedDbBackupDestination
object
Backup destination details
9 properties 1 required
ChangeDistributedDbBackupConfigDetails
object
Details of the DbBackupConfig to be updated for the Globally distreibuted database.
1 property 1 required
DistributedDatabaseGsm
object
Details of global service manager(GSM also known as shard director) instances for the Globally distributed database.
10 properties 6 required
UploadDistributedDatabaseSignedCertificateAndGenerateWalletDetails
object
Details of the request to upload the CA signed certificates to GSMs and generate wallets for GSMs of the Globally distributed database.
1 property 1 required
DistributedDatabaseCollection
object
Collection of Globally distributed databases.
1 property 1 required
DistributedDatabase
object
Globally distributed database.
34 properties 17 required
Error
object
Error Information.
2 properties 2 required
ConfigureDistributedDatabaseGsmsDetails
object
Details of the request to configure new global service manager(GSM) instances for the distributed database.
2 properties 2 required
DistributedDatabaseShard
object
Globally distributed database shard.
4 properties 4 required
DistributedDatabaseCatalog
object
Globally distributed database catalog.
4 properties 4 required
CreateDistributedDatabaseShardDetails
object
Globally distributed database shard.
1 property 1 required
PatchInstruction
object
A single instruction to be included as part of Patch request content.
2 properties 2 required
UpdateDistributedDatabaseDetails
object
The details of Globally distributed database to be updated.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-distributeddbservice-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Oracle Distributed Db Service 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.