Get application deployment configuration
GET/applications/:applicationId/deployment-configs/:version
Get application deployment configuration detail. If no environment ID is specified, a default configuration will be returned.
Request
Path Parameters
Possible values: non-empty
Possible values: non-empty
Query Parameters
Header Parameters
CodeNOW API Key
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
application-deployment-config-detail 200 response
- application/vnd.codenow.v1+json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
The deployment configuration version given in the request. In most cases it will be identical to applicationVersion, but it can differ, e.g. when the specified configuration does not exist.
A boolean flag indicating whether the deployment configuration can be used to deploy the specified application version to the given environment.
It will be set to false, if there are breaking changes between the given version and the version the configuration has been created for.
The unique identifier of the application this configuration belongs to. Any existing deployment configuration is fully identified by the combination of application, version and environment.
The application package version this configuration was created for.
The unique identifier of the environment this configuration belongs to.
versionInterval
object
nullable
The range of application package versions this configuration is currently applicable to. The intervals will adjust accordingly with the creation and deletion of configurations.
The lowest application package version this configuration is applicable to.
The highest application package version this configuration is currently applicable to. It might change with the creation and deletion of application packages and deployment configurations.
A boolean flag indicating whether there are any deployments using this configuration.
A boolean flag indicating whether any deployment configuration for given application, version and environment exists.
deploymentConfig
object
required
A map of configurations for individual application components contained in the application version, mapped by component ID.
property name*
ApplicationComponentDeploymentConfig
configFiles
object[]
required
A list of objects representing configuration files affecting the component.
The name of the configuration file.
The content of the file, base64 encoded.
The type of the configuration file corresponds to its extension, providing important information about the expected formatting and content.
Possible values: [EXISTING, PREVIOUS, DEFAULT]
Information about the origin of the configuration file.
Possible values are: EXISTING, meaning that the file is present in this version of the configuration (most common state), PREVIOUS, meaning it has been extracted from a previous configuration version (useful when creating a higher version), and DEFAULT, meaning this file is part of the default configuration prepared by CodeNOW.
connections
object[]
required
A list of objects representing connections to managed or external services.
The user-friendly name or label for the connection.
An internal identifier for the service scaffold, determined by the service type or brand in the case of managed services,
or by the template ID for external services.
Possible values: [MANAGED_COMPONENT, EXTERNAL]
The template type is closely associated with the service type and indicates whether it is a MANAGED service,
provided and maintained by CodeNOW,or EXTERNAL service, defined by the user and maintained independently outside of CodeNOW.
The unique identifier of the specific service instance connected to the component.
The type of this service instance must match the type attribute.
runtime
object
required
An object containing the runtime configuration specifications for the component.
Possible values: >= 1 and <= 40
The number of instances (containers) of this application component run in parallel. Minimum value is 1, maximum value is 40.
resources
object
required
An object specifying the minimum required and maximum allowed resources (CPU and memory)
needed by the containers running this application component.
limits
object
The maximum allowed resource allocation (CPU and memory) to the containers running this application component.
If some of the values are omitted, it means they are not set.
Possible values: non-empty
The maximum allowed CPU allocation for the containers running this application component.
It accepts two possible units: cpu (cpu core), represented by a simple number (decimals allowed),
and m (thousandth of a core), denoted by the 'm' suffix. For example, '1000m' is equivalent to '1'.
The value must not be less than 1m (0.001).
Possible values: non-empty
The maximum allowed memory allocation for the container running this application component in bytes.
You can express the value as a plain integer, a number in exponential format or as a fixed-point number using one
of these quantity suffixes: E, P, T, G, M,
k. You can also use the power-of-two equivalents: Ei, Pi, Ti,
Gi, Mi, Ki. For example, the following represent roughly the same value:
128974848, 129e6, 129M, 128974848000m, 123Mi.
The value must not be less than 1k (1000 bytes).
requests
object
The required resources (CPU and memory) needed by the containers running this application component.
If some of the values are omitted, it means they are not set.
Possible values: non-empty
The required CPU allocation for the containers running this application component.
It accepts two possible units: cpu (cpu core), represented by a simple number (decimals allowed),
and m (thousandth of a core), denoted by the 'm' suffix. For example, '1000m' is equivalent to '1'.
The value must not be less than 1m (0.001).
The value must be less than or equal to the CPU limit value.
Possible values: non-empty
The required memory allocation for the containers running this application component in bytes.
You can express the value as a plain integer, a number in exponential format or as a fixed-point number using one
of these quantity suffixes: E, P, T, G, M,
k. You can also use the power-of-two equivalents: Ei, Pi, Ti,
Gi, Mi, Ki. For example, the following represent roughly the same value:
128974848, 129e6, 129M, 128974848000m, 123Mi.
The value must not be less than 1k (1000 bytes).
The value must be less than or equal to the memory limit value.
{
"version": "string",
"compatible": true,
"applicationId": "string",
"applicationVersion": "string",
"environmentId": "string",
"versionInterval": {
"startVersion": "string",
"endVersion": "string"
},
"deployed": true,
"exists": true,
"deploymentConfig": {}
}
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.