kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/api/packages/nuget.md

11 KiB
Raw Blame History

stage group info
Package Package To determine the technical writer assigned to the Stage/Group associated with this page, see https://about..example/handbook/engineering/ux/technical-writing/#assignments

NuGet API (FREE)

This is the API documentation for NuGet Packages.

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

For instructions on how to upload and install NuGet packages from the GitLab package registry, see the NuGet package registry documentation.

NOTE: 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.

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.

Upload a NuGet package file:

PUT projects/:id/packages/nuget
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 \
     --upload-file path/to/mynugetpkg.1.3.0.17.nupkg \
     --user <username>:<personal_access_token> \
     "https://gitlab.example.com/api/v4/projects/1/packages/nuget"

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 \
     --upload-file 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

Introduced in GitLab 12.6.

Returns a list of available API resources:

GET <route-prefix>/index

Example Request:

curl --user <username>:<personal_access_token> "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": "",
            "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",
            "summary": ""
          }
        }
      ]
    }
  ]
}

Version Metadata Service

Introduced in GitLab 12.8.

Returns metadata for a specific package version:

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/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": "",
    "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",
    "summary": ""
  }
}

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": "",
      "id": "MyNuGetPkg",
      "title": "MyNuGetPkg",
      "summary": "",
      "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": ""
    }
  ]
}