DataZen API Overview
The DataZen HTTP API lets you manage agents and pipelines programmatically — for example starting or stopping a job, reading status and history, or inspecting configuration. The same API surface is available for self-hosted and cloud-based agents, although cloud access may require a specific SKU.
For short request samples that start a pipeline with token authentication, see Examples.
Base URL
The API base URL depends on how the agent is deployed:
- Self-hosted — the agent listen URL, for example
https://localhost:9550/(or the HTTP port configured for your agent). - Cloud —
https://<ENVIRONMENT>.enzounified.com/api/<AGENT ID>/
Authentication and Authorization
Clients authenticate on every request. Choose the mechanism that matches your deployment and security requirements:
- Basic Auth — supported for both cloud and self-hosted agents. It is simple to use but does not provide granular, scope-based authorization.
- NTLM — supported for self-hosted agents. Access is controlled through Active Directory (Windows) groups configured on the agent.
- Token-based authentication — send an
Authorization: Token <token>header. Tokens are either an Admin Token or a scoped Service Token issued from the Portal or DataZen Manager.
Recommended Approach
Issue a scope-based Service Token and call the API with token-based authentication. Service Tokens support least-privilege scopes and expiration, which is preferable to Basic Auth or a long-lived Admin Token for automation and integrations.
For how to create Service Tokens, Admin Tokens, and related controls, see Security.
Related Topics
- DataZen API Examples
- Examples with X.509
- Security Overview
- Authentication Sequence
- X.509 Certificates
- DataZen API Tools (MCP wrapper for the HTTP API)
