Introduction

Acceldata provides a comprehensive set of RESTful APIs that enable you to programmatically interact with the Acceldata Data Observability Cloud (ADOC) platform. These APIs are designed to support integration, automation, and advanced analytics use cases across your data ecosystem.

The API documentation offers detailed information on endpoints related to:

• User and Role Management – Manage users, roles, and access controls programmatically.
• Data Source Operations – Automate data source registration, updates, and health checks.
• Pipeline and Job Monitoring – Retrieve pipeline status, job metrics, and execution logs.
• Cost and Usage Insights – Access billing data, cost breakdowns, and usage reports.
• Custom Alerts and Dashboards – Configure alerts and extract observability metrics via APIs.

Whether you're integrating ADOC with internal tooling, building operational dashboards, or automating workflows, these APIs provide the flexibility and control to extend the platform's capabilities beyond the user interface.

How to Use These APIs

1. Authentication

   • Every API call requires an accessKey and secretKey.
   • Provide them as headers in your request.
   • See Authentication & Headers.

2. Request Format

   • Use standard REST conventions (GET, POST, PUT, DELETE).
   • Send and receive data in application/json.

3. Response Codes

Acceldata APIs return standard HTTP status codes to indicate whether an API request was successful or failed.

4. Error Handling

   • Errors are returned in a structured JSON format: { "error": { "code": 401, "message": "Invalid or missing authentication token." } }

5. Best Practices

   • Always test with smaller datasets or sample rows before running bulk operations.
   • Use pagination (limit, offset) to avoid retrieving very large results in one request.
   • Organize API usage according to workflows: Discover assets → Preview data → Monitor reliability → Enforce policies.

Recent API Changes

This section summarises API-level changes introduced in recent releases. For full payload and response comparisons across all releases, see SDK and API Changelog.

26.5.0

Pipeline APIs

• Get Pipeline – The response now includes a uid field in the pipelineSummary object. This field provides a stable, unique identifier for each pipeline and can be used for consistent referencing across systems. All other Pipeline API endpoints are unchanged.

Datasource APIs, Asset APIs, Profiling APIs, Policy APIs, Data Quality / Reconciliation APIs

• No changes in this release.

API Sections

The API documentation is organized by business workflows:

• Assets → Discover, retrieve metadata, preview sample data
• Reliability → Monitor data health, anomalies, and quality rules
• Governance → Policies, rules, and enforcement counts
• Access Management → Users, groups, and roles
• Lineage & Advanced Use Cases → Trace data flow and dependencies