# Oracle Data Catalog API

**Canonical:** https://apis.io/apis/oracle/oracle-data-catalog-api/  
**Provider:** Oracle — https://apis.io/providers/oracle/  
**Base URL:** https://{host}:{port}/ords/  
**Documentation:** https://docs.oracle.com/en/database/oracle/oracle-database/

Oracle Data Catalog API is one of 376 APIs that [Oracle](https://apis.io/providers/oracle/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Data Catalog. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

The Data Catalog API from Oracle — 86 operation(s) for data catalog.

## Operations (60 of 143)

| Method | Path | Summary |
|---|---|---|
| GET | `/catalogPrivateEndpoints` | Lists all the catalog private endpoints in the specified compartment |
| POST | `/catalogPrivateEndpoints` | Create a new private reverse connection endpoint |
| DELETE | `/catalogPrivateEndpoints/{catalogPrivateEndpointId}` | Delete a private reverse connection endpoint |
| GET | `/catalogPrivateEndpoints/{catalogPrivateEndpointId}` | Get private reverse connection endpoint |
| PUT | `/catalogPrivateEndpoints/{catalogPrivateEndpointId}` | Update the private reverse connection endpoint identified by the id |
| POST | `/catalogPrivateEndpoints/{catalogPrivateEndpointId}/actions/changeCompartment` | Moves a resource into a different compartment. |
| GET | `/catalogs` | Lists all the data catalogs in the specified compartment |
| POST | `/catalogs` | Creates a new data catalog |
| DELETE | `/catalogs/{catalogId}` | Delete a provisioned data catalog |
| GET | `/catalogs/{catalogId}` | Get data catalog |
| PUT | `/catalogs/{catalogId}` | Update the data catalog identified by the id |
| POST | `/catalogs/{catalogId}/actions/attachCatalogPrivateEndpoint` | Attaches a private reverse connection endpoint resource to a data catalog… |
| POST | `/catalogs/{catalogId}/actions/changeCompartment` | Moves a resource into a different compartment. |
| POST | `/catalogs/{catalogId}/actions/detachCatalogPrivateEndpoint` | Detaches a private reverse connection endpoint resource to a data catalog… |
| POST | `/catalogs/{catalogId}/actions/getRecommendations` | Returns a list of recommendations for the given object and recommendation type |
| POST | `/catalogs/{catalogId}/actions/objectStats` | Returns stats on objects in the repository |
| POST | `/catalogs/{catalogId}/actions/processRecommendation` | Act on a recommendation |
| POST | `/catalogs/{catalogId}/actions/suggest` | Returns a list of potential string matches for a given input string |
| POST | `/catalogs/{catalogId}/actions/users` | Returns active users in the system |
| GET | `/catalogs/{catalogId}/dataAssets` | Returns a list of data assets within a data catalog |
| POST | `/catalogs/{catalogId}/dataAssets` | Create a new data asset |
| DELETE | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}` | Delete a specific data asset identified by it's key |
| GET | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}` | Get a specific data asset for the given key within a data catalog |
| PUT | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}` | Update a specific data asset identified by the given key |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/addDataSelectorPatterns` | Add data selector pattern to the data asset used to derive logical entities… |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/asynchronousExport` | Export technical objects from a Data Asset in Excel format |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/import` | Import technical objects to a Data Asset from an exported file |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/importConnection` | Import connections from an Oracle wallet file that contains relevant metadata… |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/importLineage` | Imports lineage metadata |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/parseConnection` | Parse connection from a request payload that contains data asset references |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/removeDataSelectorPatterns` | Remove data selector pattern from the data asset used in deriving logical… |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/synchronousExport` | Export technical objects from a Data Asset in Excel file format |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/validateConnection` | Validate connection from a request payload that contains connection metadata |
| GET | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections` | Returns a list of all connections for a data asset |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections` | Create a new connection |
| DELETE | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}` | Delete a specific connection of a data asset |
| GET | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}` | Get a specific data asset connection by key |
| PUT | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}` | Update a specific connection of a data asset |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}/actions/test` | Test the connection credentials to the parent data asset |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}/actions/uploadCredentials` | Upload connection credentials file and metadata for this connection for update |
| GET | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities` | Returns a list of all entities of a data asset |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities` | Create a new data entity |
| DELETE | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}` | Delete a specific data entity |
| GET | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}` | Get a specific data entity by key for a data asset |
| PUT | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}` | Update a specific data entity |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/actions/fetchLineage` | Returns lineage for a given entity object |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/actions/listAggregatedPhysicalEntities` | List the physical entities aggregated by this logical entity |
| GET | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes` | Returns a list of all attributes of an data entity |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes` | Create a new entity attribute |
| DELETE | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}` | Delete a specific entity attribute |
| GET | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}` | Get a specific entity attribute by key |
| PUT | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}` | Update a specific data asset attribute |
| GET | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags` | Returns a list of all tags for an entity attribute |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags` | Create a new entity attribute tag |
| DELETE | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags/{tagKey}` | Delete a specific entity attribute tag |
| GET | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags/{tagKey}` | Get a specific entity attribute tag by key |
| GET | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/rules` | Returns a list of all rules of a data entity |
| GET | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags` | Returns a list of all tags for a data entity |
| POST | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags` | Create a new entity tag |
| DELETE | `/catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags/{tagKey}` | Delete a specific entity tag |

…and 83 more operations. They are listed in full on the page.

## Machine-readable artifacts (161)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-data-catalog-api-openapi.yml
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
- **APIReference** — https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
- …and 121 more, listed in full on the page.

## Other Oracle APIs (12)

- [Oracle Database REST APIs](https://apis.io/apis/oracle/oracle-database-rest-apis/)
- [Oracle Integration Cloud API](https://apis.io/apis/oracle/oracle-integration-cloud-api/)
- [Oracle Fusion Cloud Applications API](https://apis.io/apis/oracle/oracle-fusion-cloud-applications-api/)
- [Oracle Fusion Cloud Financials REST API](https://apis.io/apis/oracle/oracle-fusion-cloud-financials-rest-api/)
- [Oracle Fusion Cloud HCM REST API](https://apis.io/apis/oracle/oracle-fusion-cloud-hcm-rest-api/)
- [Oracle Fusion Cloud CX Sales and Service REST API](https://apis.io/apis/oracle/oracle-fusion-cloud-cx-sales-and-service-rest-api/)
- [Oracle Fusion Cloud SCM REST API](https://apis.io/apis/oracle/oracle-fusion-cloud-scm-rest-api/)
- [Oracle Fusion Cloud Procurement REST API](https://apis.io/apis/oracle/oracle-fusion-cloud-procurement-rest-api/)
- [Oracle Content Management API](https://apis.io/apis/oracle/oracle-content-management-api/)
- [OCI Generative AI API](https://apis.io/apis/oracle/oci-generative-ai-api/)
- [OCI AI Vision API](https://apis.io/apis/oracle/oci-ai-vision-api/)
- [OCI AI Language API](https://apis.io/apis/oracle/oci-ai-language-api/)

## Tags

Data Catalog

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/oracle/oracle-data-catalog-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/oracle/.