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.

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.