{ "opencollection": "1.0.0", "info": { "name": "Database Tools Runtime API", "version": "20230222" }, "items": [ { "info": { "name": "databaseToolsRuntime", "type": "folder" }, "items": [ { "info": { "name": "Execute statements on a database tools connection.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/actions/executeSql", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Execute statements on a database tools connection.\n" }, { "info": { "name": "Post DatabaseToolsConnectionValidate", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/actions/validateConnection", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates the specified Database Tools connection." }, { "info": { "name": "List credentials", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Returns a paginated list of `CredentialSummary` for the specified request." }, { "info": { "name": "Creates a credential for the user specified by the key.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a credential for the user specified by the key." }, { "info": { "name": "Get a credential", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials/:credentialKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" } ] }, "docs": "Get a credential" }, { "info": { "name": "Update a credential", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials/:credentialKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a credential" }, { "info": { "name": "Delete credential", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials/:credentialKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" } ] }, "docs": "Delete credential" }, { "info": { "name": "Get a list of all execute grantees", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials/:credentialKey/executeGrantees", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Get a list of all execute grantees" }, { "info": { "name": "Grants the EXECUTE privilege on the credential to the user specified by the key.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials/:credentialKey/executeGrantees", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Grants the EXECUTE privilege on the credential to the user specified by the key." }, { "info": { "name": "Get a credential execute grantee", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials/:credentialKey/executeGrantees/:executeGranteeKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" }, { "name": "executeGranteeKey", "value": "", "type": "path", "description": "The name of the user granted the EXECUTE privilege on the credential." } ] }, "docs": "Get a credential execute grantee" }, { "info": { "name": "Delete execute grantee", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials/:credentialKey/executeGrantees/:executeGranteeKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" }, { "name": "executeGranteeKey", "value": "", "type": "path", "description": "The name of the user granted the EXECUTE privilege on the credential." } ] }, "docs": "Delete execute grantee" }, { "info": { "name": "Get a list of all public synonyms for the given credential", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials/:credentialKey/publicSynonyms", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Get a list of all public synonyms for the given credential" }, { "info": { "name": "Creates a public synonym for the given credentials", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials/:credentialKey/publicSynonyms", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a public synonym for the given credentials" }, { "info": { "name": "Get a public synonym", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials/:credentialKey/publicSynonyms/:publicSynonymKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" }, { "name": "publicSynonymKey", "value": "", "type": "path", "description": "The name of the public synonym for the credential" } ] }, "docs": "Get a public synonym" }, { "info": { "name": "Delete a public synonym", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/credentials/:credentialKey/publicSynonyms/:publicSynonymKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" }, { "name": "publicSynonymKey", "value": "", "type": "path", "description": "The name of the public synonym for the credential" } ] }, "docs": "Deletes the public synonym" }, { "info": { "name": "Get a property set", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/propertySets/:propertySetKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "propertySetKey", "value": "", "type": "path", "description": "The name of the property set" } ] }, "docs": "Get a property set" }, { "info": { "name": "Update a property set", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/propertySets/:propertySetKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "propertySetKey", "value": "", "type": "path", "description": "The name of the property set" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a property set" }, { "info": { "name": "List user credentials", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/users/:userKey/credentials", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "userKey", "value": "", "type": "path", "description": "The name of the database user." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Returns a paginated list of user `UserCredentialSummary` for the specified request." }, { "info": { "name": "Get a user credential", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsConnections/:databaseToolsConnectionId/users/:userKey/credentials/:credentialKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsConnectionId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection." }, { "name": "userKey", "value": "", "type": "path", "description": "The name of the database user." }, { "name": "credentialKey", "value": "", "type": "path", "description": "The name of the credential" } ] }, "docs": "Get a user credential" }, { "info": { "name": "ListDatabaseToolsDatabaseApiGatewayConfigAdvancedProperties", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigAdvancedProperties", "headers": [ { "name": "opc-request-id", "value": "" } ] }, "docs": "Returns list of database API gateway config setting descriptions to be provided as advanced properties." }, { "info": { "name": "Get the content of a Database Tools database API gateway config", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/content", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." } ] }, "docs": "Get the content of a Database Tools database API gateway config" }, { "info": { "name": "Get a Database Tools database API gateway config global resource", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/globals/:globalKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "globalKey", "value": "", "type": "path", "description": "The key of the global config." } ] }, "docs": "Get a Database Tools database API gateway config global resource" }, { "info": { "name": "Update a Database Tools database API gateway config global resource", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/globals/:globalKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "globalKey", "value": "", "type": "path", "description": "The key of the global config." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Database Tools database API gateway config global resource" }, { "info": { "name": "List Database Tools database API gateway config pool resources", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire specified display name." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." } ] }, "docs": "Returns a list of Database Tools database API gateway config pool resources" }, { "info": { "name": "Create a Database Tools database API gateway config pool resource", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Database Tools database API gateway config pool resource" }, { "info": { "name": "Get a Database Tools database API gateway config pool resource", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." } ] }, "docs": "Get a Database Tools database API gateway config pool resource" }, { "info": { "name": "Update a Database Tools database API gateway config pool resource", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Database Tools database API gateway config pool resource" }, { "info": { "name": "Deletes a Database Tools database API gateway config pool resource.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." } ] }, "docs": "Deletes the specified Database Tools database API gateway config pool resource." }, { "info": { "name": "List Database Tools database API gateway config API spec resources", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey/apiSpecs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire specified display name." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." } ] }, "docs": "Returns a list of Database Tools database API gateway config API spec resources" }, { "info": { "name": "Create a Database Tools database API gateway config API spec resource", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey/apiSpecs", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Database Tools database API gateway config API spec resource" }, { "info": { "name": "Get a Database Tools database API gateway config API spec resource", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey/apiSpecs/:apiSpecKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." }, { "name": "apiSpecKey", "value": "", "type": "path", "description": "The key of the API spec config." } ] }, "docs": "Get a Database Tools database API gateway config API spec resource" }, { "info": { "name": "Update a Database Tools database API gateway config API spec resource", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey/apiSpecs/:apiSpecKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." }, { "name": "apiSpecKey", "value": "", "type": "path", "description": "The key of the API spec config." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Database Tools database API gateway config API spec resource" }, { "info": { "name": "Deletes a Database Tools database API gateway config API spec resource.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey/apiSpecs/:apiSpecKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." }, { "name": "apiSpecKey", "value": "", "type": "path", "description": "The key of the API spec config." } ] }, "docs": "Deletes the specified Database Tools database API gateway config API spec resource." }, { "info": { "name": "List Database Tools database API gateway config auto API spec resources", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey/autoApiSpecs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire specified display name." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." } ] }, "docs": "Returns a list of Database Tools database API gateway config auto API spec resources" }, { "info": { "name": "Create a Database Tools database API gateway config auto API spec resource", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey/autoApiSpecs", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Database Tools database API gateway config auto API spec resource" }, { "info": { "name": "Get a Database Tools database API gateway config auto API spec resource", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey/autoApiSpecs/:autoApiSpecKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." }, { "name": "autoApiSpecKey", "value": "", "type": "path", "description": "The key of the auto API spec config." } ] }, "docs": "Get a Database Tools database API gateway config auto API spec resource" }, { "info": { "name": "Update a Database Tools database API gateway config auto API spec resource", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey/autoApiSpecs/:autoApiSpecKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." }, { "name": "autoApiSpecKey", "value": "", "type": "path", "description": "The key of the auto API spec config." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Database Tools database API gateway config auto API spec resource" }, { "info": { "name": "Deletes a Database Tools database API gateway config auto API spec resource.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230222/databaseToolsDatabaseApiGatewayConfigs/:databaseToolsDatabaseApiGatewayConfigId/pools/:poolKey/autoApiSpecs/:autoApiSpecKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseToolsDatabaseApiGatewayConfigId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config." }, { "name": "poolKey", "value": "", "type": "path", "description": "The key of the pool config." }, { "name": "autoApiSpecKey", "value": "", "type": "path", "description": "The key of the auto API spec config." } ] }, "docs": "Deletes the specified Database Tools database API gateway config auto API spec resource." }, { "info": { "name": "Validates a Database Tools identity credential.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20230222/databaseToolsIdentities/:databaseToolsIdentityId/actions/validateCredential", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "databaseToolsIdentityId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools identity." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates the Database Tools identity credentials by establishing a connection to the customer database\nand executing the dbms_cloud.send_request to validate the credential.\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "resourceIdentifier", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "operationType", "value": "", "type": "query", "description": "The work request operation type." }, { "name": "createdByPrincipalId", "value": "", "type": "query", "description": "A filter to return only work requests initiated by the specified principal OCID." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only work requests with one of the specified status values." } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "GET Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the specified work request." }, { "info": { "name": "Attempts to cancel the specified work request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20230222/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Attempts to cancel the specified work request." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Returns a paginated list of errors for the specified work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20230222/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Returns a paginated list of logs for the specified work request.\n" } ] } ], "bundled": true }