Skip to main content
GET
List applications

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token in the Authorization header.

Query Parameters

limit
integer
default:25

Maximum number of items per page

Required range: 1 <= x <= 100
Example:

25

offset
integer
default:0

Number of items to skip

Required range: 0 <= x <= 10000
Example:

0

status
enum<string>

Return only applications with this status. deploymentInProgress - a deployment is currently running. deploymentSuccess - the latest deployment succeeded. deploymentFailed - the latest deployment failed. deploymentCancelled - the latest deployment was cancelled. deleting - the application is being deleted. appDeletionFailed - the last deletion attempt failed.

Available options:
deploymentInProgress,
deploymentFailed,
deploymentSuccess,
deleting,
appDeletionFailed,
deploymentCancelled
Example:

"deploymentSuccess"

source
enum<string>

Return only applications with this source type. privateGit - private Git repository connected via OAuth. publicGit - public Git repository URL. dockerImage - Docker container image from a registry. app - pipeline promotion target with no Git repository or Docker image connected; deployments arrive by promoting from another pipeline stage.

Available options:
privateGit,
publicGit,
dockerImage,
app
Example:

"privateGit"

project_id
string<uuid>

Return only applications that belong to this project.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

Return only applications whose name or display name contains this text. Matching is case-insensitive.

Required string length: 1 - 100
Example:

"my-app"

Response

Default Response

data
object[]
required

List of items

total
integer
required

Total number of items matching the query

Required range: 0 <= x <= 10000
Example:

42

offset
integer
required

Current pagination offset

Required range: 0 <= x <= 10000
Example:

0

limit
integer
required

Current pagination limit

Required range: 1 <= x <= 100
Example:

25