# Acceldata Catalog API

**Canonical:** https://apis.io/apis/acceldata/acceldata-catalog-api/  
**Provider:** Acceldata — https://apis.io/providers/acceldata/  
**Base URL:** https://{adoc-host}  
**Documentation:** https://documentation.acceldata.io/docs/acceldata/api/catalog

Acceldata Catalog API is one of 10 APIs that [Acceldata](https://apis.io/providers/acceldata/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Catalog, Data Quality, Data Observability, and Lineage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The ADOC data catalog surface: discover and search assets, read asset metadata, schema, samples, relationships and lineage, apply tags and labels, and create, schedule, execute and read the results of data reliability policies (data quality, reconciliation, data drift, schema drift, freshness and anomaly). 104 published operations.

## Operations (60 of 104)

| Method | Path | Summary |
|---|---|---|
| GET | `/catalog-server/api/assets/{id}/metadata` | Get asset metadata |
| POST | `/catalog-server/api/assets/{id}/sample/async` | Request an async sample of asset data |
| GET | `/catalog-server/api/assets/{id}/tags` | Get tags for an asset |
| POST | `/catalog-server/api/assets/{id}/tag` | Add a tag to an asset |
| DELETE | `/catalog-server/api/assets/{id}/tag/{tagId}` | Remove a tag from an asset |
| PUT | `/catalog-server/api/assets/{id}/labels` | Update asset labels |
| GET | `/catalog-server/api/assets/{id}/labels` | Get asset labels |
| POST | `/catalog-server/api/assets/{id}/watch` | Watch an asset |
| DELETE | `/catalog-server/api/assets/{id}/watch` | Unwatch an asset |
| GET | `/catalog-server/api/assets/{id}/activity` | Get asset activity |
| GET | `/catalog-server/api/assets/{id}/comments` | Get asset comments |
| GET | `/catalog-server/api/assets/{id}/incremental-strategies` | Get incremental profiling strategies |
| GET | `/catalog-server/api/assets/{id}/reference-assets/inferredMetadata` | Get inferred reference metadata for an asset |
| POST | `/catalog-server/api/assets/{id}/udf-variables` | Create a UDF variable for an asset |
| GET | `/catalog-server/api/assets/{id}/udf-variables` | List UDF variables for an asset |
| PUT | `/catalog-server/api/assets/{id}/udf-variables/{variableId}` | Update a UDF variable for an asset |
| DELETE | `/catalog-server/api/assets/{id}/udf-variables/{variableId}` | Delete a UDF variable from an asset |
| GET | `/catalog-server/api/assets/{id}/udf-variables/{variableId}` | Get a specific UDF variable for an asset |
| GET | `/catalog-server/api/assets/sample/result/{requestId}` | Get sample data result |
| POST | `/catalog-server/api/assets/byUid/{uid}/watch` | Watch an asset by UID |
| DELETE | `/catalog-server/api/assets/byUid/{uid}/watch` | Unwatch an asset by UID |
| GET | `/catalog-server/api/asset-types` | List all asset types |
| PUT | `/catalog-server/api/rules/{id}/schedule` | Toggle schedule for a policy |
| POST | `/catalog-server/api/rules/{id}/tag` | Add a single tag to a rule |
| GET | `/catalog-server/api/rules/{id}/configuration` | Get rule persistence configuration |
| GET | `/catalog-server/api/rules/executions` | List policy executions across all rule types |
| GET | `/catalog-server/api/rules/data-quality/{identifier}` | Get a data quality rule by ID or name |
| POST | `/catalog-server/api/rules/data-quality/{id}/executions` | Trigger a data quality rule execution |
| GET | `/catalog-server/api/rules/data-quality/{id}/executions` | List executions for a data quality rule |
| PUT | `/catalog-server/api/rules/data-quality/{id}` | Update a data quality rule |
| DELETE | `/catalog-server/api/rules/data-quality/{id}` | Delete (archive) a data quality rule |
| POST | `/catalog-server/api/rules/data-quality/{id}/unarchive` | Unarchive a data quality rule |
| PUT | `/catalog-server/api/rules/data-quality/{id}/schedule` | Toggle schedule for a data quality rule |
| GET | `/catalog-server/api/rules/data-quality/{id}/items` | Get data quality rule items |
| GET | `/catalog-server/api/rules/data-quality/executions/{id}` | Get data quality execution detail |
| GET | `/catalog-server/api/rules/data-quality/executions/{id}/result` | Get data quality execution result |
| POST | `/catalog-server/api/rules/data-quality` | Create a data quality rule |
| GET | `/catalog-server/api/rules/data-quality` | List all data quality rules |
| PUT | `/catalog-server/api/rules/data-quality/byName/{name}` | Update a data quality rule by name |
| DELETE | `/catalog-server/api/rules/data-quality/byName/{name}` | Delete (archive) a data quality rule by name |
| GET | `/catalog-server/api/rules/data-quality/byName/{name}` | Get a data quality rule by name |
| PUT | `/catalog-server/api/rules/data-quality/byName/{name}/schedule` | Toggle schedule for a data quality rule by name |
| GET | `/catalog-server/api/rules/data-quality/byName/{name}/items` | Get data quality rule items by name |
| POST | `/catalog-server/api/rules/data-quality/byName/{name}/unarchive` | Unarchive a data quality rule by name |
| POST | `/catalog-server/api/rules/data-quality/byName/{name}/executions` | Trigger execution of a data quality rule by name |
| GET | `/catalog-server/api/rules/data-quality/byName/{name}/executions` | List executions for a data quality rule by name |
| GET | `/catalog-server/api/rules/reconciliation/{identifier}` | Get a reconciliation rule by ID or name |
| POST | `/catalog-server/api/rules/reconciliation/{id}/executions` | Trigger a reconciliation rule execution |
| GET | `/catalog-server/api/rules/reconciliation/{id}/executions` | List executions for a reconciliation rule |
| PUT | `/catalog-server/api/rules/reconciliation/{id}` | Update a reconciliation rule |
| DELETE | `/catalog-server/api/rules/reconciliation/{id}` | Delete (archive) a reconciliation rule |
| POST | `/catalog-server/api/rules/reconciliation/{id}/unarchive` | Unarchive a reconciliation rule |
| PUT | `/catalog-server/api/rules/reconciliation/{id}/schedule` | Toggle schedule for a reconciliation rule |
| GET | `/catalog-server/api/rules/reconciliation/executions/{id}` | Get reconciliation execution detail |
| GET | `/catalog-server/api/rules/reconciliation/executions/{id}/result` | Get reconciliation execution result |
| POST | `/catalog-server/api/rules/reconciliation` | Create a reconciliation rule |
| GET | `/catalog-server/api/rules/reconciliation` | List all reconciliation rules |
| PUT | `/catalog-server/api/rules/reconciliation/byName/{name}` | Update a reconciliation rule by name |
| DELETE | `/catalog-server/api/rules/reconciliation/byName/{name}` | Delete (archive) a reconciliation rule by name |
| GET | `/catalog-server/api/rules/reconciliation/byName/{name}` | Get a reconciliation rule by name |

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

## Machine-readable artifacts (10)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/openapi/_original/acceldata-catalog-api-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/overlays/acceldata-catalog-overlay.yaml
- **Documentation** — https://docs.acceldata.io/api/introduction
- **APIReference** — https://documentation.acceldata.io/docs/acceldata/api/catalog
- **Authentication** — https://docs.acceldata.io/api/authentication
- **AgentSkill** — https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/skills/acceldata-create-and-run-data-quality-policy.md
- **AgentSkill** — https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/skills/acceldata-discover-and-tag-assets.md
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/data-model/acceldata-data-model.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/errors/acceldata-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/acceldata/refs/heads/main/conventions/acceldata-conventions.yml

## Other Acceldata APIs (9)

- [Acceldata Alerts API](https://apis.io/apis/acceldata/acceldata-alerts-api/)
- [Acceldata Data Quality Rules API](https://apis.io/apis/acceldata/acceldata-data-quality-rules-api/)
- [Acceldata Datasets API](https://apis.io/apis/acceldata/acceldata-datasets-api/)
- [Acceldata Lineage API](https://apis.io/apis/acceldata/acceldata-lineage-api/)
- [Acceldata Pipeline Jobs API](https://apis.io/apis/acceldata/acceldata-pipeline-jobs-api/)
- [Acceldata Roles API](https://apis.io/apis/acceldata/acceldata-roles-api/)
- [Acceldata Users API](https://apis.io/apis/acceldata/acceldata-users-api/)
- [Acceldata Administration API](https://apis.io/apis/acceldata/acceldata-administration-api/)
- [Acceldata Tag Services API](https://apis.io/apis/acceldata/acceldata-tags-api/)

## Tags

Catalog, Data Quality, Data Observability, Lineage

---

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