diff options
Diffstat (limited to 'doc/api/import.md')
| -rw-r--r-- | doc/api/import.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/api/import.md b/doc/api/import.md index 307796f8acb..54e7eb12ed1 100644 --- a/doc/api/import.md +++ b/doc/api/import.md @@ -29,3 +29,40 @@ Example response: "full_name": "Administrator / my-repo" } ``` + +## Import repository from Bitbucket Server + +Import your projects from Bitbucket Server to GitLab via the API. + +NOTE: **Note:** +The Bitbucket Project Key is only used for finding the repository in Bitbucket. +You must specify a `target_namespace` if you want to import the repository to a GitLab group. +If you do not specify `target_namespace`, the project will import to your personal user namespace. + +```plaintext +POST /import/bitbucket_server +``` + +| Attribute | Type | Required | Description | +|------------|---------|----------|---------------------| +| `bitbucket_server_url` | string | yes | Bitbucket Server URL | +| `bitbucket_server_username` | string | yes | Bitbucket Server Username | +| `personal_access_token` | string | yes | Bitbucket Server personal access token/password | +| `bitbucket_server_project` | string | yes | Bitbucket Project Key | +| `bitbucket_server_repo` | string | yes | Bitbucket Repository Name | +| `new_name` | string | no | New repo name | +| `target_namespace` | string | no | Namespace to import repo into | + +```shell +curl --request POST \ + --url https://gitlab.example.com/api/v4/import/bitbucket_server \ + --header "content-type: application/json" \ + --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" \ + --data '{ + "bitbucket_server_url": "http://bitbucket.example.com", + "bitbucket_server_username": "root", + "personal_access_token": "Nzk4MDcxODY4MDAyOiP8y410zF3tGAyLnHRv/E0+3xYs", + "bitbucket_server_project": "NEW", + "bitbucket_server_repo": "my-repo" +}' +``` |