Packages: NuGet

Use this API to interact with the NuGet package manager client.

This API is used by the NuGet package manager client and is generally not meant for manual consumption.

These endpoints do not adhere to the standard API authentication methods. See the NuGet package registry documentation for details on which headers and token types are supported. Undocumented authentication methods might be removed in the future.

The NuGet V3 Feed Service Index

GET /api/v4/groups/{id}/-/packages/nuget/index

This feature was introduced in GitLab 12.6

Parameters

Name	Type	Description
`id` Path, required	Integer or string	The group ID or full group path

Responses

Code	Description	Schema
`200`	OK	APIEntitiesNugetServiceIndex
`400`	Bad Request	—
`404`	Not Found	—

The NuGet Metadata Service - Package name level

GET /api/v4/groups/{id}/-/packages/nuget/metadata/{package_name}/index

This feature was introduced in GitLab 12.8

Parameters

Name	Type	Description
`id` Path, required	Integer or string	The group ID or full group path
`package_name` Path, required	String	The NuGet package name Example: `MyNuGetPkg`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesNugetPackagesMetadata
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet Metadata Service - Package name and version level

GET /api/v4/groups/{id}/-/packages/nuget/metadata/{package_name}/{package_version}

This feature was introduced in GitLab 12.8

Parameters

Name	Type	Description
`id` Path, required	Integer or string	The group ID or full group path
`package_name` Path, required	String	The NuGet package name Example: `MyNuGetPkg`
`package_version` Path, required	String	The NuGet package version Pattern: `[^\/]+` Example: `1.0.0`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesNugetPackageMetadata
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet Search Service

GET /api/v4/groups/{id}/-/packages/nuget/query

This feature was introduced in GitLab 12.8

Parameters

Name	Type	Description
`id` Path, required	Integer or string	The group ID or full group path
`q` Query	String	The search term Example: `MyNuGet`
`skip` Query	Integer	The number of results to skip Default: `0` Example: `1`
`take` Query	Integer	The number of results to return Default: `20` Example: `1`
`prerelease` Query	Boolean	Include prerelease versions Default: `true`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesNugetSearchResults
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet Symbol File Download Endpoint

GET /api/v4/groups/{id}/-/packages/nuget/symbolfiles/{file_name}/{signature}/{same_file_name}

This feature was introduced in GitLab 16.7

Parameters

Name	Type	Description
`id` Path, required	Integer or string	The group ID or full group path
`file_name` Path, required	String	The symbol file name Pattern: `[^\/]+` Example: `mynugetpkg.pdb`
`signature` Path, required	String	The symbol file signature Pattern: `[^\/]+` Example: `k813f89485474661234z7109cve5709eFFFFFFFF`
`same_file_name` Path, required	String	The symbol file name. Must match the ‘file_name’ parameter

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet V2 Feed Service Index

GET /api/v4/groups/{id}/-/packages/nuget/v2

This feature was introduced in GitLab 16.2

Parameters

Name	Type	Description
`id` Path, required	Integer or string	The group ID or full group path

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

The NuGet V2 Feed Package $metadata endpoint

GET /api/v4/groups/{id}/-/packages/nuget/v2/$metadata

This feature was introduced in GitLab 16.3

Parameters

Name	Type	Description
`id` Path, required	Integer or string	The group ID or full group path

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

Upload a NuGet v3 package file for a project

PUT /api/v4/projects/{id}/packages/nuget

Uploads a NuGet v3 package file for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (multipart/form-data)

Property	Type	Description
`package` Required	String (binary)	The package file to be published (generated by Multipart middleware)

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet Package Authorize endpoint

PUT /api/v4/projects/{id}/packages/nuget/authorize

This feature was introduced in GitLab 14.1

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet Content Service - index request

GET /api/v4/projects/{id}/packages/nuget/download/{package_name}/index

This feature was introduced in GitLab 12.8

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`package_name` Path, required	String	The NuGet package name Example: `mynugetpkg.1.3.0.17.nupkg`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesNugetPackagesVersions
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet Content Service - content request

GET /api/v4/projects/{id}/packages/nuget/download/{package_name}/{package_version}/{package_filename}

This feature was introduced in GitLab 12.8

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`package_name` Path, required	String	The NuGet package name Example: `mynugetpkg.1.3.0.17.nupkg`
`package_version` Path, required	String	The NuGet package version Pattern: `[^\/]+` Example: `1.3.0.17`
`package_filename` Path, required	String	The NuGet package filename Pattern: `[^\/]+` Example: `mynugetpkg.1.3.0.17.nupkg`

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet V3 Feed Service Index

GET /api/v4/projects/{id}/packages/nuget/index

This feature was introduced in GitLab 12.6

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	APIEntitiesNugetServiceIndex
`400`	Bad Request	—
`404`	Not Found	—

The NuGet Metadata Service - Package name level

GET /api/v4/projects/{id}/packages/nuget/metadata/{package_name}/index

This feature was introduced in GitLab 12.8

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`package_name` Path, required	String	The NuGet package name Example: `MyNuGetPkg`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesNugetPackagesMetadata
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet Metadata Service - Package name and version level

GET /api/v4/projects/{id}/packages/nuget/metadata/{package_name}/{package_version}

This feature was introduced in GitLab 12.8

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`package_name` Path, required	String	The NuGet package name Example: `MyNuGetPkg`
`package_version` Path, required	String	The NuGet package version Pattern: `[^\/]+` Example: `1.0.0`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesNugetPackageMetadata
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet Search Service

GET /api/v4/projects/{id}/packages/nuget/query

This feature was introduced in GitLab 12.8

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`q` Query	String	The search term Example: `MyNuGet`
`skip` Query	Integer	The number of results to skip Default: `0` Example: `1`
`take` Query	Integer	The number of results to return Default: `20` Example: `1`
`prerelease` Query	Boolean	Include prerelease versions Default: `true`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesNugetSearchResults
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet Symbol File Download Endpoint

GET /api/v4/projects/{id}/packages/nuget/symbolfiles/{file_name}/{signature}/{same_file_name}

This feature was introduced in GitLab 16.7

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`file_name` Path, required	String	The symbol file name Pattern: `[^\/]+` Example: `mynugetpkg.pdb`
`signature` Path, required	String	The symbol file signature Pattern: `[^\/]+` Example: `k813f89485474661234z7109cve5709eFFFFFFFF`
`same_file_name` Path, required	String	The symbol file name. Must match the ‘file_name’ parameter

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not Found	—

Upload a NuGet symbol package file

PUT /api/v4/projects/{id}/packages/nuget/symbolpackage

Uploads a specified NuGet symbol package file (.snupkg) for a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (multipart/form-data)

Property	Type	Description
`package` Required	String (binary)	The package file to be published (generated by Multipart middleware)

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet Symbol Package Authorize endpoint

PUT /api/v4/projects/{id}/packages/nuget/symbolpackage/authorize

This feature was introduced in GitLab 14.1

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet V2 Feed Service Index

GET /api/v4/projects/{id}/packages/nuget/v2

This feature was introduced in GitLab 16.2

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

Upload a NuGet v2 package file for a project

PUT /api/v4/projects/{id}/packages/nuget/v2

Uploads a NuGet v2 package file for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (multipart/form-data)

Property	Type	Description
`package` Required	String (binary)	The package file to be published (generated by Multipart middleware)

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet V2 Feed Package $metadata endpoint

GET /api/v4/projects/{id}/packages/nuget/v2/$metadata

This feature was introduced in GitLab 16.3

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

The NuGet V2 Feed Package Authorize endpoint

PUT /api/v4/projects/{id}/packages/nuget/v2/authorize

This feature was introduced in GitLab 16.2

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet Package Delete endpoint

DELETE /api/v4/projects/{id}/packages/nuget/{package_name}/{package_version}

This feature was introduced in GitLab 16.5

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`package_name` Path, required	String	The NuGet package name Pattern: `^[\-+._a-zA-Z0-9]+$` Example: `mynugetpkg`
`package_version` Path, required	String	The NuGet package version Pattern: `^(?:(0\|[1-9]\d))\.(?:(0\|[1-9]\d))(\.(?:(0\|[1-9]\d)))?(\.\d)?(?:(?:-((?:\d[a-zA-Z\-][0-9a-zA-Z\-]\|[1-9]\d\|0)(?:\.(?:\d[a-zA-Z\-][0-9a-zA-Z\-]\|[1-9]\d\|0))))?(?:\+([0-9a-zA-Z\-]+(?:\.[0-9a-zA-Z\-]+)))?)$` Example: `1.0.1`

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Not Found	—

The NuGet V2 Feed Find Packages by ID endpoint

GET /api/v4/projects/{project_id}/packages/nuget/v2/FindPackagesById()

This feature was introduced in GitLab 16.4

Parameters

Name	Type	Description
`project_id` Path, required	String or integer	The ID or URL-encoded path of the project
`id` Query, required	String	The NuGet package name Pattern: `^[\-+._a-zA-Z0-9]+$` Example: `mynugetpkg`

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

The NuGet V2 Feed Enumerate Packages endpoint

GET /api/v4/projects/{project_id}/packages/nuget/v2/Packages()

This feature was introduced in GitLab 16.4

Parameters

Name	Type	Description
`project_id` Path, required	String or integer	The ID or URL-encoded path of the project
`$filter` Query, required	String	The NuGet package name Pattern: `^[\-+._a-zA-Z0-9]+$` Example: `mynugetpkg`

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

The NuGet V2 Feed Single Package Metadata endpoint

GET /api/v4/projects/{project_id}/packages/nuget/v2/Packages(Id='{package_name}',Version='{package_version}')

This feature was introduced in GitLab 16.4

Parameters

Name	Type	Description
`project_id` Path, required	String or integer	The ID or URL-encoded path of the project
`package_name` Path, required	String	The NuGet package name Pattern: `^[\-+._a-zA-Z0-9]+$` Example: `mynugetpkg`
`package_version` Path, required	String	The NuGet package version Pattern: `^(?:(0\|[1-9]\d))\.(?:(0\|[1-9]\d))(\.(?:(0\|[1-9]\d)))?(\.\d)?(?:(?:-((?:\d[a-zA-Z\-][0-9a-zA-Z\-]\|[1-9]\d\|0)(?:\.(?:\d[a-zA-Z\-][0-9a-zA-Z\-]\|[1-9]\d\|0))))?(?:\+([0-9a-zA-Z\-]+(?:\.[0-9a-zA-Z\-]+)))?)$` Example: `1.3.0.17`

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesNugetDependency

Property	Type	Description
`@id`	String	Example: `http://gitlab.com/Sandbox.App/1.0.0.json#dependency`
`@type`	String	Example: `PackageDependency`
`id`	String	Example: `Dependency`
`range`	String	Example: `2.0.0`

APIEntitiesNugetDependencyGroup

Property	Type	Description
`@id`	String	Example: `http://gitlab.com/Sandbox.App/1.0.0.json#dependencygroup`
`@type`	String	Example: `PackageDependencyGroup`
`dependencies`	Array of APIEntitiesNugetDependency	—
`targetFramework`	String	Example: `fwk test`

APIEntitiesNugetPackageMetadata

Property	Type	Description
`@id`	String	Example: `https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json`
`catalogEntry`	APIEntitiesNugetPackageMetadataCatalogEntry	—
`packageContent`	String	Example: `https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/helloworld.1.3.0.17.nupkg`

APIEntitiesNugetPackageMetadataCatalogEntry

Property	Type	Description
`@id`	String	Example: `https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json`
`authors`	String	Example: `Authors`
`dependencyGroups`	Array of APIEntitiesNugetDependencyGroup	—
`description`	String	Example: `Description`
`iconUrl`	String	Example: `http://sandbox.com/icon`
`id`	String	Example: `MyNuGetPkg`
`licenseUrl`	String	Example: `http://sandbox.com/license`
`packageContent`	String	Example: `https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/helloworld.1.3.0.17.nupkg`
`projectUrl`	String	Example: `http://sandbox.com/project`
`published`	String	Example: `2023-05-08T17:23:25Z`
`summary`	String	Example: `Description`
`tags`	String	Example: `tag#1 tag#2`
`version`	String	Example: `1.3.0.17`

APIEntitiesNugetPackagesMetadata

Property	Type	Description
`count`	Integer	Example: `1`
`items`	Array of APIEntitiesNugetPackagesMetadataItem	—

APIEntitiesNugetPackagesMetadataItem

Property	Type	Description
`@id`	String	Example: `https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json`
`count`	Integer	Example: `1`
`items`	Array of APIEntitiesNugetPackageMetadata	—
`lower`	String	Example: `1.3.0.17`
`upper`	String	Example: `1.3.0.17`

APIEntitiesNugetPackagesVersions

Property	Type	Description
`versions`	Array of strings	Example: `["1.3.0.17"]`

APIEntitiesNugetSearchResult

Property	Type	Description
`@type`	String	Example: `Package`
`authors`	String	Example: `Authors`
`description`	String	Example: `Description`
`iconUrl`	String	Example: `http://sandbox.com/icon`
`id`	String	Example: `MyNuGetPkg`
`licenseUrl`	String	Example: `http://sandbox.com/license`
`projectUrl`	String	Example: `http://sandbox.com/project`
`summary`	String	Example: `Description`
`tags`	String	Example: `tag#1 tag#2`
`title`	String	Example: `MyNuGetPkg`
`totalDownloads`	Integer	Example: `1`
`verified`	Boolean	—
`version`	String	Example: `1.3.0.17`
`versions`	APIEntitiesNugetSearchResultVersion	—

APIEntitiesNugetSearchResults

Property	Type	Description
`data`	Array of APIEntitiesNugetSearchResult	—
`totalHits`	Integer	Example: `1`

APIEntitiesNugetSearchResultVersion

Property	Type	Description
`@id`	String	Example: `https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json`
`downloads`	Integer	Example: `1`
`version`	String	Example: `1.3.0.17`

APIEntitiesNugetServiceIndex

Property	Type	Description
`resources`	Array of objects	Example: `[{"@id":"https://gitlab.com/api/v4/projects/1/packages/nuget/query","@type":"SearchQueryService","comment":"Filter and search for packages by keyword."}]`
`version`	String	Example: `1.3.0.17`

The NuGet V3 Feed Service Index

The NuGet Metadata Service - Package name level

The NuGet Metadata Service - Package name and version level

The NuGet Search Service

The NuGet Symbol File Download Endpoint

The NuGet V2 Feed Service Index

The NuGet V2 Feed Package $metadata endpoint

Upload a NuGet v3 package file for a project

The NuGet Package Authorize endpoint

The NuGet Content Service - index request

The NuGet Content Service - content request

The NuGet V3 Feed Service Index

The NuGet Metadata Service - Package name level

The NuGet Metadata Service - Package name and version level

The NuGet Search Service

The NuGet Symbol File Download Endpoint

Upload a NuGet symbol package file

The NuGet Symbol Package Authorize endpoint

The NuGet V2 Feed Service Index

Upload a NuGet v2 package file for a project

The NuGet V2 Feed Package $metadata endpoint

The NuGet V2 Feed Package Authorize endpoint

The NuGet Package Delete endpoint

The NuGet V2 Feed Find Packages by ID endpoint

The NuGet V2 Feed Enumerate Packages endpoint

The NuGet V2 Feed Single Package Metadata endpoint

Schemas

APIEntitiesNugetDependency

APIEntitiesNugetDependencyGroup

APIEntitiesNugetPackageMetadata

APIEntitiesNugetPackageMetadataCatalogEntry

APIEntitiesNugetPackagesMetadata

APIEntitiesNugetPackagesMetadataItem

APIEntitiesNugetPackagesVersions

APIEntitiesNugetSearchResult

APIEntitiesNugetSearchResults

APIEntitiesNugetSearchResultVersion

APIEntitiesNugetServiceIndex

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC Compliance Report

Thank you

Error