Skip to main content

List Releases

GET
Retrieve a paginated list of GitHub releases.

Query Parameters

organization
string
Filter releases by organization that owns the repository.Example: OWASP
repository
string
Filter releases by repository name.Example: Nest
tag_name
string
Filter releases by tag name.Example: 0.2.10
ordering
string
Sort results by field. Prefix with - for descending order.
  • created_at - Creation date (ascending)
  • -created_at - Creation date (descending)
  • published_at - Publication date (ascending)
  • -published_at - Publication date (descending)
Default: -published_at,-created_at
page
integer
Page number for pagination. Default: 1
limit
integer
Number of results per page. Default: 100

Response Schema

items
array
Array of release objects
count
integer
Total number of releases matching the filter

Examples

# List all releases
curl -X GET "https://nest.owasp.org/api/v0/releases/"

# Filter by organization
curl -X GET "https://nest.owasp.org/api/v0/releases/?organization=OWASP"

# Filter by repository
curl -X GET "https://nest.owasp.org/api/v0/releases/?repository=Nest"

# Filter by organization and repository
curl -X GET "https://nest.owasp.org/api/v0/releases/?organization=OWASP&repository=Nest"

# Filter by tag name
curl -X GET "https://nest.owasp.org/api/v0/releases/?tag_name=0.2.10"

# Sort by creation date (newest first)
curl -X GET "https://nest.owasp.org/api/v0/releases/?ordering=-created_at"

# Sort by publication date (most recently published first)
curl -X GET "https://nest.owasp.org/api/v0/releases/?ordering=-published_at"

# Combine filters and pagination
curl -X GET "https://nest.owasp.org/api/v0/releases/?organization=OWASP&page=1&limit=20"

Get Release

GET
Retrieve detailed information about a specific GitHub release.

Path Parameters

organization_id
string
required
Organization login/username that owns the repository.Example: OWASP
repository_id
string
required
Repository name.Example: Nest
release_id
string
required
Release tag name.Example: 0.2.10

Response Schema

created_at
datetime
ISO 8601 timestamp when the release was created
name
string
Release name
published_at
datetime
ISO 8601 timestamp when the release was published (null if unpublished)
tag_name
string
Git tag name associated with the release
description
string
Release description/notes

Error Responses

404 Not Found
object

Examples

# Get release by organization, repository, and tag name
curl -X GET "https://nest.owasp.org/api/v0/releases/OWASP/Nest/0.2.10"

Build docs developers (and LLMs) love