Download an organization migration archive | GitHub API (unofficial showcase)

2 parameters

orgstringrequired

The organization name. The name is not case sensitive.

migration_idintegerrequired

The unique identifier of the migration.

2 status codes

302Returns a redirect to the migration archive download URL.

404Returned when the organization or migration cannot be found.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned when the organization or migration cannot be found. The org path parameter must identify the organization, and the migration_id path parameter must identify the migration.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

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