Skip to main content
POST
/
api
/
orchestrator-module-runtimes
Create OrchestratorModuleRuntime
curl --request POST \
  --url https://platform.kodexa.ai/api/orchestrator-module-runtimes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "backoffLimit": 123,
  "changeSequence": 123,
  "configMapName": "<string>",
  "configMapResourceVersion": "<string>",
  "cpuMillicores": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "dockerImageUri": "<string>",
  "environmentVars": {},
  "ephemeralStorageMb": 123,
  "errorMessage": "<string>",
  "executionType": "<string>",
  "id": "<string>",
  "lambdaArn": "<string>",
  "lambdaFunctionName": "<string>",
  "memoryMb": 123,
  "metadata": {},
  "name": "<string>",
  "organizationId": "<string>",
  "provisionedAt": "2023-11-07T05:31:56Z",
  "resultQueueUrl": "<string>",
  "serviceAccountName": "<string>",
  "status": "<string>",
  "timeoutSeconds": 123,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "version": "<string>"
}
'
{
  "backoffLimit": 123,
  "changeSequence": 123,
  "configMapName": "<string>",
  "configMapResourceVersion": "<string>",
  "cpuMillicores": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "dockerImageUri": "<string>",
  "environmentVars": {},
  "ephemeralStorageMb": 123,
  "errorMessage": "<string>",
  "executionType": "<string>",
  "id": "<string>",
  "lambdaArn": "<string>",
  "lambdaFunctionName": "<string>",
  "memoryMb": 123,
  "metadata": {},
  "name": "<string>",
  "organizationId": "<string>",
  "provisionedAt": "2023-11-07T05:31:56Z",
  "resultQueueUrl": "<string>",
  "serviceAccountName": "<string>",
  "status": "<string>",
  "timeoutSeconds": 123,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "version": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Body

application/json

An orchestrator module runtime defines a processing environment for orchestrator modules.

​
backoffLimit
integer<int32>
​
changeSequence
integer<int32>
​
configMapName
string | null
​
configMapResourceVersion
string | null
​
cpuMillicores
integer<int32>
​
createdOn
string<date-time>
​
description
string | null
​
dockerImageUri
string
​
environmentVars
object
​
ephemeralStorageMb
integer<int32>
​
errorMessage
string | null
​
executionType
string
​
id
string
​
lambdaArn
string | null
​
lambdaFunctionName
string | null
​
memoryMb
integer<int32>
​
metadata
object
​
name
string
​
organizationId
string
​
provisionedAt
string<date-time> | null
​
resultQueueUrl
string | null
​
serviceAccountName
string | null
​
status
string
​
timeoutSeconds
integer<int32>
​
updatedOn
string<date-time>
​
uuid
string
​
version
string

Response

Created OrchestratorModuleRuntime

An orchestrator module runtime defines a processing environment for orchestrator modules.

​
backoffLimit
integer<int32>
​
changeSequence
integer<int32>
​
configMapName
string | null
​
configMapResourceVersion
string | null
​
cpuMillicores
integer<int32>
​
createdOn
string<date-time>
​
description
string | null
​
dockerImageUri
string
​
environmentVars
object
​
ephemeralStorageMb
integer<int32>
​
errorMessage
string | null
​
executionType
string
​
id
string
​
lambdaArn
string | null
​
lambdaFunctionName
string | null
​
memoryMb
integer<int32>
​
metadata
object
​
name
string
​
organizationId
string
​
provisionedAt
string<date-time> | null
​
resultQueueUrl
string | null
​
serviceAccountName
string | null
​
status
string
​
timeoutSeconds
integer<int32>
​
updatedOn
string<date-time>
​
uuid
string
​
version
string