2020-10-26 21:08:22 +00:00
---
2021-04-23 15:09:37 +00:00
stage: Secure
group: Composition Analysis
2020-11-26 06:09:20 +00:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-10-26 21:08:22 +00:00
---
2019-07-16 13:06:09 +00:00
# Dependencies API **(ULTIMATE)**
2020-12-04 21:09:29 +00:00
WARNING:
2019-07-16 13:06:09 +00:00
This API is in an alpha stage and considered unstable.
The response payload may be subject to change or breakage
across GitLab releases.
2021-09-30 18:11:31 +00:00
> - Introduced in GitLab 12.1.
> - Pagination introduced in 14.4.
2019-08-23 11:34:05 +00:00
Every call to this endpoint requires authentication. To perform this call, user should be authorized to read repository.
To see vulnerabilities in response, user should be authorized to read
2021-12-21 03:14:09 +00:00
[Project Security Dashboard ](../user/application_security/security_dashboard/index.md ).
2019-07-16 13:06:09 +00:00
## List project dependencies
2019-08-22 08:50:31 +00:00
Get a list of project dependencies. This API partially mirroring
2019-08-15 06:15:15 +00:00
[Dependency List ](../user/application_security/dependency_list/index.md ) feature.
2019-07-16 13:06:09 +00:00
This list can be generated only for [languages and package managers ](../user/application_security/dependency_scanning/index.md#supported-languages-and-package-managers )
2019-08-22 08:50:31 +00:00
supported by Gemnasium.
2019-07-16 13:06:09 +00:00
2020-02-27 09:09:01 +00:00
```plaintext
2019-07-16 13:06:09 +00:00
GET /projects/:id/dependencies
2019-08-23 11:34:05 +00:00
GET /projects/:id/dependencies?package_manager=maven
GET /projects/:id/dependencies?package_manager=yarn,bundler
2019-07-16 13:06:09 +00:00
```
| Attribute | Type | Required | Description |
| ------------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2021-06-28 15:08:03 +00:00
| `id` | integer/string | yes | The ID or [URL-encoded path of the project ](index.md#namespaced-path-encoding ). |
2021-11-11 15:10:57 +00:00
| `package_manager` | string array | no | Returns dependencies belonging to specified package manager. Valid values: `bundler` , `composer` , `conan` , `go` , `gradle` , `maven` , `npm` , `nuget` , `pip` , `pipenv` , `yarn` , `sbt` , or `setuptools` . |
2019-07-16 13:06:09 +00:00
2020-01-30 15:09:15 +00:00
```shell
2020-05-28 00:08:37 +00:00
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/projects/4/dependencies"
2019-07-16 13:06:09 +00:00
```
Example response:
```json
[
{
"name": "rails",
"version": "5.0.1",
"package_manager": "bundler",
2019-08-23 11:34:05 +00:00
"dependency_file_path": "Gemfile.lock",
"vulnerabilities": [{
"name": "DDoS",
"severity": "unknown"
}]
2019-07-16 13:06:09 +00:00
},
{
"name": "hanami",
"version": "1.3.1",
"package_manager": "bundler",
2019-08-23 11:34:05 +00:00
"dependency_file_path": "Gemfile.lock",
"vulnerabilities": []
2019-07-16 13:06:09 +00:00
}
]
```
2021-09-30 18:11:31 +00:00
## Dependencies pagination
By default, `GET` requests return 20 results at a time because the API results
are paginated.
Read more on [pagination ](index.md#pagination ).