openapi: 3.2.0
info:
description: Use the Database Tools API to manage connections, private endpoints, and work requests in the Database Tools service.
title: Database Tools API
version: '20201005'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/2fee25285adb970d8aae87c95e09f44d7e1ae7b927e0866b7c4c4717928aa17d.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the Database Tools API OCI service and stored verbatim; API Evangelist added only this provenance block.
x-evidence:
- url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
what: Oracle's own index of every OCI service specification
- url: https://docs.oracle.com/en-us/iaas/api/specs/2fee25285adb970d8aae87c95e09f44d7e1ae7b927e0866b7c4c4717928aa17d.yaml
what: the harvested document for Database Tools API
servers:
- url: http://127.0.0.1/20201005
- url: https://127.0.0.1/20201005
tags:
- name: databaseTools
paths:
/databaseToolsConnections:
get:
description: 'Returns a list of Database Tools connections.
'
operationId: ListDatabaseToolsConnections
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/DatabaseToolsConnectionTypeQueryParam'
- $ref: '#/components/parameters/DatabaseToolsConnectionRuntimeSupportQueryParam'
- $ref: '#/components/parameters/DatabaseToolsConnectionRuntimeIdentityQueryParam'
- $ref: '#/components/parameters/RelatedResourceIdentifierQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A page of Database Tools connection summary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsConnectionCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists Database Tools connections in a compartment
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsConnections?compartmentId=<compartmentId> HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DatabaseToolsConnection'
post:
description: 'Creates a new Database Tools connection.
'
operationId: CreateDatabaseToolsConnection
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: The Database Tools connection is being created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: URI of the new resource which was created by the request.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsConnection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a new Database Tools connection
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsConnections HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"displayName\": \"ADMIN@DB202005191141_low\",\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleazhwqlcqjxznbtjietofx4ll5ez4mr3wkgbrvgiex5rt5nuikvktq\",\n \"relatedResource\": {\n \"entityType\": \"DATABASE\",\n \"identifier\": \"ocid1.database.oc1.phx.exampletksujfufl4bhe5sqkfgn7t7lcrkkpy7km5iwzvg6ycls7r5dlbx6q\"\n },\n \"connectionString\": \"mydbsystem.mysubnet.myvcn.oraclevcn.com:1521/mydb_phx1ds.mysubnet.myvcn.oraclevcn.com\",\n \"userName\": \"SYSTEM\",\n \"userPassword\": {\n \"valueType\": \"SECRETID\",\n \"secretId\": \"ocid1.vaultsecret.oc1.phx.exampleaihuofciaiazy2u5ko3uyz3sspwd6hf7oqhqmlk5xu3xdetkpui7a\"\n },\n \"privateEndpointId\": \"ocid1.dbtoolsprivateendpoint.oc1.phx.exampleaaxjx47ignvzufg74jlixkqygujmdctskf47m7d6mndd6vlzafuta\"\n}\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDatabaseToolsConnectionDetails'
description: Details for the new Database Tools connection.
required: true
/databaseToolsConnections/{databaseToolsConnectionId}:
delete:
description: Deletes the specified Database Tools connection resource.
operationId: DeleteDatabaseToolsConnection
parameters:
- $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: Request has been accepted. The Database Tools connection will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a Database Tools connection.
tags:
- databaseTools
x-example: 'DELETE /20201005/databaseToolsConnections/<databaseToolsConnectionId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DatabaseToolsConnection'
get:
description: Gets details of the specified Database Tools connection.
operationId: GetDatabaseToolsConnection
parameters:
- $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Database Tools connection's details have been retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsConnection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a Database Tools connection.
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsConnections/<databaseToolsConnectionId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
put:
description: Updates the specified Database Tools connection.
operationId: UpdateDatabaseToolsConnection
parameters:
- $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: Request has been accepted. The Database Tools connection will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a Database Tools connection.
tags:
- databaseTools
x-example: "PUT /20201005/databaseToolsConnections/<databaseToolsConnectionId>\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"displayName\": \"ADMIN@DB202010051234\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsConnection'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDatabaseToolsConnectionDetails'
description: The information to be updated.
required: true
/databaseToolsConnections/{databaseToolsConnectionId}/actions/addLock:
post:
description: Adds a lock to a DatabaseToolsConnection resource.
operationId: AddDatabaseToolsConnectionLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
- $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
responses:
200:
description: Lock is added.
headers:
etag:
description: 'etag for the returned DatabaseToolsConnection resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsConnection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a DatabaseToolsConnection resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsConnection'
/databaseToolsConnections/{databaseToolsConnectionId}/actions/changeCompartment:
post:
description: 'Moves the specified Database Tools connection to a different compartment in the same tenancy.
For information about moving resources between compartments, see
[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeDatabaseToolsConnectionCompartment
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: The resource will be moved to the specified compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Change the compartment of the Database Tools connection.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsConnections/<databaseToolsConnectionId>/actions/changeCompartment\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsConnection'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeDatabaseToolsConnectionCompartmentDetails'
description: Request to change the compartment of the Database Tools connection.
required: true
/databaseToolsConnections/{databaseToolsConnectionId}/actions/removeLock:
post:
description: Removes a lock from a DatabaseToolsConnection resource.
operationId: RemoveDatabaseToolsConnectionLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
- $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
responses:
200:
description: Lock is removed.
headers:
etag:
description: 'etag for the returned DatabaseToolsConnection resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsConnection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a DatabaseToolsConnection resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsConnection'
/databaseToolsConnections/{databaseToolsConnectionId}/actions/validateConnection:
post:
description: 'Validates the Database Tools connection details by establishing a connection to the database.
'
operationId: ValidateDatabaseToolsConnection
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
responses:
200:
description: The Database Tools connection validation details.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateDatabaseToolsConnectionResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Validates the Database Tools connection.
tags:
- databaseTools
x-example: 'POST /20201005/databaseToolsConnections/<databaseToolsConnectionId>/actions/validateConnection
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DatabaseToolsConnection'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateDatabaseToolsConnectionDetails'
description: Request to validate a Database Tools connection.
required: true
/databaseToolsDatabaseApiGatewayConfigs:
get:
description: Returns a list of Database Tools database API gateway configs.
operationId: ListDatabaseToolsDatabaseApiGatewayConfigs
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigLifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigTypeQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A page of Database Tools database API gateway config summary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists Database Tools database API gateway configs in a compartment
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsDatabaseApiGatewayConfigs?compartmentId=<compartmentId> HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfig'
post:
description: 'Creates a new Database Tools database API gateway config.
'
operationId: CreateDatabaseToolsDatabaseApiGatewayConfig
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Database Tools database API gateway config was created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: URI of the new resource which was created by the request.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfig'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a new Database Tools database API gateway config.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsDatabaseApiGatewayConfigs HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"type\": \"DEFAULT\",\n \"displayName\": \"MyDbApiConfig1\",\n \"metadataSource\": \"CLOUD\",\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleazhwqlcqjxznbtjietofx4ll5ez4mr3wkgbrvgiex5rt5nuikvktq\",\n}\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDatabaseToolsDatabaseApiGatewayConfigDetails'
description: Details for the new Database Tools database API gateway config.
required: true
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}:
delete:
description: Deletes the specified Database Tools database API gateway config resource.
operationId: DeleteDatabaseToolsDatabaseApiGatewayConfig
parameters:
- $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: Request to delete the Database Tools database API gateway config has been accepted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a Database Tools database API gateway config.
tags:
- databaseTools
x-example: 'DELETE /20201005/databaseToolsDatabaseApiGatewayConfigs/<databaseToolsDatabaseApiGatewayConfigId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfig'
get:
description: Gets details of the specified Database Tools database API gateway config.
operationId: GetDatabaseToolsDatabaseApiGatewayConfig
parameters:
- $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Database Tools database API gateway config's details have been retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfig'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a Database Tools database API gateway config.
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsDatabaseApiGatewayConfigs/<databaseToolsDatabaseApiGatewayConfigId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
put:
description: Updates the specified Database Tools database API gateway config.
operationId: UpdateDatabaseToolsDatabaseApiGatewayConfig
parameters:
- $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: The Database Tools database API gateway config's details have been updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfig'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a Database Tools database API gateway config.
tags:
- databaseTools
x-example: "PUT /20201005/databaseToolsDatabaseApiGatewayConfigs/<databaseToolsDatabaseApiGatewayConfigId>\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"type\": \"DEFAULT\",\n \"displayName\": \"DbApiGatewayConfig2\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfig'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDatabaseToolsDatabaseApiGatewayConfigDetails'
description: The information to be updated.
required: true
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/actions/addLock:
post:
description: Adds a lock to a DatabaseToolsDatabaseApiGatewayConfig resource.
operationId: AddDatabaseToolsDatabaseApiGatewayConfigLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
- $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
responses:
200:
description: Lock is added.
headers:
etag:
description: 'etag for the returned DatabaseToolsDatabaseApiGatewayConfig resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfig'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a DatabaseToolsDatabaseApiGatewayConfig resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfig'
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/actions/changeCompartment:
post:
description: 'Moves the specified Database Tools database API gateway config to a different compartment in the same tenancy.
For information about moving resources between compartments, see
[Moving Resources to a Different Compartment](/iaas/Content/DbApiGatewayConfig/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeDatabaseToolsDatabaseApiGatewayConfigCompartment
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: The resource was moved to the specified compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Changes the compartment of a Database Tools database API gateway config.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsDatabaseApiGatewayConfigs/<databaseToolsDatabaseApiGatewayConfigId>/actions/changeCompartment\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfig'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeDatabaseToolsDatabaseApiGatewayConfigCompartmentDetails'
description: Request to change the compartment of the Database Tools database API gateway config.
required: true
/databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/actions/removeLock:
post:
description: Removes a lock from a DatabaseToolsDatabaseApiGatewayConfig resource.
operationId: RemoveDatabaseToolsDatabaseApiGatewayConfigLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
- $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
responses:
200:
description: Lock is removed.
headers:
etag:
description: 'etag for the returned DatabaseToolsDatabaseApiGatewayConfig resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfig'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a DatabaseToolsDatabaseApiGatewayConfig resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfig'
/databaseToolsEndpointServices:
get:
description: 'Returns a list of Database Tools endpoint services.
'
operationId: ListDatabaseToolsEndpointServices
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/NameQueryParam'
responses:
200:
description: A page of `DatabaseToolsEndpointServiceSummary` objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsEndpointServiceCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a list of all DatabaseToolsEndpointServices in a compartment
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsEndpointServices?compartmentId=<compartmentId> HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-authz-declarations:
authorizationRequired: false
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DatabaseToolsEndpointService'
/databaseToolsEndpointServices/{databaseToolsEndpointServiceId}:
get:
description: Gets details for the specified Database Tools endpoint service.
operationId: GetDatabaseToolsEndpointService
parameters:
- $ref: '#/components/parameters/DatabaseToolsEndpointServiceIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The details of the specified Database Tools endpoint service have been retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsEndpointService'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get DatabaseToolsEndpointService
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsEndpointServices/<databaseToolsEndpointServiceId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-authz-declarations:
authorizationRequired: false
x-obmcs-client-retries-enabled: true
/databaseToolsIdentities:
get:
description: Returns a list of Database Tools identities.
operationId: ListDatabaseToolsIdentities
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DatabaseToolsIdentityLifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/DatabaseToolsConnectionIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsIdentityTypeQueryParam'
responses:
200:
description: A page of Database Tools identity summary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsIdentityCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists Database Tools identities in a compartment
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsIdentities?compartmentId=<compartmentId> HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DatabaseToolsIdentity'
post:
description: 'Creates a new Database Tools identity.
'
operationId: CreateDatabaseToolsIdentity
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: The Database Tools identity is being created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: URI of the new resource which was created by the request.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsIdentity'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a new Database Tools identity.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsIdentities HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Identity1\",\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleazhwqlcqjxznbtjietofx4ll5ez4mr3wkgbrvgiex5rt5nuikvktq\",\n \"type\": \"ORACLE_DATABASE_RESOURCE_PRINCIPAL\",\n \"databaseToolsConnectionId\": \"ocid1.databasetoolsconnection.oc1.phx.exampleaaxjx47ignvzufg74jlixkqygujmdctskf47m7d6mndd6vlzafuta\",\n \"credentialKey\": \"Key1\"\n}\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDatabaseToolsIdentityDetails'
description: Details for the new Database Tools identity.
required: true
/databaseToolsIdentities/{databaseToolsIdentityId}:
delete:
description: Deletes the specified Database Tools identity resource.
operationId: DeleteDatabaseToolsIdentity
parameters:
- $ref: '#/components/parameters/DatabaseToolsIdentityIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: Request has been accepted. The Database Tools identity will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a Database Tools identity.
tags:
- databaseTools
x-example: 'DELETE /20201005/databaseToolsIdentities/<databaseToolsIdentityId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DatabaseToolsIdentity'
get:
description: Gets details of the specified Database Tools identity.
operationId: GetDatabaseToolsIdentity
parameters:
- $ref: '#/components/parameters/DatabaseToolsIdentityIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Database Tools identity's details have been retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsIdentity'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a Database Tools identity.
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsIdentities/<databaseToolsIdentityId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
put:
description: Updates the specified Database Tools identity.
operationId: UpdateDatabaseToolsIdentity
parameters:
- $ref: '#/components/parameters/DatabaseToolsIdentityIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: Request has been accepted. The Database Tools identity will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a Database Tools identity.
tags:
- databaseTools
x-example: "PUT /20201005/databaseToolsIdentities/<databaseToolsIdentityId>\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"displayName\": \"Identity2\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsIdentity'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDatabaseToolsIdentityDetails'
description: The information to be updated.
required: true
/databaseToolsIdentities/{databaseToolsIdentityId}/actions/addLock:
post:
description: Adds a lock to a DatabaseToolsIdentity resource.
operationId: AddDatabaseToolsIdentityLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsIdentityIdPathParam'
- $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
responses:
200:
description: Lock is added.
headers:
etag:
description: 'etag for the returned DatabaseToolsIdentity resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsIdentity'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a DatabaseToolsIdentity resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsIdentity'
/databaseToolsIdentities/{databaseToolsIdentityId}/actions/changeCompartment:
post:
description: 'Moves the specified Database Tools identity to a different compartment in the same tenancy.
For information about moving resources between compartments, see
[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeDatabaseToolsIdentityCompartment
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsIdentityIdPathParam'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: The resource will be moved to the specified compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Changes the compartment of a Database Tools identity.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsIdentities/<databaseToolsIdentityId>/actions/changeCompartment\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsIdentity'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeDatabaseToolsIdentityCompartmentDetails'
description: Request to change the compartment of the Database Tools identity.
required: true
/databaseToolsIdentities/{databaseToolsIdentityId}/actions/refreshCredential:
post:
description: 'Refresh Database Tools identity credential.
'
operationId: RefreshDatabaseToolsIdentityCredential
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsIdentityIdPathParam'
responses:
202:
description: The Request to refresh Database Tools identity credential was accepted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Refresh credential of the identity in the database referenced by the related connection.
tags:
- databaseTools
x-example: 'POST /20201005/databaseToolsIdentities/<databaseToolsIdentityId>/actions/refreshCredential
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DatabaseToolsIdentity'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RefreshDatabaseToolsIdentityCredentialDetails'
description: Request to refresh Database Tools identity credential.
required: true
/databaseToolsIdentities/{databaseToolsIdentityId}/actions/removeLock:
post:
description: Removes a lock from a DatabaseToolsIdentity resource.
operationId: RemoveDatabaseToolsIdentityLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsIdentityIdPathParam'
- $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
responses:
200:
description: Lock is removed.
headers:
etag:
description: 'etag for the returned DatabaseToolsIdentity resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsIdentity'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a DatabaseToolsIdentity resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsIdentity'
/databaseToolsIdentities/{databaseToolsIdentityId}/actions/validateCredential:
post:
description: 'Validates the Database Tools identity credentials by establishing a connection to the customer database
and executing the dbms_cloud.send_request to validate the credential.
'
operationId: ValidateDatabaseToolsIdentityCredential
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsIdentityIdPathParam'
responses:
200:
description: The Database Tools identity credential validation details.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateDatabaseToolsIdentityCredentialResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Validates a Database Tools identity credential.
tags:
- databaseTools
x-example: 'POST /20230222/databaseToolsIdentities/<databaseToolsIdentityId>/actions/validateCredential
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DatabaseToolsIdentity'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateDatabaseToolsIdentityCredentialDetails'
description: Request to validate a Database Tools identity Credential.
required: true
/databaseToolsMcpServers:
get:
description: Returns a list of Database Tools MCP servers.
operationId: ListDatabaseToolsMcpServers
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DatabaseToolsMcpServerLifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/DatabaseToolsConnectionIdQueryParam'
- $ref: '#/components/parameters/RelatedResourceIdentifierQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsMcpServerTypeQueryParam'
responses:
200:
description: A page of Database Tools MCP server summary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsMcpServerCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists Database Tools MCP servers in a compartment.
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsMcpServers?compartmentId=<compartmentId> HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DatabaseToolsMcpServer'
post:
description: 'Creates a new Database Tools MCP server.
'
operationId: CreateDatabaseToolsMcpServer
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: The Database Tools MCP server is being created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: URI of the new resource which was created by the request.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsMcpServer'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a new Database Tools MCP server.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsMcpServers HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"McpServer1\",\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleazhwqlcqjxznbtjietofx4ll5ez4mr3wkgbrvgiex5rt5nuikvktq\",\n \"type\": \"DEFAULT\",\n \"databaseToolsConnectionId\": \"ocid1.databasetoolsconnection.oc1.phx.exampleaaxjx47ignvzufg74jlixkqygujmdctskf47m7d6mndd6vlzafuta\",\n \"domainId\": \"ocid1.identitydomain.oc1.phx.exampleaaxjasgkajsbfjkahsfouaslfbakhsfvkasghfljashf\"\n}\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDatabaseToolsMcpServerDetails'
description: Details for the new Database Tools MCP server.
required: true
/databaseToolsMcpServers/{databaseToolsMcpServerId}:
delete:
description: Deletes the specified Database Tools MCP server resource.
operationId: DeleteDatabaseToolsMcpServer
parameters:
- $ref: '#/components/parameters/DatabaseToolsMcpServerIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: Request has been accepted. The Database Tools MCP server will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a Database Tools MCP server.
tags:
- databaseTools
x-example: 'DELETE /20201005/databaseToolsMcpServers/<databaseToolsMcpServerId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DatabaseToolsMcpServer'
get:
description: Gets details of the specified Database Tools MCP server.
operationId: GetDatabaseToolsMcpServer
parameters:
- $ref: '#/components/parameters/DatabaseToolsMcpServerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Database Tools MCP server's details have been retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsMcpServer'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a Database Tools MCP server.
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsMcpServers/<databaseToolsMcpServerId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
put:
description: Updates the specified Database Tools MCP server.
operationId: UpdateDatabaseToolsMcpServer
parameters:
- $ref: '#/components/parameters/DatabaseToolsMcpServerIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: Request has been accepted. The Database Tools MCP Server has been updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a Database Tools MCP server.
tags:
- databaseTools
x-example: "PUT /20201005/databaseToolsMcpServers/<databaseToolsMcpServerId>\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"type\": \"DEFAULT\",\n \"displayName\": \"McpServer2\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsMcpServer'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDatabaseToolsMcpServerDetails'
description: The information to be updated.
required: true
/databaseToolsMcpServers/{databaseToolsMcpServerId}/actions/addLock:
post:
description: Adds a lock to a DatabaseToolsMcpServer resource.
operationId: AddDatabaseToolsMcpServerLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsMcpServerIdPathParam'
- $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
responses:
200:
description: Lock is added.
headers:
etag:
description: 'etag for the returned DatabaseToolsMcpServer resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsMcpServer'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a DatabaseToolsMcpServer resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsMcpServer'
/databaseToolsMcpServers/{databaseToolsMcpServerId}/actions/cascadingDelete:
post:
description: 'Deletes Database Tools McpServer resource.
'
operationId: CascadingDeleteDatabaseToolsMcpServer
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsMcpServerIdPathParam'
responses:
202:
description: The request was accepted for deleting the resource.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the Database Tools MCP server and all its MCP toolsets.
tags:
- databaseTools
x-example: 'DELETE /20201005/databaseToolsMcpServers/<databaseToolsMcpServerId>/actions/cascadingDelete
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DatabaseToolsMcpServer'
/databaseToolsMcpServers/{databaseToolsMcpServerId}/actions/changeCompartment:
post:
description: 'Moves the specified Database Tools mcpserver to a different compartment in the same tenancy.
'
operationId: ChangeDatabaseToolsMcpServerCompartment
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsMcpServerIdPathParam'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: The resource will be moved to the specified compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Changes the compartment of a Database Tools MCP server.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsMcpServers/<databaseToolsMcpServerId>/actions/changeCompartment\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsMcpServer'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeDatabaseToolsMcpServerCompartmentDetails'
description: Request to change the compartment of the Database Tools MCP server.
required: true
/databaseToolsMcpServers/{databaseToolsMcpServerId}/actions/removeLock:
post:
description: Removes a lock from a DatabaseToolsMcpServer resource.
operationId: RemoveDatabaseToolsMcpServerLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsMcpServerIdPathParam'
- $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
responses:
200:
description: Lock is removed.
headers:
etag:
description: 'etag for the returned DatabaseToolsMcpServer resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsMcpServer'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a DatabaseToolsMcpServer resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsMcpServer'
/databaseToolsMcpToolsetVersions:
get:
description: Returns a list of Database Tools Toolset versions
operationId: ListDatabaseToolsMcpToolsetVersions
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DatabaseToolsMcpServerIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A Database Tools MCP Toolset type version summary object
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsMcpToolsetVersionCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists Toolsets and their versions
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsMcpToolsetVersions?compartmentId=<compartmentId> HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DatabaseToolsMcpToolsetVersionCollection'
/databaseToolsMcpToolsets:
get:
description: Returns a list of Database Tools Toolsets.
operationId: ListDatabaseToolsMcpToolsets
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DatabaseToolsMcpToolsetLifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsMcpToolsetTypeQueryParam'
- $ref: '#/components/parameters/DatabaseToolsMcpServerIdQueryParam'
responses:
200:
description: A page of Database Tools MCP Toolset summary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsMcpToolsetCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists Database Tools MCP Toolset in a compartment.
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsMcpToolsets?compartmentId=<compartmentId> HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DatabaseToolsMcpToolset'
post:
description: 'Creates a new Database Tools MCP Toolset.
'
operationId: CreateDatabaseToolsMcpToolset
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: The Database Tools MCP Toolset is being created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: URI of the new resource which was created by the request.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsMcpToolset'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a new Database Tools McpToolset.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsMcpToolsets HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"toolset1\",\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleazhwqlcqjxznbtjietofx4ll5ez4mr3wkgbrvgiex5rt5nuikvktq\",\n \"type\": \"CUSTOM_SQL_TOOL\",\n \"databaseToolsMcpServerId\": \"ocid1.databasetoolsmcpserver.oc1.phx.exampleaaxjx47ignvzufg74jlixkqygujmdctskf47m7d6mndd6vlzafuta\"\n}\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDatabaseToolsMcpToolsetDetails'
description: Details for the new Database Tools MCP Toolset.
required: true
/databaseToolsMcpToolsets/{databaseToolsMcpToolsetId}:
delete:
description: Deletes the specified Database Tools MCP Toolset resource.
operationId: DeleteDatabaseToolsMcpToolset
parameters:
- $ref: '#/components/parameters/DatabaseToolsMcpToolsetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: Request has been accepted. The Database Tools MCP Toolset will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a Database Tools MCP Toolset.
tags:
- databaseTools
x-example: 'DELETE /20201005/databaseToolsMcpToolsets/<databaseToolsMcpToolsetId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DatabaseToolsMcpToolset'
get:
description: Gets details of the specified Database Tools MCP Toolset.
operationId: GetDatabaseToolsMcpToolset
parameters:
- $ref: '#/components/parameters/DatabaseToolsMcpToolsetIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Database Tools MCP Toolset's details have been retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsMcpToolset'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a Database Tools MCP Toolset.
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsMcpToolsets/<databaseToolsMcpToolsetId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
put:
description: Updates the specified Database Tools MCP Toolset.
operationId: UpdateDatabaseToolsMcpToolset
parameters:
- $ref: '#/components/parameters/DatabaseToolsMcpToolsetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: The Database Tools MCP Toolset is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a Database Tools MCP Toolset.
tags:
- databaseTools
x-example: "PUT /20201005/databaseToolsMcpToolsets/<databaseToolsMcpToolsetId>\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"type\": \"CUSTOM_SQL_TOOL\",\n \"displayName\": \"McpToolset2\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsMcpToolset'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDatabaseToolsMcpToolsetDetails'
description: The information to be updated.
required: true
/databaseToolsMcpToolsets/{databaseToolsMcpToolsetId}/actions/addLock:
post:
description: Adds a lock to a DatabaseToolsMcpToolset resource.
operationId: AddDatabaseToolsMcpToolsetLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsMcpToolsetIdPathParam'
- $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
responses:
200:
description: Lock is added.
headers:
etag:
description: 'etag for the returned DatabaseToolsMcpToolset resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsMcpToolset'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a DatabaseToolsMcpToolset resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsMcpToolset'
/databaseToolsMcpToolsets/{databaseToolsMcpToolsetId}/actions/changeCompartment:
post:
description: 'Moves the specified Database Tools MCP Toolset to a different compartment in the same tenancy.
'
operationId: ChangeDatabaseToolsMcpToolsetCompartment
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsMcpToolsetIdPathParam'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: The resource will be moved to the specified compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Changes the compartment of a Database Tools MCP Toolset.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsMcpToolsets/<databaseToolsMcpToolsetId>/actions/changeCompartment\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsMcpToolset'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeDatabaseToolsMcpToolsetCompartmentDetails'
description: Request to change the compartment of the Database Tools MCP Toolset.
required: true
/databaseToolsMcpToolsets/{databaseToolsMcpToolsetId}/actions/removeLock:
post:
description: Removes a lock from a DatabaseToolsMcpToolset resource.
operationId: RemoveDatabaseToolsMcpToolsetLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsMcpToolsetIdPathParam'
- $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
responses:
200:
description: Lock is removed.
headers:
etag:
description: 'etag for the returned DatabaseToolsMcpToolset resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsMcpToolset'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a DatabaseToolsMcpToolset resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsMcpToolset'
/databaseToolsPrivateEndpoints:
get:
description: 'Returns a list of Database Tools private endpoints.
'
operationId: ListDatabaseToolsPrivateEndpoints
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/SubnetIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsEndpointServiceIdQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
responses:
200:
description: A page of Database Tools private endpoint summary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsPrivateEndpointCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists all Database Tools private endpoints in a compartment.
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsPrivateEndpoints?compartmentId=<compartmentId> HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DatabaseToolsPrivateEndpoint'
post:
description: 'Creates a new Database Tools private endpoint.
'
operationId: CreateDatabaseToolsPrivateEndpoint
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: The Database Tools private endpoint is being created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: URI of the new resource which was created by the request.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsPrivateEndpoint'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a new Database Tools private endpoint.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsPrivateEndpoints HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"displayName\": \"MyPE\",\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleazhwqlcqjxznbtjietofx4ll5ez4mr3wkgbrvgiex5rt5nuikvktq\",\n \"description\": \"Private Endpoint for mySubnet\",\n \"endpointServiceId\": \"ocid1.dbtoolsendpointservice.oc1.phx.exampletksujfufl4bhe5sqkfgn7t7lcrkkpy7km5iwzvg6ycls7r5dlbx6q\",\n \"subnetId\": \"ocid1.subnet.oc1.phx.exampleaihuofciaiazy2u5ko3uyz3sspwd6hf7oqhqmlk5xu3xdetkpui7a\",\n \"privateEndpointIp\": \"10.0.0.4\",\n \"nsgIds\": [\n \"ocid1.networksecuritygroup.oc1.phx.exampleamuwsqopnr4rxtz3ejobj4suzabgosma3rspaaoufy4d35droem5q\"\n ]\n}\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDatabaseToolsPrivateEndpointDetails'
description: Details for the new Database Tools private endpoint.
required: true
/databaseToolsPrivateEndpoints/{databaseToolsPrivateEndpointId}:
delete:
description: Deletes the specified Database Tools private endpoint.
operationId: DeleteDatabaseToolsPrivateEndpoint
parameters:
- $ref: '#/components/parameters/DatabaseToolsPrivateEndpointIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: Request has been accepted. The Database Tools private endpoint will be deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a Database Tools private endpoint.
tags:
- databaseTools
x-example: 'DELETE /20201005/databaseToolsPrivateEndpoints/<databaseToolsPrivateEndpointId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DatabaseToolsPrivateEndpoint'
get:
description: Gets details of a specified Database Tools private endpoint.
operationId: GetDatabaseToolsPrivateEndpoint
parameters:
- $ref: '#/components/parameters/DatabaseToolsPrivateEndpointIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The details of the specified Database Tools private endpoint.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsPrivateEndpoint'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a Database Tools private endpoint.
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsPrivateEndpoints/<databaseToolsPrivateEndpointId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
put:
description: Updates the specified Database Tools private endpoint.
operationId: UpdateDatabaseToolsPrivateEndpoint
parameters:
- $ref: '#/components/parameters/DatabaseToolsPrivateEndpointIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: The request has been accepted. The Database Tools private endpoint will be updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a Database Tools private endpoint.
tags:
- databaseTools
x-example: "PUT /20201005/databaseToolsPrivateEndpoints/<databaseToolsPrivateEndpointId>\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"displayName\": \"MyPE-appSubnet\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsPrivateEndpoint'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDatabaseToolsPrivateEndpointDetails'
description: The information to be updated.
required: true
/databaseToolsPrivateEndpoints/{databaseToolsPrivateEndpointId}/actions/addLock:
post:
description: Adds a lock to a DatabaseToolsPrivateEndpoint resource.
operationId: AddDatabaseToolsPrivateEndpointLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsPrivateEndpointIdPathParam'
- $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
responses:
200:
description: Lock is added.
headers:
etag:
description: 'etag for the returned DatabaseToolsPrivateEndpoint resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsPrivateEndpoint'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a DatabaseToolsPrivateEndpoint resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsPrivateEndpoint'
/databaseToolsPrivateEndpoints/{databaseToolsPrivateEndpointId}/actions/changeCompartment:
post:
description: 'Moves a Database Tools private endpoint into a different compartment in the same tenancy.
For information about moving resources between compartments, see
[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeDatabaseToolsPrivateEndpointCompartment
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsPrivateEndpointIdPathParam'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
202:
description: The Database Tools private endpoint will be moved. A work request has been created to track this operation.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Change the compartment of the Database Tools private endpoint.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsPrivateEndpoints/<databaseToolsConnectionId>/actions/changeCompartment\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsPrivateEndpoint'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeDatabaseToolsPrivateEndpointCompartmentDetails'
description: Request to change the compartment of the Database Tools private endpoint.
required: true
/databaseToolsPrivateEndpoints/{databaseToolsPrivateEndpointId}/actions/removeLock:
post:
description: Removes a lock from a DatabaseToolsPrivateEndpoint resource.
operationId: RemoveDatabaseToolsPrivateEndpointLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsPrivateEndpointIdPathParam'
- $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
responses:
200:
description: Lock is removed.
headers:
etag:
description: 'etag for the returned DatabaseToolsPrivateEndpoint resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsPrivateEndpoint'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a DatabaseToolsPrivateEndpoint resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsPrivateEndpoint'
/databaseToolsSqlReports:
get:
description: Returns a list of Database Tools SQL reports.
operationId: ListDatabaseToolsSqlReports
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DatabaseToolsSqlReportLifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsSqlReportTypeQueryParam'
responses:
200:
description: A page of Database Tools SQL report summary objects.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsSqlReportCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists Database Tools SQL reports in a compartment.
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsSqlReports?compartmentId=<compartmentId> HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DatabaseToolsSqlReport'
post:
description: 'Creates a new Database Tools Sql Report.
'
operationId: CreateDatabaseToolsSqlReport
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Database Tools SQL Report has been created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: URI of the new resource which was created by the request.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsSqlReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a new Database Tools Sql Report.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsSqlReport HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"SQL Report1\",\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleazhwqlcqjxznbtjietofx4ll5ez4mr3wkgbrvgiex5rt5nuikvktq\",\n \"type\": \"ORACLE_DATABASE\",\n \"description\": \"Simple SQL query\",\n \"source\": \"SELECT * FROM SYS.DBA_HIST_SYSTEM_EVENT WHERE SNAP_ID IN(SELECT SNAP_ID FROM SYS.DBA_HIST_SNAPSHOT WHERE BEGIN_INTERVAL_TIME>SYSDATE-1)\"\n}\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDatabaseToolsSqlReportDetails'
description: Details for the new Database Tools Sql Report.
required: true
/databaseToolsSqlReports/{databaseToolsSqlReportId}:
delete:
description: Deletes the specified Database Tools SQL Report resource.
operationId: DeleteDatabaseToolsSqlReport
parameters:
- $ref: '#/components/parameters/DatabaseToolsSqlReportIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: Request has been accepted. The Database Tools SQL Report has been deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a Database Tools SQL Report.
tags:
- databaseTools
x-example: 'DELETE /20201005/databaseToolsSqlReports/<databaseToolsSqlReportId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DatabaseToolsSqlReport'
get:
description: Gets details of the specified Database Tools SQL report.
operationId: GetDatabaseToolsSqlReport
parameters:
- $ref: '#/components/parameters/DatabaseToolsSqlReportIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Database Tools SQL report's details have been retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsSqlReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a Database Tools SQL report.
tags:
- databaseTools
x-example: 'GET /20201005/databaseToolsSqlReports/<databaseToolsSqlReportId>
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
put:
description: Updates the specified Database Tools SQL Report.
operationId: UpdateDatabaseToolsSqlReport
parameters:
- $ref: '#/components/parameters/DatabaseToolsSqlReportIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: Request has been accepted. The Database Tools SQL Report has been updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsSqlReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a Database Tools SQL Report.
tags:
- databaseTools
x-example: "PUT /20201005/databaseToolsSqlReports/<databaseToolsSqlReportId>\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"type\": \"ORACLE_DATABASE\",\n \"source\": \"SELECT * FROM DUAL;\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDatabaseToolsSqlReportDetails'
description: The information to be updated.
required: true
/databaseToolsSqlReports/{databaseToolsSqlReportId}/actions/addLock:
post:
description: Adds a lock to a DatabaseToolsSqlReport resource.
operationId: AddDatabaseToolsSqlReportLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsSqlReportIdPathParam'
- $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
responses:
200:
description: Lock is added.
headers:
etag:
description: 'etag for the returned DatabaseToolsSqlReport resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsSqlReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a DatabaseToolsSqlReport resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsSqlReport'
/databaseToolsSqlReports/{databaseToolsSqlReportId}/actions/changeCompartment:
post:
description: 'Moves the specified Database Tools SQL Report to a different compartment in the same tenancy.
'
operationId: ChangeDatabaseToolsSqlReportCompartment
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseToolsSqlReportIdPathParam'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: The SQL Report has been moved to the specified compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Changes the compartment of a Database Tools SQL Report.
tags:
- databaseTools
x-example: "POST /20201005/databaseToolsSqlReports/<databaseToolsSqlReportId>/actions/changeCompartment\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n"
x-related-resource: '#/definitions/DatabaseToolsSqlReport'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeDatabaseToolsSqlReportCompartmentDetails'
description: Request to change the compartment of the Database Tools SQL Report.
required: true
/databaseToolsSqlReports/{databaseToolsSqlReportId}/actions/removeLock:
post:
description: Removes a lock from a DatabaseToolsSqlReport resource.
operationId: RemoveDatabaseToolsSqlReportLock
parameters:
- description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
required: false
schema:
type: string
- description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource''s current etag value.
'
in: header
name: if-match
schema:
type: string
- $ref: '#/components/parameters/DatabaseToolsSqlReportIdPathParam'
- $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
responses:
200:
description: Lock is removed.
headers:
etag:
description: 'etag for the returned DatabaseToolsSqlReport resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseToolsSqlReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a DatabaseToolsSqlReport resource.
tags:
- databaseTools
x-related-resource: '#/definitions/DatabaseToolsSqlReport'
/workRequests:
get:
description: 'Lists the work requests in a compartment.
'
operationId: ListWorkRequests
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/ResourceIdentifierQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List Work Requests
tags:
- databaseTools
x-example: 'GET /20201005/workRequests?compartmentId=<compartmentId> HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/WorkRequest'
/workRequests/{workRequestId}:
get:
description: Gets the status of the specified work request.
operationId: GetWorkRequest
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The detail of the work request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
schema:
type: number
format: float
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequest'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: GET Work Request Status
tags:
- databaseTools
x-example: 'GET /20201005/workRequests/<workRequestId> HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
/workRequests/{workRequestId}/errors:
get:
description: 'Returns a paginated list of errors for the specified work request.
'
operationId: ListWorkRequestErrors
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: List of work request errors.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestErrorCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists work request errors
tags:
- databaseTools
x-example: 'GET /20201005/workRequests/<workRequestId>/errors HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/WorkRequestError'
/workRequests/{workRequestId}/logs:
get:
description: 'Returns a paginated list of logs for the specified work request.
'
operationId: ListWorkRequestLogs
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: List of work request logs.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestLogEntryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists work request logs
tags:
- databaseTools
x-example: 'GET /20201005/workRequests/<workRequestId>/logs HTTP/1.1
Host: dbtools.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
parameters:
NameQueryParam:
description: A filter to return only resources that match the entire specified name.
in: query
name: name
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
RelatedResourceIdentifierQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related resource.
in: query
name: relatedResourceIdentifier
required: false
x-default-description: 'null'
schema:
type: string
DatabaseToolsMcpServerIdQueryParam:
description: A filter to return only resources matching the specified `databaseToolsMcpServerId`.
in: query
name: databaseToolsMcpServerId
required: false
x-default-description: 'null'
x-obmcs-cli-param: mcp-server-id
schema:
type: string
maxLength: 255
minLength: 1
IfMatchHeader:
description: 'For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the etag you
provide matches the resource''s current etag value.
'
in: header
name: if-match
required: false
schema:
type: string
SortOrderQueryParam:
description: The sort order to use, either 'asc' or 'desc'.
in: query
name: sortOrder
x-obmcs-top-level-enum: '#/definitions/SortOrder'
schema:
type: string
enum:
- ASC
- DESC
default: ASC
DatabaseToolsMcpToolsetTypeQueryParam:
description: A filter to return only resources with one of the specified type values.
in: query
name: type
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
enum:
- CUSTOM_SQL_TOOL
- BUILT_IN_SQL_TOOLS
- CUSTOMIZABLE_REPORTING_TOOLS
- GENAI_SQL_ASSISTANT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpToolsetType'
DatabaseToolsMcpServerIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools MCP server.
in: path
name: databaseToolsMcpServerId
required: true
x-obmcs-cli-param: mcp-server-id
schema:
type: string
DatabaseToolsMcpToolsetLifecycleStateQueryParam:
description: A filter to return resources only when their `databaseToolsMcpToolsetLifecycleState` matches the specified `databaseToolsMcpToolsetLifecycleState`.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpToolsetLifecycleState'
schema:
type: string
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
RequestIdHeader:
description: The client request ID for tracing.
in: header
name: opc-request-id
schema:
type: string
LifecycleStateQueryParam:
description: A filter to return only resources their `lifecycleState` matches the specified `lifecycleState`.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
schema:
type: string
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- INACTIVE
DatabaseToolsEndpointServiceIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools Endpoint Service.
in: path
name: databaseToolsEndpointServiceId
required: true
schema:
type: string
AddResourceLockDetailsBodyParam:
description: AddResourceLockDetails body parameter
in: body
name: AddResourceLockDetails
required: true
schema:
$ref: '#/components/schemas/AddResourceLockDetails'
SortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeCreated
- displayName
default: timeCreated
ResourceIdentifierQueryParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource.
in: query
name: resourceIdentifier
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
DatabaseToolsConnectionIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection.
in: path
name: databaseToolsConnectionId
required: true
schema:
type: string
DatabaseToolsConnectionIdQueryParam:
description: A filter to return only resources when their `databaseToolsConnectionId` matches the specified `databaseToolsConnectionId`.
in: query
name: databaseToolsConnectionId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
WorkRequestIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous request.
in: path
name: workRequestId
required: true
schema:
type: string
DatabaseToolsMcpServerLifecycleStateQueryParam:
description: A filter to return resources only when their `databaseToolsMcpServerLifecycleState` matches the specified `databaseToolsMcpServerLifecycleState`.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerLifecycleState'
schema:
type: string
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- NEEDS_ATTENTION
DatabaseToolsPrivateEndpointIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools private endpoint.
in: path
name: databaseToolsPrivateEndpointId
required: true
schema:
type: string
DatabaseToolsConnectionRuntimeIdentityQueryParam:
description: A filter to return only resources with one of the specified runtimeIdentity values.
in: query
name: runtimeIdentity
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
enum:
- AUTHENTICATED_PRINCIPAL
- RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/RuntimeIdentity'
DatabaseToolsMcpServerTypeQueryParam:
description: A filter to return only resources with one of the specified type values.
in: query
name: type
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
enum:
- DEFAULT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerType'
DatabaseToolsIdentityLifecycleStateQueryParam:
description: A filter to return resources only when their `databaseToolsIdentityLifecycleState` matches the specified `databaseToolsIdentityLifecycleState`.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsIdentityLifecycleState'
schema:
type: string
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- NEEDS_ATTENTION
DisplayNameQueryParam:
description: A filter to return only resources that match the entire specified display name.
in: query
name: displayName
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
DatabaseToolsSqlReportIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools SQL Report.
in: path
name: databaseToolsSqlReportId
required: true
x-obmcs-cli-param: sql-report-id
schema:
type: string
DatabaseToolsSqlReportTypeQueryParam:
description: A filter to return only resources with one of the specified type values.
in: query
name: type
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
enum:
- ORACLE_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsSqlReportType'
PaginationTokenQueryParam:
description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
in: query
name: page
schema:
type: string
minLength: 1
DatabaseToolsEndpointServiceIdQueryParam:
description: A filter to return only resources their `endpointServiceId` matches the specified `endpointServiceId`.
in: query
name: endpointServiceId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
DatabaseToolsConnectionTypeQueryParam:
description: A filter to return only resources their type matches the specified type.
in: query
name: type
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
enum:
- ORACLE_DATABASE
- MYSQL
- POSTGRESQL
- GENERIC_JDBC
type: string
x-obmcs-top-level-enum: '#/definitions/ConnectionType'
RetryTokenHeader:
description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations. For example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
might be rejected.
Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE "_") and dash (U+002D HYPHEN-MINUS "-")
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
pattern: ^[a-zA-Z0-9_\-]{1,64}$
DatabaseToolsDatabaseApiGatewayConfigLifecycleStateQueryParam:
description: A filter to return resources only when their `lifecycleState` matches the specified `lifecycleState`.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigLifecycleState'
schema:
type: string
enum:
- ACTIVE
- DELETED
DatabaseToolsMcpToolsetIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools MCP Toolset.
in: path
name: databaseToolsMcpToolsetId
required: true
x-obmcs-cli-param: mcp-toolset-id
schema:
type: string
DatabaseToolsConnectionRuntimeSupportQueryParam:
description: A filter to return only resources with one of the specified type values.
in: query
name: runtimeSupport
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
enum:
- SUPPORTED
- UNSUPPORTED
type: string
x-obmcs-top-level-enum: '#/definitions/RuntimeSupport'
WorkRequestSortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeAccepted
- timeUpdated
default: timeAccepted
DatabaseToolsIdentityIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools identity.
in: path
name: databaseToolsIdentityId
required: true
schema:
type: string
DatabaseToolsSqlReportLifecycleStateQueryParam:
description: A filter to return resources only when their `databaseToolsSqlReportLifecycleState` matches the specified `databaseToolsSqlReportLifecycleState`.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsSqlReportLifecycleState'
schema:
type: string
enum:
- ACTIVE
- DELETED
DatabaseToolsIdentityTypeQueryParam:
description: A filter to return only resources with one of the specified type values.
in: query
name: type
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
enum:
- ORACLE_DATABASE_RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/IdentityType'
CompartmentIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
in: query
name: compartmentId
required: true
schema:
type: string
RemoveResourceLockDetailsBodyParam:
description: RemoveResourceLockDetails body parameter
in: body
name: RemoveResourceLockDetails
required: true
schema:
$ref: '#/components/schemas/RemoveResourceLockDetails'
PaginationLimitQueryParam:
description: The maximum number of items to return.
in: query
name: limit
schema:
type: integer
default: 10
maximum: 1000
minimum: 1
DatabaseToolsDatabaseApiGatewayConfigIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config.
in: path
name: databaseToolsDatabaseApiGatewayConfigId
required: true
x-obmcs-cli-param: database-api-gateway-config-id
schema:
type: string
SubnetIdQueryParam:
description: A filter to return only resources their `subnetId` matches the specified `subnetId`.
in: query
name: subnetId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
DatabaseToolsDatabaseApiGatewayConfigTypeQueryParam:
description: A filter to return only resources with one of the specified type values.
in: query
name: type
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
enum:
- DEFAULT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
OverrideLocksQueryParameter:
description: Whether to override locks (if any exist).
in: query
name: isLockOverride
schema:
type: boolean
default: false
schemas:
DatabaseToolsConnectionCollection:
description: List of Database Tools connection summary items.
properties:
items:
description: Array of Database Tools connection summary items.
items:
$ref: '#/components/schemas/DatabaseToolsConnectionSummary'
type: array
required:
- items
type: object
Error:
description: Error Information.
properties:
code:
description: A short error code that defines the error, meant for programmatic parsing.
type: string
message:
description: A human-readable error string.
type: string
required:
- code
- message
DatabaseToolsMcpToolsetCollection:
description: List of Database Tools MCP Toolset summary items.
properties:
items:
description: Array of Database Tools MCP Toolset summary items.
items:
$ref: '#/components/schemas/DatabaseToolsMcpToolsetSummary'
type: array
required:
- items
type: object
UpdateDatabaseToolsIdentityDetails:
description: Database Tools identity information to be updated.
discriminator:
propertyName: type
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
type:
description: The Database Tools identity type.
enum:
- ORACLE_DATABASE_RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/IdentityType'
required:
- type
type: object
DatabaseToolsEndpointServiceCollection:
description: List of `DatabaseToolsEndpointServiceSummary` items.
properties:
items:
description: Array of `DatabaseToolsEndpointServiceSummary` items.
items:
$ref: '#/components/schemas/DatabaseToolsEndpointServiceSummary'
type: array
required:
- items
type: object
CreateDatabaseToolsMcpToolsetDetails:
description: Details for the new Database Tools MCP server.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools MCP server.
maxLength: 255
minLength: 1
type: string
databaseToolsMcpServerId:
description: The OCID of the Database Tools MCP Server
maxLength: 255
minLength: 1
type: string
x-obmcs-cli-param: mcp-server-id
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A human readable description of the Database Tools MCP toolset.
maxLength: 400
minLength: 0
type: string
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 1
type: array
type:
description: The Database Tools MCP Toolset type.
enum:
- CUSTOM_SQL_TOOL
- BUILT_IN_SQL_TOOLS
- CUSTOMIZABLE_REPORTING_TOOLS
- GENAI_SQL_ASSISTANT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpToolsetType'
version:
description: The MCP toolset version
type: integer
x-obmcs-cli-param: toolset-version
required:
- version
- databaseToolsMcpServerId
- compartmentId
- type
- displayName
type: object
DatabaseToolsEndpointService:
description: Description of Database Tools Endpoint Service.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools Endpoint Service.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A description of the Database Tools Endpoint Service.
maxLength: 255
minLength: 1
type: string
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools Endpoint Service.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools Endpoint Service.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- INACTIVE
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
name:
description: A unique, non-changeable resource name.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
format: date-time
type: string
timeUpdated:
description: The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
format: date-time
type: string
required:
- id
- timeCreated
- lifecycleState
type: object
DatabaseToolsMcpServerCollection:
description: List of Database Tools MCP server summary items.
properties:
items:
description: Array of Database Tools MCP server summary items.
items:
$ref: '#/components/schemas/DatabaseToolsMcpServerSummary'
type: array
required:
- items
type: object
ChangeDatabaseToolsIdentityCompartmentDetails:
description: Contains the details for the compartment to move the Database Tools identity to.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the Database Tools identity to.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
DatabaseToolsMcpServer:
description: Allows the creation, configuration and management of an MCP server.
discriminator:
propertyName: type
properties:
accessTokenExpiryInSeconds:
default: 3600
description: Access token expiry in seconds
maximum: 31622400
minimum: 60
type: integer
builtInRoles:
description: Built-in roles associated with the MCP Server.
items:
$ref: '#/components/schemas/DatabaseToolsMcpServerBuiltInRole'
maxItems: 40
minItems: 0
type: array
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools MCP server.
maxLength: 255
minLength: 1
type: string
customRoles:
description: Custom roles associated with the MCP Server.
items:
$ref: '#/components/schemas/DatabaseToolsMcpServerCustomRole'
maxItems: 40
minItems: 0
type: array
databaseToolsConnectionId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools connection.
maxLength: 255
minLength: 1
type: string
x-obmcs-cli-param: connection-id
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A human-readable description of the Database Tools MCP server.
maxLength: 400
minLength: 0
type: string
displayName:
description: A meaningful, human-readable label displayed to end users. Not required to be unique and can be changed after creation. Do not include confidential information.
maxLength: 255
minLength: 1
type: string
endpoints:
description: Invoke endpoints for the MCP server.
items:
$ref: '#/components/schemas/DatabaseToolsMcpServerEndpoint'
maxItems: 1
minItems: 0
type: array
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools MCP server.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools MCP server.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerLifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
refreshTokenExpiryInSeconds:
default: 604800
description: Refresh token expiry in seconds
maximum: 31622400
minimum: 60
type: integer
relatedResource:
$ref: '#/components/schemas/DatabaseToolsMcpServerRelatedResource'
runtimeIdentity:
default: AUTHENTICATED_PRINCIPAL
description: 'Specifies the identity used when accessing OCI resources at runtime. AUTHENTICATED_PRINCIPAL to use the caller’s identity (On-Behalf-Of token), or RESOURCE_PRINCIPAL to use the MCP Server’s resource principal (RPST).
'
enum:
- AUTHENTICATED_PRINCIPAL
- RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerRuntimeIdentity'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools MCP server was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools MCP server was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools MCP server type.
enum:
- DEFAULT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerType'
required:
- id
- compartmentId
- type
- displayName
- databaseToolsConnectionId
- lifecycleState
- timeCreated
- timeUpdated
- runtimeIdentity
- relatedResource
type: object
DatabaseToolsMcpToolsetSummary:
description: Summary of the Database Tools MCP Toolset.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools MCP server.
maxLength: 255
minLength: 1
type: string
databaseToolsMcpServerId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools McpServer.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools MCP Toolset.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools MCP Toolset.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpToolsetLifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools MCP server was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools MCP server was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools MCP Toolset type.
enum:
- CUSTOM_SQL_TOOL
- BUILT_IN_SQL_TOOLS
- CUSTOMIZABLE_REPORTING_TOOLS
- GENAI_SQL_ASSISTANT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpToolsetType'
version:
description: The toolset version
type: integer
required:
- id
- version
- compartmentId
- type
- displayName
- databaseToolsMcpServerId
- lifecycleState
- timeCreated
- timeUpdated
type: object
ChangeDatabaseToolsPrivateEndpointCompartmentDetails:
description: Contains the details for the compartment to move the Database Tools private endpoint to.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the `DatabaseConnectionProfile` to.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
UpdateDatabaseToolsMcpServerDetails:
description: Database Tools MCP server information to be updated.
discriminator:
propertyName: type
properties:
accessTokenExpiryInSeconds:
description: Access token expiry in seconds
maximum: 31622400
minimum: 60
type: integer
customRoles:
description: Custom roles associated with the MCP Server.
items:
$ref: '#/components/schemas/DatabaseToolsMcpServerCustomRole'
maxItems: 40
minItems: 0
type: array
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A human-readable description of the Database Tools MCP server.
maxLength: 400
minLength: 0
type: string
displayName:
description: A meaningful, human-readable label displayed to end users. Not required to be unique and can be changed after creation. Do not include confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
refreshTokenExpiryInSeconds:
description: Refresh token expiry in seconds
maximum: 31622400
minimum: 60
type: integer
type:
description: The Database Tools MCP server type.
enum:
- DEFAULT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerType'
required:
- type
type: object
DatabaseToolsMcpToolsetVersionCollection:
description: List of MCP toolset type version summary items.
properties:
items:
description: Array of MCP toolset type version summary items.
items:
$ref: '#/components/schemas/DatabaseToolsMcpToolsetVersionSummary'
type: array
required:
- items
type: object
UpdateDatabaseToolsSqlReportDetails:
description: Database Tools SQL report information to be updated.
discriminator:
propertyName: type
properties:
columns:
description: Descriptive information on columns referenced in the Database Tools SQL Report source.
items:
$ref: '#/components/schemas/DatabaseToolsSqlReportColumn'
maxItems: 100
type: array
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A description of the SQL report.
maxLength: 1024
minLength: 1
type: string
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
instructions:
description: Instructions on how to use the SQL report. Step-by-step guidance for an AI agent on how to execute or fill in parameters for the report.
maxLength: 4000
minLength: 1
type: string
purpose:
description: Purpose of the Database Tools SQL report. Scenario or conditions describing when or why this report should be used. Provides selection criteria to AI agents to improve report selection accuracy.
maxLength: 4000
minLength: 1
type: string
source:
description: SQL query executed to generate the report.
maxLength: 32000
minLength: 1
type: string
type:
description: The Database Tools SQL report type.
enum:
- ORACLE_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsSqlReportType'
variables:
description: Variables referenced in the Database Tools SQL Report source.
items:
$ref: '#/components/schemas/DatabaseToolsSqlReportVariable'
maxItems: 100
type: array
required:
- type
type: object
CreateDatabaseToolsIdentityDetails:
description: Details for the new Database Tools identity.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools identity.
maxLength: 255
minLength: 1
type: string
databaseToolsConnectionId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools connection.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 1
type: array
type:
description: The Database Tools identity type.
enum:
- ORACLE_DATABASE_RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/IdentityType'
required:
- type
- compartmentId
- displayName
- databaseToolsConnectionId
type: object
DatabaseToolsPrivateEndpointReverseConnectionConfiguration:
description: Reverse connection configuration details of the private endpoint.
properties:
reverseConnectionsSourceIps:
description: 'A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets
traveling from the service''s VCN to the customer''s VCN.
'
items:
$ref: '#/components/schemas/DatabaseToolsPrivateEndpointReverseConnectionsSourceIp'
type: array
type: object
RefreshDatabaseToolsIdentityCredentialDetails:
description: The Database Tools identity refresh credential details.
discriminator:
propertyName: type
properties:
type:
description: The Database Tools identity type.
enum:
- ORACLE_DATABASE_RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/IdentityType'
required:
- type
type: object
WorkRequestSummary:
description: A summary of the status of a work request.
properties:
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
maxLength: 255
minLength: 1
type: string
operationType:
description: The asynchronous operation tracked by this work request.
enum:
- CREATE_DATABASE_TOOLS_CONNECTION
- UPDATE_DATABASE_TOOLS_CONNECTION
- DELETE_DATABASE_TOOLS_CONNECTION
- CREATE_DATABASE_TOOLS_SERVICE_INSTANCE
- UPDATE_DATABASE_TOOLS_SERVICE_INSTANCE
- DELETE_DATABASE_TOOLS_SERVICE_INSTANCE
- CREATE_DATABASE_TOOLS_PRIVATE_ENDPOINT
- UPDATE_DATABASE_TOOLS_PRIVATE_ENDPOINT
- DELETE_DATABASE_TOOLS_PRIVATE_ENDPOINT
- CREATE_DATABASE_TOOLS_IDENTITY
- DELETE_DATABASE_TOOLS_IDENTITY
- UPDATE_DATABASE_TOOLS_IDENTITY
- REFRESH_DATABASE_TOOLS_IDENTITY_CREDENTIAL
- CREATE_DATABASE_TOOLS_MCP_SERVER
- DELETE_DATABASE_TOOLS_MCP_SERVER
- UPDATE_DATABASE_TOOLS_MCP_SERVER
- CREATE_DATABASE_TOOLS_MCP_TOOLSET
- DELETE_DATABASE_TOOLS_MCP_TOOLSET
- UPDATE_DATABASE_TOOLS_MCP_TOOLSET
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
percentComplete:
description: Percentage of the request completed.
format: float
type: number
resources:
description: The resources affected by this work request.
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: The status of the work request.
enum:
- ACCEPTED
- IN_PROGRESS
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
- WAITING
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: The date and time the work request was created, in the format defined by RFC3339.
format: date-time
type: string
timeFinished:
description: 'The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`.
Format is defined by RFC3339.
'
format: date-time
type: string
timeStarted:
description: 'The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`,
in the format defined by RFC3339.
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the work request was last updated,
in the format defined by RFC3339.
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- percentComplete
- timeAccepted
DatabaseToolsEndpointServiceSummary:
description: Summary of the Database Tools Endpoint Service.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools Endpoint Service.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A description of the Database Tools Endpoint Service.
maxLength: 255
minLength: 1
type: string
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools Endpoint Service.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools Endpoint Service.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- INACTIVE
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
name:
description: A unique, non-changeable resource name.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string
format: date-time
type: string
timeUpdated:
description: The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string
format: date-time
type: string
required:
- id
- displayName
type: object
DatabaseToolsSqlReportVariable:
description: A variable referenced in the Database Tools SQL Report source.
properties:
description:
description: The description of the variable
maxLength: 2000
minLength: 1
type: string
name:
description: The name of the variable
pattern: ^[A-Za-z][A-Za-z0-9_$#]{0,29}$
type: string
type:
description: The type of the variable
maxLength: 255
minLength: 1
type: string
required:
- name
- type
- description
type: object
DatabaseToolsMcpServerCustomRole:
description: DatabaseToolsMcpServerCustomRole.
properties:
description:
description: The description of the custom role.
maxLength: 400
minLength: 1
type: string
displayName:
description: The display name of the custom role.
maxLength: 100
minLength: 1
pattern: ^[a-zA-Z_][a-zA-Z0-9_\.-]{0,99}$
type: string
required:
- displayName
- description
type: object
CreateDatabaseToolsPrivateEndpointDetails:
description: The details for the new Database Tools private endpoint.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools private endpoint.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A description of the Database Tools private endpoint.
maxLength: 255
minLength: 1
type: string
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
endpointServiceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the `DatabaseToolsEndpointService`.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 1
type: array
nsgIds:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the network security groups
that the private endpoint''s VNIC belongs to. For more information about NSGs, see
[NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/).
'
items:
maxLength: 255
minLength: 1
type: string
type: array
uniqueItems: true
privateEndpointIp:
description: The private IP address that represents the access point for the associated endpoint service.
maxLength: 46
minLength: 1
type: string
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release)
'
type: object
description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}`
'
type: object
description: 'Zero trust Packet Routing (ZPR) Security Attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`
'
type: object
subnetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet that the private endpoint belongs to.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
- subnetId
- endpointServiceId
- displayName
type: object
ChangeDatabaseToolsDatabaseApiGatewayConfigCompartmentDetails:
description: Contains the details for the compartment to move the Database Tools database API gateway config to.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the Database Tools database API gateway config to.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
ChangeDatabaseToolsConnectionCompartmentDetails:
description: Contains the details for the compartment to move the Database Tools connection to.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the Database Tools connection to.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
DatabaseToolsConnectionSummary:
description: Summary of the Database Tools connection.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools connection.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools connection.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
type: string
lifecycleState:
description: The current state of the Database Tools connection.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- INACTIVE
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
runtimeEndpoint:
description: Specifies the Database Tools Runtime endpoint.
maxLength: 255
minLength: 1
type: string
runtimeIdentity:
description: 'Specifies the identity used when accessing OCI resources at runtime. AUTHENTICATED_PRINCIPAL to use the caller’s identity (On-Behalf-Of token), or RESOURCE_PRINCIPAL to use the connection’s resource principal (RPST).
'
enum:
- AUTHENTICATED_PRINCIPAL
- RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/RuntimeIdentity'
runtimeSupport:
description: Specifies whether this connection is supported by the Database Tools Runtime.
enum:
- SUPPORTED
- UNSUPPORTED
type: string
x-obmcs-top-level-enum: '#/definitions/RuntimeSupport'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools connection was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools connection was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools connection type.
enum:
- ORACLE_DATABASE
- MYSQL
- POSTGRESQL
- GENERIC_JDBC
type: string
x-obmcs-top-level-enum: '#/definitions/ConnectionType'
required:
- id
- displayName
- compartmentId
- lifecycleState
- timeCreated
- timeUpdated
- type
- runtimeSupport
- runtimeIdentity
- runtimeEndpoint
type: object
UpdateDatabaseToolsConnectionDetails:
description: The information to be updated.
discriminator:
propertyName: type
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
type:
description: The Database Tools connection type.
enum:
- ORACLE_DATABASE
- MYSQL
- POSTGRESQL
- GENERIC_JDBC
type: string
x-obmcs-top-level-enum: '#/definitions/ConnectionType'
required:
- type
type: object
UpdateDatabaseToolsDatabaseApiGatewayConfigDetails:
description: Database Tools database API gateway config information to be updated.
discriminator:
propertyName: type
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
type:
description: The Database Tools database API gateway config type.
enum:
- DEFAULT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
required:
- type
type: object
ValidateDatabaseToolsConnectionDetails:
description: Connection validation details.
discriminator:
propertyName: type
properties:
type:
description: The Database Tools connection type.
enum:
- ORACLE_DATABASE
- MYSQL
- POSTGRESQL
- GENERIC_JDBC
type: string
x-obmcs-top-level-enum: '#/definitions/ConnectionType'
required:
- type
type: object
RemoveResourceLockDetails:
allOf:
- $ref: '#/components/schemas/ResourceLock'
CreateDatabaseToolsConnectionDetails:
description: Details for the new Database Tools connection.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools connection.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 1
type: array
runtimeIdentity:
default: AUTHENTICATED_PRINCIPAL
description: 'Specifies the identity used when accessing OCI resources at runtime. AUTHENTICATED_PRINCIPAL to use the caller’s identity (On-Behalf-Of token), or RESOURCE_PRINCIPAL to use the connection’s resource principal (RPST).
'
enum:
- AUTHENTICATED_PRINCIPAL
- RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/RuntimeIdentity'
runtimeSupport:
default: SUPPORTED
description: Specifies whether this connection is supported by the Database Tools Runtime.
enum:
- SUPPORTED
- UNSUPPORTED
type: string
x-obmcs-top-level-enum: '#/definitions/RuntimeSupport'
type:
description: The Database Tools connection type.
enum:
- ORACLE_DATABASE
- MYSQL
- POSTGRESQL
- GENERIC_JDBC
type: string
x-obmcs-top-level-enum: '#/definitions/ConnectionType'
required:
- displayName
- compartmentId
- type
type: object
DatabaseToolsSqlReport:
description: Allows generating a summary of SQL query execution details for database operations.
discriminator:
propertyName: type
properties:
columns:
description: Descriptive information on columns referenced in the Database Tools SQL Report source.
items:
$ref: '#/components/schemas/DatabaseToolsSqlReportColumn'
maxItems: 100
type: array
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools SQL report.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A description of the SQL report.
maxLength: 1024
minLength: 1
type: string
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools SQL report.
maxLength: 255
minLength: 1
type: string
instructions:
description: Instructions on how to use the SQL report. Step-by-step guidance for an AI agent on how to execute or fill in parameters for the report.
maxLength: 4000
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools SQL report.
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsSqlReportLifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
purpose:
description: Purpose of the Database Tools SQL report. Scenario or conditions describing when or why this report should be used. Provides selection criteria to AI agents to improve report selection accuracy.
maxLength: 4000
minLength: 1
type: string
source:
description: SQL query executed to generate the report.
maxLength: 32000
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools SQL report was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools SQL report was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools SQL report type.
enum:
- ORACLE_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsSqlReportType'
variables:
description: Variables referenced in the Database Tools SQL Report source.
items:
$ref: '#/components/schemas/DatabaseToolsSqlReportVariable'
maxItems: 100
type: array
required:
- id
- type
- compartmentId
- displayName
- source
- lifecycleState
- timeCreated
- timeUpdated
type: object
ValidateDatabaseToolsIdentityCredentialDetails:
description: Identity Credential validation details.
discriminator:
propertyName: type
properties:
type:
description: The Database Tools identity type.
enum:
- ORACLE_DATABASE_RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/IdentityType'
required:
- type
type: object
DatabaseToolsPrivateEndpoint:
description: Allows the Database Tools service to connect to databases in a customer's virtual cloud network (VCN).
properties:
additionalFqdns:
description: A list of additional FQDNs that can be also be used for the private endpoint.
items:
maxLength: 255
minLength: 1
type: string
type: array
uniqueItems: true
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools private endpoint.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A description of the Database Tools private endpoint.
maxLength: 255
minLength: 0
type: string
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
endpointFqdn:
description: Then FQDN to use for the private endpoint.
maxLength: 255
minLength: 1
type: string
endpointServiceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools Endpoint Service.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools private endpoint.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools private endpoint.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- INACTIVE
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
nsgIds:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the network security groups
that the private endpoint''s VNIC belongs to. For more information about NSGs, see
[NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/).
'
items:
maxLength: 255
minLength: 1
type: string
type: array
uniqueItems: true
privateEndpointIp:
description: The private IP address that represents the access point for the associated endpoint service.
maxLength: 46
minLength: 1
type: string
privateEndpointVnicId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the private endpoint's VNIC.
maxLength: 255
minLength: 1
type: string
reverseConnectionConfiguration:
$ref: '#/components/schemas/DatabaseToolsPrivateEndpointReverseConnectionConfiguration'
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release)
'
type: object
description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}`
'
type: object
description: 'Zero trust Packet Routing (ZPR) Security Attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`
'
type: object
subnetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet that the private endpoint belongs to.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string
format: date-time
type: string
timeUpdated:
description: The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string
format: date-time
type: string
vcnId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VCN that the private endpoint belongs to.
maxLength: 255
minLength: 1
type: string
required:
- id
- compartmentId
- subnetId
- endpointServiceId
- timeCreated
- timeUpdated
- lifecycleState
type: object
DatabaseToolsDatabaseApiGatewayConfig:
description: Manage configuration related to database API gateway config resources.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools database API gateway config.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools database API gateway config.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools database API gateway config.
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigLifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
metadataSource:
description: The RESTful service definition location.
enum:
- DATABASE
- CLOUD
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigMetadataSource'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools database API gateway config type.
enum:
- DEFAULT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
required:
- id
- type
- compartmentId
- displayName
- metadataSource
- lifecycleState
- timeCreated
- timeUpdated
type: object
CreateDatabaseToolsMcpServerDetails:
description: Details for the new Database Tools MCP server.
discriminator:
propertyName: type
properties:
accessTokenExpiryInSeconds:
default: 3600
description: Access token expiry in seconds
maximum: 31622400
minimum: 60
type: integer
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools MCP server.
maxLength: 255
minLength: 1
type: string
customRoles:
description: Custom Roles associated with the MCP Server.
items:
$ref: '#/components/schemas/DatabaseToolsMcpServerCustomRole'
maxItems: 40
minItems: 0
type: array
databaseToolsConnectionId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools connection.
maxLength: 255
minLength: 1
type: string
x-obmcs-cli-param: connection-id
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A human-readable description of the Database Tools MCP server.
maxLength: 400
minLength: 0
type: string
displayName:
description: A meaningful, human-readable label displayed to end users. Not required to be unique and can be changed after creation. Do not include confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 1
type: array
refreshTokenExpiryInSeconds:
default: 604800
description: Refresh token expiry in seconds
maximum: 31622400
minimum: 60
type: integer
runtimeIdentity:
default: AUTHENTICATED_PRINCIPAL
description: 'Specifies the identity used when accessing OCI resources at runtime. AUTHENTICATED_PRINCIPAL to use the caller’s identity (On-Behalf-Of token), or RESOURCE_PRINCIPAL to use the MCP Server’s resource principal (RPST).
'
enum:
- AUTHENTICATED_PRINCIPAL
- RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerRuntimeIdentity'
type:
description: The Database Tools MCP server type.
enum:
- DEFAULT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerType'
required:
- compartmentId
- type
- displayName
- databaseToolsConnectionId
type: object
ChangeDatabaseToolsMcpServerCompartmentDetails:
description: Contains the details for the compartment to move the Database Tools MCP server to.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the Database Tools MCP server to.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
UpdateDatabaseToolsPrivateEndpointDetails:
description: The information to be updated.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A description of the Database Tools private endpoint.
maxLength: 255
minLength: 0
type: string
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
nsgIds:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the network security groups
that the private endpoint''s VNIC belongs to. For more information about NSGs, see
[NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/).
'
items:
maxLength: 255
minLength: 1
type: string
type: array
uniqueItems: true
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release)
'
type: object
description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}`
'
type: object
description: 'Zero trust Packet Routing (ZPR) Security Attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`
'
type: object
type: object
WorkRequestLogEntry:
description: A log message from the execution of a work request.
properties:
message:
description: Human-readable log message.
type: string
timestamp:
description: The time the log message was written. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- message
- timestamp
WorkRequest:
description: An asynchronous work request.
properties:
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
maxLength: 255
minLength: 1
type: string
operationType:
description: The asynchronous operation tracked by this work request.
enum:
- CREATE_DATABASE_TOOLS_CONNECTION
- UPDATE_DATABASE_TOOLS_CONNECTION
- DELETE_DATABASE_TOOLS_CONNECTION
- CREATE_DATABASE_TOOLS_SERVICE_INSTANCE
- UPDATE_DATABASE_TOOLS_SERVICE_INSTANCE
- DELETE_DATABASE_TOOLS_SERVICE_INSTANCE
- CREATE_DATABASE_TOOLS_PRIVATE_ENDPOINT
- UPDATE_DATABASE_TOOLS_PRIVATE_ENDPOINT
- DELETE_DATABASE_TOOLS_PRIVATE_ENDPOINT
- CREATE_DATABASE_TOOLS_IDENTITY
- DELETE_DATABASE_TOOLS_IDENTITY
- UPDATE_DATABASE_TOOLS_IDENTITY
- REFRESH_DATABASE_TOOLS_IDENTITY_CREDENTIAL
- CREATE_DATABASE_TOOLS_MCP_SERVER
- DELETE_DATABASE_TOOLS_MCP_SERVER
- UPDATE_DATABASE_TOOLS_MCP_SERVER
- CREATE_DATABASE_TOOLS_MCP_TOOLSET
- DELETE_DATABASE_TOOLS_MCP_TOOLSET
- UPDATE_DATABASE_TOOLS_MCP_TOOLSET
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
percentComplete:
description: Percentage of the request completed.
format: float
type: number
resources:
description: The resources affected by this work request.
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: The status of the work request.
enum:
- ACCEPTED
- IN_PROGRESS
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
- WAITING
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: The date and time the work request was created, in the format defined by RFC3339.
format: date-time
type: string
timeFinished:
description: 'The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`.
Format is defined by RFC3339.
'
format: date-time
type: string
timeStarted:
description: 'The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`,
in the format defined by RFC3339.
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the work request was last updated,
in the format defined by RFC3339.
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- resources
- percentComplete
- timeAccepted
DatabaseToolsSqlReportColumn:
description: Descriptive information on columns referenced in the Database Tools SQL Report source.
properties:
description:
description: The description of the column
maxLength: 2000
minLength: 1
type: string
name:
description: The name of the column
type: string
type:
description: The type of the column
maxLength: 255
minLength: 1
type: string
required:
- name
- type
- description
type: object
DatabaseToolsIdentity:
description: Manages credentials in a database to access service resources.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools identity.
maxLength: 255
minLength: 1
type: string
databaseToolsConnectionId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools connection.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools identity.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools identity.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsIdentityLifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools identity was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools identity was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools identity type.
enum:
- ORACLE_DATABASE_RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/IdentityType'
required:
- id
- type
- compartmentId
- displayName
- databaseToolsConnectionId
- lifecycleState
- timeCreated
- timeUpdated
type: object
DatabaseToolsPrivateEndpointReverseConnectionsSourceIp:
description: Source IP information for reverse connection configuration.
properties:
sourceIp:
description: 'The IP address in the customer''s VCN to be used as the source IP for reverse connection packets
traveling from the customer''s VCN to the service''s VCN.
'
maxLength: 46
minLength: 8
type: string
type: object
WorkRequestCollection:
description: List of `WorkRequestSummary` items.
properties:
items:
description: Array of `WorkRequestSummary` items.
items:
$ref: '#/components/schemas/WorkRequestSummary'
type: array
required:
- items
type: object
DatabaseToolsPrivateEndpointCollection:
description: List of Database Tools private endpoint summary items.
properties:
items:
description: Array of Database Tools private endpoint summary items.
items:
$ref: '#/components/schemas/DatabaseToolsPrivateEndpointSummary'
type: array
required:
- items
type: object
WorkRequestResource:
description: A resource created or operated on by a work request.
properties:
actionType:
description: 'The way in which this resource is affected by the work tracked in the work request.
A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
work is complete for that resource at which point it will transition to CREATED, UPDATED,
or DELETED, respectively.
'
enum:
- CREATED
- UPDATED
- DELETED
- IN_PROGRESS
- RELATED
type: string
x-obmcs-top-level-enum: '#/definitions/ActionType'
entityType:
description: The resource type the work request affects.
type: string
entityUri:
description: The URI path that the user can use for a GET operation to access the resource metadata.
type: string
identifier:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the resource the work request affects.
type: string
required:
- actionType
- entityType
- identifier
DatabaseToolsIdentitySummary:
description: Summary of the Database Tools identity.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools identity.
maxLength: 255
minLength: 1
type: string
databaseToolsConnectionId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools connection.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools identity.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools identity.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsIdentityLifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools identity was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools identity was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools identity type.
enum:
- ORACLE_DATABASE_RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/IdentityType'
required:
- id
- type
- compartmentId
- displayName
- databaseToolsConnectionId
- lifecycleState
- timeCreated
- timeUpdated
type: object
CreateDatabaseToolsSqlReportDetails:
description: Details for the new Database Tools SQL report.
discriminator:
propertyName: type
properties:
columns:
description: Descriptive information on columns referenced in the Database Tools SQL Report source.
items:
$ref: '#/components/schemas/DatabaseToolsSqlReportColumn'
maxItems: 100
type: array
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools SQL report.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A description of the SQL report.
maxLength: 400
minLength: 0
type: string
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
instructions:
description: Instructions on how to use the SQL report. Step-by-step guidance for an AI agent on how to execute or fill in parameters for the report.
maxLength: 4000
minLength: 0
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 1
type: array
purpose:
description: Purpose of the Database Tools SQL report. Scenario or conditions describing when or why this report should be used. Provides selection criteria to AI agents to improve report selection accuracy.
maxLength: 4000
minLength: 0
type: string
source:
description: SQL query executed to generate the report.
maxLength: 32000
minLength: 1
type: string
type:
description: The Database Tools SQL report type.
enum:
- ORACLE_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsSqlReportType'
variables:
description: Variables referenced in the Database Tools SQL Report source.
items:
$ref: '#/components/schemas/DatabaseToolsSqlReportVariable'
maxItems: 100
type: array
required:
- compartmentId
- type
- displayName
- source
type: object
DatabaseToolsSqlReportCollection:
description: List of Database Tools SQL report summary items.
properties:
items:
description: Array of Database Tools SQL report summary items.
items:
$ref: '#/components/schemas/DatabaseToolsSqlReportSummary'
type: array
required:
- items
type: object
ChangeDatabaseToolsSqlReportCompartmentDetails:
description: Contains the details for the compartment to move the Database Tools SQL Report to.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the Database Tools SQL Report to.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
WorkRequestError:
description: An error encountered while executing a work request.
properties:
code:
description: 'A machine-usable code for the error that occured. Error codes are listed on
(https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
'
type: string
message:
description: A human readable description of the issue encountered.
type: string
timestamp:
description: The time the error occured. An RFC3339 formatted datetime string.
format: date-time
type: string
required:
- code
- message
- timestamp
DatabaseToolsMcpServerBuiltInRole:
description: Built-in MCP server roles
properties:
description:
description: The description of the built-in role.
maxLength: 400
minLength: 1
type: string
displayName:
description: The display name of the built-in role.
maxLength: 100
minLength: 1
type: string
required:
- displayName
- description
type: object
ValidateDatabaseToolsConnectionResult:
description: Connection validation result.
discriminator:
propertyName: type
properties:
action:
description: A human-readable message that suggests a remedial action to resolve the validation error.
type: string
cause:
description: A human-readable message that describes possible causes for the validation error.
type: string
code:
description: A short code that defines the result of the validation, meant for programmatic parsing. The value OK indicates that the validation was successful.
type: string
message:
description: A human-readable message that describes the result of the validation.
type: string
type:
description: The Database Tools connection type.
enum:
- ORACLE_DATABASE
- MYSQL
- POSTGRESQL
- GENERIC_JDBC
type: string
x-obmcs-top-level-enum: '#/definitions/ConnectionType'
required:
- type
- code
- message
type: object
ResourceLock:
description: 'Resource locks are used to prevent certain APIs from being called for the resource.
A full lock prevents both updating the resource and deleting the resource. A delete
lock prevents deleting the resource.
'
properties:
compartmentId:
description: The compartment ID of the lock.
type: string
message:
description: 'A message added by the creator of the lock. This is typically used to give an
indication of why the resource is locked.
'
type: string
relatedResourceId:
description: 'The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
'
type: string
timeCreated:
description: When the lock was created.
format: date-time
type: string
type:
description: Type of the lock.
enum:
- FULL
- DELETE
type: string
required:
- type
- compartmentId
type: object
DatabaseToolsMcpServerSummary:
description: Summary of the Database Tools MCP server.
discriminator:
propertyName: type
properties:
builtInRoles:
description: Built-in roles associated with the MCP Server.
items:
$ref: '#/components/schemas/DatabaseToolsMcpServerBuiltInRole'
maxItems: 40
minItems: 0
type: array
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools MCP server.
maxLength: 255
minLength: 1
type: string
customRoles:
description: Custom roles associated with the MCP Server.
items:
$ref: '#/components/schemas/DatabaseToolsMcpServerCustomRole'
maxItems: 40
minItems: 0
type: array
databaseToolsConnectionId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools connection.
maxLength: 255
minLength: 1
type: string
x-obmcs-cli-param: connection-id
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A meaningful, human-readable label displayed to end users. Not required to be unique and can be changed after creation. Do not include confidential information.
maxLength: 255
minLength: 1
type: string
endpoints:
description: Invoke endpoint of MCP server.
items:
$ref: '#/components/schemas/DatabaseToolsMcpServerEndpoint'
maxItems: 1
minItems: 0
type: array
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools MCP server.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools MCP server.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- NEEDS_ATTENTION
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerLifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
relatedResource:
$ref: '#/components/schemas/DatabaseToolsMcpServerRelatedResource'
runtimeIdentity:
default: AUTHENTICATED_PRINCIPAL
description: 'Specifies the identity used when accessing OCI resources at runtime. AUTHENTICATED_PRINCIPAL to use the caller’s identity (On-Behalf-Of token), or RESOURCE_PRINCIPAL to use the MCP Server’s resource principal (RPST).
'
enum:
- AUTHENTICATED_PRINCIPAL
- RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerRuntimeIdentity'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools MCP server was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools MCP server was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools MCP server type.
enum:
- DEFAULT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerType'
required:
- id
- type
- compartmentId
- displayName
- databaseToolsConnectionId
- endpoints
- lifecycleState
- timeCreated
- timeUpdated
- runtimeIdentity
- relatedResource
type: object
DatabaseToolsDatabaseApiGatewayConfigCollection:
description: List of Database Tools database API gateway config summary items.
properties:
items:
description: Array of Database Tools database API gateway config summary items.
items:
$ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigSummary'
type: array
required:
- items
type: object
DatabaseToolsDatabaseApiGatewayConfigSummary:
description: Summary of the Database Tools database API gateway config.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools database API gateway config.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools database API gateway config.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools database API gateway config.
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigLifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
metadataSource:
description: The RESTful service definition location.
enum:
- DATABASE
- CLOUD
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigMetadataSource'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools database API gateway config type.
enum:
- DEFAULT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
required:
- id
- type
- compartmentId
- displayName
- metadataSource
- lifecycleState
- timeCreated
- timeUpdated
type: object
ValidateDatabaseToolsIdentityCredentialResult:
description: Identity validation result.
discriminator:
propertyName: type
properties:
action:
description: A human-readable message that suggests a remedial action to resolve the validation error.
type: string
cause:
description: A human-readable message that describes possible causes for the validation error.
type: string
code:
description: A short code that defines the result of the validation, meant for programmatic parsing. The value OK indicates that the validation was successful.
type: string
message:
description: A human-readable message that describes the result of the validation.
type: string
type:
description: The Database Tools identity type.
enum:
- ORACLE_DATABASE_RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/IdentityType'
required:
- type
- code
- message
type: object
DatabaseToolsMcpServerEndpoint:
description: The details of an MCP server endpoint.
properties:
endpoint:
description: The URI endpoint of the MCP server
maxLength: 255
minLength: 1
type: string
type:
description: The MCP server type
enum:
- DEFAULT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerType'
type: object
DatabaseToolsPrivateEndpointSummary:
description: Summary of the Database Tools private endpoint.
properties:
additionalFqdns:
description: A list of additional FQDNs that can be also be used for the private endpoint.
items:
maxLength: 255
minLength: 1
type: string
type: array
uniqueItems: true
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the private endpoint.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A description of the Database Tools private endpoint.
maxLength: 255
minLength: 0
type: string
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
endpointFqdn:
description: Then FQDN to use for the private endpoint.
maxLength: 255
minLength: 1
type: string
endpointServiceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools Endpoint Service.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools private endpoint.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools private endpoint.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- INACTIVE
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
nsgIds:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the network security groups
that the private endpoint''s VNIC belongs to. For more information about NSGs, see
[NetworkSecurityGroup](#/en/iaas/20160918/NetworkSecurityGroup/).
'
items:
maxLength: 255
minLength: 1
type: string
type: array
uniqueItems: true
privateEndpointIp:
description: The private IP address that represents the access point for the associated endpoint service.
maxLength: 46
minLength: 1
type: string
privateEndpointVnicId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the private endpoint's VNIC.
maxLength: 255
minLength: 1
type: string
reverseConnectionConfiguration:
$ref: '#/components/schemas/DatabaseToolsPrivateEndpointReverseConnectionConfiguration'
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release)
'
type: object
description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}`
'
type: object
description: 'Zero trust Packet Routing (ZPR) Security Attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`
'
type: object
subnetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet that the private endpoint belongs to.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
vcnId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VCN that the private endpoint belongs to.
maxLength: 255
minLength: 1
type: string
required:
- id
- compartmentId
- subnetId
- endpointServiceId
- timeCreated
- timeUpdated
- lifecycleState
type: object
CreateDatabaseToolsDatabaseApiGatewayConfigDetails:
description: Details for the new Database Tools database API gateway config.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools database API gateway config.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 1
type: array
metadataSource:
description: The RESTful service definition location.
enum:
- DATABASE
- CLOUD
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigMetadataSource'
type:
description: The Database Tools DP API gateway config type.
enum:
- DEFAULT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
required:
- type
- compartmentId
- displayName
- metadataSource
type: object
DatabaseToolsMcpServerRelatedResource:
description: A related resource
properties:
entityType:
description: The resource entity type.
enum:
- AUTONOMOUSDATABASE
- DATABASE
- PLUGGABLEDATABASE
- MYSQLDBSYSTEM
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpServerRelatedResourceEntityType'
identifier:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related resource.
maxLength: 255
minLength: 1
type: string
required:
- entityType
- identifier
type: object
UpdateDatabaseToolsMcpToolsetDetails:
description: Database Tools MCP Toolset information to be updated.
discriminator:
propertyName: type
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A human readable description of the Database Tools MCP toolset.
maxLength: 400
minLength: 0
type: string
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
type:
description: The Database Tools MCP Toolset type.
enum:
- CUSTOM_SQL_TOOL
- BUILT_IN_SQL_TOOLS
- CUSTOMIZABLE_REPORTING_TOOLS
- GENAI_SQL_ASSISTANT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpToolsetType'
version:
description: The MCP toolset version
type: integer
x-obmcs-cli-param: toolset-version
required:
- type
type: object
ChangeDatabaseToolsMcpToolsetCompartmentDetails:
description: Contains the details for the compartment to move the Database Tools MCP Toolset to.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the Database Tools MCP Toolset to.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
DatabaseToolsMcpToolsetVersionSummary:
description: Summary of versions available for a specific MCP toolset type.
discriminator:
propertyName: type
properties:
defaultVersion:
description: The default version for this toolset type.
type: integer
type:
description: The MCP toolset type.
enum:
- CUSTOM_SQL_TOOL
- BUILT_IN_SQL_TOOLS
- CUSTOMIZABLE_REPORTING_TOOLS
- GENAI_SQL_ASSISTANT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpToolsetVersionType'
required:
- type
- defaultVersion
type: object
DatabaseToolsMcpToolset:
description: Allows the creation, configuration and management of an MCP Toolset.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the Database Tools MCP Toolset to.
maxLength: 255
minLength: 1
type: string
databaseToolsMcpServerId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools McpServer.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A human readable description of the Database Tools MCP toolset.
maxLength: 400
minLength: 0
type: string
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools MCP Toolsets.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools MCP Toolset.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpToolsetLifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools MCP server was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools MCP server was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools MCP Toolset type.
enum:
- CUSTOM_SQL_TOOL
- BUILT_IN_SQL_TOOLS
- CUSTOMIZABLE_REPORTING_TOOLS
- GENAI_SQL_ASSISTANT
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsMcpToolsetType'
version:
description: The MCP toolset version
type: integer
x-obmcs-cli-param: toolset-version
required:
- id
- version
- compartmentId
- type
- displayName
- databaseToolsMcpServerId
- lifecycleState
- timeCreated
- timeUpdated
type: object
WorkRequestErrorCollection:
description: List of WorkRequestError items.
properties:
items:
description: Array of Work Request Error items.
items:
$ref: '#/components/schemas/WorkRequestError'
type: array
required:
- items
type: object
DatabaseToolsIdentityCollection:
description: List of Database Tools identity summary items.
properties:
items:
description: Array of Database Tools identity summary items.
items:
$ref: '#/components/schemas/DatabaseToolsIdentitySummary'
type: array
required:
- items
type: object
AddResourceLockDetails:
allOf:
- $ref: '#/components/schemas/ResourceLock'
DatabaseToolsSqlReportSummary:
description: Summary of the Database Tools SQL report.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools SQL Report.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
description:
description: A description of the SQL report.
maxLength: 1024
minLength: 1
type: string
displayName:
description: A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools SQL Report.
maxLength: 255
minLength: 1
type: string
instructions:
description: Instructions on how to use the SQL report. Step-by-step guidance for an AI agent on how to execute or fill in parameters for the report.
maxLength: 4000
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state of the Database Tools SQL Report.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools SQL Report.
enum:
- ACTIVE
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsSqlReportLifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
purpose:
description: Purpose of the Database Tools SQL report. Scenario or conditions describing when or why this report should be used. Provides selection criteria to AI agents to improve report selection accuracy.
maxLength: 4000
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools SQL Report was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools SQL Report was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools SQL Report type.
enum:
- ORACLE_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseToolsSqlReportType'
required:
- id
- type
- compartmentId
- displayName
- lifecycleState
- timeCreated
- timeUpdated
type: object
WorkRequestLogEntryCollection:
description: List of work request log items.
properties:
items:
description: Array of work request log items.
items:
$ref: '#/components/schemas/WorkRequestLogEntry'
type: array
required:
- items
type: object
DatabaseToolsConnection:
description: Provides connectivity details required to establish a connection to a database.
discriminator:
propertyName: type
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the Database Tools connection.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
displayName:
description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Tools connection.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the Database Tools connection.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- INACTIVE
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
maxItems: 2
type: array
runtimeEndpoint:
description: Specifies the Database Tools Runtime endpoint.
maxLength: 255
minLength: 1
type: string
runtimeIdentity:
description: 'Specifies the identity used when accessing OCI resources at runtime. AUTHENTICATED_PRINCIPAL to use the caller’s identity (On-Behalf-Of token), or RESOURCE_PRINCIPAL to use the connection’s resource principal (RPST).
'
enum:
- AUTHENTICATED_PRINCIPAL
- RESOURCE_PRINCIPAL
type: string
x-obmcs-top-level-enum: '#/definitions/RuntimeIdentity'
runtimeSupport:
description: Specifies whether this connection is supported by the Database Tools Runtime.
enum:
- SUPPORTED
- UNSUPPORTED
type: string
x-obmcs-top-level-enum: '#/definitions/RuntimeSupport'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: The time the Database Tools connection was created. An RFC3339 formatted datetime string.
format: date-time
type: string
timeUpdated:
description: The time the Database Tools connection was updated. An RFC3339 formatted datetime string.
format: date-time
type: string
type:
description: The Database Tools connection type.
enum:
- ORACLE_DATABASE
- MYSQL
- POSTGRESQL
- GENERIC_JDBC
type: string
x-obmcs-top-level-enum: '#/definitions/ConnectionType'
required:
- id
- displayName
- compartmentId
- lifecycleState
- timeCreated
- timeUpdated
- type
- runtimeSupport
- runtimeIdentity
- runtimeEndpoint
type: object
responses:
DefaultError:
description: Unknown Error
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Unknown Error
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-anchors:
x-headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
type: string
location:
description: URI of the new resource which was created by the request.
type: string
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
format: float
type: number
x-properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
'
type: object
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release)
'
type: object
description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}`
'
type: object
description: 'Zero trust Packet Routing (ZPR) Security Attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`
'
type: object
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
x-oracle-package: com.oracle.pic.dbtools