Skip to main content

Read an application

Provides information about the application

Query Parameters
metadata_include string

Comma separated properties that should be included in the metadata response, available values [schemas, tags]

Example: schema,tags

Responses
200

An object representing the application

Schema OPTIONAL
id integer

A system-wide unique ID for the application

name string

Possible values: length ≤ 60

The application name

slug string

Possible values: length ≤ 60

A namespace-wide unique slug for the application

namespace_id integer

The ID of the namespace that owns this application

status string

Possible values: [pending, creating, updating, active, inactive, failed]

repository_url string

Possible values: length ≤ 250

The URL of the repository that holds this application (eg: https://github.com/myorg/myapp/)

repository_app_path string OPTIONAL

The folder where the application is located inside a monorepo.

is_mono_repo boolean

True if the application shares the repository with other apps, false otherwise.

auto_deploy_on_creation boolean

True if the application must be deployed immediately after being created, false otherwise.

template_id integer

The ID of the template that was used to create this application

metadata object OPTIONAL

The metadata loaded via metadata api

key string OPTIONAL

The key of the metadata

value string OPTIONAL

The value of the metadata

additional_properties object OPTIONAL

Additional properties of the metadata

schemas array OPTIONAL

The json schemas of the metadata

tags object[] OPTIONAL
key string OPTIONAL
value string OPTIONAL