GitHub: Download a user migration archive

← Migrations operations · Get started

Operation github.migrations_get_archive_for_authenticated_user

Provider route: GET /user/migrations/{migration_id}/archive. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["migrations"]["migrationsGetArchiveForAuthenticatedUser"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.migrations.migrationsGetArchiveForAuthenticatedUser(input);
    const result = await call.wait();
    return result.response;
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.migrations.migrations_get_archive_for_authenticated_user(arguments)
        result = await call.wait()
        return result.response

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.migration_id	integer	Required within parent

Response

GitHub returns a redirect (302, 304). Alter preserves the status and response headers and does not follow the redirect. The example returns the retained response; inspect its headers for Location to obtain the download destination. Handle that destination in your application without forwarding the provider credential. There is no successful JSON response to decode.

Policy, approvals and errors

SDK function policy ID: github.migrations_get_archive_for_authenticated_user. Catalog operation: migrations/get-archive-for-authenticated-user. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source