@@ -74,8 +74,8 @@ POST /projects/:id/access_requests
Example request:
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/:id/access_requests
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/:id/access_requests
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/:id/access_requests"
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/:id/access_requests"
```
Example response:
...
...
@@ -109,8 +109,8 @@ PUT /projects/:id/access_requests/:user_id/approve
Example request:
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/:id/access_requests/:user_id/approve?access_level=20
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/:id/access_requests/:user_id/approve?access_level=20
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/:id/access_requests/:user_id/approve?access_level=20"
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/:id/access_requests/:user_id/approve?access_level=20"
| `email_header_and_footer_enabled` | boolean | no | Add header and footer to all outgoing emails if enabled
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/application/appearance?email_header_and_footer_enabled=true&header_message=test
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/application/appearance?email_header_and_footer_enabled=true&header_message=test"
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"name=MyApplication&redirect_uri=http://redirect.uri&scopes="https://gitlab.example.com/api/v4/applications
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"name=MyApplication&redirect_uri=http://redirect.uri&scopes=""https://gitlab.example.com/api/v4/applications"
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji?name=rocket
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji?name=rocket"
| `name` | string | yes | The name of the new board |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/boards?name=newboard
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/boards?name=newboard"
```
Example response:
...
...
@@ -254,7 +254,7 @@ PUT /projects/:id/boards/:board_id
| `weight` | integer | no | The weight range from 0 to 9, to which the board should be scoped to |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/boards/1?name=new_name&milestone_id=43&assignee_id=1&labels=Doing&weight=4
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/boards/1?name=new_name&milestone_id=43&assignee_id=1&labels=Doing&weight=4"
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/repository/branches?branch=newbranch&ref=master
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/repository/branches?branch=newbranch&ref=master"
curl --data"message=Deploy in progress&color=#cecece"--header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/broadcast_messages
curl --data"message=Deploy in progress&color=#cecece"--header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/broadcast_messages"
```
Example response:
...
...
@@ -148,7 +148,7 @@ Parameters:
Example request:
```shell
curl --request PUT --data"message=Update message&color=#000"--header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/broadcast_messages/1
curl --request PUT --data"message=Update message&color=#000"--header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/broadcast_messages/1"
@@ -84,7 +84,7 @@ PUT /projects/:id/custom_attributes/:key
| `value` | string | yes | The value of the custom attribute |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"--data"value=Greenland"https://gitlab.example.com/api/v4/users/42/custom_attributes/location
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"--data"value=Greenland""https://gitlab.example.com/api/v4/users/42/custom_attributes/location"
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/issues/11/discussions?body=comment
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/issues/11/discussions?body=comment"
```
### Add note to existing issue thread
...
...
@@ -184,7 +184,7 @@ Parameters:
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment"
```
### Modify existing issue thread note
...
...
@@ -206,7 +206,7 @@ Parameters:
| `body` | string | yes | The content of the note/reply |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?body=comment
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?body=comment"
```
### Delete an issue thread note
...
...
@@ -227,7 +227,7 @@ Parameters:
| `note_id` | integer | yes | The ID of a discussion note |
| `discussion_id` | integer | yes | The ID of a discussion item |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7"
```
### Create new snippet thread
...
...
@@ -367,7 +367,7 @@ Parameters:
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions?body=comment
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions?body=comment"
```
### Add note to existing snippet thread
...
...
@@ -390,7 +390,7 @@ Parameters:
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment"
```
### Modify existing snippet thread note
...
...
@@ -412,7 +412,7 @@ Parameters:
| `body` | string | yes | The content of the note/reply |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?body=comment
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?body=comment"
```
### Delete a snippet thread note
...
...
@@ -433,7 +433,7 @@ Parameters:
| `note_id` | integer | yes | The ID of a discussion note |
| `discussion_id` | integer | yes | The ID of a discussion item |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7"
```
### Create new epic thread
...
...
@@ -574,7 +574,7 @@ Parameters:
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/5/epics/11/discussions?body=comment
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/5/epics/11/discussions?body=comment"
```
### Add note to existing epic thread
...
...
@@ -598,7 +598,7 @@ Parameters:
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment"
```
### Modify existing epic thread note
...
...
@@ -620,7 +620,7 @@ Parameters:
| `body` | string | yes | The content of note/reply |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?body=comment
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?body=comment"
```
### Delete an epic thread note
...
...
@@ -641,7 +641,7 @@ Parameters:
| `note_id` | integer | yes | The ID of a thread note |
| `position[y]` | integer | no | Y coordinate (for 'image' diff notes) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions?body=comment
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions?body=comment"
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7?resolved=true
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7?resolved=true"
```
### Add note to existing merge request thread
...
...
@@ -899,7 +899,7 @@ Parameters:
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment"
```
### Modify an existing merge request thread note
...
...
@@ -922,13 +922,13 @@ Parameters:
| `resolved` | boolean | no | Resolve/unresolve the note (exactly one of `body` or `resolved` must be set |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?body=comment
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?body=comment"
```
Resolving a note:
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?resolved=true
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?resolved=true"
```
### Delete a merge request thread note
...
...
@@ -949,7 +949,7 @@ Parameters:
| `note_id` | integer | yes | The ID of a thread note |
| `position[y]` | integer | no | Y coordinate (for 'image' diff notes) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/commits/11/discussions?body=comment
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/commits/11/discussions?body=comment"
```
### Add note to existing commit thread
...
...
@@ -1170,7 +1170,7 @@ Parameters:
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/commits/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/commits/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment
```
### Modify an existing commit thread note
...
...
@@ -1192,13 +1192,13 @@ Parameters:
| `body` | string | no | The content of a note |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/commits/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?body=comment
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/commits/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?body=comment"
```
Resolving a note:
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/commits/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?resolved=true
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/commits/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?resolved=true"
```
### Delete a commit thread note
...
...
@@ -1219,5 +1219,5 @@ Parameters:
| `note_id` | integer | yes | The ID of a thread note |
@@ -80,7 +80,7 @@ POST /groups/:id/epics/:epic_iid/epics
| `child_epic_id` | integer | yes | The global ID of the child epic. Internal ID can't be used because they can conflict with epics from other groups. |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/1/epics/5/epics/6
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/1/epics/5/epics/6"
```
Example response:
...
...
@@ -133,7 +133,7 @@ POST /groups/:id/epics/:epic_iid/epics
| `title` | string | yes | The title of a newly created epic. |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/1/epics/5/epics?title=Newpic
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/1/epics/5/epics?title=Newpic"
```
Example response:
...
...
@@ -168,7 +168,7 @@ PUT /groups/:id/epics/:epic_iid/epics/:child_epic_id
| `move_after_id` | integer | no | The global ID of a sibling epic that should be placed after the child epic. |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/1/epics/4/epics/5
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/1/epics/4/epics/5"
| `child_epic_id` | integer | yes | The global ID of the child epic. Internal ID can't be used because they can conflict with epics from other groups. |
@@ -76,7 +76,7 @@ GET /groups/:id/epics?state=opened
| `my_reaction_emoji` | string | no | Return epics reacted by the authenticated user by the given emoji. `None` returns epics not given a reaction. `Any` returns epics given at least one reaction. Introduced in [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31479)|
| `parent_id` | integer/string | no | The ID of a parent epic (since 11.11) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/1/epics?title=Epic&description=Epic%20description
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/1/epics?title=Epic&description=Epic%20description"
```
Example response:
...
...
@@ -336,7 +336,7 @@ PUT /groups/:id/epics/:epic_iid
| `state_event` | string | no | State event for an epic. Set `close` to close the epic and `reopen` to reopen it (since 11.4) |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/1/epics/5?title=New%20Title
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/1/epics/5?title=New%20Title"
| `image_url` | string | yes | URL of the badge image |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&position=0"https://gitlab.example.com/api/v4/groups/:id/badges
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&position=0""https://gitlab.example.com/api/v4/groups/:id/badges"
```
Example response:
...
...
@@ -124,7 +124,7 @@ PUT /groups/:id/badges/:badge_id
| `image_url` | string | no | URL of the badge image |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id"
| `name` | string | yes | The name of the new board |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/5/boards?name=newboard
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/5/boards?name=newboard"
```
Example response:
...
...
@@ -327,7 +327,7 @@ PUT /groups/:id/boards/:board_id
| `weight` | integer | no | The weight range from 0 to 9, to which the board should be scoped to |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/5/boards/1?name=new_name&milestone_id=44&assignee_id=1&labels=GroupLabel&weight=4
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/5/boards/1?name=new_name&milestone_id=44&assignee_id=1&labels=GroupLabel&weight=4"
@@ -83,7 +83,7 @@ The `file=` parameter must point to a file on your file system and be preceded
by `@`. For example:
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--form"name=imported-group"--form"path=imported-group"--form"file=@/path/to/file"https://gitlab.example.com/api/v4/groups/import
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--form"name=imported-group"--form"path=imported-group"--form"file=@/path/to/file""https://gitlab.example.com/api/v4/groups/import"
@@ -400,7 +400,7 @@ The `projects` and `shared_projects` attributes in the response are deprecated a
To get the details of all projects within a group, use either the [list a group's projects](#list-a-groups-projects) or the [list a group's shared projects](#list-a-groups-shared-projects) endpoint.
| `target_namespace` | string | yes | Namespace to import repository into |
```shell
curl --request POST --header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"--data"personal_access_token=abc123&repo_id=12345&target_namespace=root" https://gitlab.example.com/api/v4/import/github
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"personal_access_token=abc123&repo_id=12345&target_namespace=root""https://gitlab.example.com/api/v4/import/github"
| `non_archived` | boolean | no | Return issues only from non-archived projects. If `false`, response will return issues from both archived and non-archived projects. Default is `true`. _(Introduced in [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/197170))_ |
@@ -232,7 +232,7 @@ GET /groups/:id/issues?confidential=true
| `non_archived` | boolean | no | Return issues from non archived projects. Default is true. _(Introduced in [GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/23785))_ |
@@ -386,7 +386,7 @@ GET /projects/:id/issues?confidential=true
| `not` | Hash | no | Return issues that do not match the parameters supplied. Accepts: `labels`, `milestone`, `author_id`, `author_username`, `assignee_id`, `assignee_username`, `my_reaction_emoji`, `search`, `in` |
| `epic_iid`**(ULTIMATE)** | integer | no | IID of the epic to add the issue to. Valid values are greater than or equal to 0. (deprecated, [will be removed in version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157)) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/4/issues?title=Issues%20with%20auth&labels=bug
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/4/issues?title=Issues%20with%20auth&labels=bug"
```
Example response:
...
...
@@ -785,7 +785,7 @@ PUT /projects/:id/issues/:issue_iid
| `epic_iid`**(ULTIMATE)** | integer | no | IID of the epic to add the issue to. Valid values are greater than or equal to 0. (deprecated, [will be removed in version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157)) |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/4/issues/85?state_event=close
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/4/issues/85?state_event=close"
| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, or `manual`. All jobs are returned if `scope` is not provided. |
@@ -149,7 +149,7 @@ GET /projects/:id/pipelines/:pipeline_id/jobs
| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, or `manual`. All jobs are returned if `scope` is not provided. |
| `project` | string | no (optional) | Use `project` as a context when creating references using GitLab Flavored Markdown. [Authentication](README.md#authentication) is required if a project is not public. |
| `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"user_id=1&access_level=30"https://gitlab.example.com/api/v4/groups/:id/members
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"user_id=1&access_level=30"https://gitlab.example.com/api/v4/projects/:id/members
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"user_id=1&access_level=30""https://gitlab.example.com/api/v4/groups/:id/members"
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"user_id=1&access_level=30""https://gitlab.example.com/api/v4/projects/:id/members"
```
Example response:
...
...
@@ -264,8 +264,8 @@ PUT /projects/:id/members/:user_id
| `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/:id/members/:user_id?access_level=40
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/:id/members/:user_id?access_level=40
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/:id/members/:user_id?access_level=40"
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/:id/members/:user_id?access_level=40"
```
Example response:
...
...
@@ -301,7 +301,7 @@ POST /groups/:id/members/:user_id/override
| `user_id` | integer | yes | The user ID of the member |
```shell
curl --request PUT --header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override
curl --request PUT --header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK""https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override"
@@ -2322,7 +2322,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/time_estimate
| `duration` | string | yes | The duration in human format. e.g: 3h30m |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_estimate?duration=3h30m
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_estimate?duration=3h30m"
```
Example response:
...
...
@@ -2350,7 +2350,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/reset_time_estimate
| `merge_request_iid` | integer | yes | The internal ID of a project's merge_request |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_time_estimate
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_time_estimate"
```
Example response:
...
...
@@ -2379,7 +2379,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/add_spent_time
| `duration` | string | yes | The duration in human format. e.g: 3h30m |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/merge_requests/93/add_spent_time?duration=1h
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/merge_requests/93/add_spent_time?duration=1h"
```
Example response:
...
...
@@ -2407,7 +2407,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/reset_spent_time
| `merge_request_iid` | integer | yes | The internal ID of a project's merge_request |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_spent_time
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/merge_requests/93/reset_spent_time"
```
Example response:
...
...
@@ -2433,7 +2433,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/time_stats
| `merge_request_iid` | integer | yes | The internal ID of the merge request |
@@ -133,8 +133,8 @@ PUT /projects/:id/notification_settings
```
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/groups/5/notification_settings?level=watch
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/8/notification_settings?level=custom&new_note=true
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/groups/5/notification_settings?level=watch"
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/8/notification_settings?level=custom&new_note=true"
| `package_name` | string | no | Filter the project packages with a fuzzy search by name. (_[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30980) in GitLab 13.0_)
@@ -126,15 +126,15 @@ POST /projects/:id/pages/domains
| `key` | file/string | no | The certificate key in PEM format. |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--form"domain=ssl.domain.example"--form"certificate=@/path/to/cert.pem"--form"key=@/path/to/key.pem"https://gitlab.example.com/api/v4/projects/5/pages/domains
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--form"domain=ssl.domain.example"--form"certificate=@/path/to/cert.pem"--form"key=@/path/to/key.pem""https://gitlab.example.com/api/v4/projects/5/pages/domains"
```
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--form"domain=ssl.domain.example"--form"certificate=$CERT_PEM"--form"key=$KEY_PEM"https://gitlab.example.com/api/v4/projects/5/pages/domains
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--form"domain=ssl.domain.example"--form"certificate=$CERT_PEM"--form"key=$KEY_PEM""https://gitlab.example.com/api/v4/projects/5/pages/domains"
```
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--form"domain=ssl.domain.example"--form"auto_ssl_enabled=true"https://gitlab.example.com/api/v4/projects/5/pages/domains
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--form"domain=ssl.domain.example"--form"auto_ssl_enabled=true""https://gitlab.example.com/api/v4/projects/5/pages/domains"
```
```json
...
...
@@ -170,11 +170,11 @@ PUT /projects/:id/pages/domains/:domain
### Adding certificate
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"--form"certificate=@/path/to/cert.pem"--form"key=@/path/to/key.pem"https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"--form"certificate=@/path/to/cert.pem"--form"key=@/path/to/key.pem""https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example"
```
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"--form"certificate=$CERT_PEM"--form"key=$KEY_PEM"https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"--form"certificate=$CERT_PEM"--form"key=$KEY_PEM""https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example"
### Enabling Let's Encrypt integration for Pages custom domains
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"--form"auto_ssl_enabled=true"https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"--form"auto_ssl_enabled=true""https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example"
To remove the SSL certificate attached to the Pages domain, run:
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"--form"certificate="--form"key="https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"--form"certificate="--form"key=""https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example"
| `image_url` | string | yes | URL of the badge image |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&position=0"https://gitlab.example.com/api/v4/projects/:id/badges
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&position=0""https://gitlab.example.com/api/v4/projects/:id/badges"
```
Example response:
...
...
@@ -130,7 +130,7 @@ PUT /projects/:id/badges/:badge_id
| `image_url` | string | no | URL of the badge image |
```shell
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"
@@ -142,7 +142,7 @@ The `file=` parameter must point to a file on your file system and be preceded
by `@`. For example:
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--form"path=api-project"--form"file=@/path/to/file"https://gitlab.example.com/api/v4/projects/import
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--form"path=api-project"--form"file=@/path/to/file""https://gitlab.example.com/api/v4/projects/import"
```
cURL doesn't support posting a file from a remote server. Importing a project from a remote server can be accomplished through something like the following:
...
...
@@ -194,7 +194,7 @@ GET /projects/:id/import
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
@@ -165,7 +165,7 @@ POST /projects/:id/protected_branches
```
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"'https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&push_access_level=30&merge_access_level=30&unprotect_access_level=40'
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&push_access_level=30&merge_access_level=30&unprotect_access_level=40"
```
| Attribute | Type | Required | Description |
...
...
@@ -251,7 +251,7 @@ Elements in the `allowed_to_push` / `allowed_to_merge` / `allowed_to_unprotect`
form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md#restricting-push-and-merge-access-to-certain-users-starter) and were [added to the API in](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/3516) in GitLab 10.3 EE.
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"'https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&allowed_to_push%5B%5D%5Buser_id%5D=1'
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&allowed_to_push%5B%5D%5Buser_id%5D=1"
@@ -89,7 +89,7 @@ POST /projects/:id/protected_environments
```
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"'https://gitlab.example.com/api/v4/projects/5/protected_environments?name=staging&deploy_access_levels%5B%5D%5Buser_id%5D=1'
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/protected_environments?name=staging&deploy_access_levels%5B%5D%5Buser_id%5D=1"
@@ -88,7 +88,7 @@ POST /projects/:id/protected_tags
```
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"'https://gitlab.example.com/api/v4/projects/5/protected_tags?name=*-stable&create_access_level=30'
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/protected_tags?name=*-stable&create_access_level=30"
@@ -64,7 +64,7 @@ POST /projects/:id/remote_mirrors
Example request:
```shell
curl --request POST --data"url=https://username:token@example.com/gitlab/example.git"--header"PRIVATE-TOKEN: <your_access_token>"'https://gitlab.example.com/api/v4/projects/42/remote_mirrors'
curl --request POST --data"url=https://username:token@example.com/gitlab/example.git"--header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/42/remote_mirrors"
```
Example response:
...
...
@@ -105,7 +105,7 @@ PUT /projects/:id/remote_mirrors/:mirror_id
Example request:
```shell
curl --request PUT --data"enabled=false"--header"PRIVATE-TOKEN: <your_access_token>"'https://gitlab.example.com/api/v4/projects/42/remote_mirrors/101486'
curl --request PUT --data"enabled=false"--header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/42/remote_mirrors/101486"
-`sha` (optional) - The commit SHA to download. A tag, branch reference, or SHA can be used. This defaults to the tip of the default branch if not specified. For example:
| `resource_label_event_id` | integer | yes | The ID of a label event |
```shell
curl --request GET --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/merge_requests/11/resource_label_events/120
curl --request GET --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/merge_requests/11/resource_label_events/120"
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/application/settings?signup_enabled=false&default_project_visibility=internal
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/application/settings?signup_enabled=false&default_project_visibility=internal"
@@ -1355,7 +1355,7 @@ POST /users/:user_id/impersonation_tokens
| `scopes` | array | yes | The array of scopes of the impersonation token (`api`, `read_user`) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"name=mytoken"--data"expires_at=2017-04-04"--data"scopes[]=api"https://gitlab.example.com/api/v4/users/42/impersonation_tokens
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"--data"name=mytoken"--data"expires_at=2017-04-04"--data"scopes[]=api""https://gitlab.example.com/api/v4/users/42/impersonation_tokens"
| `position[y]` | integer | no | Y coordinate (Only stored for `image` diff notes) |
```shell
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/projects/5/merge_requests/11/visual_review_discussions?body=comment
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/merge_requests/11/visual_review_discussions?body=comment"
@@ -39,7 +39,7 @@ POST /security/projects/:id/vulnerability_exports
| `id` | integer or string | yes | The ID or [URL-encoded path](README.md#namespaced-path-encoding) of the project which the authenticated user is a member of |
```shell
curl --header POST "PRIVATE-TOKEN: <your_access_token>"https://gitlab.example.com/api/v4/security/projects/1/vulnerability_exports
curl --header POST "PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/1/vulnerability_exports"
```
The created vulnerability export is automatically deleted after 1 hour.
...
...
@@ -155,7 +155,7 @@ GET /security/vulnerability_exports/:id
| `id` | integer or string | yes | The vulnerability export's ID |