Skip to content

Get a paginated, filterable list of release labels

GET
/v1/apps/{appName}/deployments/{deploymentName}/labels
curl --request GET \
--url 'https://api.aetherpush.com/v1/apps/example/deployments/example/labels?isMandatory=true&isDisabled=true&releaseMethod=Upload' \
--header 'Authorization: Bearer <token>'

Returns a lightweight, paginated view of release labels. Unlike /history, this endpoint excludes heavy fields (blobUrl, hashes) and supports filtering by label, appVersion, description, mandatory/disabled flags, releaseMethod, and upload-time range. Designed for dashboard release tables.

appName
required
string
deploymentName
required
string
label
string
appVersion
string
description
string

Case-insensitive substring match.

isMandatory
string
Allowed values: true false
isDisabled
string
Allowed values: true false
releaseMethod
string
Allowed values: Upload Promote Rollback
uploadTimeStart
string

Unix timestamp (ms) lower bound, as a string.

uploadTimeEnd
string

Unix timestamp (ms) upper bound, as a string.

page
integer
>= 1
size
integer
>= 1

Paginated labels with meta and links.

Media typeapplication/json
object
data
required
Array<object>
object
label
required
string
appVersion
required
string
description
required
string
isMandatory
required
boolean
isDisabled
required
boolean
releaseMethod
string
Allowed values: Upload Promote Rollback
uploadTime
required
integer format: int64
size
required
integer format: int64
meta
required
object
totalItems
required
integer
itemCount

Number of items in the current page.

integer
itemsPerPage
required
integer
>= 1
totalPages
required
integer
>= 1
currentPage
required
integer
>= 1
links
required
object
first
required
string format: uri
previous
required
string format: uri
next
required
string format: uri
last
required
string format: uri

Example

{
"data": [
{
"label": "v3",
"releaseMethod": "Upload"
}
]
}

Unauthenticated.

Media typeapplication/json
Error

Standard error envelope. code is the stable machine identifier for client branching and i18n. The wording of error is a human-readable fallback and is not part of the contract. Specialized responses keep narrower code enums where clients already branch on them.

object
error
required

Human-readable error message.

string
code
required

Stable machine code. Prefer this over matching on error. The values this API can answer with are listed in the ApiErrorCode schema of the raw document at https://api.aetherpush.com/openapi.yaml. The field stays an open string here so that a release adding a value does not invalidate this response.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
"error": "The requested resource was not found.",
"code": "not_found",
"requestId": "req_abc123"
}

The API key’s scopes do not grant read, which answers required_scopes. A refusal raised before the route is reached, such as a request that did not arrive through the trusted edge, answers a plain error instead.

Media typeapplication/json
One of:
Error

Standard error envelope. code is the stable machine identifier for client branching and i18n. The wording of error is a human-readable fallback and is not part of the contract. Specialized responses keep narrower code enums where clients already branch on them.

object
error
required

Human-readable error message.

string
code
required

Stable machine code. Prefer this over matching on error. The values this API can answer with are listed in the ApiErrorCode schema of the raw document at https://api.aetherpush.com/openapi.yaml. The field stays an open string here so that a release adding a value does not invalidate this response.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Examples

The API key's scopes do not grant read

{
"error": "Insufficient permissions",
"code": "insufficient_scopes",
"required_scopes": [
"read"
],
"requestId": "req_abc123"
}

App or deployment not found.

Media typeapplication/json
Error

Standard error envelope. code is the stable machine identifier for client branching and i18n. The wording of error is a human-readable fallback and is not part of the contract. Specialized responses keep narrower code enums where clients already branch on them.

object
error
required

Human-readable error message.

string
code
required

Stable machine code. Prefer this over matching on error. The values this API can answer with are listed in the ApiErrorCode schema of the raw document at https://api.aetherpush.com/openapi.yaml. The field stays an open string here so that a release adding a value does not invalidate this response.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
"error": "The requested resource was not found.",
"code": "not_found",
"requestId": "req_abc123"
}

The tenant’s per-minute management API budget is spent. Retry-After and X-RateLimit-* say when to retry. This is not a plan quota: quota 429s use the Error envelope and do not set Retry-After.

Media typeapplication/json
RateLimitError

Returned with HTTP 429 when an endpoint-specific rate limit is hit, including the per-tenant management API budget. Not the process-wide address limiter (see GlobalAddressRateLimitErrorResponse). retryAfterSeconds indicates how long the client should wait before retrying, and matches the Retry-After header when that header is set. code names the limit that fired so clients can translate without matching on error.

object
error
required
string
code
required
string
retryAfterSeconds
required
integer
>= 1
requestId
string

Example

{
"error": "Rate limit exceeded",
"code": "tenant_rate_limit_exceeded",
"retryAfterSeconds": 60
}
Retry-After
integer
>= 1

Seconds until the tenant window resets.