- Package index
- Download a package file
- Upload a package file
- Upload a symbol package file
- Route prefix
- Service Index
- Metadata Service
- Version Metadata Service
- Search Service
- Delete service
- V2 Feed Metadata Endpoints
NuGet API
This is the API documentation for NuGet Packages.
For instructions on how to upload and install NuGet packages from the GitLab package registry, see the NuGet package registry documentation.
Package index
Introduced in GitLab 12.8.
Returns the index for a given package, which includes a list of available versions:
GET projects/:id/packages/nuget/download/:package_name/index
Attribute | Type | Required | Description |
---|---|---|---|
id | string | yes | The ID or full path of the project. |
package_name | string | yes | The name of the package. |
curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/index"
Example response:
{
"versions": [
"1.3.0.17"
]
}
Download a package file
Introduced in GitLab 12.8.
Download a NuGet package file. The metadata service provides this URL.
GET projects/:id/packages/nuget/download/:package_name/:package_version/:package_filename
Attribute | Type | Required | Description |
---|---|---|---|
id | string | yes | The ID or full path of the project. |
package_name | string | yes | The name of the package. |
package_version | string | yes | The version of the package. |
package_filename | string | yes | The name of the file. |
curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/mynugetpkg.1.3.0.17.nupkg"
Write the output to a file:
curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/mynugetpkg.1.3.0.17.nupkg" > MyNuGetPkg.1.3.0.17.nupkg
This writes the downloaded file to MyNuGetPkg.1.3.0.17.nupkg
in the current directory.
Upload a package file
- Introduced in GitLab 12.8 for NuGet v3 feed.
- Introduced in GitLab 16.2 for NuGet v2 feed.
Upload a NuGet package file:
-
For NuGet v3 feed:
PUT projects/:id/packages/nuget
-
For NuGet V2 feed:
PUT projects/:id/packages/nuget/v2
Attribute | Type | Required | Description |
---|---|---|---|
id | string | yes | The ID or full path of the project. |
package_name | string | yes | The name of the package. |
package_version | string | yes | The version of the package. |
package_filename | string | yes | The name of the file. |
-
For NuGet v3 feed:
curl --request PUT \ --form 'package=@path/to/mynugetpkg.1.3.0.17.nupkg' \ --user <username>:<personal_access_token> \ "https://gitlab.example.com/api/v4/projects/1/packages/nuget/"
-
For NuGet v2 feed:
curl --request PUT \ --form 'package=@path/to/mynugetpkg.1.3.0.17.nupkg' \ --user <username>:<personal_access_token> \ "https://gitlab.example.com/api/v4/projects/1/packages/nuget/v2"
Upload a symbol package file
Introduced in GitLab 12.8.
Upload a NuGet symbol package file (.snupkg
):
PUT projects/:id/packages/nuget/symbolpackage
Attribute | Type | Required | Description |
---|---|---|---|
id | string | yes | The ID or full path of the project. |
package_name | string | yes | The name of the package. |
package_version | string | yes | The version of the package. |
package_filename | string | yes | The name of the file. |
curl --request PUT \
--form 'package=@path/to/mynugetpkg.1.3.0.17.snupkg' \
--user <username>:<personal_access_token> \
"https://gitlab.example.com/api/v4/projects/1/packages/nuget/symbolpackage"
Route prefix
For the remaining routes, there are two sets of identical routes that each make requests in different scopes:
- Use the group-level prefix to make requests in a group’s scope.
- Use the project-level prefix to make requests in a single project’s scope.
The examples in this document all use the project-level prefix.
Group-level
/groups/:id/-/packages/nuget`
Attribute | Type | Required | Description |
---|---|---|---|
id | string | yes | The group ID or full group path. |
Project-level
/projects/:id/packages/nuget`
Attribute | Type | Required | Description |
---|---|---|---|
id | string | yes | The project ID or full project path. |
Service Index
V2 source feed/protocol
Returns an XML document that represents the service index of the v2 NuGet source feed. Authentication is not required:
GET <route-prefix>/v2
Example Request:
curl "https://gitlab.example.com/api/v4/projects/1/packages/nuget/v2"
Example response:
<?xml version="1.0" encoding="utf-8"?>
<service xmlns="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom" xml:base="https://gitlab.example.com/api/v4/projects/1/packages/nuget/v2">
<workspace>
<atom:title type="text">Default</atom:title>
<collection href="Packages">
<atom:title type="text">Packages</atom:title>
</collection>
</workspace>
</service>
V3 source feed/protocol
- Introduced in GitLab 12.6.
- Changed to be public in GitLab 16.1.
Returns a list of available API resources. Authentication is not required:
GET <route-prefix>/index
Example Request:
curl "https://gitlab.example.com/api/v4/projects/1/packages/nuget/index"
Example response:
{
"version": "3.0.0",
"resources": [
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/query",
"@type": "SearchQueryService",
"comment": "Filter and search for packages by keyword."
},
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/query",
"@type": "SearchQueryService/3.0.0-beta",
"comment": "Filter and search for packages by keyword."
},
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/query",
"@type": "SearchQueryService/3.0.0-rc",
"comment": "Filter and search for packages by keyword."
},
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata",
"@type": "RegistrationsBaseUrl",
"comment": "Get package metadata."
},
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata",
"@type": "RegistrationsBaseUrl/3.0.0-beta",
"comment": "Get package metadata."
},
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata",
"@type": "RegistrationsBaseUrl/3.0.0-rc",
"comment": "Get package metadata."
},
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/download",
"@type": "PackageBaseAddress/3.0.0",
"comment": "Get package content (.nupkg)."
},
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget",
"@type": "PackagePublish/2.0.0",
"comment": "Push and delete (or unlist) packages."
},
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/symbolpackage",
"@type": "SymbolPackagePublish/4.9.0",
"comment": "Push symbol packages."
}
]
}
The URLs in the response have the same route prefix used to request them. If you request them with
the group-level route, the returned URLs contain /groups/:id/-
.
Metadata Service
Introduced in GitLab 12.8.
Returns metadata for a package:
GET <route-prefix>/metadata/:package_name/index
Attribute | Type | Required | Description |
---|---|---|---|
package_name | string | yes | The name of the package. |
curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/index"
Example response:
{
"count": 1,
"items": [
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json",
"lower": "1.3.0.17",
"upper": "1.3.0.17",
"count": 1,
"items": [
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json",
"packageContent": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/helloworld.1.3.0.17.nupkg",
"catalogEntry": {
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json",
"authors": "Author1, Author2",
"dependencyGroups": [],
"id": "MyNuGetPkg",
"version": "1.3.0.17",
"tags": "",
"packageContent": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/helloworld.1.3.0.17.nupkg",
"description": "Description of the package",
"summary": "Description of the package",
"published": "2023-05-08T17:23:25Z",
}
}
]
}
]
}
Version Metadata Service
Introduced in GitLab 12.8.
Returns metadata for a specific package version:
GET <route-prefix>/metadata/:package_name/:package_version
Attribute | Type | Required | Description |
---|---|---|---|
package_name | string | yes | The name of the package. |
package_version | string | yes | The version of the package. |
curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17"
Example response:
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json",
"packageContent": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/helloworld.1.3.0.17.nupkg",
"catalogEntry": {
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json",
"authors": "Author1, Author2",
"dependencyGroups": [],
"id": "MyNuGetPkg",
"version": "1.3.0.17",
"tags": "",
"packageContent": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/helloworld.1.3.0.17.nupkg",
"description": "Description of the package",
"summary": "Description of the package",
"published": "2023-05-08T17:23:25Z",
}
}
Search Service
Introduced in GitLab 12.8.
Given a query, search for NuGet packages in the repository:
GET <route-prefix>/query
Attribute | Type | Required | Description |
---|---|---|---|
q | string | yes | The search query. |
skip | integer | no | The number of results to skip. |
take | integer | no | The number of results to return. |
prerelease | boolean | no | Include prerelease versions. Defaults to true if no value is supplied. |
curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/projects/1/packages/nuget/query?q=MyNuGet"
Example response:
{
"totalHits": 1,
"data": [
{
"@type": "Package",
"authors": "Author1, Author2",
"id": "MyNuGetPkg",
"title": "MyNuGetPkg",
"description": "Description of the package",
"summary": "Description of the package",
"totalDownloads": 0,
"verified": true,
"version": "1.3.0.17",
"versions": [
{
"@id": "https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json",
"version": "1.3.0.17",
"downloads": 0
}
],
"tags": ""
}
]
}
Delete service
Introduced in GitLab 16.5.
Delete a NuGet package:
DELETE projects/:id/packages/nuget/:package_name/:package_version
Attribute | Type | Required | Description |
---|---|---|---|
id | string | yes | The ID or full path of the project. |
package_name | string | yes | The name of the package. |
package_version | string | yes | The version of the package. |
curl --request DELETE \
--user <username>:<personal_access_token> \
"https://gitlab.example.com/api/v4/projects/1/packages/nuget/MyNuGetPkg/1.3.0.17"
Possible request responses:
Status | Description |
---|---|
204 | Package deleted |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
V2 Feed Metadata Endpoints
Introduced in GitLab 16.3.
$metadata endpoint
Authentication is not required. Returns metadata for a V2 feed available endpoints:
GET <route-prefix>/v2/$metadata
curl "https://gitlab.example.com/api/v4/projects/1/packages/nuget/v2/$metadata"
Example response:
<edmx:Edmx xmlns:edmx="http://schemas.microsoft.com/ado/2007/06/edmx" Version="1.0">
<edmx:DataServices xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" m:DataServiceVersion="2.0" m:MaxDataServiceVersion="2.0">
<Schema xmlns="http://schemas.microsoft.com/ado/2006/04/edm" Namespace="NuGetGallery.OData">
<EntityType Name="V2FeedPackage" m:HasStream="true">
<Key>
<PropertyRef Name="Id"/>
<PropertyRef Name="Version"/>
</Key>
<Property Name="Id" Type="Edm.String" Nullable="false"/>
<Property Name="Version" Type="Edm.String" Nullable="false"/>
<Property Name="Authors" Type="Edm.String"/>
<Property Name="Dependencies" Type="Edm.String"/>
<Property Name="Description" Type="Edm.String"/>
<Property Name="DownloadCount" Type="Edm.Int64" Nullable="false"/>
<Property Name="IconUrl" Type="Edm.String"/>
<Property Name="Published" Type="Edm.DateTime" Nullable="false"/>
<Property Name="ProjectUrl" Type="Edm.String"/>
<Property Name="Tags" Type="Edm.String"/>
<Property Name="Title" Type="Edm.String"/>
<Property Name="LicenseUrl" Type="Edm.String"/>
</EntityType>
</Schema>
<Schema xmlns="http://schemas.microsoft.com/ado/2006/04/edm" Namespace="NuGetGallery">
<EntityContainer Name="V2FeedContext" m:IsDefaultEntityContainer="true">
<EntitySet Name="Packages" EntityType="NuGetGallery.OData.V2FeedPackage"/>
<FunctionImport Name="FindPackagesById" ReturnType="Collection(NuGetGallery.OData.V2FeedPackage)" EntitySet="Packages">
<Parameter Name="id" Type="Edm.String" FixedLength="false" Unicode="false"/>
</FunctionImport>
</EntityContainer>
</Schema>
</edmx:DataServices>
</edmx:Edmx>
OData package entry endpoints
Introduced in GitLab 16.4.
Endpoint | Description |
---|---|
GET projects/:id/packages/nuget/v2/Packages()?$filter=(tolower(Id) eq '<package_name>') | Returns an OData XML document containing information about the package with the given name. |
GET projects/:id/packages/nuget/v2/FindPackagesById()?id='<package_name>' | Returns an OData XML document containing information about the package with the given name. |
GET projects/:id/packages/nuget/v2/Packages(Id='<package_name>',Version='<package_version>') | Returns an OData XML document containing information about the package with the given name and version. |
curl "https://gitlab.example.com/api/v4/projects/1/packages/nuget/v2/Packages(Id='mynugetpkg',Version='1.0.0')"
Example response:
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xml:base="https://gitlab.example.com/api/v4/projects/1/packages/nuget/v2">
<id>https://gitlab.example.com/api/v4/projects/1/packages/nuget/v2/Packages(Id='mynugetpkg',Version='1.0.0')</id>
<category term="V2FeedPackage" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/>
<title type="text">mynugetpkg</title>
<content type="application/zip" src="https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/mynugetpkg/1.0.0/mynugetpkg.1.0.0.nupkg"/>
<m:properties>
<d:Version>1.0.0</d:Version>
</m:properties>
</entry>
Packages()
and
FindPackagesByID()
endpoints, so the latest version of the package
cannot be returned. You must provide the version when you install
or upgrade a package with the NuGet v2 feed.curl "https://gitlab.example.com/api/v4/projects/1/packages/nuget/v2/Packages()?$filter=(tolower(Id) eq 'mynugetpkg')"
Example response:
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xml:base="https://gitlab.example.com/api/v4/projects/1/packages/nuget/v2">
<id>https://gitlab.example.com/api/v4/projects/1/packages/nuget/v2/Packages(Id='mynugetpkg',Version='')</id>
<category term="V2FeedPackage" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/>
<title type="text">mynugetpkg</title>
<content type="application/zip" src="https://gitlab.example.com/api/v4/projects/1/packages/nuget/v2"/>
<m:properties>
<d:Version></d:Version>
</m:properties>
</entry>