51 lines
2.2 KiB
Markdown
51 lines
2.2 KiB
Markdown
|
# Dependencies API **(ULTIMATE)**
|
||
|
|
|
||
|
|
CAUTION: **Caution:**
|
||
|
|
This API is in an alpha stage and considered unstable.
|
||
|
|
The response payload may be subject to change or breakage
|
||
|
|
across GitLab releases.
|
||
|
|
|
||
|
|
Every call to this endpoint requires authentication. To perform this call, user should be authorized to read
|
||
|
|
[Project Security Dashboard](../user/application_security/security_dashboard/index.md#project-security-dashboard).
|
||
|
|
|
||
|
|
## List project dependencies
|
||
|
|
|
||
|
|
Get a list of project dependencies. This API partially mirroring
|
||
|
|
[Dependency List](../user/application_security/dependency_scanning/index.md#dependency-list) feature.
|
||
|
|
This list can be generated only for [languages and package managers](../user/application_security/dependency_scanning/index.md#supported-languages-and-package-managers)
|
||
|
|
supported by Gemnasium.
|
||
|
|
|
||
|
|
```
|
||
|
|
GET /projects/:id/dependencies
|
||
|
|
GET /projects/:id/vulnerabilities?package_manger=maven
|
||
|
|
GET /projects/:id/vulnerabilities?package_manger=yarn,bundler
|
||
|
|
```
|
||
|
|
|
||
|
|
| Attribute | Type | Required | Description |
|
||
|
|
| ------------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||
|
|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
|
||
|
|
| `package_manager` | string array | no | Returns dependencies belonging to specified package manager. Valid values: `bundler`, `composer`, `maven`, `npm`, `pip` or `yarn`. |
|
||
|
|
|
||
|
|
```bash
|
||
|
|
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/dependencies
|
||
|
|
```
|
||
|
|
|
||
|
|
Example response:
|
||
|
|
|
||
|
|
```json
|
||
|
|
[
|
||
|
|
{
|
||
|
|
"name": "rails",
|
||
|
|
"version": "5.0.1",
|
||
|
|
"package_manager": "bundler",
|
||
|
|
"dependency_file_path": "Gemfile.lock"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"name": "hanami",
|
||
|
|
"version": "1.3.1",
|
||
|
|
"package_manager": "bundler",
|
||
|
|
"dependency_file_path": "Gemfile.lock"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
```
|