List Releases
  • 21 Feb 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

List Releases

  • Dark
    Light
  • PDF

Article Summary

The List Releases is an endpoint in ProGet's SCA Directory API that will return an array of ReleaseInfo Object objects describing the releases of a specified project.

šŸš€ Quick Example: Listing Releases of a Project with Curl

This example lists releases of 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"

Request Specification

To list all releases of a project, simply GET to the URL with an appropriate API Key.

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

Listing releases requires the project name (e.g. myProject):

GET /api/sca/releases?project=myProject

Response Specification

A successful (200) response body will contain an array of ReleaseInfo Object objects. For example, to listing release versions of a project named myProject, the request would return this:

GET /api/sca/releases?project=myProject

[
  {
    "version":"1.0.0",
    "active":true,
    "viewReleaseUrl":"https://proget.corp.local/projects/release?projectReleaseId=1",
    "viewIssuesUrl":"https://proget.corp.local/projects/release/issues?projectReleaseId=1"
  },
  {
    "version":"1.1.0",
    "active":true,
    "viewReleaseUrl":"https://proget.corp.local/projects/release?projectReleaseId=2",
    "viewIssuesUrl":"https://proget.corp.local/projects/release/issues?projectReleaseId=2"
  },
  {
    "version":"1.2.3",
    "active":true,
    "viewReleaseUrl":"https://proget.corp.local/projects/release?projectReleaseId=3",
    "viewIssuesUrl":"https://proget.corp.local/projects/release/issues?projectReleaseId=3"
  },
  {...}
]
ResponseDetails
200 (Success)body will contain an array of ReleaseInfo objects
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
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?