Skip to main content

Deploy an application

POST 
/api/v1/applications/deploy

Deploys a new application within a specified project

Request​

Header Parameters

    X-API-KEY stringrequired

    API Key

Body

required

Application deployment data

    externalAccess

    object

    accessType string

    Possible values: [Ingress, LoadBalancer, None]

    dnsEndpoint string
    name stringrequired

    Possible values: non-empty and <= 50 characters

    name is the name of the application. Every application name should be unique within the organization.

    namespace string

    Possible values: <= 63 characters

    namespace specifies the namespace to deploy the application. If not specified, the platform will create namespace based on the application name.

    profileName stringrequired

    Possible values: non-empty and <= 50 characters

    profileName is the name of the application profile. Once set, it is immutable.

    source

    object

    required

    helm

    object

    repo

    object

    chartName string
    chartVersion string
    releaseName string
    repoURL string

    values

    object

    files string[]
    object object
    type string

    Possible values: [files, object]

    image

    object

    registry string
    repository string
    tag string

    repository

    object

    repo

    object

    path string
    releaseName string
    repoURL string
    targetRevision string

    values

    object

    files string[]
    object object
    type string

    Possible values: [files, object]

    type string

    Possible values: [image, helm, yaml, repository]

    yaml

    object

    exclude string
    include string
    recursive boolean

    repo

    object

    path string
    releaseName string
    repoURL string
    targetRevision string
    syncType string

    Possible values: [auto, manual]

    syncType defines if the application should be auto-synced or not. The values can be either "auto" or "manual". The default value is "auto". Only use manual for testing purposes on the live cluster.

Responses​

Application deployed successfully

Loading...