Paginated listing of Channels

Query Parameters

page_size
integer
(int32)

Sets the number of items to return in paginated endpoints

page
integer
(int32)

Sets the page number for paginated endpoints

Response

200 Channel Listing
data
object[]

Resource Data

app_id
string

App ID

created
string
(date-time)

Creation datetime

deploy
object

App Snapshot

android_version
object

Android Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

app_id
string

App ID

created
string
(date-time)

Created datetime

ios_version
object

iOS Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

note
string

Short note describing the Snapshot

user_metadata
object

Custom metadata

uuid
string
(uuid)

Snapshot ID

label
string

Name of the channel

tag
string

Unique tag used to reference the channel

uuid
string
(uuid)

Channel ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Create a deploy channel

Request Body

schema application/json
label
string

Reference label

tag
string

Unique tag

Response

201 Channel
data
object

Resource Data

app_id
string

App ID

created
string
(date-time)

Creation datetime

deploy
object

App Snapshot

android_version
object

Android Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

app_id
string

App ID

created
string
(date-time)

Created datetime

ios_version
object

iOS Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

note
string

Short note describing the Snapshot

user_metadata
object

Custom metadata

uuid
string
(uuid)

Snapshot ID

label
string

Name of the channel

tag
string

Unique tag used to reference the channel

uuid
string
(uuid)

Channel ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Retrieve a single Channel

Path Parameters

channel_id
string
(uuid)

Channel ID

Response

200 Channel
data
object

Resource Data

app_id
string

App ID

created
string
(date-time)

Creation datetime

deploy
object

App Snapshot

android_version
object

Android Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

app_id
string

App ID

created
string
(date-time)

Created datetime

ios_version
object

iOS Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

note
string

Short note describing the Snapshot

user_metadata
object

Custom metadata

uuid
string
(uuid)

Snapshot ID

label
string

Name of the channel

tag
string

Unique tag used to reference the channel

uuid
string
(uuid)

Channel ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Update a deploy channel

Path Parameters

channel_id
string
(uuid)

Channel ID

Request Body

schema application/json
label
string

Reference label

tag
string

Unique tag

Response

200 Channel
data
object

Resource Data

app_id
string

App ID

created
string
(date-time)

Creation datetime

deploy
object

App Snapshot

android_version
object

Android Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

app_id
string

App ID

created
string
(date-time)

Created datetime

ios_version
object

iOS Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

note
string

Short note describing the Snapshot

user_metadata
object

Custom metadata

uuid
string
(uuid)

Snapshot ID

label
string

Name of the channel

tag
string

Unique tag used to reference the channel

uuid
string
(uuid)

Channel ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Path Parameters

channel_id
string
(uuid)

Channel ID

Response

204 No Content

Retrieve a single Channel by it’s tag

Path Parameters

tag
string

Channel Tag

Response

200 Channel
data
object

Resource Data

app_id
string

App ID

created
string
(date-time)

Creation datetime

deploy
object

App Snapshot

android_version
object

Android Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

app_id
string

App ID

created
string
(date-time)

Created datetime

ios_version
object

iOS Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

note
string

Short note describing the Snapshot

user_metadata
object

Custom metadata

uuid
string
(uuid)

Snapshot ID

label
string

Name of the channel

tag
string

Unique tag used to reference the channel

uuid
string
(uuid)

Channel ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

List recent deploys

Query Parameters

channel
string
(uuid)

Channel Tag. Filters deploys by the channel tag.

page_size
integer
(int32)

Sets the number of items to return in paginated endpoints

page
integer
(int32)

Sets the page number for paginated endpoints

Response

200 Deploy
data
object[]

Resource Data

channel
string

Channel ID

created
string
(date-time)

Creation datetime

snapshot
string

Snapshot ID

uuid
string
(uuid)

Deploy ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Deploy an App Snapshot to the specified Channel

Request Body

schema application/json
channel
string
(uuid)

Channel ID

snapshot
string
(uuid)

Snapshot ID

Response

200 Deploy
data
object

Resource Data

channel
string

Channel ID

created
string
(date-time)

Creation datetime

snapshot
string

Snapshot ID

uuid
string
(uuid)

Deploy ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

List App Snapshots

Query Parameters

page_size
integer
(int32)

Sets the number of items to return in paginated endpoints

page
integer
(int32)

Sets the page number for paginated endpoints

fields
string[]

Additional Fields to return

Additional Fields

android_version
object

Android Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

ios_version
object

iOS Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

user_metadata
object

Custom metadata

Response

200 Paginated listing of Snapshots
data
object

Resource Data

app_id
string

App ID

created
string
(date-time)

Created datetime

note
string

Short note describing the Snapshot

uuid
string
(uuid)

Snapshot ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Path Parameters

snapshot_id
string
(uuid)

Snapshot ID

Response

200 Snapshot
data
object

Resource Data

android_version
object

Android Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

app_id
string

App ID

created
string
(date-time)

Created datetime

ios_version
object

iOS Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

note
string

Short note describing the Snapshot

user_metadata
object

Custom metadata

uuid
string
(uuid)

Snapshot ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Path Parameters

snapshot_id
string
(uuid)

Snapshot ID

Request Body

schema application/json
android_version
object

Android Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

ios_version
object

iOS Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

note
string

Short note describing the Snapshot

user_metadata
object

Custom metadata

Response

200 Updated Snapshot
data
object

Resource Data

android_version
object

Android Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

app_id
string

App ID

created
string
(date-time)

Created datetime

ios_version
object

iOS Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

note
string

Short note describing the Snapshot

user_metadata
object

Custom metadata

uuid
string
(uuid)

Snapshot ID

meta
object

Response Metadata

request_id
string
(uuid)

Request Reference ID

status
integer
(int32)

HTTP Response Code

version
string
(semver)

API Version

Models

The following is a collection of model references

Channel

schema application/json
app_id
string

App ID

created
string
(date-time)

Creation datetime

deploy
object

App Snapshot

android_version
object

Android Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

app_id
string

App ID

created
string
(date-time)

Created datetime

ios_version
object

iOS Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

note
string

Short note describing the Snapshot

user_metadata
object

Custom metadata

uuid
string
(uuid)

Snapshot ID

label
string

Name of the channel

tag
string

Unique tag used to reference the channel

uuid
string
(uuid)

Channel ID

IOSVersion

schema application/json
eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

Snapshot

schema application/json
android_version
object

Android Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

app_id
string

App ID

created
string
(date-time)

Created datetime

ios_version
object

iOS Snapshot Version

eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

note
string

Short note describing the Snapshot

user_metadata
object

Custom metadata

uuid
string
(uuid)

Snapshot ID

Deploy

schema application/json
channel
string

Channel ID

created
string
(date-time)

Creation datetime

snapshot
string

Snapshot ID

uuid
string
(uuid)

Deploy ID

AndroidVersion

schema application/json
eq
string
(semver)

Equivalent App binary version. i.e. This version is equivalent to the binary version of the app

max
string
(semver)

Maximum App binary version supported

min
string
(semver)

Minimum App binary version supported

Services

    API

      General