Get Release
  • 21 Feb 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

Get Release

  • Dark
    Light
  • PDF

Article Summary

The Get Release is an endpoint in ProGet's SCA Directory API that will get a specified project release, and return a ReleaseInfo Object object describing the release.

šŸš€ Quick Example: Getting a Release with Curl

This example gets version 1.2.3 of a release for a project named myProject, authenticating with the API key abc12345:

curl -X GET -H "X-ApiKey: abc12345" "https://proget.corp.local/api/sca/releases?project=myProject&version=1.2.3"

Request Specification

To get a release, simply GET to the URL with an appropriate API Key.

GET /api/sca/releases?name=Ā«projectNameĀ»&version=Ā«versionNumberĀ»

Getting a release requires the project name (e.g. myProject) and the version (e.g. 1.2.3):

GET /api/sca/releases?project=myProject&version=1.2.3

Response Specification

A successful (200) response body will contain a ReleaseInfo Object object. For example, to getting release version 1.2.3 of a project named myProject, the request would return this:

GET /api/sca/releases?project=myProject&version=1.2.3

{
  "version":"1.2.3",
  "active":true,
  "viewReleaseUrl":"http://192.168.0.189:8624/projects/release?projectReleaseId=2", 
  "viewIssuesUrl":"http://192.168.0.189:8624/projects/release/issues?projectReleaseId=2",
  "comments":[],
  "packages":[]
}
ResponseDetails
200 (Success)body will contain a ReleaseInfo object
400 (Invalid Input)indicates invalid or missing properties
403 (Unauthorized API Key)indicates a missing, unknown, or unauthorized API Key; the body will be empty
404 (Project or Release Not Found)indicates that the specified project or release does not exist
500 (Server Error)indicates an unexpected error; the body will contain the message and stack trace, and this will also be logged

Was this article helpful?

What's Next