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 Database Tools Runtime API

The databaseToolsRuntime API from Oracle — 25 operation(s) for databasetoolsruntime.

Oracle Database Tools Runtime API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 44 operations across 25 paths, and defines 58 schemas. It is described by OpenAPI 3.2.0, at version 20230222.

Requests are made against 2 base URLs: http://127.0.0.1/20230222, https://127.0.0.1/20230222.

44 operations 25 paths 58 schemas 7 DELETE22 GET9 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 44

Across 25 paths, the API surfaces 44 operations — 7 DELETE, 22 GET, 9 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

databaseToolsRuntime 44
POST
/databaseToolsConnections/{databaseToolsConnectionId}/actions/executeSql
Execute statements on a database tools connection.
ExecuteSqlDatabaseToolsConnection 3 params body → 200202400401404409412429
POST
/databaseToolsConnections/{databaseToolsConnectionId}/actions/validateConnection
Post DatabaseToolsConnectionValidate
ValidateDatabaseToolsConnection 3 params body → 200400401404412429500503
GET
/databaseToolsConnections/{databaseToolsConnectionId}/credentials
List credentials
ListCredentials 6 params → 200400401404412429500503
POST
/databaseToolsConnections/{databaseToolsConnectionId}/credentials
Creates a credential for the user specified by the key.
CreateCredential 3 params body → 200400401404412429500503
DELETE
/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}
Delete credential
DeleteCredential 4 params → 204400401404412429500503
GET
/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}
Get a credential
GetCredential 4 params → 200400401404412429500503
PUT
/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}
Update a credential
UpdateCredential 4 params body → 200400401404405412429500
GET
/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/executeGrantees
Get a list of all execute grantees
ListCredentialExecuteGrantees 7 params → 200400401404412429500503
POST
/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/executeGrantees
Grants the EXECUTE privilege on the credential to the user specified by the key.
CreateCredentialExecuteGrantee 4 params body → 200400401404412429500503
DELETE
/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/executeGrantees/{executeGranteeKey}
Delete execute grantee
DeleteCredentialExecuteGrantee 5 params → 204400401404412429500503
GET
/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/executeGrantees/{executeGranteeKey}
Get a credential execute grantee
GetCredentialExecuteGrantee 5 params → 200400401404412429500503
GET
/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/publicSynonyms
Get a list of all public synonyms for the given credential
ListCredentialPublicSynonyms 7 params → 200400401404412429500503
POST
/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/publicSynonyms
Creates a public synonym for the given credentials
CreateCredentialPublicSynonym 4 params body → 200400401404412429500503
DELETE
/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/publicSynonyms/{publicSynonymKey}
Delete a public synonym
DeleteCredentialPublicSynonym 5 params → 204400401404412429500503
GET
/databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/publicSynonyms/{publicSynonymKey}
Get a public synonym
GetCredentialPublicSynonym 5 params → 200400401404412429500503
GET
/databaseToolsConnections/{databaseToolsConnectionId}/propertySets/{propertySetKey}
Get a property set
GetPropertySet 4 params → 200400401404412429500503
PUT
/databaseToolsConnections/{databaseToolsConnectionId}/propertySets/{propertySetKey}
Update a property set
UpdatePropertySet 4 params body → 200400401404405412429500
GET
/databaseToolsConnections/{databaseToolsConnectionId}/users/{userKey}/credentials
List user credentials
ListUserCredentials 7 params → 200400401404412429500503
GET
/databaseToolsConnections/{databaseToolsConnectionId}/users/{userKey}/credentials/{credentialKey}
Get a user credential
GetUserCredential 5 params → 200400401404412429500503
GET
/databaseToolsDatabaseApiGatewayConfigAdvancedProperties
Returns list of database API gateway config setting descriptions to be provided as advanced properties.
ListDatabaseToolsDatabaseApiGatewayConfigAdvancedProperties 1 param → 200400401404429500default
GET
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/content
Get the content of a Database Tools database API gateway config
GetDatabaseToolsDatabaseApiGatewayConfigContent 4 params → 200400401404412429500default
GET
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/globals/{globalKey}
Get a Database Tools database API gateway config global resource
GetDatabaseToolsDatabaseApiGatewayConfigGlobal 4 params → 200400401404412429500default
PUT
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/globals/{globalKey}
Update a Database Tools database API gateway config global resource
UpdateDatabaseToolsDatabaseApiGatewayConfigGlobal 4 params body → 200400401404412429500default
GET
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools
List Database Tools database API gateway config pool resources
ListDatabaseToolsDatabaseApiGatewayConfigPools 7 params → 200400401404429500default
POST
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools
Create a Database Tools database API gateway config pool resource
CreateDatabaseToolsDatabaseApiGatewayConfigPool 3 params body → 200400401404409429500default
DELETE
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}
Deletes a Database Tools database API gateway config pool resource.
DeleteDatabaseToolsDatabaseApiGatewayConfigPool 4 params → 204400401404412429500default
GET
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}
Get a Database Tools database API gateway config pool resource
GetDatabaseToolsDatabaseApiGatewayConfigPool 4 params → 200400401404412429500default
PUT
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}
Update a Database Tools database API gateway config pool resource
UpdateDatabaseToolsDatabaseApiGatewayConfigPool 4 params body → 200400401404412429500default
GET
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs
List Database Tools database API gateway config API spec resources
ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecs 8 params → 200400401404429500default
POST
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs
Create a Database Tools database API gateway config API spec resource
CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec 4 params body → 200400401404409429500default
DELETE
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs/{apiSpecKey}
Deletes a Database Tools database API gateway config API spec resource.
DeleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec 5 params → 204400401404412429500default
GET
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs/{apiSpecKey}
Get a Database Tools database API gateway config API spec resource
GetDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec 5 params → 200400401404412429500default
PUT
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs/{apiSpecKey}
Update a Database Tools database API gateway config API spec resource
UpdateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec 5 params body → 200400401404412429500default
GET
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs
List Database Tools database API gateway config auto API spec resources
ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecs 8 params → 200400401404429500default
POST
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs
Create a Database Tools database API gateway config auto API spec resource
CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec 4 params body → 200400401404409429500default
DELETE
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs/{autoApiSpecKey}
Deletes a Database Tools database API gateway config auto API spec resource.
DeleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec 5 params → 204400401404412429500default
GET
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs/{autoApiSpecKey}
Get a Database Tools database API gateway config auto API spec resource
GetDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec 5 params → 200400401404412429500default
PUT
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs/{autoApiSpecKey}
Update a Database Tools database API gateway config auto API spec resource
UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec 5 params body → 200400401404412429500default
POST
/databaseToolsIdentities/{databaseToolsIdentityId}/actions/validateCredential
Validates a Database Tools identity credential.
ValidateDatabaseToolsIdentityCredential 3 params body → 200400401404409412429500
GET
/workRequests
List Work Requests
ListWorkRequests 10 params → 200400401404429500default
DELETE
/workRequests/{workRequestId}
Attempts to cancel the specified work request
CancelWorkRequest 3 params → 202400401404412429500503
GET
/workRequests/{workRequestId}
GET Work Request Status
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
Lists work request errors
ListWorkRequestErrors 6 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
Lists work request logs
ListWorkRequestLogs 6 params → 200400401404429500default

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are DatabaseToolsDatabaseApiGatewayConfigPool (17 properties), CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails (14 properties), WorkRequest (14 properties), UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails (14 properties). Each schema is shown below with its type and property counts.

DatabaseToolsDatabaseApiGatewayConfigPoolApiSpecCollection
object
List of Database Tools database API gateway config API spec summary items.
1 property 1 required
DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary
object
Description of a database API gateway config setting to be provided as an advanced property.
14 properties 3 required
UserCredentialCollection
object
List of UserCredentialSummary items.
1 property 1 required
ValidateDatabaseToolsConnectionResult
object
Connection validation result.
5 properties 3 required
WorkRequestSummary
object
A summary of the status of a work request.
14 properties 6 required
ExecuteSqlOutputDispositionDetails
object
Describes how the response of a command is to be stored
1 property 1 required
CredentialRelatedResource
object
A related resource for a credential.
2 properties 2 required
DatabaseToolsDatabaseApiGatewayConfigPoolSummary
object
Summary of the Database Tools database API gateway config pool resource.
6 properties 6 required
PropertySet
object
The base definition for a property set
2 properties 2 required
UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails
object
The content of the Database Tools database API gateway config global sub resource to be updated.
9 properties 1 required
DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecCollection
object
List of Database Tools database API gateway config auto API spec summary items.
1 property 1 required
ExecuteSqlResponseEnv
object
Database session environment.
1 property 1 required
CredentialPublicSynonym
object
The public synonym information
1 property 1 required
ExecuteSqlDatabaseToolsConnectionDetails
object
A request
2 properties 1 required
CredentialSummary
object
Credential information
7 properties 4 required
WorkRequestCollection
object
List of WorkRequestSummary items.
1 property 1 required
DatabaseToolsDatabaseApiGatewayConfigGlobal
object
The content of a Database Tools database API gateway config global resource.
13 properties 4 required
CredentialPublicSynonymCollection
object
List of CredentialPublicSynonymSummary items.
1 property 1 required
CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails
object
The content of a Database Tools database API gateway config pool sub resource to be created.
14 properties 4 required
UserCredentialSummary
object
User Credential information
7 properties 4 required
WorkRequestErrorCollection
object
List of WorkRequestError items.
1 property 1 required
WorkRequestError
object
An error encountered while executing a work request.
3 properties 3 required
DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecSummary
object
Summary of the Database Tools database API gateway config auto API spec resource.
5 properties 5 required
CreateCredentialPublicSynonymDetails
object
The public synonym information
1 property 1 required
DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryCollection
object
List of database API gateway config setting descriptions to be provided as advanced properties.
1 property 1 required
UpdatePropertySetDetails
object
The base definition for a property set update
1 property 1 required
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties 2 required
ValidateDatabaseToolsIdentityCredentialResult
object
Identity validation result.
5 properties 3 required
CreateCredentialDetails
object
Details for the new credential.
2 properties 2 required
DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
object
The content of a Database Tools database API gateway config auto API spec sub resource defined within a pool.
13 properties 5 required
CredentialExecuteGranteeSummary
object
Specifies the database user, the grantee, who is granted the execute privilege on the credential.
1 property 1 required
CredentialCollection
object
List of CredentialSummary items.
1 property 1 required
CredentialExecuteGrantee
object
Specifies the database user, the grantee, who is granted the execute privilege on the credential.
1 property 1 required
ValidateDatabaseToolsIdentityCredentialDetails
object
Identity Credential validation details.
1 property 1 required
DatabaseToolsDatabaseApiGatewayConfigPoolApiSpecSummary
object
Summary of the Database Tools database API gateway config API spec resource.
5 properties 5 required
ExecuteSqlOutputResultDispositionTemplate
object
Template defining how the result of a command should be stored.
2 properties 2 required
UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails
object
The content of a Database Tools database API gateway config pool sub resource to be updated.
14 properties 1 required
WorkRequest
object
An asynchronous work request.
14 properties 7 required
CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecDetails
object
The content of a Database Tools database API gateway config API spec sub resource to be created.
3 properties 3 required
Credential
object
Credential information
7 properties 4 required
ExecuteSqlResponse
object
Contains the details for the SQL statements to execute on the database connection.
3 properties 1 required
UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetails
object
The content of a Database Tools database API gateway config auto API spec sub resource to be updated.
10 properties 1 required
WorkRequestResource
object
A resource created or operated on by a work request.
5 properties 3 required
ExecuteSqlOutputDetails
object
Defines how the script result should be stored
2 properties 1 required
DatabaseApiGatewayConfigCertificateBundle
object
The certificate bundle that describes the SSL certicicate. Ignored if the httpsPort is 0.
1 property 1 required
DatabaseToolsDatabaseApiGatewayConfigPoolCollection
object
List of Database Tools database API gateway config pool summary items.
1 property 1 required
UpdateCredentialDetails
object
Credential information to be updated.
1 property 1 required
ValidateDatabaseToolsConnectionDetails
object
Connection validation details.
1 property 1 required
WorkRequestLogEntryCollection
object
List of work request log items.
1 property 1 required
DatabaseToolsDatabaseApiGatewayConfigPool
object
The content of a Database Tools database API gateway config pool sub resource.
17 properties 4 required
CreateCredentialExecuteGranteeDetails
object
Specifies the database user, the grantee, who is granted the execute privilege on the credential.
1 property 1 required
CredentialExecuteGranteeCollection
object
List of CredentialExecuteGranteeSummary items.
1 property 1 required
CredentialPublicSynonymSummary
object
The public synonym information
1 property 1 required
Error
object
Error Information.
2 properties 2 required
DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec
object
The content of a Database Tools database API gateway config API spec sub resource defined within a pool.
6 properties 6 required
UpdateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecDetails
object
The content of a Database Tools database API gateway config API spec sub resource to be updated.
3 properties 1 required
UserCredential
object
Credential information
7 properties 4 required
CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetails
object
The content of a Database Tools database API gateway config auto API spec sub resource to be created.
10 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-databasetoolsruntime-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 Database Tools Runtime 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.