Skip to content

DATAMIMIC API

DATAMIMIC exposes a REST API for use in CI/CD pipelines and external automation. The API covers project management, task execution (generation, de-identification, processing), and artifact retrieval.

Overview

  • Integrations: Use the REST API to integrate DATAMIMIC with CI/CD pipelines (GitHub Actions, GitLab CI, Jenkins, Azure Pipelines) and other internal tooling.
  • Automation: Trigger generation and de-identification tasks programmatically and fetch artifacts on completion.
  • Multi-Environment: Run the same API surface against development, staging, and production-equivalent DATAMIMIC deployments.

Getting Started

For endpoints, request/response formats, and authentication, see the API Documentation.

To read and change project files from CI/CD with a project access token, use the Workspace API.

To change a stored artifact of a finished task and get the result in the same response, use the Artifact Operate API.

File API Migration Guide

If you use the legacy /files routes, see the File API Migration Guide to move to the Workspace API.

Swagger Documentation

The interactive Swagger documentation lists every endpoint with request and response schemas.

Generated artifacts

The task artifact metadata endpoint returns a path for each file, relative to the task, such as xml/customers.xml. Use this path with the single-artifact download endpoint; percent-encode special characters in each segment and preserve / between segments. Invalid paths return 400 INVALID_FILE_PATH. Unicode filenames are supported. The ZIP download preserves the task directory and its nested folders.

The name and type fields describe the final filename, while path distinguishes files in different folders. For example, xml/customers.csv and json/customers.csv are separate artifacts even though both have name: customers and type: csv. Paths allow up to 32 segments; the complete storage key, including the task ID and separator, must not exceed 1024 UTF-8 bytes. Empty segments, . and .., backslashes, and control characters are rejected.