Get Environment Transfer

LLM-friendly URL

POST

https://api.luzmo.com/0.1.0/environmenttransfer

API call form

Examples

Retrieve an environment transfer job, to follow its progress and read its outcome. Only an Organization Owner of an organization for which Luzmo has enabled environment transfer can retrieve a job. A job ID that does not belong to your organization returns 404 .

To list the jobs of your organization instead, leave out where . The response is then { "count": <number of jobs>, "rows": [<jobs>] } , newest first, 25 jobs per page by default. Use limit (up to 100) and offset to page through the list.

The job has one of these statuses:

running : the job is waiting to start or in progress, and result is null . Retrieve the job again after a few seconds.
done : the job is finished, and result holds its outcome:
- For an export, download_url is the link to download the artifact, and expires_at is when that link expires. Download the artifact with a GET request on the link: the link itself grants access, so share it only with the people who import the artifact. not_exported lists the requested IDs that were not exported.
- For an import plan, plan lists the resources per outcome, connections lists the connections to map, and plan_hash is what you pass to apply the plan. When the artifact cannot be read, for example because it is damaged, was changed after the export, is signed by an environment this environment does not trust, or has a format version this environment cannot read, blocked_artifact says why, and plan_hash is null .
- For an import apply, applied holds the plan that was written, with the ID of each new resource as target_id in create . If the apply was refused, rejected holds the reason and a message instead, and nothing was written: plan the import again.
error : the job failed, and result is null . error holds a message you can show to the user: This environment transfer failed unexpectedly. The job does not return the internal cause of the failure. A failed import apply writes nothing.

Request parameters

Response schema

Can be executed by:

Organization Owner

Can be associated to:

Did this page help you?

Yes

Language

Shell

Node

Java

.NET

Python

PHP

Install

npm install @luzmo/nodejs-sdk

Example Request

import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.get('environmenttransfer',
  {
    where: {
      id: "<your job id>"
    }
  }
);

Example Response

200

400

500

{
  "id": "6f1c2a4e-8d3b-4f7a-9c21-3b5e7d9a1f04",
  "type": "export",
  "name": "Sales dashboards",
  "status": "done",
  "result": {
    "download_url": "https://app.luzmo.com/environment-transfer/6f1c2a4e-8d3b-4f7a-9c21-3b5e7d9a1f04?expires=1793960100000&signature=<signature>",
    "expires_at": "2026-11-06T10:15:00.000Z",
    "summary": {
      "dashboard": 2,
      "dataset": 3,
      "theme": 1,
      "connection": 1
    },
    "not_exported": []
  },
  "error": null,
  "created_at": "2026-10-30T10:14:52.000Z",
  "created_by": {
    "id": "9c3e5a7b-1d2f-4e6a-8b0c-4d6f8a0b2c35",
    "name": "Alex Smith",
    "email": "alex@example.com"
  }
}