Download an organization migration archive

2 parameters

orgstringrequired

The organization name containing the migration; the name is not case sensitive.

migration_idintegerrequired

The unique integer identifier of the migration archive to download.

2 status codes

302Returns a redirect to the URL of the organization migration archive.

404Returned when the specified organization or migration cannot be found.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned when the specified organization or migration does not exist. org must identify the organization and migration_id must identify the requested migration.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.archive.list({
  org: "acme-inc",
  migrationId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors