diff options
Diffstat (limited to 'doc/api/pipelines.md')
| -rw-r--r-- | doc/api/pipelines.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index d8b4b4cf41f..1b75a3f74b5 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -36,18 +36,18 @@ GET /projects/:id/pipelines | Attribute | Type | Required | Description | |------------------|----------------|----------|-------------| | `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | -| `scope` | string | No | The scope of pipelines, one of: `running`, `pending`, `finished`, `branches`, `tags` | -| `status` | string | No | The status of pipelines, one of: `created`, `waiting_for_resource`, `preparing`, `pending`, `running`, `success`, `failed`, `canceled`, `skipped`, `manual`, `scheduled` | -| `source` | string | No | In [GitLab 14.3 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/325439), how the pipeline was triggered, one of: `api`, `chat`, `external`, `external_pull_request_event`, `merge_request_event`, `ondemand_dast_scan`, `ondemand_dast_validation`, `parent_pipeline`, `pipeline`, `push`, `schedule`, `security_orchestration_policy`, `trigger`, `web`, or `webide`. | +| `name` | string | No | Return pipelines with the specified name. Introduced in GitLab 15.11, not available by default. | +| `order_by` | string | No | Order pipelines by `id`, `status`, `ref`, `updated_at` or `user_id` (default: `id`) | | `ref` | string | No | The ref of pipelines | +| `scope` | string | No | The scope of pipelines, one of: `running`, `pending`, `finished`, `branches`, `tags` | | `sha` | string | No | The SHA of pipelines | -| `yaml_errors` | boolean | No | Returns pipelines with invalid configurations | -| `username` | string | No | The username of the user who triggered pipelines | +| `sort` | string | No | Sort pipelines in `asc` or `desc` order (default: `desc`) | +| `source` | string | No | In [GitLab 14.3 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/325439), how the pipeline was triggered, one of: `api`, `chat`, `external`, `external_pull_request_event`, `merge_request_event`, `ondemand_dast_scan`, `ondemand_dast_validation`, `parent_pipeline`, `pipeline`, `push`, `schedule`, `security_orchestration_policy`, `trigger`, `web`, or `webide`. | +| `status` | string | No | The status of pipelines, one of: `created`, `waiting_for_resource`, `preparing`, `pending`, `running`, `success`, `failed`, `canceled`, `skipped`, `manual`, `scheduled` | | `updated_after` | datetime | No | Return pipelines updated after the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`). | | `updated_before` | datetime | No | Return pipelines updated before the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`). | -| `name` | string | No | Return pipelines with the specified name. Introduced in GitLab 15.11, not available by default. | -| `order_by` | string | No | Order pipelines by `id`, `status`, `ref`, `updated_at` or `user_id` (default: `id`) | -| `sort` | string | No | Sort pipelines in `asc` or `desc` order (default: `desc`) | +| `username` | string | No | The username of the user who triggered pipelines | +| `yaml_errors` | boolean | No | Returns pipelines with invalid configurations | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipelines" @@ -530,8 +530,8 @@ PUT /projects/:id/pipelines/:pipeline_id/metadata | Attribute | Type | Required | Description | |---------------|----------------|----------|-------------| | `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | -| `pipeline_id` | integer | Yes | The ID of a pipeline | | `name` | string | Yes | The new name of the pipeline | +| `pipeline_id` | integer | Yes | The ID of a pipeline | Sample request: |