118 lines
2.8 KiB
Markdown
118 lines
2.8 KiB
Markdown
---
|
|
stage: Create
|
|
group: Source Code
|
|
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers"
|
|
type: reference, api
|
|
---
|
|
|
|
# Project Aliases API **(PREMIUM ONLY)**
|
|
|
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3264) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.1.
|
|
|
|
All methods require administrator authorization.
|
|
|
|
## List all project aliases
|
|
|
|
Get a list of all project aliases:
|
|
|
|
```plaintext
|
|
GET /project_aliases
|
|
```
|
|
|
|
```shell
|
|
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases"
|
|
```
|
|
|
|
Example response:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"id": 1,
|
|
"project_id": 1,
|
|
"name": "gitlab-foss"
|
|
},
|
|
{
|
|
"id": 2,
|
|
"project_id": 2,
|
|
"name": "gitlab"
|
|
}
|
|
]
|
|
```
|
|
|
|
## Get project alias' details
|
|
|
|
Get details of a project alias:
|
|
|
|
```plaintext
|
|
GET /project_aliases/:name
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
|-----------|--------|----------|-----------------------|
|
|
| `name` | string | yes | The name of the alias |
|
|
|
|
```shell
|
|
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases/gitlab"
|
|
```
|
|
|
|
Example response:
|
|
|
|
```json
|
|
{
|
|
"id": 1,
|
|
"project_id": 1,
|
|
"name": "gitlab"
|
|
}
|
|
```
|
|
|
|
## Create a project alias
|
|
|
|
Add a new alias for a project. Responds with a 201 when successful,
|
|
400 when there are validation errors (e.g. alias already exists):
|
|
|
|
```plaintext
|
|
POST /project_aliases
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
|--------------|----------------|----------|----------------------------------------|
|
|
| `project_id` | integer/string | yes | The ID or path of the project. |
|
|
| `name` | string | yes | The name of the alias. Must be unique. |
|
|
|
|
```shell
|
|
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases" --form "project_id=1" --form "name=gitlab"
|
|
```
|
|
|
|
or
|
|
|
|
```shell
|
|
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases" --form "project_id=gitlab-org/gitlab" --form "name=gitlab"
|
|
```
|
|
|
|
Example response:
|
|
|
|
```json
|
|
{
|
|
"id": 1,
|
|
"project_id": 1,
|
|
"name": "gitlab"
|
|
}
|
|
```
|
|
|
|
## Delete a project alias
|
|
|
|
Removes a project aliases. Responds with a 204 when project alias
|
|
exists, 404 when it doesn't:
|
|
|
|
```plaintext
|
|
DELETE /project_aliases/:name
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
|-----------|--------|----------|-----------------------|
|
|
| `name` | string | yes | The name of the alias |
|
|
|
|
```shell
|
|
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases/gitlab"
|
|
```
|