Dynamic Engine

Manage Dynamic Engines

Endpoints

Global security

These security schemes apply to the entire API

Security scheme

This scheme can be referenced across the API

Public
Bearer authentication
NameDescription
FormatBearer <jwt>

Delete a Dynamic Engine instance

DELETE /processing/runtimes/dynamic-engines/{id}
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Path variables
NameDescriptionTypeAttributes and examples
idThe dynamic-engine’s idstring Required

Response

200Status 200
OK
202Status 202
Accepted
Body
Object
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

Update a Dynamic Engine instance

PUT /processing/runtimes/dynamic-engines/{id}
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Path variables
NameDescriptionTypeAttributes and examples
idThe dynamic-engine’s idstring Required
Body
UpdateDynamicEngineRequest

Response

200Status 200
OK
Body
DynamicEngineDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
409Status 409
There is already an ongoing operation for this dynamic-engine
Body
ApiError

Get a Dynamic Engine instance by its ID

GET /processing/runtimes/dynamic-engines/{id}
Required entitlement TMC_CLUSTER_MANAGEMENT or DYN_ENGINE_READ

Request

Path variables
NameDescriptionTypeAttributes and examples
idThe dynamic-engine’s idstring Required

Response

200Status 200
OK
Body
DynamicEngineDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Not Found
Body
ApiError

Get all your Dynamic Engine instances

GET /processing/runtimes/dynamic-engines
Required entitlement TMC_CLUSTER_MANAGEMENT or TMC_RUN_PROFILE_MANAGEMENT or TMC_ENVIRONMENT_MANAGEMENT

Response

200Status 200
OK
Body
details
NameDescriptionTypeAttributes and examples
array of DynamicEngineDetailsResponse
Datatype details
TypeDescriptionAttributes and examples
array
DynamicEngineDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

Create a new Dynamic Engine instance

POST /processing/runtimes/dynamic-engines
Required entitlement TMC_CLUSTER_MANAGEMENT

Request

Body
one of CreateDynamicEngineRequest

Response

201Status 201
Created
Body
DynamicEngineDetailsResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation

Return the manifest for the infrastructure and all associated environments

POST /processing/runtimes/dynamic-engines/{dynamicEngineId}/actions/generate-manifest
This endpoint returns the manifest for the infrastructure and all the environments associated with the given Dynamic Engine instance

Request

Path variables
NameDescriptionTypeAttributes and examples
dynamicEngineIdThe dynamic engine’s idstring Required
Body
GenerateDeploymentOptions

Response

200Status 200
OK
Body
Object
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Dynamic-engine does not exist or doesn’t have any status yet
Body
ApiError
500Status 500
Internal Server Error
Body
ApiError

Return the Helm values for the infrastructure and all associated environments

POST /processing/runtimes/dynamic-engines/{dynamicEngineId}/actions/generate-helm
This endpoint returns the Helm information for the infrastructure and all the environments associated with the given Dynamic Engine instance

Request

Path variables
NameDescriptionTypeAttributes and examples
dynamicEngineIdThe dynamic engine’s idstring Required
Body
GenerateDeploymentOptions

Response

200Status 200
OK
Body
Object
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Dynamic-engine does not exist or doesn’t have any status yet
Body
ApiError
500Status 500
Internal Server Error
Body
ApiError

Fetch the Dynamic Engine infrastructure status

GET /processing/runtimes/dynamic-engines/{dynamicEngineId}/infra/status
The status is the runtime state of services belonging to the qlik-dynamic-engine namespace.

Request

Path variables
NameDescriptionTypeAttributes and examples
dynamicEngineIdThe dynamic engine’s idstring Required

Response

200Status 200
OK
Body
StatusResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Dynamic-engine does not exist or doesn’t have any status yet
Body
ApiError
500Status 500
Internal Server Error
Body
ApiError

Fetch the Dynamic Engine environment status

GET /processing/runtimes/dynamic-engines/{dynamicEngineId}/environments/{environmentId}/status
The status is the runtime state of processing services belonging to an environment assigned to the given Dynamic Engine instance.

Request

Path variables
NameDescriptionTypeAttributes and examples
dynamicEngineIdThe dynamic engine’s idstring Required
environmentIdThe environment’s idstring Required

Response

200Status 200
OK
Body
StatusResponse
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Environment does not exist or is not associated to a dynamic engine
Body
ApiError
500Status 500
Internal Server Error
Body
ApiError

Return all supported Dynamic Engine versions.

GET /processing/runtimes/dynamic-engine-versions
A Dynamic Engine version is a consistent baseline of processing services that can be used to generate a deployment manifest.

Response

200Status 200
OK
Body
details
NameDescriptionTypeAttributes and examples
array of DynamicEngineVersion
Datatype details
TypeDescriptionAttributes and examples
array
DynamicEngineVersion
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
500Status 500
Internal Server Error
Body
ApiError

Delete an environment assignment.

DELETE /processing/runtimes/dynamic-engines/{dynamicEngineId}/environments/{environmentId}
This removes the association between the given environment and the given Dynamic Engine instance.

Request

Path variables
NameDescriptionTypeAttributes and examples
dynamicEngineIdThe dynamic engine’s idstring Required
environmentIdThe environment’s idstring Required

Response

202Status 202
Accepted
400Status 400
Your request is invalid
401Status 401
You must be authenticated to execute this operation
403Status 403
You do not have the permissions to execute this operation
404Status 404
Environment does not exist or is not associated to a dynamic engine
Body
ApiError
409Status 409
There is already an ongoing operation for this environment
Body
ApiError
500Status 500
Internal Server Error
Body
ApiError

ApiError

Describe an API error
Object
NameDescriptionTypeAttributes and examples
statusThe http status’s codeinteger Optional
INT32
titleThe error’s titlestring Optional
detailsThe error’s detailsstring Optional
instanceThe error’s instancestring Optional
typeThe error’s typestring Optional
codeThe error’s codestring Optional
dataObjectOptional

GenerateDeploymentOptions

Describe the supported options to generate a manifest for the infrastructure and all the environments
Object
NameDescriptionTypeAttributes and examples
versionRequested version of the dynamic engine. Leave empty to get the latest version. See dynamic-engine-versions endpoint for the list of supported past versions.string Optional
generateNewPairingKeyForce the generation of a new pairing keyboolean Optional

KubernetesEvent

Describe an engine event
Object
NameDescriptionTypeAttributes and examples
messageThe event’s messagestring Optional
1
sourceThe event’s sourcestring Optional
1
creationDateThe event’s creation date with timezonestring Optional
1

ServiceDetails

Details of the installed service
Object
NameDescriptionTypeAttributes and examples
nameThe service’s namestring Optional
1
statusThe service’s statusstring Required
chartVersionThe service’s versionstring Optional
creationDateThe service’s creation date with timezonestring Optional
lastUpdateDateThe service’s last update date with timezonestring Optional
appsVersionAll application’s version running in this serviceObjectOptional
podsErrorsThe error messages of all the non-running pods of the serviceObjectOptional
resourcesErrorsThe error messages of all the non-deployment resources of the service that are not readyObjectOptional
jobStatusThe status of the job that installed the servicestring Optional
jobErrorMessageThe error message of the job that installed the servicestring Optional

StatusResponse

Describe the status
Object
NameDescriptionTypeAttributes and examples
statusThe global statusstring Required
dynamicEngineVersionThe version of the dynamic enginestring Optional
deploymentTypeThe type of deployment used to install the dynamic enginestring Optional
jobDeleteStatusThe status of the delete jobstring Optional
servicesarray of ServiceDetails Optional
Datatype details
TypeDescriptionAttributes and examples
arrayThe services details
50
ServiceDetails
failureEventsarray of KubernetesEvent Optional
Datatype details
TypeDescriptionAttributes and examples
arrayThe failure events
100
KubernetesEvent

DynamicEngineReleaseNote

Describe a dynamic engine version release note
Object
NameDescriptionTypeAttributes and examples
releaseNotesLinkThe link to the release notestring Optional
changelogLinkThe link to the changelogstring Optional

DynamicEngineService

Describe a dynamic engine version service
Object
NameDescriptionTypeAttributes and examples
idThe idstring Optional
featureThe featurestring Optional
versionThe versionstring Optional
flagFlag Optional

DynamicEngineVersion

Describe a dynamic engine version
Object
NameDescriptionTypeAttributes and examples
idThe idstring Optional
nameThe namestring Optional
publicationDateThe publication datedatetime Optional
RFC3339
kubeVersionThe supported kubernetes versionstring Optional
releaseNotesDynamicEngineReleaseNote Optional
servicesarray of DynamicEngineService Optional
Datatype details
TypeDescriptionAttributes and examples
arrayThe list of services
DynamicEngineService

Flag

Object
NameDescriptionTypeAttributes and examples
keystring Optional
deploymentTypestring Optional

UpdateDynamicEngineRequest

The request payload to update a dynamic-engine
Object
NameDescriptionTypeAttributes and examples
nameThe namestring Required
255
descriptionThe descriptionstring Required
1024

DynamicEngineDetailsResponse

Describe a dynamic-engine
Object
NameDescriptionTypeAttributes and examples
idThe idstring Required
nameThe namestring Required
descriptionThe descriptionstring Optional
stateThe current statestring Required
creationDateThe creation datedatetime Required
RFC3339
lastModifiedDateThe last modified datedatetime Required
RFC3339
lastModifiedStateDateThe last state modified datedatetime Required
RFC3339
createdByThe user that created this dynamic-enginestring Required
lastModifiedByThe last user that modified this dynamic-enginestring Required

CreateDynamicEngineRequest

The request payload to create a dynamic-engine
Object
NameDescriptionTypeAttributes and examples
nameThe namestring Required
255
descriptionThe descriptionstring Optional
1024
back to top↑