Start an import - GitHub v3 REST API

Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status 422 Unprocessable Entity response.

curl --location --request PUT 'https://api.github.com/repos///import' \ --header 'Content-Type: application/json' \ --data-raw '{ "vcs": "subversion", "vcs_password": "secret", "vcs_url": "http://svn.mycompany.com/svn/myproject", "vcs_username": "octocat" }'

{ "authors_count": 0, "authors_url": "http://example.com", "commit_count": 0, "error_message": "string", "failed_step": "string", "has_large_files": true, "html_url": "http://example.com", "import_percent": 0, "large_files_count": 0, "large_files_size": 0, "message": "string", "project_choices": [ { "human_name": "string", "tfvc_project": "string", "vcs": "string" } ], "push_percent": 0, "repository_url": "http://example.com", "status": "auth", "status_text": "string", "svc_root": "string", "svn_root": "string", "tfvc_project": "string", "url": "http://example.com", "use_lfs": true, "vcs": "string", "vcs_url": "string" }

Request

Path Params

owner

string

required

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

repo

string

required

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

Body Params application/json

tfvc_project

string

optional

For a tfvc import, the name of the project that is being imported.

vcs

enum<string>

optional

The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.

Allowed values:

subversiongitmercurialtfvc

vcs_password

string

optional

If authentication is required, the password to provide to vcs_url.

vcs_url

string

required

The URL of the originating repository.

vcs_username

string

optional

If authentication is required, the username to provide to vcs_url.

Examples

Responses

🟢201Response

application/json

Body

A repository import from an external source.

authors_count

integer | null

optional

authors_url

string <uri>

required

commit_count

integer | null

optional

error_message

string | null

optional

failed_step

string | null

optional

has_large_files

boolean

optional

html_url

string <uri>

required

import_percent

integer | null

optional

large_files_count

integer

optional

large_files_size

integer

optional

message

string

optional

project_choices

array [object {3}]

optional

human_name

string

optional

tfvc_project

string

optional

vcs

string

optional

push_percent

integer | null

optional

repository_url

string <uri>

required

status

enum<string>

required

Allowed values:

autherrornonedetectingchooseauth_failedimportingmappingwaiting_to_pushpushingcompletesetupunknowndetection_found_multipledetection_found_nothingdetection_needs_auth

status_text

string | null

optional

svc_root

string

optional

svn_root

string

optional

tfvc_project

string

optional

url

string <uri>

required

use_lfs

boolean

optional

vcs

string | null

required

vcs_url

string

required

The URL of the originating repository.

🟠404404

🟠422422

🔴503503