diff options
| author | Lee Tickett <lee@tickett.net> | 2019-06-24 12:18:40 +0000 |
|---|---|---|
| committer | Kamil Trzciński <ayufan@ayufan.eu> | 2019-06-24 12:18:40 +0000 |
| commit | ec66f1b5ca20764abe21524792480755b614dbc7 (patch) | |
| tree | 3ec0bcd669e9d015687effe037c18a3acf389952 /doc/api | |
| parent | cf137da316175ed43a980f57e22a81c537a54169 (diff) | |
| download | gitlab-ce-ec66f1b5ca20764abe21524792480755b614dbc7.tar.gz | |
Add name & search parameters to project environments API
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/environments.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/api/environments.md b/doc/api/environments.md index ebcdc546d08..44f86861ff7 100644 --- a/doc/api/environments.md +++ b/doc/api/environments.md @@ -11,9 +11,11 @@ GET /projects/:id/environments | Attribute | Type | Required | Description | | --------- | ------- | -------- | --------------------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `name` | string | no | Return the environment with this name. Mutually exclusive with `search` | +| `search` | string | no | Return list of environments matching the search criteria. Mutually exclusive with `name` | ```bash -curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/environments +curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/environments?name=review%2Ffix-foo ``` Example response: |