Search + K

Command Palette

Search for a command to run...

Sign In

Update an import

Deprecated
PATCH /repos/{owner}/{repo}/import
Copy endpoint
https://api.github.com

An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted.

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will have the status detection_found_multiple and the Import Progress response will include a project_choices array. You can select the project to import by providing one of the objects in the project_choices array in the update request.

[!WARNING] Endpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

Parameters

path Path Parameters

Name Type
owner required

The account owner of the repository. The name is not case sensitive.

string
repo required

The name of the repository without the .git extension. The name is not case sensitive.

string

Request Body

application/json
{
vcs_username?: string;
vcs_password?: string;
vcs?: "subversion" | "tfvc" | "git" | "mercurial";
tfvc_project?: string;
}
| null

Responses

200 application/json

Response

interface Import {
vcs: string | null;
use_lfs?: boolean;
vcs_url: string;
svc_root?: string;
tfvc_project?: string;
status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth";
status_text?: string | null;
failed_step?: string | null;
error_message?: string | null;
import_percent?: number | null;
commit_count?: number | null;
push_percent?: number | null;
has_large_files?: boolean;
large_files_size?: number;
large_files_count?: number;
project_choices?: { vcs?: string;tfvc_project?: string;human_name?: string; }[];
message?: string;
authors_count?: number | null;
url: string;
html_url: string;
authors_url: string;
repository_url: string;
svn_root?: string;
}

Server Errors

503 application/json

Unavailable due to service under maintenance.

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}