Get application deployment detail
GET/applications/:applicationId/deployments/:environmentId
Get application deployment detail
Request
Path Parameters
Possible values: non-empty
Possible values: non-empty
Header Parameters
CodeNOW API Key
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
application-deployment-detail 200 response
- application/vnd.codenow.v1+json
- Schema
- Example (from schema)
Schema
- 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.
Array [
]
The internal unique identifier of the deployment.
Possible values: non-empty
The unique identifier of the deployed application.
Possible values: non-empty
The unique identifier of the environment the application is deployed to.
Possible values: non-empty
The deployed application package version.
The deployment configuration version used for the deployment.
The user-friendly label for the deployment. It consists of a combination of the application and environment IDs.
Possible values: [REQUESTED
, HEALTHY
, PROGRESSING
, DEGRADED
, MISSING
, UNKNOWN
, NOT_DEPLOYED
, DELETING
, FAILED_TO_CREATE
, FAILED_TO_UPDATE
, UPDATING
]
The status of the deployment.
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.
The URL address under which the application component is accessible.
Preview URL address under which the application component is accessible.
The unique identifier of the application component.
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.
A boolean flag indicating whether any application components have been deployed directly
to the environment in form of a preview build.
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationId": "string",
"environmentId": "string",
"version": "string",
"configurationVersion": "string",
"name": "string",
"status": "REQUESTED",
"dateCreated": "2024-07-29T15:51:28.071Z",
"endpoints": [
{
"url": "string",
"previewUrl": "string",
"applicationComponentId": "string",
"primary": true,
"type": "INTERNAL"
}
],
"isPreview": true,
"errorCode": "string",
"errorMessage": "string"
}
The request was unacceptable, often due to missing a required parameter.
No valid API key provided.
The API key doesn't have permissions to perform the request.
Resource not found.
Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
Something went wrong on CodeNOW's end.