Skip to main content

List application deployments

GET 
/applications/:applicationId/deployments

List application deployments

Request​

Path Parameters

    applicationId stringrequired

    Possible values: non-empty

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses​

application-deployments-list 200 response

Schema

  • Array [

    • id uuidrequired


    The internal unique identifier of the deployment.

    applicationId stringrequired

    Possible values: non-empty


    The unique identifier of the deployed application.

    environmentId stringrequired

    Possible values: non-empty


    The unique identifier of the environment the application is deployed to.

    version stringrequired

    Possible values: non-empty


    The deployed application package version.

    configurationVersion stringrequired


    The deployment configuration version used for the deployment.

    name stringrequired


    The user-friendly label for the deployment. It consists of a combination of the application and environment IDs.

    status DeploymentStatus (string)

    Possible values: [REQUESTED, HEALTHY, PROGRESSING, DEGRADED, MISSING, UNKNOWN, NOT_DEPLOYED, DELETING, FAILED_TO_CREATE, FAILED_TO_UPDATE, UPDATING]

    The status of the deployment.

    • REQUESTED: The deployment has been requested.
    • HEALTHY: The deployment is healthy.
    • PROGRESSING: The deployment is in progress.
    • DEGRADED: The deployment is degraded.
    • MISSING: The deployment is incomplete / missing some parts.
    • UNKNOWN: The deployment status is unknown.
    • NOT_DEPLOYED: The deployment is not deployed.
    • DELETING: The deployment is being deleted.
    • FAILED_TO_CREATE: The deployment failed to be created.
    • FAILED_TO_UPDATE: The deployment failed to be updated.
    • UPDATING: The deployment is being updated.
    dateCreated date-timerequired


    The timestamp when the deployment was issued. It is an automatically generated value that records the exact date and time when the deployment started.

    endpoints

    object[]

    nullable


    A list of objects representing the URL addresses under which the individual application components are available.
    Please note, this list may differ from the one you see in the CodeNow UI.

  • Array [

    • url string


    The URL address under which the application component is accessible.

    previewUrl string


    Preview URL address under which the application component is accessible.

    applicationComponentId string


    The unique identifier of the application component.

    primary boolean
    type EndpointType (string)

    Possible values: [INTERNAL, EXTERNAL, UNKNOWN]

    Type of endpoint
    INTERNAL - Endpoint where your component is reachable internally within the cluster.
    EXTERNAL - Endpoint at which your component can be reached externally.

  • ]

    • isPreview booleannullable


    A boolean flag indicating whether any application components have been deployed directly to the environment in form of a preview build.

    errorCode stringnullable
    errorMessage stringnullable

  • ]

Loading...