Get Migration JSON by Export Version

get

https://{environment}.origamirisk.com/OrigamiApi/api/Migrations/GetMigrationJson/{exportVersionID}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Retrieves the JSON configuration package for a specific migration export version. This endpoint is the data delivery mechanism used when promoting specific configurations across environments (Dev→Test→Prod) as part of an orchestrated deployment workflow.

Unlike the automated /api/SilentMigration endpoint that pulls the latest bureau standards, this endpoint retrieves a specific version by ID, giving you precise control over what gets deployed where and when. The returned JSON package contains all the database records, configuration settings, and reference data needed to apply the migration to the target environment.

Primary Behavior

Fetches the complete JSON configuration package for the specified exportVersionID
Returns the file contents as plain text (UTF-8 encoded JSON)

Optional Behavior if MigrationSourcePushRequestID Header is provided

Updates deployment lifecycle tracking
Prevents duplicate deliveries by enforcing status transitions
Maintains audit trail of configuration deployments

curl -X GET \ 'https://environment.origamirisk.com/OrigamiApi/api/Migrations/GetMigrationJson/456' \
  -H 'Token: your-api-token-here' \
  -H 'MigrationSourcePushRequestID: 789'

Important

This endpoint retrieves data only. It does not apply or import the migration. The returned JSON must be processed by downstream import logic to actually apply the configuration changes to your database.

Path Params

exportVersionID

integer

required

The unique database identifier for a specific migration export version snapshot. This numeric ID precisely identifies which configuration package to retrieve, ensuring you get exactly the version you intend to deploy rather than the "latest" version.

Each time a migration export is generated (whether for bureau standards or custom configurations), the system creates a versioned snapshot with a unique ID. This parameter specifies which snapshot to retrieve.

How to obtain this value:

Browse available exports via the Origami admin interface under Migration Exports
Query the MigrationExportVersions table directly
Receive it from deployment orchestration workflows
Reference it from previous successful deployments for rollback scenarios

Headers

MigrationSourcePushRequestID

integer

The unique identifier of a deployment tracking record used to monitor and audit configuration package deliveries across environments. When provided, the endpoint validates and updates the deployment lifecycle status, preventing duplicate deliveries and maintaining an audit trail.

When to include this header:

Part of an automated environment-to-environment deployment workflow
Need to track which configurations were delivered where and when
Want to prevent accidental duplicate deliveries of the same package
Implementing formal change management with audit requirements
When to omit this header:

Manual/ad-hoc retrieval for testing or inspection
Downloading packages for offline use
No deployment tracking requirements
Simplified integration without orchestration
How it works:
When provided, the endpoint looks up the corresponding MigrationSourcePushRequest record, validates its status is "R" (Requested), updates it to "D" (Delivered), and records the delivery timestamp. If the status is already "D", the request fails to prevent duplicate processing. If omitted, no tracking occurs and the JSON is returned without any status validation.

How to obtain this value:

Provided by deployment orchestration systems
Created when initiating a push from source to target environment
Retrieved from the MigrationSourcePushRequests table
Included in migration tokens during scheduled deployments

Response

200