Skip to content

G
gitlab-ce
Commit 663d717d authored by Greg Myers's avatar Greg Myers Committed by Amy Qualls
Browse files
Options

Quote API curl example URLs 

Also Standardize quote usage & replace look-alike PRIVATE-TOKENs
parent 9a11d189
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 450 additions and 450 deletions
doc/api/README.md
View file @ 663d717d
...@@ -107,13 +107,13 @@ You can use an [OAuth2 token](oauth2.md) to authenticate with the API by passing ...@@ -107,13 +107,13 @@ You can use an [OAuth2 token](oauth2.md) to authenticate with the API by passing
Example of using the OAuth2 token in a parameter: Example of using the OAuth2 token in a parameter:
```shell ```shell
curl https://gitlab.example.com/api/v4/projects?access_token=OAUTH-TOKEN curl "https://gitlab.example.com/api/v4/projects?access_token=OAUTH-TOKEN"
``` ```
Example of using the OAuth2 token in a header: Example of using the OAuth2 token in a header:
```shell ```shell
curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/api/v4/projects curl --header "Authorization: Bearer OAUTH-TOKEN" "https://gitlab.example.com/api/v4/projects"
``` ```
Read more about [GitLab as an OAuth2 provider](oauth2.md). Read more about [GitLab as an OAuth2 provider](oauth2.md).
...@@ -126,19 +126,19 @@ or the `Private-Token` header. ...@@ -126,19 +126,19 @@ or the `Private-Token` header.
Example of using the personal/project access token in a parameter: Example of using the personal/project access token in a parameter:
```shell ```shell
curl https://gitlab.example.com/api/v4/projects?private_token=<your_access_token> curl "https://gitlab.example.com/api/v4/projects?private_token=<your_access_token>"
``` ```
Example of using the personal/project access token in a header: Example of using the personal/project access token in a header:
```shell ```shell
curl --header "Private-Token: <your_access_token>" https://gitlab.example.com/api/v4/projects curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects"
``` ```
You can also use personal/project access tokens with OAuth-compliant headers: You can also use personal/project access tokens with OAuth-compliant headers:
```shell ```shell
curl --header "Authorization: Bearer <your_access_token>" https://gitlab.example.com/api/v4/projects curl --header "Authorization: Bearer <your_access_token>" "https://gitlab.example.com/api/v4/projects"
``` ```
### Session cookie ### Session cookie
...@@ -348,7 +348,7 @@ and we request the second page (`page=2`) of [comments](notes.md) of the issue ...@@ -348,7 +348,7 @@ and we request the second page (`page=2`) of [comments](notes.md) of the issue
with ID `8` which belongs to the project with ID `8`: with ID `8` which belongs to the project with ID `8`:
```shell ```shell
curl --head --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/8/issues/8/notes?per_page=3&page=2 curl --head --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/8/issues/8/notes?per_page=3&page=2"
``` ```
The response will then be: The response will then be:
...@@ -450,7 +450,7 @@ The `:id` path parameter needs to be replaced with the project ID, and the `:gro ...@@ -450,7 +450,7 @@ The `:id` path parameter needs to be replaced with the project ID, and the `:gro
The resulting cURL call for a project with ID `5` and a group ID of `17` is then: The resulting cURL call for a project with ID `5` and a group ID of `17` is then:
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/share/17 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/share/17"
``` ```
NOTE: **Note:** NOTE: **Note:**
...@@ -521,10 +521,10 @@ https://gitlab.example.com/api/v4/projects/import ...@@ -521,10 +521,10 @@ https://gitlab.example.com/api/v4/projects/import
`variables` is a parameter of type `array` containing hash key/value pairs `[{ 'key' => 'UPLOAD_TO_S3', 'value' => 'true' }]`: `variables` is a parameter of type `array` containing hash key/value pairs `[{ 'key' => 'UPLOAD_TO_S3', 'value' => 'true' }]`:
```shell ```shell
curl --globoff --request POST --header "PRIVATE-TOKEN: ********************" \ curl --globoff --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
"https://gitlab.example.com/api/v4/projects/169/pipeline?ref=master&variables[][key]=VAR1&variables[][value]=hello&variables[][key]=VAR2&variables[][value]=world" "https://gitlab.example.com/api/v4/projects/169/pipeline?ref=master&variables[][key]=VAR1&variables[][value]=hello&variables[][key]=VAR2&variables[][value]=world"
curl --request POST --header "PRIVATE-TOKEN: ********************" \ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-Type: application/json" \ --header "Content-Type: application/json" \
--data '{ "ref": "master", "variables": [ {"key": "VAR1", "value": "hello"}, {"key": "VAR2", "value": "world"} ] }' \ --data '{ "ref": "master", "variables": [ {"key": "VAR1", "value": "hello"}, {"key": "VAR2", "value": "world"} ] }' \
"https://gitlab.example.com/api/v4/projects/169/pipeline" "https://gitlab.example.com/api/v4/projects/169/pipeline"
......
doc/api/access_requests.md
View file @ 663d717d
...@@ -31,8 +31,8 @@ GET /projects/:id/access_requests ...@@ -31,8 +31,8 @@ GET /projects/:id/access_requests
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/access_requests curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/access_requests"
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/access_requests curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/access_requests"
``` ```
Example response: Example response:
...@@ -74,8 +74,8 @@ POST /projects/:id/access_requests ...@@ -74,8 +74,8 @@ POST /projects/:id/access_requests
Example request: Example request:
```shell ```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/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/projects/:id/access_requests"
``` ```
Example response: Example response:
...@@ -109,8 +109,8 @@ PUT /projects/:id/access_requests/:user_id/approve ...@@ -109,8 +109,8 @@ PUT /projects/:id/access_requests/:user_id/approve
Example request: Example request:
```shell ```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/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/projects/:id/access_requests/:user_id/approve?access_level=20"
``` ```
Example response: Example response:
...@@ -143,6 +143,6 @@ DELETE /projects/:id/access_requests/:user_id ...@@ -143,6 +143,6 @@ DELETE /projects/:id/access_requests/:user_id
Example request: Example request:
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/access_requests/:user_id curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/access_requests/:user_id"
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/access_requests/:user_id curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/access_requests/:user_id"
``` ```
doc/api/admin_sidekiq_queues.md
View file @ 663d717d
...@@ -33,7 +33,7 @@ DELETE /admin/sidekiq/queues/:queue_name ...@@ -33,7 +33,7 @@ DELETE /admin/sidekiq/queues/:queue_name
At least one attribute, other than `queue_name`, is required. At least one attribute, other than `queue_name`, is required.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/admin/sidekiq/queues/authorized_projects?user=root curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/admin/sidekiq/queues/authorized_projects?user=root"
``` ```
Example response: Example response:
......
doc/api/appearance.md
View file @ 663d717d
...@@ -14,7 +14,7 @@ GET /application/appearance ...@@ -14,7 +14,7 @@ GET /application/appearance
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/application/appearance curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/appearance"
``` ```
Example response: Example response:
...@@ -60,7 +60,7 @@ PUT /application/appearance ...@@ -60,7 +60,7 @@ PUT /application/appearance
| `email_header_and_footer_enabled` | boolean | no | Add header and footer to all outgoing emails if enabled | `email_header_and_footer_enabled` | boolean | no | Add header and footer to all outgoing emails if enabled
```shell ```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"
``` ```
Example response: Example response:
......
doc/api/applications.md
View file @ 663d717d
...@@ -32,7 +32,7 @@ Parameters: ...@@ -32,7 +32,7 @@ Parameters:
Example request: Example request:
```shell ```shell
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"
``` ```
Example response: Example response:
...@@ -59,7 +59,7 @@ GET /applications ...@@ -59,7 +59,7 @@ GET /applications
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/applications curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/applications"
``` ```
Example response: Example response:
...@@ -98,5 +98,5 @@ Parameters: ...@@ -98,5 +98,5 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/applications/:id curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/applications/:id"
``` ```
doc/api/audit_events.md
View file @ 663d717d
...@@ -25,7 +25,7 @@ are paginated. ...@@ -25,7 +25,7 @@ are paginated.
Read more on [pagination](README.md#pagination). Read more on [pagination](README.md#pagination).
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://primary.example.com/api/v4/audit_events curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/audit_events"
``` ```
Example response: Example response:
...@@ -96,7 +96,7 @@ GET /audit_events/:id ...@@ -96,7 +96,7 @@ GET /audit_events/:id
| `id` | integer | yes | The ID of the audit event | | `id` | integer | yes | The ID of the audit event |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://primary.example.com/api/v4/audit_events/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/audit_events/1"
``` ```
Example response: Example response:
...@@ -146,7 +146,7 @@ are paginated. ...@@ -146,7 +146,7 @@ are paginated.
Read more on [pagination](README.md#pagination). Read more on [pagination](README.md#pagination).
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://primary.example.com/api/v4/groups/60/audit_events curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/groups/60/audit_events"
``` ```
Example response: Example response:
...@@ -202,7 +202,7 @@ GET /groups/:id/audit_events/:audit_event_id ...@@ -202,7 +202,7 @@ GET /groups/:id/audit_events/:audit_event_id
| `audit_event_id` | integer | yes | The ID of the audit event | | `audit_event_id` | integer | yes | The ID of the audit event |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://primary.example.com/api/v4/groups/60/audit_events/2 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/groups/60/audit_events/2"
``` ```
Example response: Example response:
......
doc/api/avatar.md
View file @ 663d717d
...@@ -29,7 +29,7 @@ Parameters: ...@@ -29,7 +29,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl https://gitlab.example.com/api/v4/avatar?email=admin@example.com&size=32 curl "https://gitlab.example.com/api/v4/avatar?email=admin@example.com&size=32"
``` ```
Example response: Example response:
......
doc/api/award_emoji.md
View file @ 663d717d
...@@ -42,7 +42,7 @@ Parameters: ...@@ -42,7 +42,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji"
``` ```
Example response: Example response:
...@@ -105,7 +105,7 @@ Parameters: ...@@ -105,7 +105,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/1"
``` ```
Example response: Example response:
...@@ -148,7 +148,7 @@ Parameters: ...@@ -148,7 +148,7 @@ Parameters:
| `name` | string | yes | Name of the emoji without colons. | | `name` | string | yes | Name of the emoji without colons. |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji?name=blowfish curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji?name=blowfish"
``` ```
Example Response: Example Response:
...@@ -194,7 +194,7 @@ Parameters: ...@@ -194,7 +194,7 @@ Parameters:
| `award_id` | integer | yes | ID of an award emoji. | | `award_id` | integer | yes | ID of an award emoji. |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/344"
``` ```
## Award Emoji on Comments ## Award Emoji on Comments
...@@ -225,7 +225,7 @@ Parameters: ...@@ -225,7 +225,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji"
``` ```
Example response: Example response:
...@@ -271,7 +271,7 @@ Parameters: ...@@ -271,7 +271,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji/2 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/notes/1/award_emoji/2"
``` ```
Example response: Example response:
...@@ -315,7 +315,7 @@ Parameters: ...@@ -315,7 +315,7 @@ Parameters:
Example request: Example request:
```shell ```shell
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"
``` ```
Example response: Example response:
...@@ -362,5 +362,5 @@ Parameters: ...@@ -362,5 +362,5 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/345 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/80/award_emoji/345"
``` ```
doc/api/boards.md
View file @ 663d717d
...@@ -24,7 +24,7 @@ GET /projects/:id/boards ...@@ -24,7 +24,7 @@ GET /projects/:id/boards
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards"
``` ```
Example response: Example response:
...@@ -99,7 +99,7 @@ GET /projects/:id/boards/:board_id ...@@ -99,7 +99,7 @@ GET /projects/:id/boards/:board_id
| `board_id` | integer | yes | The ID of a board | | `board_id` | integer | yes | The ID of a board |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1"
``` ```
Example response: Example response:
...@@ -173,7 +173,7 @@ POST /projects/:id/boards ...@@ -173,7 +173,7 @@ POST /projects/:id/boards
| `name` | string | yes | The name of the new board | | `name` | string | yes | The name of the new board |
```shell ```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: Example response:
...@@ -254,7 +254,7 @@ PUT /projects/:id/boards/:board_id ...@@ -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 | | `weight` | integer | no | The weight range from 0 to 9, to which the board should be scoped to |
```shell ```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"
``` ```
Example response: Example response:
...@@ -328,7 +328,7 @@ DELETE /projects/:id/boards/:board_id ...@@ -328,7 +328,7 @@ DELETE /projects/:id/boards/:board_id
| `board_id` | integer | yes | The ID of a board | | `board_id` | integer | yes | The ID of a board |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1"
``` ```
## List board lists ## List board lists
...@@ -346,7 +346,7 @@ GET /projects/:id/boards/:board_id/lists ...@@ -346,7 +346,7 @@ GET /projects/:id/boards/:board_id/lists
| `board_id` | integer | yes | The ID of a board | | `board_id` | integer | yes | The ID of a board |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1/lists curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1/lists"
``` ```
Example response: Example response:
...@@ -404,7 +404,7 @@ GET /projects/:id/boards/:board_id/lists/:list_id ...@@ -404,7 +404,7 @@ GET /projects/:id/boards/:board_id/lists/:list_id
| `list_id`| integer | yes | The ID of a board's list | | `list_id`| integer | yes | The ID of a board's list |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1"
``` ```
Example response: Example response:
...@@ -446,7 +446,7 @@ Check the [Issue Board docs](../user/project/issue_board.md#summary-of-features- ...@@ -446,7 +446,7 @@ Check the [Issue Board docs](../user/project/issue_board.md#summary-of-features-
for more information regarding the required license for each list type. for more information regarding the required license for each list type.
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1/lists?label_id=5 curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1/lists?label_id=5"
``` ```
Example response: Example response:
...@@ -481,7 +481,7 @@ PUT /projects/:id/boards/:board_id/lists/:list_id ...@@ -481,7 +481,7 @@ PUT /projects/:id/boards/:board_id/lists/:list_id
| `position` | integer | yes | The position of the list | | `position` | integer | yes | The position of the list |
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1?position=2 curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1?position=2"
``` ```
Example response: Example response:
...@@ -515,5 +515,5 @@ DELETE /projects/:id/boards/:board_id/lists/:list_id ...@@ -515,5 +515,5 @@ DELETE /projects/:id/boards/:board_id/lists/:list_id
| `list_id` | integer | yes | The ID of a board's list | | `list_id` | integer | yes | The ID of a board's list |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1"
``` ```
doc/api/branches.md
View file @ 663d717d
...@@ -26,7 +26,7 @@ Parameters: ...@@ -26,7 +26,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/repository/branches curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/branches"
``` ```
Example response: Example response:
...@@ -83,7 +83,7 @@ Parameters: ...@@ -83,7 +83,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/repository/branches/master curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/branches/master"
``` ```
Example response: Example response:
...@@ -145,7 +145,7 @@ Parameters: ...@@ -145,7 +145,7 @@ Parameters:
Example request: Example request:
```shell ```shell
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"
``` ```
Example response: Example response:
...@@ -199,7 +199,7 @@ Parameters: ...@@ -199,7 +199,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/repository/branches/newbranch curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/branches/newbranch"
``` ```
## Delete merged branches ## Delete merged branches
...@@ -222,5 +222,5 @@ Parameters: ...@@ -222,5 +222,5 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/repository/merged_branches curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/merged_branches"
``` ```
doc/api/broadcast_messages.md
View file @ 663d717d
...@@ -20,7 +20,7 @@ GET /broadcast_messages ...@@ -20,7 +20,7 @@ GET /broadcast_messages
Example request: Example request:
```shell ```shell
curl https://gitlab.example.com/api/v4/broadcast_messages curl "https://gitlab.example.com/api/v4/broadcast_messages"
``` ```
Example response: Example response:
...@@ -59,7 +59,7 @@ Parameters: ...@@ -59,7 +59,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl https://gitlab.example.com/api/v4/broadcast_messages/1 curl "https://gitlab.example.com/api/v4/broadcast_messages/1"
``` ```
Example response: Example response:
...@@ -103,7 +103,7 @@ Parameters: ...@@ -103,7 +103,7 @@ Parameters:
Example request: Example request:
```shell ```shell
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: Example response:
...@@ -148,7 +148,7 @@ Parameters: ...@@ -148,7 +148,7 @@ Parameters:
Example request: Example request:
```shell ```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"
``` ```
Example response: Example response:
...@@ -185,5 +185,5 @@ Parameters: ...@@ -185,5 +185,5 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/broadcast_messages/1 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/broadcast_messages/1"
``` ```
doc/api/commits.md
View file @ 663d717d
...@@ -132,7 +132,7 @@ PAYLOAD=$(cat << 'JSON' ...@@ -132,7 +132,7 @@ PAYLOAD=$(cat << 'JSON'
} }
JSON JSON
) )
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" --data "$PAYLOAD" https://gitlab.example.com/api/v4/projects/1/repository/commits curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" --data "$PAYLOAD" "https://gitlab.example.com/api/v4/projects/1/repository/commits"
``` ```
Example response: Example response:
...@@ -206,7 +206,7 @@ Parameters: ...@@ -206,7 +206,7 @@ Parameters:
| `stats` | boolean | no | Include commit stats. Default is true | | `stats` | boolean | no | Include commit stats. Default is true |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/commits/master curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/commits/master"
``` ```
Example response: Example response:
...@@ -498,7 +498,7 @@ POST /projects/:id/repository/commits/:sha/comments ...@@ -498,7 +498,7 @@ POST /projects/:id/repository/commits/:sha/comments
| `line_type` | string | no | The line type. Takes `new` or `old` as arguments | | `line_type` | string | no | The line type. Takes `new` or `old` as arguments |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "note=Nice picture man\!" --form "path=dudeism.md" --form "line=11" --form "line_type=new" https://gitlab.example.com/api/v4/projects/17/repository/commits/18f3e63d05582537db6d183d9d557be09e1f90c8/comments curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "note=Nice picture man\!" --form "path=dudeism.md" --form "line=11" --form "line_type=new" "https://gitlab.example.com/api/v4/projects/17/repository/commits/18f3e63d05582537db6d183d9d557be09e1f90c8/comments"
``` ```
Example response: Example response:
......
doc/api/custom_attributes.md
View file @ 663d717d
...@@ -20,7 +20,7 @@ GET /projects/:id/custom_attributes ...@@ -20,7 +20,7 @@ GET /projects/:id/custom_attributes
| `id` | integer | yes | The ID of a resource | | `id` | integer | yes | The ID of a resource |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/42/custom_attributes curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/custom_attributes"
``` ```
Example response: Example response:
...@@ -54,7 +54,7 @@ GET /projects/:id/custom_attributes/:key ...@@ -54,7 +54,7 @@ GET /projects/:id/custom_attributes/:key
| `key` | string | yes | The key of the custom attribute | | `key` | string | yes | The key of the custom attribute |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/42/custom_attributes/location curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/custom_attributes/location"
``` ```
Example response: Example response:
...@@ -84,7 +84,7 @@ PUT /projects/:id/custom_attributes/:key ...@@ -84,7 +84,7 @@ PUT /projects/:id/custom_attributes/:key
| `value` | string | yes | The value of the custom attribute | | `value` | string | yes | The value of the custom attribute |
```shell ```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"
``` ```
Example response: Example response:
...@@ -112,5 +112,5 @@ DELETE /projects/:id/custom_attributes/:key ...@@ -112,5 +112,5 @@ DELETE /projects/:id/custom_attributes/:key
| `key` | string | yes | The key of the custom attribute | | `key` | string | yes | The key of the custom attribute |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/42/custom_attributes/location curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/custom_attributes/location"
``` ```
doc/api/dependencies.md
View file @ 663d717d
...@@ -28,7 +28,7 @@ GET /projects/:id/dependencies?package_manager=yarn,bundler ...@@ -28,7 +28,7 @@ GET /projects/:id/dependencies?package_manager=yarn,bundler
| `package_manager` | string array | no | Returns dependencies belonging to specified package manager. Valid values: `bundler`, `composer`, `maven`, `npm`, `pip` or `yarn`. | | `package_manager` | string array | no | Returns dependencies belonging to specified package manager. Valid values: `bundler`, `composer`, `maven`, `npm`, `pip` or `yarn`. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/dependencies curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/dependencies"
``` ```
Example response: Example response:
......
doc/api/deploy_keys.md
View file @ 663d717d
...@@ -185,7 +185,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git ...@@ -185,7 +185,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git
Enables a deploy key for a project so this can be used. Returns the enabled key, with a status code 201 when successful. Enables a deploy key for a project so this can be used. Returns the enabled key, with a status code 201 when successful.
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/deploy_keys/13/enable curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/deploy_keys/13/enable"
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
...@@ -213,19 +213,19 @@ First, find the ID of the projects you're interested in, by either listing all ...@@ -213,19 +213,19 @@ First, find the ID of the projects you're interested in, by either listing all
projects: projects:
```shell ```shell
curl --header 'PRIVATE-TOKEN: <your_access_token>' https://gitlab.example.com/api/v4/projects curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects"
``` ```
Or finding the ID of a group: Or finding the ID of a group:
```shell ```shell
curl --header 'PRIVATE-TOKEN: <your_access_token>' https://gitlab.example.com/api/v4/groups curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups"
``` ```
Then listing all projects in that group (for example, group 1234): Then listing all projects in that group (for example, group 1234):
```shell ```shell
curl --header 'PRIVATE-TOKEN: <your_access_token>' https://gitlab.example.com/api/v4/groups/1234 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1234"
``` ```
With those IDs, add the same deploy key to all: With those IDs, add the same deploy key to all:
...@@ -233,6 +233,6 @@ With those IDs, add the same deploy key to all: ...@@ -233,6 +233,6 @@ With those IDs, add the same deploy key to all:
```shell ```shell
for project_id in 321 456 987; do for project_id in 321 456 987; do
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \
--data '{"title": "my key", "key": "ssh-rsa AAAA..."}' https://gitlab.example.com/api/v4/projects/${project_id}/deploy_keys --data '{"title": "my key", "key": "ssh-rsa AAAA..."}' "https://gitlab.example.com/api/v4/projects/${project_id}/deploy_keys"
done done
``` ```
doc/api/discussions.md
View file @ 663d717d
This diff is collapsed.
doc/api/environments.md
View file @ 663d717d
...@@ -15,7 +15,7 @@ GET /projects/:id/environments ...@@ -15,7 +15,7 @@ GET /projects/:id/environments
| `search` | string | no | Return list of environments matching the search criteria. Mutually exclusive with `name` | | `search` | string | no | Return list of environments matching the search criteria. Mutually exclusive with `name` |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/environments?name=review%2Ffix-foo curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments?name=review%2Ffix-foo"
``` ```
Example response: Example response:
......
doc/api/epic_issues.md
View file @ 663d717d
...@@ -26,7 +26,7 @@ GET /groups/:id/epics/:epic_iid/issues ...@@ -26,7 +26,7 @@ GET /groups/:id/epics/:epic_iid/issues
| `epic_iid` | integer/string | yes | The internal ID of the epic. | | `epic_iid` | integer/string | yes | The internal ID of the epic. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5/issues/ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5/issues/"
``` ```
Example response: Example response:
...@@ -123,7 +123,7 @@ POST /groups/:id/epics/:epic_iid/issues/:issue_id ...@@ -123,7 +123,7 @@ POST /groups/:id/epics/:epic_iid/issues/:issue_id
| `issue_id` | integer/string | yes | The ID of the issue. | | `issue_id` | integer/string | yes | The ID of the issue. |
```shell ```shell
curl --header POST "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5/issues/55 curl --header POST "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5/issues/55"
``` ```
Example response: Example response:
...@@ -229,7 +229,7 @@ DELETE /groups/:id/epics/:epic_iid/issues/:epic_issue_id ...@@ -229,7 +229,7 @@ DELETE /groups/:id/epics/:epic_iid/issues/:epic_issue_id
| `epic_issue_id` | integer/string | yes | The ID of the issue - epic association. | | `epic_issue_id` | integer/string | yes | The ID of the issue - epic association. |
```shell ```shell
curl --header DELETE "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5/issues/11 curl --header DELETE "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5/issues/11"
``` ```
Example response: Example response:
...@@ -337,7 +337,7 @@ PUT /groups/:id/epics/:epic_iid/issues/:epic_issue_id ...@@ -337,7 +337,7 @@ PUT /groups/:id/epics/:epic_iid/issues/:epic_issue_id
| `move_after_id` | integer/string | no | The ID of the issue - epic association that should be placed after the link in the question. | | `move_after_id` | integer/string | no | The ID of the issue - epic association that should be placed after the link in the question. |
```shell ```shell
curl --header PUT "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5/issues/11?move_before_id=20 curl --header PUT "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5/issues/11?move_before_id=20"
``` ```
Example response: Example response:
......
doc/api/epic_links.md
View file @ 663d717d
...@@ -25,7 +25,7 @@ GET /groups/:id/epics/:epic_iid/epics ...@@ -25,7 +25,7 @@ GET /groups/:id/epics/:epic_iid/epics
| `epic_iid` | integer | yes | The internal ID of the epic. | | `epic_iid` | integer | yes | The internal ID of the epic. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5/epics/ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5/epics/"
``` ```
Example response: Example response:
...@@ -80,7 +80,7 @@ POST /groups/:id/epics/:epic_iid/epics ...@@ -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. | | `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 ```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: Example response:
...@@ -133,7 +133,7 @@ POST /groups/:id/epics/:epic_iid/epics ...@@ -133,7 +133,7 @@ POST /groups/:id/epics/:epic_iid/epics
| `title` | string | yes | The title of a newly created epic. | | `title` | string | yes | The title of a newly created epic. |
```shell ```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: Example response:
...@@ -168,7 +168,7 @@ PUT /groups/:id/epics/:epic_iid/epics/:child_epic_id ...@@ -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. | | `move_after_id` | integer | no | The global ID of a sibling epic that should be placed after the child epic. |
```shell ```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"
``` ```
Example response: Example response:
...@@ -223,7 +223,7 @@ DELETE /groups/:id/epics/:epic_iid/epics/:child_epic_id ...@@ -223,7 +223,7 @@ DELETE /groups/:id/epics/:epic_iid/epics/:child_epic_id
| `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. | | `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 ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/4/epics/5 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/4/epics/5"
``` ```
Example response: Example response:
......
doc/api/epics.md
View file @ 663d717d
...@@ -76,7 +76,7 @@ GET /groups/:id/epics?state=opened ...@@ -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)| | `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)|
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics"
``` ```
Example response: Example response:
...@@ -183,7 +183,7 @@ GET /groups/:id/epics/:epic_iid ...@@ -183,7 +183,7 @@ GET /groups/:id/epics/:epic_iid
| `epic_iid` | integer/string | yes | The internal ID of the epic. | | `epic_iid` | integer/string | yes | The internal ID of the epic. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5"
``` ```
Example response: Example response:
...@@ -259,7 +259,7 @@ POST /groups/:id/epics ...@@ -259,7 +259,7 @@ POST /groups/:id/epics
| `parent_id` | integer/string | no | The ID of a parent epic (since 11.11) | | `parent_id` | integer/string | no | The ID of a parent epic (since 11.11) |
```shell ```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: Example response:
...@@ -336,7 +336,7 @@ PUT /groups/:id/epics/:epic_iid ...@@ -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) | | `state_event` | string | no | State event for an epic. Set `close` to close the epic and `reopen` to reopen it (since 11.4) |
```shell ```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"
``` ```
Example response: Example response:
...@@ -399,7 +399,7 @@ DELETE /groups/:id/epics/:epic_iid ...@@ -399,7 +399,7 @@ DELETE /groups/:id/epics/:epic_iid
| `epic_iid` | integer/string | yes | The internal ID of the epic. | | `epic_iid` | integer/string | yes | The internal ID of the epic. |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5"
``` ```
## Create a todo ## Create a todo
...@@ -418,7 +418,7 @@ POST /groups/:id/epics/:epic_iid/todo ...@@ -418,7 +418,7 @@ POST /groups/:id/epics/:epic_iid/todo
| `epic_iid` | integer | yes | The internal ID of a group's epic | | `epic_iid` | integer | yes | The internal ID of a group's epic |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5/todo curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5/todo"
``` ```
Example response: Example response:
......
doc/api/error_tracking.md
View file @ 663d717d
...@@ -17,7 +17,7 @@ GET /projects/:id/error_tracking/settings ...@@ -17,7 +17,7 @@ GET /projects/:id/error_tracking/settings
| `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/error_tracking/settings curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings"
``` ```
Example response: Example response:
...@@ -45,7 +45,7 @@ PATCH /projects/:id/error_tracking/settings ...@@ -45,7 +45,7 @@ PATCH /projects/:id/error_tracking/settings
| `active` | boolean | yes | Pass `true` to enable the already configured error tracking settings or `false` to disable it. | | `active` | boolean | yes | Pass `true` to enable the already configured error tracking settings or `false` to disable it. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/error_tracking/settings?active=true curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings?active=true"
``` ```
Example response: Example response:
......
doc/api/events.md
View file @ 663d717d
...@@ -72,7 +72,7 @@ Parameters: ...@@ -72,7 +72,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/events?target_type=issue&action=created&after=2017-01-31&before=2017-03-01&scope=all curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/events?target_type=issue&action=created&after=2017-01-31&before=2017-03-01&scope=all"
``` ```
Example response: Example response:
...@@ -144,7 +144,7 @@ Parameters: ...@@ -144,7 +144,7 @@ Parameters:
| `sort` | string | no | Sort events in `asc` or `desc` order by `created_at`. Default is `desc` | | `sort` | string | no | Sort events in `asc` or `desc` order by `created_at`. Default is `desc` |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/:id/events curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/:id/events"
``` ```
Example response: Example response:
...@@ -277,7 +277,7 @@ Parameters: ...@@ -277,7 +277,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:project_id/events?target_type=issue&action=created&after=2017-01-31&before=2017-03-01 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:project_id/events?target_type=issue&action=created&after=2017-01-31&before=2017-03-01"
``` ```
Example response: Example response:
......
doc/api/feature_flag_specs.md
View file @ 663d717d
...@@ -29,7 +29,7 @@ GET /projects/:id/feature_flag_scopes ...@@ -29,7 +29,7 @@ GET /projects/:id/feature_flag_scopes
| `environment` | string | yes | The [environment](../ci/environments/index.md) name | | `environment` | string | yes | The [environment](../ci/environments/index.md) name |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/feature_flag_scopes?environment=production curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/feature_flag_scopes?environment=production"
``` ```
Example response: Example response:
...@@ -97,7 +97,7 @@ GET /projects/:id/feature_flags/:name/scopes ...@@ -97,7 +97,7 @@ GET /projects/:id/feature_flags/:name/scopes
| `name` | string | yes | The name of the feature flag. | | `name` | string | yes | The name of the feature flag. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/feature_flags/new_live_trace/scopes curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/feature_flags/new_live_trace/scopes"
``` ```
Example response: Example response:
...@@ -163,7 +163,7 @@ POST /projects/:id/feature_flags/:name/scopes ...@@ -163,7 +163,7 @@ POST /projects/:id/feature_flags/:name/scopes
| `strategies` | json | yes | The [strategies](../user/project/operations/feature_flags.md#feature-flag-strategies) of the feature flag spec. | | `strategies` | json | yes | The [strategies](../user/project/operations/feature_flags.md#feature-flag-strategies) of the feature flag spec. |
```shell ```shell
curl https://gitlab.example.com/api/v4/projects/1/feature_flags/new_live_trace/scopes \ curl "https://gitlab.example.com/api/v4/projects/1/feature_flags/new_live_trace/scopes" \
--header "PRIVATE-TOKEN: <your_access_token>" \ --header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-type: application/json" \ --header "Content-type: application/json" \
--data @- << EOF --data @- << EOF
...@@ -208,7 +208,7 @@ GET /projects/:id/feature_flags/:name/scopes/:environment_scope ...@@ -208,7 +208,7 @@ GET /projects/:id/feature_flags/:name/scopes/:environment_scope
| `environment_scope` | string | yes | The URL-encoded [environment spec](../ci/environments/index.md#scoping-environments-with-specs) of the feature flag. | | `environment_scope` | string | yes | The URL-encoded [environment spec](../ci/environments/index.md#scoping-environments-with-specs) of the feature flag. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/feature_flags/new_live_trace/scopes/production curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/feature_flags/new_live_trace/scopes/production"
``` ```
Example response: Example response:
...@@ -246,7 +246,7 @@ PUT /projects/:id/feature_flags/:name/scopes/:environment_scope ...@@ -246,7 +246,7 @@ PUT /projects/:id/feature_flags/:name/scopes/:environment_scope
| `strategies` | json | yes | The [strategies](../user/project/operations/feature_flags.md#feature-flag-strategies) of the feature flag spec. | | `strategies` | json | yes | The [strategies](../user/project/operations/feature_flags.md#feature-flag-strategies) of the feature flag spec. |
```shell ```shell
curl https://gitlab.example.com/api/v4/projects/1/feature_flags/new_live_trace/scopes/production \ curl "https://gitlab.example.com/api/v4/projects/1/feature_flags/new_live_trace/scopes/production" \
--header "PRIVATE-TOKEN: <your_access_token>" \ --header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-type: application/json" \ --header "Content-type: application/json" \
--data @- << EOF --data @- << EOF
...@@ -290,5 +290,5 @@ DELETE /projects/:id/feature_flags/:name/scopes/:environment_scope ...@@ -290,5 +290,5 @@ DELETE /projects/:id/feature_flags/:name/scopes/:environment_scope
| `environment_scope` | string | yes | The URL-encoded [environment spec](../ci/environments/index.md#scoping-environments-with-specs) of the feature flag. | | `environment_scope` | string | yes | The URL-encoded [environment spec](../ci/environments/index.md#scoping-environments-with-specs) of the feature flag. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" --request DELETE https://gitlab.example.com/api/v4/projects/1/feature_flags/new_live_trace/scopes/production curl --header "PRIVATE-TOKEN: <your_access_token>" --request DELETE "https://gitlab.example.com/api/v4/projects/1/feature_flags/new_live_trace/scopes/production"
``` ```
doc/api/feature_flag_user_lists.md
View file @ 663d717d
...@@ -23,7 +23,7 @@ GET /projects/:id/feature_flags_user_lists ...@@ -23,7 +23,7 @@ GET /projects/:id/feature_flags_user_lists
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists"
``` ```
Example response: Example response:
...@@ -66,7 +66,7 @@ POST /projects/:id/feature_flags_user_lists ...@@ -66,7 +66,7 @@ POST /projects/:id/feature_flags_user_lists
| `user_xids` | string | yes | A comma separated list of user IDs. | | `user_xids` | string | yes | A comma separated list of user IDs. |
```shell ```shell
curl https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists \ curl "https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists" \
--header "PRIVATE-TOKEN: <your_access_token>" \ --header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-type: application/json" \ --header "Content-type: application/json" \
--data @- << EOF --data @- << EOF
...@@ -105,7 +105,7 @@ GET /projects/:id/feature_flags_user_lists/:iid ...@@ -105,7 +105,7 @@ GET /projects/:id/feature_flags_user_lists/:iid
| `iid` | integer/string | yes | The internal ID of the project's feature flag user list. | | `iid` | integer/string | yes | The internal ID of the project's feature flag user list. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists/1"
``` ```
Example response: Example response:
...@@ -138,7 +138,7 @@ PUT /projects/:id/feature_flags_user_lists/:iid ...@@ -138,7 +138,7 @@ PUT /projects/:id/feature_flags_user_lists/:iid
| `user_xids` | string | no | A comma separated list of user IDs. | | `user_xids` | string | no | A comma separated list of user IDs. |
```shell ```shell
curl https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists/1 \ curl "https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists/1" \
--header "PRIVATE-TOKEN: <your_access_token>" \ --header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-type: application/json" \ --header "Content-type: application/json" \
--request PUT \ --request PUT \
...@@ -177,5 +177,5 @@ DELETE /projects/:id/feature_flags_user_lists/:iid ...@@ -177,5 +177,5 @@ DELETE /projects/:id/feature_flags_user_lists/:iid
| `iid` | integer/string | yes | The internal ID of the project's feature flag user list | | `iid` | integer/string | yes | The internal ID of the project's feature flag user list |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" --request DELETE https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists/1 curl --header "PRIVATE-TOKEN: <your_access_token>" --request DELETE "https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists/1"
``` ```
doc/api/feature_flags.md
View file @ 663d717d
...@@ -28,7 +28,7 @@ GET /projects/:id/feature_flags ...@@ -28,7 +28,7 @@ GET /projects/:id/feature_flags
| `scope` | string | no | The condition of feature flags, one of: `enabled`, `disabled`. | | `scope` | string | no | The condition of feature flags, one of: `enabled`, `disabled`. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/feature_flags curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/feature_flags"
``` ```
Example response: Example response:
...@@ -146,7 +146,7 @@ POST /projects/:id/feature_flags ...@@ -146,7 +146,7 @@ POST /projects/:id/feature_flags
| `strategies:scopes:environment_scope` | string | no | The environment spec for the scope. | | `strategies:scopes:environment_scope` | string | no | The environment spec for the scope. |
```shell ```shell
curl https://gitlab.example.com/api/v4/projects/1/feature_flags \ curl "https://gitlab.example.com/api/v4/projects/1/feature_flags" \
--header "PRIVATE-TOKEN: <your_access_token>" \ --header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-type: application/json" \ --header "Content-type: application/json" \
--data @- << EOF --data @- << EOF
...@@ -206,7 +206,7 @@ PUT /projects/:id/feature_flags/:name ...@@ -206,7 +206,7 @@ PUT /projects/:id/feature_flags/:name
| `strategies:scopes:environment_scope` | string | no | The environment spec for the scope. | | `strategies:scopes:environment_scope` | string | no | The environment spec for the scope. |
```shell ```shell
curl https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature \ curl "https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature" \
--header "PRIVATE-TOKEN: <your_access_token>" \ --header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-type: application/json" \ --header "Content-type: application/json" \
--data @- << EOF --data @- << EOF
...@@ -270,5 +270,5 @@ DELETE /projects/:id/feature_flags/:name ...@@ -270,5 +270,5 @@ DELETE /projects/:id/feature_flags/:name
| `name` | string | yes | The name of the feature flag. | | `name` | string | yes | The name of the feature flag. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" --request DELETE https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature curl --header "PRIVATE-TOKEN: <your_access_token>" --request DELETE "https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature"
``` ```
doc/api/features.md
View file @ 663d717d
...@@ -16,7 +16,7 @@ GET /features ...@@ -16,7 +16,7 @@ GET /features
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/features curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/features"
``` ```
Example response: Example response:
...@@ -80,7 +80,7 @@ Note that you can enable or disable a feature for a `feature_group`, a `user`, ...@@ -80,7 +80,7 @@ Note that you can enable or disable a feature for a `feature_group`, a `user`,
a `group`, and a `project` in a single API call. a `group`, and a `project` in a single API call.
```shell ```shell
curl --data "value=30" --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/features/new_library curl --data "value=30" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/features/new_library"
``` ```
Example response: Example response:
......
doc/api/geo_nodes.md
View file @ 663d717d
...@@ -12,7 +12,7 @@ POST /geo_nodes ...@@ -12,7 +12,7 @@ POST /geo_nodes
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://primary.example.com/api/v4/geo_nodes \ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_nodes" \
--request POST \ --request POST \
-d "name=himynameissomething" \ -d "name=himynameissomething" \
-d "url=https://another-node.example.com/" -d "url=https://another-node.example.com/"
...@@ -73,7 +73,7 @@ GET /geo_nodes ...@@ -73,7 +73,7 @@ GET /geo_nodes
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://primary.example.com/api/v4/geo_nodes curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_nodes"
``` ```
Example response: Example response:
...@@ -140,7 +140,7 @@ GET /geo_nodes/:id ...@@ -140,7 +140,7 @@ GET /geo_nodes/:id
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://primary.example.com/api/v4/geo_nodes/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_nodes/1"
``` ```
Example response: Example response:
...@@ -287,7 +287,7 @@ GET /geo_nodes/status ...@@ -287,7 +287,7 @@ GET /geo_nodes/status
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://primary.example.com/api/v4/geo_nodes/status curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_nodes/status"
``` ```
Example response: Example response:
...@@ -452,7 +452,7 @@ GET /geo_nodes/:id/status ...@@ -452,7 +452,7 @@ GET /geo_nodes/:id/status
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://primary.example.com/api/v4/geo_nodes/2/status curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_nodes/2/status"
``` ```
Example response: Example response:
...@@ -530,7 +530,7 @@ GET /geo_nodes/current/failures ...@@ -530,7 +530,7 @@ GET /geo_nodes/current/failures
This endpoint uses [Pagination](README.md#pagination). This endpoint uses [Pagination](README.md#pagination).
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://primary.example.com/api/v4/geo_nodes/current/failures curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_nodes/current/failures"
``` ```
Example response: Example response:
......
doc/api/group_activity_analytics.md
View file @ 663d717d
...@@ -17,7 +17,7 @@ Parameters: ...@@ -17,7 +17,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/analytics/group_activity/issues_count?group_path=gitlab-org curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/analytics/group_activity/issues_count?group_path=gitlab-org"
``` ```
Example response: Example response:
...@@ -41,7 +41,7 @@ Parameters: ...@@ -41,7 +41,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/analytics/group_activity/merge_requests_count?group_path=gitlab-org curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/analytics/group_activity/merge_requests_count?group_path=gitlab-org"
``` ```
Example response: Example response:
...@@ -65,7 +65,7 @@ Parameters: ...@@ -65,7 +65,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/analytics/group_activity/new_members_count?group_path=gitlab-org curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/analytics/group_activity/new_members_count?group_path=gitlab-org"
``` ```
Example response: Example response:
......
doc/api/group_badges.md
View file @ 663d717d
...@@ -28,7 +28,7 @@ GET /groups/:id/badges ...@@ -28,7 +28,7 @@ GET /groups/:id/badges
| `name` | string | no | Name of the badges to return (case-sensitive). | | `name` | string | no | Name of the badges to return (case-sensitive). |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/badges?name=Coverage curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges?name=Coverage"
``` ```
Example response: Example response:
...@@ -61,7 +61,7 @@ GET /groups/:id/badges/:badge_id ...@@ -61,7 +61,7 @@ GET /groups/:id/badges/:badge_id
| `badge_id` | integer | yes | The badge ID | | `badge_id` | integer | yes | The badge ID |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id"
``` ```
Example response: Example response:
...@@ -92,7 +92,7 @@ POST /groups/:id/badges ...@@ -92,7 +92,7 @@ POST /groups/:id/badges
| `image_url` | string | yes | URL of the badge image | | `image_url` | string | yes | URL of the badge image |
```shell ```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: Example response:
...@@ -124,7 +124,7 @@ PUT /groups/:id/badges/:badge_id ...@@ -124,7 +124,7 @@ PUT /groups/:id/badges/:badge_id
| `image_url` | string | no | URL of the badge image | | `image_url` | string | no | URL of the badge image |
```shell ```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"
``` ```
Example response: Example response:
...@@ -154,7 +154,7 @@ DELETE /groups/:id/badges/:badge_id ...@@ -154,7 +154,7 @@ DELETE /groups/:id/badges/:badge_id
| `badge_id` | integer | yes | The badge ID | | `badge_id` | integer | yes | The badge ID |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id"
``` ```
## Preview a badge from a group ## Preview a badge from a group
...@@ -172,7 +172,7 @@ GET /groups/:id/badges/render ...@@ -172,7 +172,7 @@ GET /groups/:id/badges/render
| `image_url` | string | yes | URL of the badge image | | `image_url` | string | yes | URL of the badge image |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/badges/render?link_url=http%3A%2F%2Fexample.com%2Fci_status.svg%3Fproject%3D%25%7Bproject_path%7D%26ref%3D%25%7Bdefault_branch%7D&image_url=https%3A%2F%2Fshields.io%2Fmy%2Fbadge curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges/render?link_url=http%3A%2F%2Fexample.com%2Fci_status.svg%3Fproject%3D%25%7Bproject_path%7D%26ref%3D%25%7Bdefault_branch%7D&image_url=https%3A%2F%2Fshields.io%2Fmy%2Fbadge"
``` ```
Example response: Example response:
......
doc/api/group_boards.md
View file @ 663d717d
...@@ -24,7 +24,7 @@ GET /groups/:id/boards ...@@ -24,7 +24,7 @@ GET /groups/:id/boards
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards"
``` ```
Example response: Example response:
...@@ -142,7 +142,7 @@ GET /groups/:id/boards/:board_id ...@@ -142,7 +142,7 @@ GET /groups/:id/boards/:board_id
| `board_id` | integer | yes | The ID of a board | | `board_id` | integer | yes | The ID of a board |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1"
``` ```
Example response: Example response:
...@@ -256,7 +256,7 @@ POST /groups/:id/boards ...@@ -256,7 +256,7 @@ POST /groups/:id/boards
| `name` | string | yes | The name of the new board | | `name` | string | yes | The name of the new board |
```shell ```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: Example response:
...@@ -327,7 +327,7 @@ PUT /groups/:id/boards/:board_id ...@@ -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 | | `weight` | integer | no | The weight range from 0 to 9, to which the board should be scoped to |
```shell ```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"
``` ```
Example response: Example response:
...@@ -388,7 +388,7 @@ DELETE /groups/:id/boards/:board_id ...@@ -388,7 +388,7 @@ DELETE /groups/:id/boards/:board_id
| `board_id` | integer | yes | The ID of a board | | `board_id` | integer | yes | The ID of a board |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards/1 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1"
``` ```
## List group issue board lists ## List group issue board lists
...@@ -406,7 +406,7 @@ GET /groups/:id/boards/:board_id/lists ...@@ -406,7 +406,7 @@ GET /groups/:id/boards/:board_id/lists
| `board_id` | integer | yes | The ID of a board | | `board_id` | integer | yes | The ID of a board |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards/1/lists curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1/lists"
``` ```
Example response: Example response:
...@@ -458,7 +458,7 @@ GET /groups/:id/boards/:board_id/lists/:list_id ...@@ -458,7 +458,7 @@ GET /groups/:id/boards/:board_id/lists/:list_id
| `list_id` | integer | yes | The ID of a board's list | | `list_id` | integer | yes | The ID of a board's list |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards/1/lists/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1/lists/1"
``` ```
Example response: Example response:
...@@ -490,7 +490,7 @@ POST /groups/:id/boards/:board_id/lists ...@@ -490,7 +490,7 @@ POST /groups/:id/boards/:board_id/lists
| `label_id` | integer | yes | The ID of a label | | `label_id` | integer | yes | The ID of a label |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/4/boards/12/lists?milestone_id=7 curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4/boards/12/lists?milestone_id=7"
``` ```
Example response: Example response:
...@@ -532,7 +532,7 @@ PUT /groups/:id/boards/:board_id/lists/:list_id ...@@ -532,7 +532,7 @@ PUT /groups/:id/boards/:board_id/lists/:list_id
| `position` | integer | yes | The position of the list | | `position` | integer | yes | The position of the list |
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/group/5/boards/1/lists/1?position=2 curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/group/5/boards/1/lists/1?position=2"
``` ```
Example response: Example response:
...@@ -564,5 +564,5 @@ DELETE /groups/:id/boards/:board_id/lists/:list_id ...@@ -564,5 +564,5 @@ DELETE /groups/:id/boards/:board_id/lists/:list_id
| `list_id` | integer | yes | The ID of a board's list | | `list_id` | integer | yes | The ID of a board's list |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards/1/lists/1 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1/lists/1"
``` ```
doc/api/group_clusters.md
View file @ 663d717d
...@@ -22,7 +22,7 @@ Parameters: ...@@ -22,7 +22,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/groups/26/clusters curl --header 'Private-Token: <your_access_token>' "https://gitlab.example.com/api/v4/groups/26/clusters"
``` ```
Example response: Example response:
...@@ -90,7 +90,7 @@ Parameters: ...@@ -90,7 +90,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/groups/26/clusters/18 curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/groups/26/clusters/18"
``` ```
Example response: Example response:
...@@ -166,7 +166,7 @@ Parameters: ...@@ -166,7 +166,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/groups/26/clusters/user \ curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/groups/26/clusters/user" \
-H "Accept: application/json" \ -H "Accept: application/json" \
-H "Content-Type:application/json" \ -H "Content-Type:application/json" \
--request POST --data '{"name":"cluster-5", "platform_kubernetes_attributes":{"api_url":"https://35.111.51.20","token":"12345","ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"}}' --request POST --data '{"name":"cluster-5", "platform_kubernetes_attributes":{"api_url":"https://35.111.51.20","token":"12345","ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"}}'
...@@ -238,7 +238,7 @@ through the ["Add existing cluster to group"](#add-existing-cluster-to-group) en ...@@ -238,7 +238,7 @@ through the ["Add existing cluster to group"](#add-existing-cluster-to-group) en
Example request: Example request:
```shell ```shell
curl --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/groups/26/clusters/24 \ curl --header 'Private-Token: <your_access_token>' "https://gitlab.example.com/api/v4/groups/26/clusters/24" \
-H "Content-Type:application/json" \ -H "Content-Type:application/json" \
--request PUT --data '{"name":"new-cluster-name","domain":"new-domain.com","api_url":"https://new-api-url.com"}' --request PUT --data '{"name":"new-cluster-name","domain":"new-domain.com","api_url":"https://new-api-url.com"}'
``` ```
...@@ -307,5 +307,5 @@ Parameters: ...@@ -307,5 +307,5 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --request DELETE --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/groups/26/clusters/23 curl --request DELETE --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/groups/26/clusters/23"
``` ```
doc/api/group_import_export.md
View file @ 663d717d
...@@ -28,7 +28,7 @@ POST /groups/:id/export ...@@ -28,7 +28,7 @@ POST /groups/:id/export
| `id` | integer/string | yes | ID of the group owned by the authenticated user | | `id` | integer/string | yes | ID of the group owned by the authenticated user |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/export curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/export"
``` ```
```json ```json
...@@ -50,7 +50,7 @@ GET /groups/:id/export/download ...@@ -50,7 +50,7 @@ GET /groups/:id/export/download
| `id` | integer/string | yes | ID of the group owned by the authenticated user | | `id` | integer/string | yes | ID of the group owned by the authenticated user |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" --remote-header-name --remote-name https://gitlab.example.com/api/v4/groups/1/export/download curl --header "PRIVATE-TOKEN: <your_access_token>" --remote-header-name --remote-name "https://gitlab.example.com/api/v4/groups/1/export/download"
``` ```
```shell ```shell
...@@ -83,7 +83,7 @@ The `file=` parameter must point to a file on your file system and be preceded ...@@ -83,7 +83,7 @@ The `file=` parameter must point to a file on your file system and be preceded
by `@`. For example: by `@`. For example:
```shell ```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"
``` ```
## Important notes ## Important notes
......
doc/api/group_labels.md
View file @ 663d717d
...@@ -28,7 +28,7 @@ GET /groups/:id/labels ...@@ -28,7 +28,7 @@ GET /groups/:id/labels
| `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. | | `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/labels?with_counts=true curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels?with_counts=true"
``` ```
Example response: Example response:
...@@ -77,7 +77,7 @@ GET /groups/:id/labels/:label_id ...@@ -77,7 +77,7 @@ GET /groups/:id/labels/:label_id
| `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. | | `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/labels/bug curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels/bug"
``` ```
Example response: Example response:
...@@ -113,7 +113,7 @@ POST /groups/:id/labels ...@@ -113,7 +113,7 @@ POST /groups/:id/labels
| `description` | string | no | The description of the label, | | `description` | string | no | The description of the label, |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" --data '{"name": "Feature Proposal", "color": "#FFA500", "description": "Describes new ideas" }' https://gitlab.example.com/api/v4/groups/5/labels curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" --data '{"name": "Feature Proposal", "color": "#FFA500", "description": "Describes new ideas" }' "https://gitlab.example.com/api/v4/groups/5/labels"
``` ```
Example response: Example response:
...@@ -150,7 +150,7 @@ PUT /groups/:id/labels/:label_id ...@@ -150,7 +150,7 @@ PUT /groups/:id/labels/:label_id
| `description` | string | no | The description of the label. | | `description` | string | no | The description of the label. |
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" --data '{"new_name": "Feature Idea" }' https://gitlab.example.com/api/v4/groups/5/labels/Feature%20Proposal curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" --data '{"new_name": "Feature Idea" }' "https://gitlab.example.com/api/v4/groups/5/labels/Feature%20Proposal"
``` ```
Example response: Example response:
...@@ -186,7 +186,7 @@ DELETE /groups/:id/labels/:label_id ...@@ -186,7 +186,7 @@ DELETE /groups/:id/labels/:label_id
| `label_id` | integer or string | yes | The ID or title of a group's label. | | `label_id` | integer or string | yes | The ID or title of a group's label. |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/labels/bug curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels/bug"
``` ```
NOTE: **Note:** An older endpoint `DELETE /groups/:id/labels` with `name` in the parameters is still available, but deprecated. NOTE: **Note:** An older endpoint `DELETE /groups/:id/labels` with `name` in the parameters is still available, but deprecated.
...@@ -206,7 +206,7 @@ POST /groups/:id/labels/:label_id/subscribe ...@@ -206,7 +206,7 @@ POST /groups/:id/labels/:label_id/subscribe
| `label_id` | integer or string | yes | The ID or title of a group's label. | | `label_id` | integer or string | yes | The ID or title of a group's label. |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/labels/9/subscribe curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels/9/subscribe"
``` ```
Example response: Example response:
...@@ -242,7 +242,7 @@ POST /groups/:id/labels/:label_id/unsubscribe ...@@ -242,7 +242,7 @@ POST /groups/:id/labels/:label_id/unsubscribe
| `label_id` | integer or string | yes | The ID or title of a group's label. | | `label_id` | integer or string | yes | The ID or title of a group's label. |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/labels/9/unsubscribe curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels/9/unsubscribe"
``` ```
Example response: Example response:
......
doc/api/group_milestones.md
View file @ 663d717d
...@@ -33,7 +33,7 @@ Parameters: ...@@ -33,7 +33,7 @@ Parameters:
| `search` | string | no | Return only milestones with a title or description matching the provided string | | `search` | string | no | Return only milestones with a title or description matching the provided string |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/milestones curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/milestones"
``` ```
Example Response: Example Response:
......
doc/api/groups.md
View file @ 663d717d
...@@ -400,7 +400,7 @@ The `projects` and `shared_projects` attributes in the response are deprecated a ...@@ -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. 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.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/4 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4"
``` ```
This endpoint returns: This endpoint returns:
...@@ -581,7 +581,7 @@ Additional response parameters: ...@@ -581,7 +581,7 @@ Additional response parameters:
When adding the parameter `with_projects=false`, projects will not be returned. When adding the parameter `with_projects=false`, projects will not be returned.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/4?with_projects=false curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4?with_projects=false"
``` ```
Example response: Example response:
...@@ -674,7 +674,7 @@ Parameters: ...@@ -674,7 +674,7 @@ Parameters:
| `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | | `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/4/projects/56 curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4/projects/56"
``` ```
## Update group ## Update group
......
doc/api/import.md
View file @ 663d717d
...@@ -16,7 +16,7 @@ POST /import/github ...@@ -16,7 +16,7 @@ POST /import/github
| `target_namespace` | string | yes | Namespace to import repository into | | `target_namespace` | string | yes | Namespace to import repository into |
```shell ```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"
``` ```
Example response: Example response:
......
doc/api/issues.md
View file @ 663d717d
...@@ -76,7 +76,7 @@ GET /issues?confidential=true ...@@ -76,7 +76,7 @@ GET /issues?confidential=true
| `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))_ | | `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))_ |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/issues curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/issues"
``` ```
Example response: Example response:
...@@ -232,7 +232,7 @@ GET /groups/:id/issues?confidential=true ...@@ -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))_ | | `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))_ |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/4/issues curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4/issues"
``` ```
Example response: Example response:
...@@ -386,7 +386,7 @@ GET /projects/:id/issues?confidential=true ...@@ -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` | | `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` |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/issues curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/issues"
``` ```
Example response: Example response:
...@@ -514,7 +514,7 @@ GET /projects/:id/issues/:issue_iid ...@@ -514,7 +514,7 @@ GET /projects/:id/issues/:issue_iid
| `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_iid` | integer | yes | The internal ID of a project's issue |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/issues/41 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/issues/41"
``` ```
Example response: Example response:
...@@ -667,7 +667,7 @@ POST /projects/:id/issues ...@@ -667,7 +667,7 @@ POST /projects/:id/issues
| `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)) | | `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 ```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: Example response:
...@@ -785,7 +785,7 @@ PUT /projects/:id/issues/:issue_iid ...@@ -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)) | | `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 ```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"
``` ```
Example response: Example response:
...@@ -891,7 +891,7 @@ DELETE /projects/:id/issues/:issue_iid ...@@ -891,7 +891,7 @@ DELETE /projects/:id/issues/:issue_iid
| `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_iid` | integer | yes | The internal ID of a project's issue |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/issues/85 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/issues/85"
``` ```
## Move an issue ## Move an issue
...@@ -914,7 +914,7 @@ POST /projects/:id/issues/:issue_iid/move ...@@ -914,7 +914,7 @@ POST /projects/:id/issues/:issue_iid/move
| `to_project_id` | integer | yes | The ID of the new project | | `to_project_id` | integer | yes | The ID of the new project |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" --form to_project_id=5 https://gitlab.example.com/api/v4/projects/4/issues/85/move curl --header "PRIVATE-TOKEN: <your_access_token>" --form to_project_id=5 "https://gitlab.example.com/api/v4/projects/4/issues/85/move"
``` ```
Example response: Example response:
...@@ -1020,7 +1020,7 @@ POST /projects/:id/issues/:issue_iid/subscribe ...@@ -1020,7 +1020,7 @@ POST /projects/:id/issues/:issue_iid/subscribe
| `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_iid` | integer | yes | The internal ID of a project's issue |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/subscribe curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/93/subscribe"
``` ```
Example response: Example response:
...@@ -1126,7 +1126,7 @@ POST /projects/:id/issues/:issue_iid/unsubscribe ...@@ -1126,7 +1126,7 @@ POST /projects/:id/issues/:issue_iid/unsubscribe
| `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_iid` | integer | yes | The internal ID of a project's issue |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/unsubscribe curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/93/unsubscribe"
``` ```
Example response: Example response:
...@@ -1197,7 +1197,7 @@ POST /projects/:id/issues/:issue_iid/todo ...@@ -1197,7 +1197,7 @@ POST /projects/:id/issues/:issue_iid/todo
| `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_iid` | integer | yes | The internal ID of a project's issue |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/todo curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/93/todo"
``` ```
Example response: Example response:
...@@ -1312,7 +1312,7 @@ POST /projects/:id/issues/:issue_iid/time_estimate ...@@ -1312,7 +1312,7 @@ POST /projects/:id/issues/:issue_iid/time_estimate
| `duration` | string | yes | The duration in human format. e.g: 3h30m | | `duration` | string | yes | The duration in human format. e.g: 3h30m |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/time_estimate?duration=3h30m curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/93/time_estimate?duration=3h30m"
``` ```
Example response: Example response:
...@@ -1340,7 +1340,7 @@ POST /projects/:id/issues/:issue_iid/reset_time_estimate ...@@ -1340,7 +1340,7 @@ POST /projects/:id/issues/:issue_iid/reset_time_estimate
| `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_iid` | integer | yes | The internal ID of a project's issue |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/reset_time_estimate curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/93/reset_time_estimate"
``` ```
Example response: Example response:
...@@ -1369,7 +1369,7 @@ POST /projects/:id/issues/:issue_iid/add_spent_time ...@@ -1369,7 +1369,7 @@ POST /projects/:id/issues/:issue_iid/add_spent_time
| `duration` | string | yes | The duration in human format. e.g: 3h30m | | `duration` | string | yes | The duration in human format. e.g: 3h30m |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/add_spent_time?duration=1h curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/93/add_spent_time?duration=1h"
``` ```
Example response: Example response:
...@@ -1397,7 +1397,7 @@ POST /projects/:id/issues/:issue_iid/reset_spent_time ...@@ -1397,7 +1397,7 @@ POST /projects/:id/issues/:issue_iid/reset_spent_time
| `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_iid` | integer | yes | The internal ID of a project's issue |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/reset_spent_time curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/93/reset_spent_time"
``` ```
Example response: Example response:
...@@ -1423,7 +1423,7 @@ GET /projects/:id/issues/:issue_iid/time_stats ...@@ -1423,7 +1423,7 @@ GET /projects/:id/issues/:issue_iid/time_stats
| `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_iid` | integer | yes | The internal ID of a project's issue |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/time_stats curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/93/time_stats"
``` ```
Example response: Example response:
...@@ -1451,7 +1451,7 @@ GET /projects/:id/issues/:issue_id/related_merge_requests ...@@ -1451,7 +1451,7 @@ GET /projects/:id/issues/:issue_id/related_merge_requests
| `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_iid` | integer | yes | The internal ID of a project's issue |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/11/related_merge_requests curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/11/related_merge_requests"
``` ```
Example response: Example response:
...@@ -1607,7 +1607,7 @@ GET /projects/:id/issues/:issue_iid/closed_by ...@@ -1607,7 +1607,7 @@ GET /projects/:id/issues/:issue_iid/closed_by
| `issue_iid` | integer | yes | The internal ID of a project issue | | `issue_iid` | integer | yes | The internal ID of a project issue |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/11/closed_by curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/issues/11/closed_by"
``` ```
Example response: Example response:
...@@ -1680,7 +1680,7 @@ GET /projects/:id/issues/:issue_iid/participants ...@@ -1680,7 +1680,7 @@ GET /projects/:id/issues/:issue_iid/participants
| `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_iid` | integer | yes | The internal ID of a project's issue |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/participants curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/93/participants"
``` ```
Example response: Example response:
...@@ -1724,7 +1724,7 @@ GET /projects/:id/issues/:issue_iid/user_agent_detail ...@@ -1724,7 +1724,7 @@ GET /projects/:id/issues/:issue_iid/user_agent_detail
| `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_iid` | integer | yes | The internal ID of a project's issue |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/user_agent_detail curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/93/user_agent_detail"
``` ```
Example response: Example response:
......
doc/api/issues_statistics.md
View file @ 663d717d
...@@ -46,7 +46,7 @@ GET /issues_statistics?confidential=true ...@@ -46,7 +46,7 @@ GET /issues_statistics?confidential=true
| `confidential` | boolean | no | Filter confidential or public issues. | | `confidential` | boolean | no | Filter confidential or public issues. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/issues_statistics curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/issues_statistics"
``` ```
Example response: Example response:
...@@ -102,7 +102,7 @@ GET /groups/:id/issues_statistics?confidential=true ...@@ -102,7 +102,7 @@ GET /groups/:id/issues_statistics?confidential=true
| `confidential` | boolean | no | Filter confidential or public issues. | | `confidential` | boolean | no | Filter confidential or public issues. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/4/issues_statistics curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4/issues_statistics"
``` ```
Example response: Example response:
...@@ -158,7 +158,7 @@ GET /projects/:id/issues_statistics?confidential=true ...@@ -158,7 +158,7 @@ GET /projects/:id/issues_statistics?confidential=true
| `confidential` | boolean | no | Filter confidential or public issues. | | `confidential` | boolean | no | Filter confidential or public issues. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/issues_statistics curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/issues_statistics"
``` ```
Example response: Example response:
......
doc/api/jobs.md
View file @ 663d717d
...@@ -14,7 +14,7 @@ GET /projects/:id/jobs ...@@ -14,7 +14,7 @@ GET /projects/: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. | | `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. |
```shell ```shell
curl --globoff --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/1/jobs?scope[]=pending&scope[]=running' curl --globoff --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/jobs?scope[]=pending&scope[]=running"
``` ```
Example of response Example of response
...@@ -149,7 +149,7 @@ GET /projects/:id/pipelines/:pipeline_id/jobs ...@@ -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. | | `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. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/1/pipelines/6/jobs?scope[]=pending&scope[]=running' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipelines/6/jobs?scope[]=pending&scope[]=running"
``` ```
Example of response Example of response
......
doc/api/keys.md
View file @ 663d717d
...@@ -15,7 +15,7 @@ GET /keys/:id ...@@ -15,7 +15,7 @@ GET /keys/:id
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/keys/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/keys/1"
``` ```
```json ```json
...@@ -74,7 +74,7 @@ GET /keys ...@@ -74,7 +74,7 @@ GET /keys
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/keys?fingerprint=ba:81:59:68:d7:6c:cd:02:02:bf:6a:9b:55:4e:af:d1' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/keys?fingerprint=ba:81:59:68:d7:6c:cd:02:02:bf:6a:9b:55:4e:af:d1"
``` ```
If using sha256 fingerprint API calls, make sure that the fingerprint is URL-encoded. If using sha256 fingerprint API calls, make sure that the fingerprint is URL-encoded.
...@@ -82,7 +82,7 @@ If using sha256 fingerprint API calls, make sure that the fingerprint is URL-enc ...@@ -82,7 +82,7 @@ If using sha256 fingerprint API calls, make sure that the fingerprint is URL-enc
For example, `/` is represented by `%2F` and `:` is represented by`%3A`: For example, `/` is represented by `%2F` and `:` is represented by`%3A`:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/keys?fingerprint=SHA256%3AnUhzNyftwADy8AH3wFY31tAKs7HufskYTte2aXo%2FlCg curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/keys?fingerprint=SHA256%3AnUhzNyftwADy8AH3wFY31tAKs7HufskYTte2aXo%2FlCg"
``` ```
Example response: Example response:
...@@ -141,7 +141,7 @@ fingerprint you get additional information about the projects using that key. ...@@ -141,7 +141,7 @@ fingerprint you get additional information about the projects using that key.
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/keys?fingerprint=SHA256%3AnUhzNyftwADy8AH3wFY31tAKs7HufskYTte2aXo%2FlCg curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/keys?fingerprint=SHA256%3AnUhzNyftwADy8AH3wFY31tAKs7HufskYTte2aXo%2FlCg"
``` ```
Example response: Example response:
......
doc/api/labels.md
View file @ 663d717d
...@@ -26,7 +26,7 @@ GET /projects/:id/labels ...@@ -26,7 +26,7 @@ GET /projects/:id/labels
| `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. | | `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/labels?with_counts=true curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels?with_counts=true"
``` ```
Example response: Example response:
...@@ -121,7 +121,7 @@ GET /projects/:id/labels/:label_id ...@@ -121,7 +121,7 @@ GET /projects/:id/labels/:label_id
| `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. | | `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/labels/bug curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels/bug"
``` ```
Example response: Example response:
...@@ -297,7 +297,7 @@ POST /projects/:id/labels/:label_id/subscribe ...@@ -297,7 +297,7 @@ POST /projects/:id/labels/:label_id/subscribe
| `label_id` | integer or string | yes | The ID or title of a project's label | | `label_id` | integer or string | yes | The ID or title of a project's label |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/labels/1/subscribe curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/labels/1/subscribe"
``` ```
Example response: Example response:
...@@ -335,5 +335,5 @@ POST /projects/:id/labels/:label_id/unsubscribe ...@@ -335,5 +335,5 @@ POST /projects/:id/labels/:label_id/unsubscribe
| `label_id` | integer or string | yes | The ID or title of a project's label | | `label_id` | integer or string | yes | The ID or title of a project's label |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/labels/1/unsubscribe curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/labels/1/unsubscribe"
``` ```
doc/api/lint.md
View file @ 663d717d
...@@ -13,7 +13,7 @@ POST /ci/lint ...@@ -13,7 +13,7 @@ POST /ci/lint
| `content` | string | yes | the `.gitlab-ci.yaml` content| | `content` | string | yes | the `.gitlab-ci.yaml` content|
```shell ```shell
curl --header "Content-Type: application/json" https://gitlab.example.com/api/v4/ci/lint --data '{"content": "{ \"image\": \"ruby:2.6\", \"services\": [\"postgres\"], \"before_script\": [\"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}"}' curl --header "Content-Type: application/json" "https://gitlab.example.com/api/v4/ci/lint" --data '{"content": "{ \"image\": \"ruby:2.6\", \"services\": [\"postgres\"], \"before_script\": [\"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}"}'
``` ```
Be sure to copy paste the exact contents of `.gitlab-ci.yml` as YAML is very picky about indentation and spaces. Be sure to copy paste the exact contents of `.gitlab-ci.yml` as YAML is very picky about indentation and spaces.
......
doc/api/managed_licenses.md
View file @ 663d717d
...@@ -13,7 +13,7 @@ GET /projects/:id/managed_licenses ...@@ -13,7 +13,7 @@ GET /projects/:id/managed_licenses
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/managed_licenses curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/managed_licenses"
``` ```
Example response: Example response:
......
doc/api/markdown.md
View file @ 663d717d
...@@ -23,7 +23,7 @@ POST /api/v4/markdown ...@@ -23,7 +23,7 @@ POST /api/v4/markdown
| `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. | | `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. |
```shell ```shell
curl --header Content-Type:application/json --data '{"text":"Hello world! :tada:", "gfm":true, "project":"group_example/project_example"}' https://gitlab.example.com/api/v4/markdown curl --header Content-Type:application/json --data '{"text":"Hello world! :tada:", "gfm":true, "project":"group_example/project_example"}' "https://gitlab.example.com/api/v4/markdown"
``` ```
Response example: Response example:
......
doc/api/members.md
View file @ 663d717d
...@@ -31,8 +31,8 @@ GET /projects/:id/members ...@@ -31,8 +31,8 @@ GET /projects/:id/members
| `user_ids` | array of integers | no | Filter the results on the given user IDs | | `user_ids` | array of integers | no | Filter the results on the given user IDs |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/members curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members"
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/members curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/members"
``` ```
Example response: Example response:
...@@ -89,8 +89,8 @@ GET /projects/:id/members/all ...@@ -89,8 +89,8 @@ GET /projects/:id/members/all
| `user_ids` | array of integers | no | Filter the results on the given user IDs | | `user_ids` | array of integers | no | Filter the results on the given user IDs |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/members/all curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/all"
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/members/all curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/members/all"
``` ```
Example response: Example response:
...@@ -153,8 +153,8 @@ GET /projects/:id/members/:user_id ...@@ -153,8 +153,8 @@ GET /projects/:id/members/:user_id
| `user_id` | integer | yes | The user ID of the member | | `user_id` | integer | yes | The user ID of the member |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/members/:user_id curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id"
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/members/:user_id curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/members/:user_id"
``` ```
Example response: Example response:
...@@ -190,8 +190,8 @@ GET /projects/:id/members/all/:user_id ...@@ -190,8 +190,8 @@ GET /projects/:id/members/all/:user_id
| `user_id` | integer | yes | The user ID of the member | | `user_id` | integer | yes | The user ID of the member |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/members/all/:user_id curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/all/:user_id"
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/members/all/:user_id curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/members/all/:user_id"
``` ```
Example response: Example response:
...@@ -227,8 +227,8 @@ POST /projects/:id/members ...@@ -227,8 +227,8 @@ POST /projects/:id/members
| `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY | | `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY |
```shell ```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/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/projects/:id/members"
``` ```
Example response: Example response:
...@@ -264,8 +264,8 @@ PUT /projects/:id/members/:user_id ...@@ -264,8 +264,8 @@ PUT /projects/:id/members/:user_id
| `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY | | `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY |
```shell ```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/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/projects/:id/members/:user_id?access_level=40"
``` ```
Example response: Example response:
...@@ -301,7 +301,7 @@ POST /groups/:id/members/:user_id/override ...@@ -301,7 +301,7 @@ POST /groups/:id/members/:user_id/override
| `user_id` | integer | yes | The user ID of the member | | `user_id` | integer | yes | The user ID of the member |
```shell ```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"
``` ```
Example response: Example response:
...@@ -337,7 +337,7 @@ DELETE /groups/:id/members/:user_id/override ...@@ -337,7 +337,7 @@ DELETE /groups/:id/members/:user_id/override
| `user_id` | integer | yes | The user ID of the member | | `user_id` | integer | yes | The user ID of the member |
```shell ```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"
``` ```
Example response: Example response:
...@@ -371,8 +371,8 @@ DELETE /projects/:id/members/:user_id ...@@ -371,8 +371,8 @@ DELETE /projects/:id/members/:user_id
| `user_id` | integer | yes | The user ID of the member | | `user_id` | integer | yes | The user ID of the member |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/members/:user_id curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id"
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/members/:user_id curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/members/:user_id"
``` ```
## Give a group access to a project ## Give a group access to a project
......
doc/api/merge_requests.md
View file @ 663d717d
...@@ -1297,7 +1297,7 @@ DELETE /projects/:id/merge_requests/:merge_request_iid ...@@ -1297,7 +1297,7 @@ DELETE /projects/:id/merge_requests/:merge_request_iid
| `merge_request_iid` | integer | yes | The internal ID of the merge request | | `merge_request_iid` | integer | yes | The internal ID of the merge request |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/merge_requests/85 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/merge_requests/85"
``` ```
## Accept MR ## Accept MR
...@@ -1655,7 +1655,7 @@ PUT /projects/:id/merge_requests/:merge_request_iid/rebase ...@@ -1655,7 +1655,7 @@ PUT /projects/:id/merge_requests/:merge_request_iid/rebase
| `skip_ci` | boolean | no | Set to `true` to skip creating a CI pipeline | | `skip_ci` | boolean | no | Set to `true` to skip creating a CI pipeline |
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/76/merge_requests/1/rebase curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/76/merge_requests/1/rebase"
``` ```
This is an asynchronous request. The API will return a `202 Accepted` response This is an asynchronous request. The API will return a `202 Accepted` response
...@@ -1717,7 +1717,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/closes_issues ...@@ -1717,7 +1717,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/closes_issues
| `merge_request_iid` | integer | yes | The internal ID of the merge request | | `merge_request_iid` | integer | yes | The internal ID of the merge request |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/76/merge_requests/1/closes_issues curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/76/merge_requests/1/closes_issues"
``` ```
Example response when the GitLab issue tracker is used: Example response when the GitLab issue tracker is used:
...@@ -1793,7 +1793,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/subscribe ...@@ -1793,7 +1793,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/subscribe
| `merge_request_iid` | integer | yes | The internal ID of the merge request | | `merge_request_iid` | integer | yes | The internal ID of the merge request |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/subscribe curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/17/subscribe"
``` ```
Example response: Example response:
...@@ -1944,7 +1944,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe ...@@ -1944,7 +1944,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe
| `merge_request_iid` | integer | yes | The internal ID of the merge request | | `merge_request_iid` | integer | yes | The internal ID of the merge request |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/merge_requests/17/unsubscribe curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/17/unsubscribe"
``` ```
Example response: Example response:
...@@ -2095,7 +2095,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/todo ...@@ -2095,7 +2095,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/todo
| `merge_request_iid` | integer | yes | The internal ID of the merge request | | `merge_request_iid` | integer | yes | The internal ID of the merge request |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/merge_requests/27/todo curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/27/todo"
``` ```
Example response: Example response:
...@@ -2212,7 +2212,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/versions ...@@ -2212,7 +2212,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/versions
| `merge_request_iid` | integer | yes | The internal ID of the merge request | | `merge_request_iid` | integer | yes | The internal ID of the merge request |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions"
``` ```
Example response: Example response:
...@@ -2254,7 +2254,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/versions/:version_id ...@@ -2254,7 +2254,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/versions/:version_id
| `version_id` | integer | yes | The ID of the merge request diff version | | `version_id` | integer | yes | The ID of the merge request diff version |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/merge_requests/1/versions/1"
``` ```
Example response: Example response:
...@@ -2322,7 +2322,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/time_estimate ...@@ -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 | | `duration` | string | yes | The duration in human format. e.g: 3h30m |
```shell ```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: Example response:
...@@ -2350,7 +2350,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/reset_time_estimate ...@@ -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 | | `merge_request_iid` | integer | yes | The internal ID of a project's merge_request |
```shell ```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: Example response:
...@@ -2379,7 +2379,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/add_spent_time ...@@ -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 | | `duration` | string | yes | The duration in human format. e.g: 3h30m |
```shell ```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: Example response:
...@@ -2407,7 +2407,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/reset_spent_time ...@@ -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 | | `merge_request_iid` | integer | yes | The internal ID of a project's merge_request |
```shell ```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: Example response:
...@@ -2433,7 +2433,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/time_stats ...@@ -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 | | `merge_request_iid` | integer | yes | The internal ID of the merge request |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_stats curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/93/time_stats"
``` ```
Example response: Example response:
......
doc/api/merge_trains.md
View file @ 663d717d
...@@ -32,7 +32,7 @@ GET /projects/:id/merge_trains?scope=complete ...@@ -32,7 +32,7 @@ GET /projects/:id/merge_trains?scope=complete
| `sort` | string | no | Return Merge Trains sorted in `asc` or `desc` order. Default is `desc`. | | `sort` | string | no | Return Merge Trains sorted in `asc` or `desc` order. Default is `desc`. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/merge_trains curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/merge_trains"
``` ```
Example response: Example response:
......
doc/api/metrics_dashboard_annotations.md
View file @ 663d717d
...@@ -24,7 +24,7 @@ Parameters: ...@@ -24,7 +24,7 @@ Parameters:
| `description` | string | yes | Description of the annotation. | | `description` | string | yes | Description of the annotation. |
```shell ```shell
curl --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/environments/1/metrics_dashboard/annotations \ curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/environments/1/metrics_dashboard/annotations" \
--data-urlencode "dashboard_path=.gitlab/dashboards/custom_metrics.yml" \ --data-urlencode "dashboard_path=.gitlab/dashboards/custom_metrics.yml" \
--data-urlencode "starting_at=2016-03-11T03:45:40Z" \ --data-urlencode "starting_at=2016-03-11T03:45:40Z" \
--data-urlencode "description=annotation description" --data-urlencode "description=annotation description"
......
doc/api/milestones.md
View file @ 663d717d
...@@ -31,7 +31,7 @@ Parameters: ...@@ -31,7 +31,7 @@ Parameters:
| `search` | string | optional | Return only milestones with a title or description matching the provided string | | `search` | string | optional | Return only milestones with a title or description matching the provided string |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/milestones curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/milestones"
``` ```
Example Response: Example Response:
......
doc/api/namespaces.md
View file @ 663d717d
...@@ -19,7 +19,7 @@ GET /namespaces ...@@ -19,7 +19,7 @@ GET /namespaces
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/namespaces curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/namespaces"
``` ```
Example response: Example response:
...@@ -85,7 +85,7 @@ GET /namespaces?search=foobar ...@@ -85,7 +85,7 @@ GET /namespaces?search=foobar
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/namespaces?search=twitter curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/namespaces?search=twitter"
``` ```
Example response: Example response:
...@@ -119,7 +119,7 @@ GET /namespaces/:id ...@@ -119,7 +119,7 @@ GET /namespaces/:id
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/namespaces/2 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/namespaces/2"
``` ```
Example response: Example response:
...@@ -139,7 +139,7 @@ Example response: ...@@ -139,7 +139,7 @@ Example response:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/namespaces/group1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/namespaces/group1"
``` ```
Example response: Example response:
......
doc/api/notes.md
View file @ 663d717d
...@@ -82,7 +82,7 @@ GET /projects/:id/issues/:issue_iid/notes?sort=asc&order_by=updated_at ...@@ -82,7 +82,7 @@ GET /projects/:id/issues/:issue_iid/notes?sort=asc&order_by=updated_at
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/11/notes curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/notes"
``` ```
### Get single issue note ### Get single issue note
...@@ -100,7 +100,7 @@ Parameters: ...@@ -100,7 +100,7 @@ Parameters:
- `note_id` (required) - The ID of an issue note - `note_id` (required) - The ID of an issue note
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/11/notes/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/1"
``` ```
### Create new issue note ### Create new issue note
...@@ -119,7 +119,7 @@ Parameters: ...@@ -119,7 +119,7 @@ Parameters:
- `created_at` (optional) - Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) - `created_at` (optional) - Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights)
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/11/notes?body=note curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/notes?body=note"
``` ```
### Modify existing issue note ### Modify existing issue note
...@@ -138,7 +138,7 @@ Parameters: ...@@ -138,7 +138,7 @@ Parameters:
- `body` (required) - The content of a note. Limited to 1,000,000 characters. - `body` (required) - The content of a note. Limited to 1,000,000 characters.
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/11/notes?body=note curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/notes?body=note"
``` ```
### Delete an issue note ### Delete an issue note
...@@ -158,7 +158,7 @@ Parameters: ...@@ -158,7 +158,7 @@ Parameters:
| `note_id` | integer | yes | The ID of a note | | `note_id` | integer | yes | The ID of a note |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/11/notes/636 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/636"
``` ```
## Snippets ## Snippets
...@@ -180,7 +180,7 @@ GET /projects/:id/snippets/:snippet_id/notes?sort=asc&order_by=updated_at ...@@ -180,7 +180,7 @@ GET /projects/:id/snippets/:snippet_id/notes?sort=asc&order_by=updated_at
| `order_by` | string | no | Return snippet notes ordered by `created_at` or `updated_at` fields. Default is `created_at` | `order_by` | string | no | Return snippet notes ordered by `created_at` or `updated_at` fields. Default is `created_at`
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/snippets/11/notes curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes"
``` ```
### Get single snippet note ### Get single snippet note
...@@ -217,7 +217,7 @@ Parameters: ...@@ -217,7 +217,7 @@ Parameters:
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/snippets/11/notes/11 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes/11"
``` ```
### Create new snippet note ### Create new snippet note
...@@ -237,7 +237,7 @@ Parameters: ...@@ -237,7 +237,7 @@ Parameters:
- `created_at` (optional) - Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z - `created_at` (optional) - Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note"
``` ```
### Modify existing snippet note ### Modify existing snippet note
...@@ -256,7 +256,7 @@ Parameters: ...@@ -256,7 +256,7 @@ Parameters:
- `body` (required) - The content of a note. Limited to 1,000,000 characters. - `body` (required) - The content of a note. Limited to 1,000,000 characters.
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/snippets/11/notes?body=note curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes?body=note"
``` ```
### Delete a snippet note ### Delete a snippet note
...@@ -276,7 +276,7 @@ Parameters: ...@@ -276,7 +276,7 @@ Parameters:
| `note_id` | integer | yes | The ID of a note | | `note_id` | integer | yes | The ID of a note |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/snippets/52/notes/1659 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippets/52/notes/1659"
``` ```
## Merge Requests ## Merge Requests
...@@ -298,7 +298,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/notes?sort=asc&order_by=upda ...@@ -298,7 +298,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/notes?sort=asc&order_by=upda
| `order_by` | string | no | Return merge request notes ordered by `created_at` or `updated_at` fields. Default is `created_at` | `order_by` | string | no | Return merge request notes ordered by `created_at` or `updated_at` fields. Default is `created_at`
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes"
``` ```
### Get single merge request note ### Get single merge request note
...@@ -340,7 +340,7 @@ Parameters: ...@@ -340,7 +340,7 @@ Parameters:
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes/1"
``` ```
### Create new merge request note ### Create new merge request note
...@@ -376,7 +376,7 @@ Parameters: ...@@ -376,7 +376,7 @@ Parameters:
- `body` (required) - The content of a note. Limited to 1,000,000 characters. - `body` (required) - The content of a note. Limited to 1,000,000 characters.
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes?body=note curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes?body=note"
``` ```
### Delete a merge request note ### Delete a merge request note
...@@ -396,7 +396,7 @@ Parameters: ...@@ -396,7 +396,7 @@ Parameters:
| `note_id` | integer | yes | The ID of a note | | `note_id` | integer | yes | The ID of a note |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/merge_requests/7/notes/1602 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/7/notes/1602"
``` ```
## Epics **(ULTIMATE)** ## Epics **(ULTIMATE)**
...@@ -418,7 +418,7 @@ GET /groups/:id/epics/:epic_id/notes?sort=asc&order_by=updated_at ...@@ -418,7 +418,7 @@ GET /groups/:id/epics/:epic_id/notes?sort=asc&order_by=updated_at
| `order_by` | string | no | Return epic notes ordered by `created_at` or `updated_at` fields. Default is `created_at` | | `order_by` | string | no | Return epic notes ordered by `created_at` or `updated_at` fields. Default is `created_at` |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/11/notes curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epics/11/notes"
``` ```
### Get single epic note ### Get single epic note
...@@ -458,7 +458,7 @@ Parameters: ...@@ -458,7 +458,7 @@ Parameters:
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1"
``` ```
### Create new epic note ### Create new epic note
...@@ -479,7 +479,7 @@ Parameters: ...@@ -479,7 +479,7 @@ Parameters:
| `body` | string | yes | The content of a note. Limited to 1,000,000 characters. | | `body` | string | yes | The content of a note. Limited to 1,000,000 characters. |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note"
``` ```
### Modify existing epic note ### Modify existing epic note
...@@ -500,7 +500,7 @@ Parameters: ...@@ -500,7 +500,7 @@ Parameters:
| `body` | string | yes | The content of a note. Limited to 1,000,000 characters. | | `body` | string | yes | The content of a note. Limited to 1,000,000 characters. |
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note"
``` ```
### Delete an epic note ### Delete an epic note
...@@ -520,5 +520,5 @@ Parameters: ...@@ -520,5 +520,5 @@ Parameters:
| `note_id` | integer | yes | The ID of a note | | `note_id` | integer | yes | The ID of a note |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/52/notes/1659 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epics/52/notes/1659"
``` ```
doc/api/notification_settings.md
View file @ 663d717d
...@@ -43,7 +43,7 @@ GET /notification_settings ...@@ -43,7 +43,7 @@ GET /notification_settings
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/notification_settings curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/notification_settings"
``` ```
Example response: Example response:
...@@ -64,7 +64,7 @@ PUT /notification_settings ...@@ -64,7 +64,7 @@ PUT /notification_settings
``` ```
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/notification_settings?level=watch curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/notification_settings?level=watch"
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
...@@ -107,8 +107,8 @@ GET /projects/:id/notification_settings ...@@ -107,8 +107,8 @@ GET /projects/:id/notification_settings
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/notification_settings curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/notification_settings"
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/8/notification_settings curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/8/notification_settings"
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
...@@ -133,8 +133,8 @@ PUT /projects/:id/notification_settings ...@@ -133,8 +133,8 @@ PUT /projects/:id/notification_settings
``` ```
```shell ```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/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/projects/8/notification_settings?level=custom&new_note=true"
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
......
doc/api/oauth2.md
View file @ 663d717d
...@@ -177,7 +177,7 @@ Example cURL request: ...@@ -177,7 +177,7 @@ Example cURL request:
```shell ```shell
echo 'grant_type=password&username=<your_username>&password=<your_password>' > auth.txt echo 'grant_type=password&username=<your_username>&password=<your_password>' > auth.txt
curl --data "@auth.txt" --request POST https://gitlab.example.com/oauth/token curl --data "@auth.txt" --request POST "https://gitlab.example.com/oauth/token"
``` ```
Then, you'll receive the access token back in the response: Then, you'll receive the access token back in the response:
...@@ -210,7 +210,7 @@ GET https://gitlab.example.com/api/v4/user?access_token=OAUTH-TOKEN ...@@ -210,7 +210,7 @@ GET https://gitlab.example.com/api/v4/user?access_token=OAUTH-TOKEN
or you can put the token to the Authorization header: or you can put the token to the Authorization header:
```shell ```shell
curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/api/v4/user curl --header "Authorization: Bearer OAUTH-TOKEN" "https://gitlab.example.com/api/v4/user"
``` ```
## Retrieving the token information ## Retrieving the token information
...@@ -229,7 +229,7 @@ You must supply the access token, either: ...@@ -229,7 +229,7 @@ You must supply the access token, either:
- In the Authorization header: - In the Authorization header:
```shell ```shell
curl --header "Authorization: Bearer <OAUTH-TOKEN>" https://gitlab.example.com/oauth/token/info curl --header "Authorization: Bearer <OAUTH-TOKEN>" "https://gitlab.example.com/oauth/token/info"
``` ```
The following is an example response: The following is an example response:
......
doc/api/packages.md
View file @ 663d717d
...@@ -24,7 +24,7 @@ GET /projects/:id/packages ...@@ -24,7 +24,7 @@ GET /projects/:id/packages
| `package_name` | string | no | Filter the project packages with a fuzzy search by name. (_Introduced in GitLab 12.9_) | `package_name` | string | no | Filter the project packages with a fuzzy search by name. (_Introduced in GitLab 12.9_)
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/packages curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages"
``` ```
Example response: Example response:
...@@ -71,7 +71,7 @@ GET /groups/:id/packages ...@@ -71,7 +71,7 @@ GET /groups/:id/packages
| `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_) | `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_)
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/packages?exclude_subgroups=true curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/packages?exclude_subgroups=true"
``` ```
CAUTION: **Deprecation** CAUTION: **Deprecation**
...@@ -156,7 +156,7 @@ GET /projects/:id/packages/:package_id ...@@ -156,7 +156,7 @@ GET /projects/:id/packages/:package_id
| `package_id` | integer | yes | ID of a package. | | `package_id` | integer | yes | ID of a package. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/packages/:package_id curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/:package_id"
``` ```
CAUTION: **Deprecation** CAUTION: **Deprecation**
...@@ -233,7 +233,7 @@ GET /projects/:id/packages/:package_id/package_files ...@@ -233,7 +233,7 @@ GET /projects/:id/packages/:package_id/package_files
| `package_id` | integer | yes | ID of a package. | | `package_id` | integer | yes | ID of a package. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/packages/4/package_files curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/4/package_files"
``` ```
Example response: Example response:
...@@ -288,7 +288,7 @@ DELETE /projects/:id/packages/:package_id ...@@ -288,7 +288,7 @@ DELETE /projects/:id/packages/:package_id
| `package_id` | integer | yes | ID of a package. | | `package_id` | integer | yes | ID of a package. |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/packages/:package_id curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/:package_id"
``` ```
Can return the following status codes: Can return the following status codes:
......
doc/api/pages.md
View file @ 663d717d
...@@ -17,5 +17,5 @@ DELETE /projects/:id/pages ...@@ -17,5 +17,5 @@ DELETE /projects/:id/pages
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
```shell ```shell
curl --request 'DELETE' --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/2/pages curl --request 'DELETE' --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/2/pages"
``` ```
doc/api/pages_domains.md
View file @ 663d717d
...@@ -13,7 +13,7 @@ GET /pages/domains ...@@ -13,7 +13,7 @@ GET /pages/domains
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/pages/domains curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/pages/domains"
``` ```
```json ```json
...@@ -44,7 +44,7 @@ GET /projects/:id/pages/domains ...@@ -44,7 +44,7 @@ GET /projects/:id/pages/domains
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/pages/domains curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/pages/domains"
``` ```
```json ```json
...@@ -81,7 +81,7 @@ GET /projects/:id/pages/domains/:domain ...@@ -81,7 +81,7 @@ GET /projects/:id/pages/domains/:domain
| `domain` | string | yes | The custom domain indicated by the user | | `domain` | string | yes | The custom domain indicated by the user |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/pages/domains/www.domain.example curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/pages/domains/www.domain.example"
``` ```
```json ```json
...@@ -92,7 +92,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/ap ...@@ -92,7 +92,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/ap
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example"
``` ```
```json ```json
...@@ -126,15 +126,15 @@ POST /projects/:id/pages/domains ...@@ -126,15 +126,15 @@ POST /projects/:id/pages/domains
| `key` | file/string | no | The certificate key in PEM format. | | `key` | file/string | no | The certificate key in PEM format. |
```shell ```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 ```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 ```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 ```json
...@@ -170,11 +170,11 @@ PUT /projects/:id/pages/domains/:domain ...@@ -170,11 +170,11 @@ PUT /projects/:id/pages/domains/:domain
### Adding certificate ### Adding certificate
```shell ```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 ```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"
``` ```
```json ```json
...@@ -194,7 +194,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form "certifi ...@@ -194,7 +194,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form "certifi
### Enabling Let's Encrypt integration for Pages custom domains ### Enabling Let's Encrypt integration for Pages custom domains
```shell ```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"
``` ```
```json ```json
...@@ -210,7 +210,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form "auto_ss ...@@ -210,7 +210,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form "auto_ss
To remove the SSL certificate attached to the Pages domain, run: To remove the SSL certificate attached to the Pages domain, run:
```shell ```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"
``` ```
```json ```json
...@@ -235,5 +235,5 @@ DELETE /projects/:id/pages/domains/:domain ...@@ -235,5 +235,5 @@ DELETE /projects/:id/pages/domains/:domain
| `domain` | string | yes | The custom domain indicated by the user | | `domain` | string | yes | The custom domain indicated by the user |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example"
``` ```
doc/api/pipeline_schedules.md
View file @ 663d717d
...@@ -16,7 +16,7 @@ GET /projects/:id/pipeline_schedules ...@@ -16,7 +16,7 @@ GET /projects/:id/pipeline_schedules
| `scope` | string | no | The scope of pipeline schedules, one of: `active`, `inactive` | | `scope` | string | no | The scope of pipeline schedules, one of: `active`, `inactive` |
```shell ```shell
curl --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules" curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules"
``` ```
```json ```json
...@@ -57,7 +57,7 @@ GET /projects/:id/pipeline_schedules/:pipeline_schedule_id ...@@ -57,7 +57,7 @@ GET /projects/:id/pipeline_schedules/:pipeline_schedule_id
| `pipeline_schedule_id` | integer | yes | The pipeline schedule ID | | `pipeline_schedule_id` | integer | yes | The pipeline schedule ID |
```shell ```shell
curl --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13" curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13"
``` ```
```json ```json
...@@ -113,7 +113,7 @@ POST /projects/:id/pipeline_schedules ...@@ -113,7 +113,7 @@ POST /projects/:id/pipeline_schedules
| `active` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: `true`) | | `active` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: `true`) |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" --form description="Build packages" --form ref="master" --form cron="0 1 * * 5" --form cron_timezone="UTC" --form active="true" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules" curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form description="Build packages" --form ref="master" --form cron="0 1 * * 5" --form cron_timezone="UTC" --form active="true" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules"
``` ```
```json ```json
...@@ -158,7 +158,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id ...@@ -158,7 +158,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id
| `active` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially. | | `active` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially. |
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" --form cron="0 2 * * *" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13" curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form cron="0 2 * * *" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13"
``` ```
```json ```json
...@@ -203,7 +203,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/take_ownership ...@@ -203,7 +203,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/take_ownership
| `pipeline_schedule_id` | integer | yes | The pipeline schedule ID | | `pipeline_schedule_id` | integer | yes | The pipeline schedule ID |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: hf2CvZXB9w8Uc5pZKpSB" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13/take_ownership" curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13/take_ownership"
``` ```
```json ```json
...@@ -248,7 +248,7 @@ DELETE /projects/:id/pipeline_schedules/:pipeline_schedule_id ...@@ -248,7 +248,7 @@ DELETE /projects/:id/pipeline_schedules/:pipeline_schedule_id
| `pipeline_schedule_id` | integer | yes | The pipeline schedule ID | | `pipeline_schedule_id` | integer | yes | The pipeline schedule ID |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13" curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13"
``` ```
```json ```json
...@@ -298,7 +298,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/play ...@@ -298,7 +298,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/play
Example request: Example request:
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/42/pipeline_schedules/1/play curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/42/pipeline_schedules/1/play"
``` ```
Example response: Example response:
...@@ -330,7 +330,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables ...@@ -330,7 +330,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables
| `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` | | `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" --form "key=NEW_VARIABLE" --form "value=new value" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13/variables" curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "key=NEW_VARIABLE" --form "value=new value" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13/variables"
``` ```
```json ```json
...@@ -358,7 +358,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key ...@@ -358,7 +358,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key
| `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` | | `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` |
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" --form "value=updated value" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13/variables/NEW_VARIABLE" curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form "value=updated value" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13/variables/NEW_VARIABLE"
``` ```
```json ```json
...@@ -384,7 +384,7 @@ DELETE /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key ...@@ -384,7 +384,7 @@ DELETE /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key
| `key` | string | yes | The `key` of a variable | | `key` | string | yes | The `key` of a variable |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13/variables/NEW_VARIABLE" curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13/variables/NEW_VARIABLE"
``` ```
```json ```json
......
doc/api/project_badges.md
View file @ 663d717d
...@@ -25,7 +25,7 @@ GET /projects/:id/badges ...@@ -25,7 +25,7 @@ GET /projects/:id/badges
| `name` | string | no | Name of the badges to return (case-sensitive). | | `name` | string | no | Name of the badges to return (case-sensitive). |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/badges curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges"
``` ```
Example response: Example response:
...@@ -67,7 +67,7 @@ GET /projects/:id/badges/:badge_id ...@@ -67,7 +67,7 @@ GET /projects/:id/badges/:badge_id
| `badge_id` | integer | yes | The badge ID | | `badge_id` | integer | yes | The badge ID |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"
``` ```
Example response: Example response:
...@@ -98,7 +98,7 @@ POST /projects/:id/badges ...@@ -98,7 +98,7 @@ POST /projects/:id/badges
| `image_url` | string | yes | URL of the badge image | | `image_url` | string | yes | URL of the badge image |
```shell ```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: Example response:
...@@ -130,7 +130,7 @@ PUT /projects/:id/badges/:badge_id ...@@ -130,7 +130,7 @@ PUT /projects/:id/badges/:badge_id
| `image_url` | string | no | URL of the badge image | | `image_url` | string | no | URL of the badge image |
```shell ```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"
``` ```
Example response: Example response:
...@@ -160,7 +160,7 @@ DELETE /projects/:id/badges/:badge_id ...@@ -160,7 +160,7 @@ DELETE /projects/:id/badges/:badge_id
| `badge_id` | integer | yes | The badge ID | | `badge_id` | integer | yes | The badge ID |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"
``` ```
## Preview a badge from a project ## Preview a badge from a project
...@@ -178,7 +178,7 @@ GET /projects/:id/badges/render ...@@ -178,7 +178,7 @@ GET /projects/:id/badges/render
| `image_url` | string | yes | URL of the badge image | | `image_url` | string | yes | URL of the badge image |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/badges/render?link_url=http%3A%2F%2Fexample.com%2Fci_status.svg%3Fproject%3D%25%7Bproject_path%7D%26ref%3D%25%7Bdefault_branch%7D&image_url=https%3A%2F%2Fshields.io%2Fmy%2Fbadge curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/render?link_url=http%3A%2F%2Fexample.com%2Fci_status.svg%3Fproject%3D%25%7Bproject_path%7D%26ref%3D%25%7Bdefault_branch%7D&image_url=https%3A%2F%2Fshields.io%2Fmy%2Fbadge"
``` ```
Example response: Example response:
......
doc/api/project_clusters.md
View file @ 663d717d
...@@ -22,7 +22,7 @@ Parameters: ...@@ -22,7 +22,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/projects/26/clusters curl --header 'Private-Token: <your_access_token>' "https://gitlab.example.com/api/v4/projects/26/clusters"
``` ```
Example response: Example response:
...@@ -91,7 +91,7 @@ Parameters: ...@@ -91,7 +91,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/projects/26/clusters/18 curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/26/clusters/18"
``` ```
Example response: Example response:
...@@ -192,7 +192,7 @@ Parameters: ...@@ -192,7 +192,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/projects/26/clusters/user \ curl --header 'Private-Token: <your_access_token>' "https://gitlab.example.com/api/v4/projects/26/clusters/user" \
-H "Accept: application/json" \ -H "Accept: application/json" \
-H "Content-Type:application/json" \ -H "Content-Type:application/json" \
-X POST --data '{"name":"cluster-5", "platform_kubernetes_attributes":{"api_url":"https://35.111.51.20","token":"12345","namespace":"cluster-5-namespace","ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"}}' -X POST --data '{"name":"cluster-5", "platform_kubernetes_attributes":{"api_url":"https://35.111.51.20","token":"12345","namespace":"cluster-5-namespace","ca_cert":"-----BEGIN CERTIFICATE-----\r\nhFiK1L61owwDQYJKoZIhvcNAQELBQAw\r\nLzEtMCsGA1UEAxMkZDA1YzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM4ZDBj\r\nMB4XDTE4MTIyNzIwMDM1MVoXDTIzMTIyNjIxMDM1MVowLzEtMCsGA1UEAxMkZDA1\r\nYzQ1YjctNzdiMS00NDY0LThjNmEtMTQ0ZDJkZjM.......-----END CERTIFICATE-----"}}'
...@@ -289,7 +289,7 @@ through the ["Add existing cluster to project"](#add-existing-cluster-to-project ...@@ -289,7 +289,7 @@ through the ["Add existing cluster to project"](#add-existing-cluster-to-project
Example request: Example request:
```shell ```shell
curl --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/projects/26/clusters/24 \ curl --header 'Private-Token: <your_access_token>' "https://gitlab.example.com/api/v4/projects/26/clusters/24" \
-H "Content-Type:application/json" \ -H "Content-Type:application/json" \
-X PUT --data '{"name":"new-cluster-name","domain":"new-domain.com","api_url":"https://new-api-url.com"}' -X PUT --data '{"name":"new-cluster-name","domain":"new-domain.com","api_url":"https://new-api-url.com"}'
``` ```
...@@ -383,5 +383,5 @@ Parameters: ...@@ -383,5 +383,5 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --request DELETE --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/projects/26/clusters/23 curl --request DELETE --header 'Private-Token: <your_access_token>' "https://gitlab.example.com/api/v4/projects/26/clusters/23"
``` ```
doc/api/project_import_export.md
View file @ 663d717d
...@@ -31,7 +31,7 @@ POST /projects/:id/export ...@@ -31,7 +31,7 @@ POST /projects/:id/export
| `upload[http_method]` | string | no | The HTTP method to upload the exported project. Only `PUT` and `POST` methods allowed. Default is `PUT` | | `upload[http_method]` | string | no | The HTTP method to upload the exported project. Only `PUT` and `POST` methods allowed. Default is `PUT` |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/export \ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/export" \
--data "upload[http_method]=PUT" \ --data "upload[http_method]=PUT" \
--data-urlencode "upload[url]=https://example-bucket.s3.eu-west-3.amazonaws.com/backup?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIMBJHN2O62W8IELQ%2F20180312%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20180312T110328Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=8413facb20ff33a49a147a0b4abcff4c8487cc33ee1f7e450c46e8f695569dbd" --data-urlencode "upload[url]=https://example-bucket.s3.eu-west-3.amazonaws.com/backup?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIMBJHN2O62W8IELQ%2F20180312%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20180312T110328Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=8413facb20ff33a49a147a0b4abcff4c8487cc33ee1f7e450c46e8f695569dbd"
``` ```
...@@ -58,7 +58,7 @@ GET /projects/:id/export ...@@ -58,7 +58,7 @@ GET /projects/:id/export
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/export curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/export"
``` ```
Status can be one of: Status can be one of:
...@@ -111,7 +111,7 @@ GET /projects/:id/export/download ...@@ -111,7 +111,7 @@ GET /projects/:id/export/download
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" --remote-header-name --remote-name https://gitlab.example.com/api/v4/projects/5/export/download curl --header "PRIVATE-TOKEN: <your_access_token>" --remote-header-name --remote-name "https://gitlab.example.com/api/v4/projects/5/export/download"
``` ```
```shell ```shell
...@@ -142,7 +142,7 @@ The `file=` parameter must point to a file on your file system and be preceded ...@@ -142,7 +142,7 @@ The `file=` parameter must point to a file on your file system and be preceded
by `@`. For example: by `@`. For example:
```shell ```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: 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 ...@@ -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 | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/import curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/import"
``` ```
Status can be one of: Status can be one of:
......
doc/api/project_snippets.md
View file @ 663d717d
...@@ -86,7 +86,7 @@ Parameters: ...@@ -86,7 +86,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --request POST https://gitlab.com/api/v4/projects/:id/snippets \ curl --request POST "https://gitlab.com/api/v4/projects/:id/snippets" \
--header "PRIVATE-TOKEN: <your access token>" \ --header "PRIVATE-TOKEN: <your access token>" \
--header "Content-Type: application/json" \ --header "Content-Type: application/json" \
-d @snippet.json -d @snippet.json
...@@ -125,7 +125,7 @@ Parameters: ...@@ -125,7 +125,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --request PUT https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id \ curl --request PUT "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id" \
--header "PRIVATE-TOKEN: <your_access_token>" \ --header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-Type: application/json" \ --header "Content-Type: application/json" \
-d @snippet.json -d @snippet.json
...@@ -159,7 +159,7 @@ Parameters: ...@@ -159,7 +159,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --request DELETE https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id \ curl --request DELETE "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id" \
--header "PRIVATE-TOKEN: <your_access_token>" --header "PRIVATE-TOKEN: <your_access_token>"
``` ```
...@@ -179,7 +179,7 @@ Parameters: ...@@ -179,7 +179,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id/raw \ curl "https://gitlab.com/api/v4/projects/:id/snippets/:snippet_id/raw" \
--header "PRIVATE-TOKEN: <your_access_token>" --header "PRIVATE-TOKEN: <your_access_token>"
``` ```
...@@ -201,7 +201,7 @@ GET /projects/:id/snippets/:snippet_id/user_agent_detail ...@@ -201,7 +201,7 @@ GET /projects/:id/snippets/:snippet_id/user_agent_detail
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/snippets/2/user_agent_detail curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/snippets/2/user_agent_detail"
``` ```
Example response: Example response:
......
doc/api/project_vulnerabilities.md
View file @ 663d717d
...@@ -44,7 +44,7 @@ GET /projects/:id/vulnerabilities ...@@ -44,7 +44,7 @@ GET /projects/:id/vulnerabilities
| `id` | integer or string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | | `id` | integer or string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/vulnerabilities curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/vulnerabilities"
``` ```
Example response: Example response:
...@@ -133,7 +133,7 @@ its source Vulnerability Finding, or with these default values: ...@@ -133,7 +133,7 @@ its source Vulnerability Finding, or with these default values:
| `confidence` | The `confidence` attribute of a Vulnerability Finding | | `confidence` | The `confidence` attribute of a Vulnerability Finding |
```shell ```shell
curl --header POST "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/vulnerabilities?finding_id=1 curl --header POST "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/vulnerabilities?finding_id=1"
``` ```
Example response: Example response:
......
doc/api/projects.md
View file @ 663d717d
...@@ -1857,7 +1857,7 @@ The `file=` parameter must point to a file on your filesystem and be preceded ...@@ -1857,7 +1857,7 @@ The `file=` parameter must point to a file on your filesystem and be preceded
by `@`. For example: by `@`. For example:
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "file=@dk.png" https://gitlab.example.com/api/v4/projects/5/uploads curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "file=@dk.png" "https://gitlab.example.com/api/v4/projects/5/uploads"
``` ```
Returned object: Returned object:
...@@ -1904,7 +1904,7 @@ DELETE /projects/:id/share/:group_id ...@@ -1904,7 +1904,7 @@ DELETE /projects/:id/share/:group_id
| `group_id` | integer | yes | The ID of the group | | `group_id` | integer | yes | The ID of the group |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/share/17 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/share/17"
``` ```
## Hooks ## Hooks
...@@ -2070,7 +2070,7 @@ GET /projects ...@@ -2070,7 +2070,7 @@ GET /projects
| `sort` | string | no | Return requests sorted in `asc` or `desc` order | | `sort` | string | no | Return requests sorted in `asc` or `desc` order |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects?search=test curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects?search=test"
``` ```
## Start the Housekeeping task for a Project ## Start the Housekeeping task for a Project
...@@ -2230,7 +2230,7 @@ POST /projects/:id/mirror/pull ...@@ -2230,7 +2230,7 @@ POST /projects/:id/mirror/pull
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/mirror/pull curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/mirror/pull"
``` ```
## Project badges ## Project badges
......
doc/api/protected_branches.md
View file @ 663d717d
...@@ -27,7 +27,7 @@ GET /projects/:id/protected_branches ...@@ -27,7 +27,7 @@ GET /projects/:id/protected_branches
| `search` | string | no | Name or part of the name of protected branches to be searched for | | `search` | string | no | Name or part of the name of protected branches to be searched for |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_branches' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches"
``` ```
Example response: Example response:
...@@ -101,7 +101,7 @@ GET /projects/:id/protected_branches/:name ...@@ -101,7 +101,7 @@ GET /projects/:id/protected_branches/:name
| `name` | string | yes | The name of the branch or wildcard | | `name` | string | yes | The name of the branch or wildcard |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_branches/master' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/master"
``` ```
Example response: Example response:
...@@ -165,7 +165,7 @@ POST /projects/:id/protected_branches ...@@ -165,7 +165,7 @@ POST /projects/:id/protected_branches
``` ```
```shell ```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 | | Attribute | Type | Required | Description |
...@@ -251,7 +251,7 @@ Elements in the `allowed_to_push` / `allowed_to_merge` / `allowed_to_unprotect` ...@@ -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. 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 ```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"
``` ```
Example response: Example response:
...@@ -297,7 +297,7 @@ DELETE /projects/:id/protected_branches/:name ...@@ -297,7 +297,7 @@ DELETE /projects/:id/protected_branches/:name
``` ```
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_branches/*-stable' curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/*-stable"
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
...@@ -314,7 +314,7 @@ PATCH /projects/:id/protected_branches/:name ...@@ -314,7 +314,7 @@ PATCH /projects/:id/protected_branches/:name
``` ```
```shell ```shell
curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_branches/feature-branch' curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches/feature-branch"
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
......
doc/api/protected_environments.md
View file @ 663d717d
...@@ -26,7 +26,7 @@ GET /projects/:id/protected_environments ...@@ -26,7 +26,7 @@ GET /projects/:id/protected_environments
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_environments/' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_environments/"
``` ```
Example response: Example response:
...@@ -61,7 +61,7 @@ GET /projects/:id/protected_environments/:name ...@@ -61,7 +61,7 @@ GET /projects/:id/protected_environments/:name
| `name` | string | yes | The name of the protected environment | | `name` | string | yes | The name of the protected environment |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_environments/production' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_environments/production"
``` ```
Example response: Example response:
...@@ -89,7 +89,7 @@ POST /projects/:id/protected_environments ...@@ -89,7 +89,7 @@ POST /projects/:id/protected_environments
``` ```
```shell ```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"
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
...@@ -127,7 +127,7 @@ DELETE /projects/:id/protected_environments/:name ...@@ -127,7 +127,7 @@ DELETE /projects/:id/protected_environments/:name
``` ```
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_environments/staging' curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_environments/staging"
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
......
doc/api/protected_tags.md
View file @ 663d717d
...@@ -26,7 +26,7 @@ GET /projects/:id/protected_tags ...@@ -26,7 +26,7 @@ GET /projects/:id/protected_tags
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_tags' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_tags"
``` ```
Example response: Example response:
...@@ -61,7 +61,7 @@ GET /projects/:id/protected_tags/:name ...@@ -61,7 +61,7 @@ GET /projects/:id/protected_tags/:name
| `name` | string | yes | The name of the tag or wildcard | | `name` | string | yes | The name of the tag or wildcard |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_tags/release-1-0' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_tags/release-1-0"
``` ```
Example response: Example response:
...@@ -88,7 +88,7 @@ POST /projects/:id/protected_tags ...@@ -88,7 +88,7 @@ POST /projects/:id/protected_tags
``` ```
```shell ```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"
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
...@@ -120,7 +120,7 @@ DELETE /projects/:id/protected_tags/:name ...@@ -120,7 +120,7 @@ DELETE /projects/:id/protected_tags/:name
``` ```
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_tags/*-stable' curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_tags/*-stable"
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
......
doc/api/remote_mirrors.md
View file @ 663d717d
...@@ -18,7 +18,7 @@ GET /projects/:id/remote_mirrors ...@@ -18,7 +18,7 @@ GET /projects/:id/remote_mirrors
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/42/remote_mirrors' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/42/remote_mirrors"
``` ```
Example response: Example response:
...@@ -64,7 +64,7 @@ POST /projects/:id/remote_mirrors ...@@ -64,7 +64,7 @@ POST /projects/:id/remote_mirrors
Example request: Example request:
```shell ```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: Example response:
...@@ -105,7 +105,7 @@ PUT /projects/:id/remote_mirrors/:mirror_id ...@@ -105,7 +105,7 @@ PUT /projects/:id/remote_mirrors/:mirror_id
Example request: Example request:
```shell ```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"
``` ```
Example response: Example response:
......
doc/api/repositories.md
View file @ 663d717d
...@@ -124,7 +124,7 @@ Parameters: ...@@ -124,7 +124,7 @@ Parameters:
- `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: - `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:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.com/api/v4/projects/<project_id>/repository/archive?sha=<commit_sha> curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.com/api/v4/projects/<project_id>/repository/archive?sha=<commit_sha>"
``` ```
## Compare branches, tags or commits ## Compare branches, tags or commits
......
doc/api/repository_files.md
View file @ 663d717d
...@@ -25,7 +25,7 @@ GET /projects/:id/repository/files/:file_path ...@@ -25,7 +25,7 @@ GET /projects/:id/repository/files/:file_path
``` ```
```shell ```shell
curl --header 'PRIVATE-TOKEN: <your_access_token>' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=master' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=master"
``` ```
Example response: Example response:
...@@ -60,7 +60,7 @@ HEAD /projects/:id/repository/files/:file_path ...@@ -60,7 +60,7 @@ HEAD /projects/:id/repository/files/:file_path
``` ```
```shell ```shell
curl --head --header 'PRIVATE-TOKEN: <your_access_token>' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=master' curl --head --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=master"
``` ```
Example response: Example response:
...@@ -89,7 +89,7 @@ GET /projects/:id/repository/files/:file_path/blame ...@@ -89,7 +89,7 @@ GET /projects/:id/repository/files/:file_path/blame
``` ```
```shell ```shell
curl --header 'PRIVATE-TOKEN: <your_access_token>' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=master' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=master"
``` ```
Example response: Example response:
...@@ -129,7 +129,7 @@ NOTE: **Note:** ...@@ -129,7 +129,7 @@ NOTE: **Note:**
`HEAD` method return just file metadata as in [Get file from repository](repository_files.md#get-file-from-repository). `HEAD` method return just file metadata as in [Get file from repository](repository_files.md#get-file-from-repository).
```shell ```shell
curl --head --header 'PRIVATE-TOKEN: <your_access_token>' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=master' curl --head --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=master"
``` ```
Example response: Example response:
...@@ -156,7 +156,7 @@ GET /projects/:id/repository/files/:file_path/raw ...@@ -156,7 +156,7 @@ GET /projects/:id/repository/files/:file_path/raw
``` ```
```shell ```shell
curl --header 'PRIVATE-TOKEN: <your_access_token>' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb/raw?ref=master' curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb/raw?ref=master"
``` ```
Parameters: Parameters:
...@@ -179,7 +179,7 @@ POST /projects/:id/repository/files/:file_path ...@@ -179,7 +179,7 @@ POST /projects/:id/repository/files/:file_path
curl --request POST --header 'PRIVATE-TOKEN: <your_access_token>' --header "Content-Type: application/json" \ curl --request POST --header 'PRIVATE-TOKEN: <your_access_token>' --header "Content-Type: application/json" \
--data '{"branch": "master", "author_email": "author@example.com", "author_name": "Firstname Lastname", \ --data '{"branch": "master", "author_email": "author@example.com", "author_name": "Firstname Lastname", \
"content": "some content", "commit_message": "create a new file"}' \ "content": "some content", "commit_message": "create a new file"}' \
'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb' "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb"
``` ```
Example response: Example response:
...@@ -214,7 +214,7 @@ PUT /projects/:id/repository/files/:file_path ...@@ -214,7 +214,7 @@ PUT /projects/:id/repository/files/:file_path
curl --request PUT --header 'PRIVATE-TOKEN: <your_access_token>' --header "Content-Type: application/json" \ curl --request PUT --header 'PRIVATE-TOKEN: <your_access_token>' --header "Content-Type: application/json" \
--data '{"branch": "master", "author_email": "author@example.com", "author_name": "Firstname Lastname", \ --data '{"branch": "master", "author_email": "author@example.com", "author_name": "Firstname Lastname", \
"content": "some content", "commit_message": "update file"}' \ "content": "some content", "commit_message": "update file"}' \
'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb' "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb"
``` ```
Example response: Example response:
...@@ -260,7 +260,7 @@ DELETE /projects/:id/repository/files/:file_path ...@@ -260,7 +260,7 @@ DELETE /projects/:id/repository/files/:file_path
curl --request DELETE --header 'PRIVATE-TOKEN: <your_access_token>' --header "Content-Type: application/json" \ curl --request DELETE --header 'PRIVATE-TOKEN: <your_access_token>' --header "Content-Type: application/json" \
--data '{"branch": "master", "author_email": "author@example.com", "author_name": "Firstname Lastname", \ --data '{"branch": "master", "author_email": "author@example.com", "author_name": "Firstname Lastname", \
"commit_message": "delete file"}' \ "commit_message": "delete file"}' \
'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb' "https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb"
``` ```
Parameters: Parameters:
......
doc/api/resource_label_events.md
View file @ 663d717d
...@@ -65,7 +65,7 @@ GET /projects/:id/issues/:issue_iid/resource_label_events ...@@ -65,7 +65,7 @@ GET /projects/:id/issues/:issue_iid/resource_label_events
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/11/resource_label_events curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/resource_label_events"
``` ```
### Get single issue label event ### Get single issue label event
...@@ -85,7 +85,7 @@ Parameters: ...@@ -85,7 +85,7 @@ Parameters:
| `resource_label_event_id` | integer | yes | The ID of a label event | | `resource_label_event_id` | integer | yes | The ID of a label event |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/11/resource_label_events/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/resource_label_events/1"
``` ```
## Epics **(ULTIMATE)** ## Epics **(ULTIMATE)**
...@@ -151,7 +151,7 @@ GET /groups/:id/epics/:epic_id/resource_label_events ...@@ -151,7 +151,7 @@ GET /groups/:id/epics/:epic_id/resource_label_events
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/11/resource_label_events curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/11/resource_label_events"
``` ```
### Get single epic label event ### Get single epic label event
...@@ -171,7 +171,7 @@ Parameters: ...@@ -171,7 +171,7 @@ Parameters:
| `resource_label_event_id` | integer | yes | The ID of a label event | | `resource_label_event_id` | integer | yes | The ID of a label event |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/11/resource_label_events/107 curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/11/resource_label_events/107"
``` ```
## Merge requests ## Merge requests
...@@ -237,7 +237,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/resource_label_events ...@@ -237,7 +237,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/resource_label_events
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/merge_requests/11/resource_label_events curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/resource_label_events"
``` ```
### Get single merge request label event ### Get single merge request label event
...@@ -257,5 +257,5 @@ Parameters: ...@@ -257,5 +257,5 @@ Parameters:
| `resource_label_event_id` | integer | yes | The ID of a label event | | `resource_label_event_id` | integer | yes | The ID of a label event |
```shell ```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"
``` ```
doc/api/scim.md
View file @ 663d717d
...@@ -86,7 +86,7 @@ Parameters: ...@@ -86,7 +86,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl 'https://example.gitlab.com/api/scim/v2/groups/test_group/Users/f0b1d561c-21ff-4092-beab-8154b17f82f2' --header "Authorization: Bearer <your_scim_token>" --header "Content-Type: application/scim+json" curl "https://example.gitlab.com/api/scim/v2/groups/test_group/Users/f0b1d561c-21ff-4092-beab-8154b17f82f2" --header "Authorization: Bearer <your_scim_token>" --header "Content-Type: application/scim+json"
``` ```
Example response: Example response:
...@@ -130,7 +130,7 @@ Parameters: ...@@ -130,7 +130,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --verbose --request POST 'https://example.gitlab.com/api/scim/v2/groups/test_group/Users' --data '{"externalId":"test_uid","active":null,"userName":"username","emails":[{"primary":true,"type":"work","value":"name@example.com"}],"name":{"formatted":"Test User","familyName":"User","givenName":"Test"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"meta":{"resourceType":"User"}}' --header "Authorization: Bearer <your_scim_token>" --header "Content-Type: application/scim+json" curl --verbose --request POST "https://example.gitlab.com/api/scim/v2/groups/test_group/Users" --data '{"externalId":"test_uid","active":null,"userName":"username","emails":[{"primary":true,"type":"work","value":"name@example.com"}],"name":{"formatted":"Test User","familyName":"User","givenName":"Test"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"meta":{"resourceType":"User"}}' --header "Authorization: Bearer <your_scim_token>" --header "Content-Type: application/scim+json"
``` ```
Example response: Example response:
...@@ -184,7 +184,7 @@ Parameters: ...@@ -184,7 +184,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --verbose --request PATCH 'https://example.gitlab.com/api/scim/v2/groups/test_group/Users/f0b1d561c-21ff-4092-beab-8154b17f82f2' --data '{ "Operations": [{"op":"Add","path":"name.formatted","value":"New Name"}] }' --header "Authorization: Bearer <your_scim_token>" --header "Content-Type: application/scim+json" curl --verbose --request PATCH "https://example.gitlab.com/api/scim/v2/groups/test_group/Users/f0b1d561c-21ff-4092-beab-8154b17f82f2" --data '{ "Operations": [{"op":"Add","path":"name.formatted","value":"New Name"}] }' --header "Authorization: Bearer <your_scim_token>" --header "Content-Type: application/scim+json"
``` ```
Returns an empty response with a `204` status code if successful. Returns an empty response with a `204` status code if successful.
...@@ -207,7 +207,7 @@ Parameters: ...@@ -207,7 +207,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --verbose --request DELETE 'https://example.gitlab.com/api/scim/v2/groups/test_group/Users/f0b1d561c-21ff-4092-beab-8154b17f82f2' --header "Authorization: Bearer <your_scim_token>" --header "Content-Type: application/scim+json" curl --verbose --request DELETE "https://example.gitlab.com/api/scim/v2/groups/test_group/Users/f0b1d561c-21ff-4092-beab-8154b17f82f2" --header "Authorization: Bearer <your_scim_token>" --header "Content-Type: application/scim+json"
``` ```
Returns an empty response with a `204` status code if successful. Returns an empty response with a `204` status code if successful.
......
doc/api/search.md
View file @ 663d717d
...@@ -26,7 +26,7 @@ The response depends on the requested scope. ...@@ -26,7 +26,7 @@ The response depends on the requested scope.
### Scope: projects ### Scope: projects
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=projects&search=flight curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=projects&search=flight"
``` ```
Example response: Example response:
...@@ -57,7 +57,7 @@ Example response: ...@@ -57,7 +57,7 @@ Example response:
### Scope: issues ### Scope: issues
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=issues&search=file curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=issues&search=file"
``` ```
Example response: Example response:
...@@ -122,7 +122,7 @@ Example response: ...@@ -122,7 +122,7 @@ Example response:
### Scope: merge_requests ### Scope: merge_requests
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=merge_requests&search=file curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=merge_requests&search=file"
``` ```
Example response: Example response:
...@@ -200,7 +200,7 @@ Example response: ...@@ -200,7 +200,7 @@ Example response:
### Scope: milestones ### Scope: milestones
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=milestones&search=release curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=milestones&search=release"
``` ```
Example response: Example response:
...@@ -225,7 +225,7 @@ Example response: ...@@ -225,7 +225,7 @@ Example response:
### Scope: snippet_titles ### Scope: snippet_titles
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=snippet_titles&search=sample curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=snippet_titles&search=sample"
``` ```
Example response: Example response:
...@@ -258,7 +258,7 @@ Example response: ...@@ -258,7 +258,7 @@ Example response:
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=wiki_blobs&search=bye curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=wiki_blobs&search=bye"
``` ```
Example response: Example response:
...@@ -286,7 +286,7 @@ Example response: ...@@ -286,7 +286,7 @@ Example response:
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=commits&search=bye curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=commits&search=bye"
``` ```
Example response: Example response:
...@@ -329,7 +329,7 @@ to use a filter simply include it in your query like so: `a query filename:some_ ...@@ -329,7 +329,7 @@ to use a filter simply include it in your query like so: `a query filename:some_
You may use wildcards (`*`) to use glob matching. You may use wildcards (`*`) to use glob matching.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=blobs&search=installation curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=blobs&search=installation"
``` ```
Example response: Example response:
...@@ -355,7 +355,7 @@ Example response: ...@@ -355,7 +355,7 @@ Example response:
### Scope: users ### Scope: users
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/search?scope=users&search=doe curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/search?scope=users&search=doe"
``` ```
Example response: Example response:
...@@ -398,7 +398,7 @@ The response depends on the requested scope. ...@@ -398,7 +398,7 @@ The response depends on the requested scope.
### Scope: projects ### Scope: projects
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/3/search?scope=projects&search=flight curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=projects&search=flight"
``` ```
Example response: Example response:
...@@ -429,7 +429,7 @@ Example response: ...@@ -429,7 +429,7 @@ Example response:
### Scope: issues ### Scope: issues
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/3/search?scope=issues&search=file curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=issues&search=file"
``` ```
Example response: Example response:
...@@ -494,7 +494,7 @@ Example response: ...@@ -494,7 +494,7 @@ Example response:
### Scope: merge_requests ### Scope: merge_requests
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/3/search?scope=merge_requests&search=file curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=merge_requests&search=file"
``` ```
Example response: Example response:
...@@ -572,7 +572,7 @@ Example response: ...@@ -572,7 +572,7 @@ Example response:
### Scope: milestones ### Scope: milestones
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/3/search?scope=milestones&search=release curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=milestones&search=release"
``` ```
Example response: Example response:
...@@ -599,7 +599,7 @@ Example response: ...@@ -599,7 +599,7 @@ Example response:
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/6/search?scope=wiki_blobs&search=bye curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/6/search?scope=wiki_blobs&search=bye"
``` ```
Example response: Example response:
...@@ -627,7 +627,7 @@ Example response: ...@@ -627,7 +627,7 @@ Example response:
This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/6/search?scope=commits&search=bye curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/6/search?scope=commits&search=bye"
``` ```
Example response: Example response:
...@@ -670,7 +670,7 @@ to use a filter simply include it in your query like so: `a query filename:some_ ...@@ -670,7 +670,7 @@ to use a filter simply include it in your query like so: `a query filename:some_
You may use wildcards (`*`) to use glob matching. You may use wildcards (`*`) to use glob matching.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/6/search?scope=blobs&search=installation curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/6/search?scope=blobs&search=installation"
``` ```
Example response: Example response:
...@@ -696,7 +696,7 @@ Example response: ...@@ -696,7 +696,7 @@ Example response:
### Scope: users ### Scope: users
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/3/search?scope=users&search=doe curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/3/search?scope=users&search=doe"
``` ```
Example response: Example response:
...@@ -738,7 +738,7 @@ The response depends on the requested scope. ...@@ -738,7 +738,7 @@ The response depends on the requested scope.
### Scope: issues ### Scope: issues
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/12/search?scope=issues&search=file curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/12/search?scope=issues&search=file"
``` ```
Example response: Example response:
...@@ -803,7 +803,7 @@ Example response: ...@@ -803,7 +803,7 @@ Example response:
### Scope: merge_requests ### Scope: merge_requests
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=merge_requests&search=file curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=merge_requests&search=file"
``` ```
Example response: Example response:
...@@ -881,7 +881,7 @@ Example response: ...@@ -881,7 +881,7 @@ Example response:
### Scope: milestones ### Scope: milestones
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/12/search?scope=milestones&search=release curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/12/search?scope=milestones&search=release"
``` ```
Example response: Example response:
...@@ -906,7 +906,7 @@ Example response: ...@@ -906,7 +906,7 @@ Example response:
### Scope: notes ### Scope: notes
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=notes&search=maxime curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=notes&search=maxime"
``` ```
Example response: Example response:
...@@ -955,7 +955,7 @@ results: ...@@ -955,7 +955,7 @@ results:
times in the content. times in the content.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=wiki_blobs&search=bye curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=wiki_blobs&search=bye"
``` ```
Example response: Example response:
...@@ -981,7 +981,7 @@ Example response: ...@@ -981,7 +981,7 @@ Example response:
### Scope: commits ### Scope: commits
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=commits&search=bye curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=commits&search=bye"
``` ```
Example response: Example response:
...@@ -1028,7 +1028,7 @@ Blobs searches are performed on both filenames and contents. Search results: ...@@ -1028,7 +1028,7 @@ Blobs searches are performed on both filenames and contents. Search results:
times in the content. times in the content.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=installation&ref=feature curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=blobs&search=installation&ref=feature"
``` ```
Example response: Example response:
...@@ -1054,7 +1054,7 @@ Example response: ...@@ -1054,7 +1054,7 @@ Example response:
### Scope: users ### Scope: users
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/6/search?scope=users&search=doe curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/6/search?scope=users&search=doe"
``` ```
Example response: Example response:
......
doc/api/settings.md
View file @ 663d717d
...@@ -15,7 +15,7 @@ GET /application/settings ...@@ -15,7 +15,7 @@ GET /application/settings
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/application/settings curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/settings"
``` ```
Example response: Example response:
...@@ -99,7 +99,7 @@ PUT /application/settings ...@@ -99,7 +99,7 @@ PUT /application/settings
``` ```
```shell ```shell
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"
``` ```
Example response: Example response:
......
doc/api/sidekiq_metrics.md
View file @ 663d717d
...@@ -15,7 +15,7 @@ GET /sidekiq/queue_metrics ...@@ -15,7 +15,7 @@ GET /sidekiq/queue_metrics
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/sidekiq/queue_metrics curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/sidekiq/queue_metrics"
``` ```
Example response: Example response:
...@@ -40,7 +40,7 @@ GET /sidekiq/process_metrics ...@@ -40,7 +40,7 @@ GET /sidekiq/process_metrics
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/sidekiq/process_metrics curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/sidekiq/process_metrics"
``` ```
Example response: Example response:
...@@ -82,7 +82,7 @@ GET /sidekiq/job_stats ...@@ -82,7 +82,7 @@ GET /sidekiq/job_stats
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/sidekiq/job_stats curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/sidekiq/job_stats"
``` ```
Example response: Example response:
...@@ -107,7 +107,7 @@ GET /sidekiq/compound_metrics ...@@ -107,7 +107,7 @@ GET /sidekiq/compound_metrics
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/sidekiq/compound_metrics curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/sidekiq/compound_metrics"
``` ```
Example response: Example response:
......
doc/api/snippets.md
View file @ 663d717d
...@@ -28,7 +28,7 @@ GET /snippets ...@@ -28,7 +28,7 @@ GET /snippets
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/snippets curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets"
``` ```
Example response: Example response:
...@@ -95,7 +95,7 @@ Parameters: ...@@ -95,7 +95,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/snippets/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/1"
``` ```
Example response: Example response:
...@@ -141,7 +141,7 @@ Parameters: ...@@ -141,7 +141,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/snippets/1/raw curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/1/raw"
``` ```
Example response: Example response:
...@@ -177,8 +177,8 @@ Example request: ...@@ -177,8 +177,8 @@ Example request:
curl --request POST \ curl --request POST \
--data '{"title": "This is a snippet", "content": "Hello world", "description": "Hello World snippet", "file_name": "test.txt", "visibility": "internal" }' \ --data '{"title": "This is a snippet", "content": "Hello world", "description": "Hello World snippet", "file_name": "test.txt", "visibility": "internal" }' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--header "PRIVATE-TOKEN: valid_api_token" \ --header "PRIVATE-TOKEN: <your_access_token>" \
https://gitlab.example.com/api/v4/snippets "https://gitlab.example.com/api/v4/snippets"
``` ```
Example response: Example response:
...@@ -235,8 +235,8 @@ Example request: ...@@ -235,8 +235,8 @@ Example request:
curl --request PUT \ curl --request PUT \
--data '{"title": "foo", "content": "bar"}' \ --data '{"title": "foo", "content": "bar"}' \
--header 'Content-Type: application/json' \ --header 'Content-Type: application/json' \
--header "PRIVATE-TOKEN: valid_api_token" \ --header "PRIVATE-TOKEN: <your_access_token>" \
https://gitlab.example.com/api/v4/snippets/1 "https://gitlab.example.com/api/v4/snippets/1"
``` ```
Example response: Example response:
...@@ -310,7 +310,7 @@ Parameters: ...@@ -310,7 +310,7 @@ Parameters:
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/snippets/public?per_page=2&page=1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/public?per_page=2&page=1"
``` ```
Example response: Example response:
...@@ -375,7 +375,7 @@ GET /snippets/:id/user_agent_detail ...@@ -375,7 +375,7 @@ GET /snippets/:id/user_agent_detail
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/snippets/1/user_agent_detail curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/1/user_agent_detail"
``` ```
Example response: Example response:
......
doc/api/statistics.md
View file @ 663d717d
...@@ -13,7 +13,7 @@ GET /application/statistics ...@@ -13,7 +13,7 @@ GET /application/statistics
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/application/statistics curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/statistics"
``` ```
Example response: Example response:
......
doc/api/suggestions.md
View file @ 663d717d
...@@ -16,7 +16,7 @@ PUT /suggestions/:id/apply ...@@ -16,7 +16,7 @@ PUT /suggestions/:id/apply
| `id` | integer/string | yes | The ID of a suggestion | | `id` | integer/string | yes | The ID of a suggestion |
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/suggestions/5/apply curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/suggestions/5/apply"
``` ```
Example response: Example response:
......
doc/api/system_hooks.md
View file @ 663d717d
...@@ -18,7 +18,7 @@ GET /hooks ...@@ -18,7 +18,7 @@ GET /hooks
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/hooks curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/hooks"
``` ```
Example response: Example response:
...@@ -92,7 +92,7 @@ GET /hooks/:id ...@@ -92,7 +92,7 @@ GET /hooks/:id
Example request: Example request:
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/hooks/2 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/hooks/2"
``` ```
Example response: Example response:
...@@ -123,5 +123,5 @@ DELETE /hooks/:id ...@@ -123,5 +123,5 @@ DELETE /hooks/:id
Example request: Example request:
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/hooks/2 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/hooks/2"
``` ```
doc/api/tags.md
View file @ 663d717d
...@@ -69,7 +69,7 @@ Parameters: ...@@ -69,7 +69,7 @@ Parameters:
| `tag_name` | string | yes | The name of the tag | | `tag_name` | string | yes | The name of the tag |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/repository/tags/v1.0.0 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/tags/v1.0.0"
``` ```
Example Response: Example Response:
......
doc/api/todos.md
View file @ 663d717d
...@@ -29,7 +29,7 @@ Parameters: ...@@ -29,7 +29,7 @@ Parameters:
| `type` | string | no | The type of a todo. Can be either `Issue` or `MergeRequest` | | `type` | string | no | The type of a todo. Can be either `Issue` or `MergeRequest` |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/todos curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/todos"
``` ```
Example Response: Example Response:
...@@ -203,7 +203,7 @@ Parameters: ...@@ -203,7 +203,7 @@ Parameters:
| `id` | integer | yes | The ID of a todo | | `id` | integer | yes | The ID of a todo |
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/todos/130/mark_as_done curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/todos/130/mark_as_done"
``` ```
Example Response: Example Response:
...@@ -294,5 +294,5 @@ POST /todos/mark_as_done ...@@ -294,5 +294,5 @@ POST /todos/mark_as_done
``` ```
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/todos/mark_as_done curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/todos/mark_as_done"
``` ```
doc/api/users.md
View file @ 663d717d
...@@ -643,7 +643,7 @@ PUT /user/status ...@@ -643,7 +643,7 @@ PUT /user/status
When both parameters `emoji` and `message` are empty, the status will be cleared. When both parameters `emoji` and `message` are empty, the status will be cleared.
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --data "emoji=coffee" --data "message=I crave coffee" https://gitlab.example.com/api/v4/user/status curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --data "emoji=coffee" --data "message=I crave coffee" "https://gitlab.example.com/api/v4/user/status"
``` ```
Example responses Example responses
...@@ -833,7 +833,7 @@ GET /user/gpg_keys ...@@ -833,7 +833,7 @@ GET /user/gpg_keys
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/user/gpg_keys curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/user/gpg_keys"
``` ```
Example response: Example response:
...@@ -863,7 +863,7 @@ Parameters: ...@@ -863,7 +863,7 @@ Parameters:
| `key_id` | integer | yes | The ID of the GPG key | | `key_id` | integer | yes | The ID of the GPG key |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/user/gpg_keys/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/user/gpg_keys/1"
``` ```
Example response: Example response:
...@@ -891,7 +891,7 @@ Parameters: ...@@ -891,7 +891,7 @@ Parameters:
| key | string | yes | The new GPG key | | key | string | yes | The new GPG key |
```shell ```shell
curl --data "key=-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFV..." --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/user/gpg_keys curl --data "key=-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFV..." --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/user/gpg_keys"
``` ```
Example response: Example response:
...@@ -921,7 +921,7 @@ Parameters: ...@@ -921,7 +921,7 @@ Parameters:
| `key_id` | integer | yes | The ID of the GPG key | | `key_id` | integer | yes | The ID of the GPG key |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/user/gpg_keys/1 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/user/gpg_keys/1"
``` ```
Returns `204 No Content` on success, or `404 Not found` if the key cannot be found. Returns `204 No Content` on success, or `404 Not found` if the key cannot be found.
...@@ -941,7 +941,7 @@ Parameters: ...@@ -941,7 +941,7 @@ Parameters:
| `id` | integer | yes | The ID of the user | | `id` | integer | yes | The ID of the user |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/2/gpg_keys curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/2/gpg_keys"
``` ```
Example response: Example response:
...@@ -972,7 +972,7 @@ Parameters: ...@@ -972,7 +972,7 @@ Parameters:
| `key_id` | integer | yes | The ID of the GPG key | | `key_id` | integer | yes | The ID of the GPG key |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/2/gpg_keys/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/2/gpg_keys/1"
``` ```
Example response: Example response:
...@@ -1001,7 +1001,7 @@ Parameters: ...@@ -1001,7 +1001,7 @@ Parameters:
| `key_id` | integer | yes | The ID of the GPG key | | `key_id` | integer | yes | The ID of the GPG key |
```shell ```shell
curl --data "key=-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFV..." --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/2/gpg_keys curl --data "key=-----BEGIN PGP PUBLIC KEY BLOCK-----\r\n\r\nxsBNBFV..." --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/2/gpg_keys"
``` ```
Example response: Example response:
...@@ -1032,7 +1032,7 @@ Parameters: ...@@ -1032,7 +1032,7 @@ Parameters:
| `key_id` | integer | yes | The ID of the GPG key | | `key_id` | integer | yes | The ID of the GPG key |
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/2/gpg_keys/1 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/2/gpg_keys/1"
``` ```
## List emails ## List emails
...@@ -1261,7 +1261,7 @@ Parameters: ...@@ -1261,7 +1261,7 @@ Parameters:
| `state` | string | no | filter tokens based on state (`all`, `active`, `inactive`) | | `state` | string | no | filter tokens based on state (`all`, `active`, `inactive`) |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/42/impersonation_tokens curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/impersonation_tokens"
``` ```
Example response: Example response:
...@@ -1313,7 +1313,7 @@ Parameters: ...@@ -1313,7 +1313,7 @@ Parameters:
| `impersonation_token_id` | integer | yes | The ID of the impersonation token | | `impersonation_token_id` | integer | yes | The ID of the impersonation token |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/42/impersonation_tokens/2 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/impersonation_tokens/2"
``` ```
Example response: Example response:
...@@ -1355,7 +1355,7 @@ POST /users/:user_id/impersonation_tokens ...@@ -1355,7 +1355,7 @@ POST /users/:user_id/impersonation_tokens
| `scopes` | array | yes | The array of scopes of the impersonation token (`api`, `read_user`) | | `scopes` | array | yes | The array of scopes of the impersonation token (`api`, `read_user`) |
```shell ```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"
``` ```
Example response: Example response:
...@@ -1387,7 +1387,7 @@ DELETE /users/:user_id/impersonation_tokens/:impersonation_token_id ...@@ -1387,7 +1387,7 @@ DELETE /users/:user_id/impersonation_tokens/:impersonation_token_id
``` ```
```shell ```shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/42/impersonation_tokens/1 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/42/impersonation_tokens/1"
``` ```
Parameters: Parameters:
...@@ -1425,7 +1425,7 @@ Parameters: ...@@ -1425,7 +1425,7 @@ Parameters:
| `from` | string | no | Date string in the format YEAR-MONTH-DAY. For example, `2016-03-11`. Defaults to 6 months ago. | | `from` | string | no | Date string in the format YEAR-MONTH-DAY. For example, `2016-03-11`. Defaults to 6 months ago. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/user/activities curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/user/activities"
``` ```
Example response: Example response:
...@@ -1480,7 +1480,7 @@ Returns: ...@@ -1480,7 +1480,7 @@ Returns:
- `400 Bad Request` when requested type is not supported. - `400 Bad Request` when requested type is not supported.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/users/<user_id>/memberships curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/:user_id/memberships"
``` ```
Example response: Example response:
......
doc/api/version.md
View file @ 663d717d
...@@ -10,7 +10,7 @@ GET /version ...@@ -10,7 +10,7 @@ GET /version
``` ```
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/version curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/version"
``` ```
Example response: Example response:
......
doc/api/visual_review_discussions.md
View file @ 663d717d
...@@ -36,5 +36,5 @@ Parameters: ...@@ -36,5 +36,5 @@ Parameters:
| `position[y]` | integer | no | Y coordinate (Only stored for `image` diff notes) | | `position[y]` | integer | no | Y coordinate (Only stored for `image` diff notes) |
```shell ```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"
``` ```
doc/api/vulnerabilities.md
View file @ 663d717d
...@@ -40,7 +40,7 @@ GET /vulnerabilities/:id ...@@ -40,7 +40,7 @@ GET /vulnerabilities/:id
| `id` | integer or string | yes | The ID of a Vulnerability to get | | `id` | integer or string | yes | The ID of a Vulnerability to get |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/vulnerabilities/1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/vulnerabilities/1"
``` ```
Example response: Example response:
......
doc/api/vulnerability_exports.md
View file @ 663d717d
...@@ -39,7 +39,7 @@ POST /security/projects/:id/vulnerability_exports ...@@ -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 | | `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 ```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. The created vulnerability export is automatically deleted after 1 hour.
...@@ -155,7 +155,7 @@ GET /security/vulnerability_exports/:id ...@@ -155,7 +155,7 @@ GET /security/vulnerability_exports/:id
| `id` | integer or string | yes | The vulnerability export's ID | | `id` | integer or string | yes | The vulnerability export's ID |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/security/vulnerability_exports/2 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/security/vulnerability_exports/2"
``` ```
If the vulnerability export isn't finished, the response is `202 Accepted`. If the vulnerability export isn't finished, the response is `202 Accepted`.
...@@ -192,7 +192,7 @@ GET /security/vulnerability_exports/:id/download ...@@ -192,7 +192,7 @@ GET /security/vulnerability_exports/:id/download
| `id` | integer or string | yes | The vulnerability export's ID | | `id` | integer or string | yes | The vulnerability export's ID |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/security/vulnerability_exports/2/download curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/security/vulnerability_exports/2/download"
``` ```
The response will be `404 Not Found` if the vulnerability export is not finished yet or was not found. The response will be `404 Not Found` if the vulnerability export is not finished yet or was not found.
......
doc/api/vulnerability_findings.md
View file @ 663d717d
...@@ -59,7 +59,7 @@ Beginning with GitLab 12.9, the `undefined` severity level is deprecated and the ...@@ -59,7 +59,7 @@ Beginning with GitLab 12.9, the `undefined` severity level is deprecated and the
| `pipeline_id` | integer/string | no | Returns vulnerability findings belonging to specified pipeline. | | `pipeline_id` | integer/string | no | Returns vulnerability findings belonging to specified pipeline. |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/vulnerability_findings curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/vulnerability_findings"
``` ```
Example response: Example response:
......
doc/api/wikis.md
View file @ 663d717d
...@@ -18,7 +18,7 @@ GET /projects/:id/wikis ...@@ -18,7 +18,7 @@ GET /projects/:id/wikis
| `with_content` | boolean | no | Include pages' content | | `with_content` | boolean | no | Include pages' content |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/wikis?with_content=1 curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/wikis?with_content=1"
``` ```
Example response: Example response:
...@@ -59,7 +59,7 @@ GET /projects/:id/wikis/:slug ...@@ -59,7 +59,7 @@ GET /projects/:id/wikis/:slug
| `slug` | string | yes | The slug (a unique string) of the wiki page | | `slug` | string | yes | The slug (a unique string) of the wiki page |
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/wikis/home curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/wikis/home"
``` ```
Example response: Example response:
...@@ -174,7 +174,7 @@ The `file=` parameter must point to a file on your filesystem and be preceded ...@@ -174,7 +174,7 @@ The `file=` parameter must point to a file on your filesystem and be preceded
by `@`. For example: by `@`. For example:
```shell ```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "file=@dk.png" https://gitlab.example.com/api/v4/projects/1/wikis/attachments curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "file=@dk.png" "https://gitlab.example.com/api/v4/projects/1/wikis/attachments"
``` ```
Example response: Example response:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7