Get a paginated, filterable list of release labels

GET

/v1/apps/{appName}/deployments/{deploymentName}/labels

const url = 'https://api.aetherpush.com/v1/apps/example/deployments/example/labels?isMandatory=true&isDisabled=true&releaseMethod=Upload';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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, diffPackageMap) and supports filtering by label, appVersion, releasedBy, description, mandatory/disabled flags, releaseMethod, and upload-time range. Designed for dashboard release tables.

Authorizations

accessKeyAuth
apiKeyAuth
read

Parameters

Path Parameters

appName

required

string

deploymentName

required

string

Query Parameters

label

string

appVersion

string

releasedBy

string

Case-insensitive substring match.

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

Responses

200

Paginated labels with meta and links.

application/json

object

data

required

Array<object>

object

label

required

string

appVersion

required

string

description

required

string

isMandatory

required

boolean

isDisabled

required

boolean

releasedBy

string format: email

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"
    }
  ]
}

401

Unauthenticated, or not a collaborator.

application/json

object

error

required

Human-readable error message.

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.",
  "requestId": "req_abc123"
}

404

App or deployment not found.

application/json

object

error

required

Human-readable error message.

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.",
  "requestId": "req_abc123"
}