Diese Version von GitHub Enterprise Server wird eingestellt am 2026-08-25. Nicht mehr unterstützte Versionen werden nicht unterstützt. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Eine bessere Leistung, verbesserte Sicherheit und neue Features in GitHub Enterprise Server finden Sie unter Overview des Upgradeprozesses. Wenden Sie sich bei Fragen zum Upgrade an den GitHub Enterprise Support.

Die REST-API ist jetzt versioniert. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

REST API endpoints for Enterprise Live Migrations

Use the REST API to manage Enterprise Live Migrations on your GitHub Enterprise Server instance.

Hinweis

Enterprise Live Migrations ist in Öffentliche Vorschau und kann geändert werden.

List Enterprise Live Migrations

List Enterprise Live Migrations (ELM) for the current GHES appliance.

Feinkörnige Zugriffstoken für "List Enterprise Live Migrations"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "List Enterprise Live Migrations"

Header
accept string

Setting to application/vnd.github+json is recommended.

Abfrageparameter
page_size integer

Number of results per page.

after string

Cursor for pagination. Use the value from next_cursor of a previous response.

status string

Optional filter by migration status.

Kann eine der folgenden sein: created, queued, in_progress, paused, completed, failed, terminated, all

HTTP-Antwortstatuscodes für "List Enterprise Live Migrations"

StatuscodeBESCHREIBUNG
200

OK

400

Bad Request

401

Requires authentication

403

Forbidden

404

Resource not found

422

The migration service is missing the source or target credentials required to service this request. An organization administrator must configure the required secrets before retrying.

500

Internal Error

501

Not implemented.

Codebeispiele für "List Enterprise Live Migrations"

Anforderungsbeispiel

get/enterprise/live-migrations
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/enterprise/live-migrations

Response

Status: 200

Create an Enterprise Live Migration

Create an Enterprise Live Migration (ELM) for a single repository on the current GHES appliance. The migration is created in a created state and is not started; run the start endpoint to launch backfill and live updates. Credentials are referenced by name (pat_name) rather than submitted inline, and are not echoed back in the response.

Feinkörnige Zugriffstoken für "Create an Enterprise Live Migration"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Create an Enterprise Live Migration"

Header
accept string

Setting to application/vnd.github+json is recommended.

Körperparameter
source_organization_login string Erforderlich

Source organization login on the GHES appliance.

source_repository_name string Erforderlich

Source repository name.

target_organization_login string Erforderlich

Target organization login on the destination GitHub environment.

target_repository_name string Erforderlich

Target repository name.

target_api_endpoint string Erforderlich

Migration target API endpoint URL. Must be a valid HTTPS URL.

pat_name string Erforderlich

Name of the organization-scoped migration credential set to use. The raw token is never submitted inline and is never returned in the response.

target_visibility string

Target repository visibility. Defaults to internal when omitted. A source repository with public visibility must set this explicitly.

Kann eine der folgenden sein: private, internal

HTTP-Antwortstatuscodes für "Create an Enterprise Live Migration"

StatuscodeBESCHREIBUNG
201

The migration was created. The response contains the new migration identifier and its expiration. No credentials are returned.

400

Bad Request

401

Requires authentication

403

Forbidden

404

Resource not found

409

Conflict. The request conflicts with the current state of the migration.

422

The migration service is missing the source or target credentials required to service this request. An organization administrator must configure the required secrets before retrying.

500

Internal Error

Codebeispiele für "Create an Enterprise Live Migration"

Anforderungsbeispiel

post/enterprise/live-migrations
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/enterprise/live-migrations

The migration was created. The response contains the new migration identifier and its expiration. No credentials are returned.

Status: 201

Get an Enterprise Live Migration

Retrieve combined status, progress, cutover readiness, expiration, and timing for an Enterprise Live Migration (ELM) on the current GHES appliance.

Feinkörnige Zugriffstoken für "Get an Enterprise Live Migration"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Get an Enterprise Live Migration"

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
migration_id string Erforderlich

The ID of the migration.

HTTP-Antwortstatuscodes für "Get an Enterprise Live Migration"

StatuscodeBESCHREIBUNG
200

OK

400

Bad Request

401

Requires authentication

403

Forbidden

404

Resource not found

422

The migration service is missing the source or target credentials required to service this request. An organization administrator must configure the required secrets before retrying.

500

Internal Error

Codebeispiele für "Get an Enterprise Live Migration"

Anforderungsbeispiel

get/enterprise/live-migrations/{migration_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/enterprise/live-migrations/MIGRATION_ID

Response

Status: 200

Cancel an Enterprise Live Migration

Cancel an Enterprise Live Migration (ELM) in progress. This terminates the migration: it is cancelled locally, aborted on the migration backend, and its work items are removed. This is a terminal action with no recovery — a subsequent status request reflects the terminated state.

Feinkörnige Zugriffstoken für "Cancel an Enterprise Live Migration"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Cancel an Enterprise Live Migration"

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
migration_id string Erforderlich

The ID of the migration.

HTTP-Antwortstatuscodes für "Cancel an Enterprise Live Migration"

StatuscodeBESCHREIBUNG
204

The migration was cancelled. No content is returned; query the migration status to observe the terminal state.

400

Bad Request

401

Requires authentication

403

Forbidden

404

Resource not found

409

Conflict. The migration is not in a state that can be cancelled (for example, it has already completed or been terminated).

422

The migration service is missing the source or target credentials required to service this request. An organization administrator must configure the required secrets before retrying.

500

Internal Error

Codebeispiele für "Cancel an Enterprise Live Migration"

Anforderungsbeispiel

post/enterprise/live-migrations/{migration_id}/cancel
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/enterprise/live-migrations/MIGRATION_ID/cancel

The migration was cancelled. No content is returned; query the migration status to observe the terminal state.

Status: 204

Cutover an Enterprise Live Migration

Initiate cutover for an Enterprise Live Migration (ELM), archiving the source repository and draining remaining changes. Cutover is asynchronous; the migration transitions through cutover_pending and cutover_finalizing to completed. No content is returned — query the migration status to observe progress.

Feinkörnige Zugriffstoken für "Cutover an Enterprise Live Migration"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Cutover an Enterprise Live Migration"

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
migration_id string Erforderlich

The ID of the migration.

Körperparameter
force boolean

Bypass the cutover readiness checks and initiate cutover even when the migration is not reported as ready. Defaults to false.

Standard: false

HTTP-Antwortstatuscodes für "Cutover an Enterprise Live Migration"

StatuscodeBESCHREIBUNG
204

Cutover was initiated. No content is returned; query the migration status to observe the cutover progress.

400

Bad Request

401

Requires authentication

403

Forbidden

404

Resource not found

409

Conflict. The migration is not ready for cutover (for example, backfill is still in progress, or the migration has already completed, been cancelled, or failed).

422

The migration service is missing the source or target credentials required to service this request. An organization administrator must configure the required secrets before retrying.

500

Internal Error

Codebeispiele für "Cutover an Enterprise Live Migration"

Anforderungsbeispiel

post/enterprise/live-migrations/{migration_id}/cutover
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/enterprise/live-migrations/MIGRATION_ID/cutover

Cutover was initiated. No content is returned; query the migration status to observe the cutover progress.

Status: 204

Pause an Enterprise Live Migration

Pause source-load work for an active Enterprise Live Migration (ELM). Backfill and Git synchronization are paused while live event collection and delivery continue. The operation is idempotent for a migration that is already paused. No content is returned; query the migration status to observe the durable state.

Feinkörnige Zugriffstoken für "Pause an Enterprise Live Migration"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Pause an Enterprise Live Migration"

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
migration_id string Erforderlich

The unique identifier of the Enterprise Live Migration.

HTTP-Antwortstatuscodes für "Pause an Enterprise Live Migration"

StatuscodeBESCHREIBUNG
204

The migration was paused. No content is returned; query the migration status to confirm its current state.

400

Bad Request

401

Requires authentication

403

Forbidden

404

Resource not found

409

Conflict. The migration is not in a state that can be paused, such as when it has not been started or has already completed.

422

The pause request was accepted by the migration service, but the migration did not complete the transition to paused. Query the migration status and retry. This status is also returned when the migration service is missing the source or target credentials required to service the request; an organization administrator must configure the required secrets before retrying.

500

Internal Error

Codebeispiele für "Pause an Enterprise Live Migration"

Anforderungsbeispiel

post/enterprise/live-migrations/{migration_id}/pause
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/enterprise/live-migrations/MIGRATION_ID/pause

The migration was paused. No content is returned; query the migration status to confirm its current state.

Status: 204

Resume an Enterprise Live Migration

Resume a paused Enterprise Live Migration (ELM). The migration is re-queued and resumes backfill and live updates. A subsequent status request reflects the resumed state.

Feinkörnige Zugriffstoken für "Resume an Enterprise Live Migration"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Resume an Enterprise Live Migration"

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
migration_id string Erforderlich

The ID of the migration.

HTTP-Antwortstatuscodes für "Resume an Enterprise Live Migration"

StatuscodeBESCHREIBUNG
204

The migration was resumed. No content is returned; query the migration status to observe the resumed state.

400

Bad Request

401

Requires authentication

403

Forbidden

404

Resource not found

409

Conflict. The migration is not in a state that can be resumed (for example, it is not paused, or has completed or terminated).

422

The migration service is missing the source or target credentials required to service this request. An organization administrator must configure the required secrets before retrying.

500

Internal Error

Codebeispiele für "Resume an Enterprise Live Migration"

Anforderungsbeispiel

post/enterprise/live-migrations/{migration_id}/resume
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/enterprise/live-migrations/MIGRATION_ID/resume

The migration was resumed. No content is returned; query the migration status to observe the resumed state.

Status: 204

Revert cutover for an Enterprise Live Migration

Revert cutover for an Enterprise Live Migration (ELM). This unarchives the source repository and terminates any cutover or migration still in progress so the source repository can be migrated again.

Feinkörnige Zugriffstoken für "Revert cutover for an Enterprise Live Migration"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Revert cutover for an Enterprise Live Migration"

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
migration_id string Erforderlich

The ID of the migration.

HTTP-Antwortstatuscodes für "Revert cutover for an Enterprise Live Migration"

StatuscodeBESCHREIBUNG
200

The cutover was reverted.

400

Bad Request

401

Requires authentication

403

Forbidden

404

Resource not found

409

Conflict. The migration is not in a state where cutover can be reverted.

422

The migration service is missing the source or target credentials required to service this request. An organization administrator must configure the required secrets before retrying.

500

Internal Error

503

Service unavailable

Codebeispiele für "Revert cutover for an Enterprise Live Migration"

Anforderungsbeispiel

post/enterprise/live-migrations/{migration_id}/revert-cutover
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/enterprise/live-migrations/MIGRATION_ID/revert-cutover

The cutover was reverted.

Status: 200

Start an Enterprise Live Migration

Start a created Enterprise Live Migration (ELM), launching backfill and enabling live updates. The migration must be in a startable state (for example, created, paused, or failed); preflight validation runs before the migration is queued unless it has been skipped.

Feinkörnige Zugriffstoken für "Start an Enterprise Live Migration"

Dieser Endpunkt funktioniert nicht mit GitHub App-Benutzerzugriffstoken, GitHub App-Installationszugriffstoken oder fein abgestimmten persönlichen Zugriffstoken.

Parameter für "Start an Enterprise Live Migration"

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
migration_id string Erforderlich

The ID of the migration.

HTTP-Antwortstatuscodes für "Start an Enterprise Live Migration"

StatuscodeBESCHREIBUNG
204

The migration was started (queued for execution). No content is returned; query the migration status to observe progress.

400

Bad Request

401

Requires authentication

403

Forbidden

404

Resource not found

409

Conflict. The migration is not in a state that can be started (for example, it has already been started or has completed).

422

The migration could not be started because preflight validation did not pass. Query the migration status for details. This status is also returned when the migration service is missing the source or target credentials required to service the request; an organization administrator must configure the required secrets before retrying.

500

Internal Error

Codebeispiele für "Start an Enterprise Live Migration"

Anforderungsbeispiel

post/enterprise/live-migrations/{migration_id}/start
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ http(s)://HOSTNAME/api/v3/enterprise/live-migrations/MIGRATION_ID/start

The migration was started (queued for execution). No content is returned; query the migration status to observe progress.

Status: 204