Skip to main content
PUT
/
api
/
agent-runtimes
/
{id}
Update OrchestratorAgentRuntime
curl --request PUT \
  --url https://platform.kodexa.ai/api/agent-runtimes/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agentRuntimeArn": "<string>",
  "awsRuntimeId": "<string>",
  "changeSequence": 123,
  "configMapName": "<string>",
  "configMapResourceVersion": "<string>",
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "endpointArn": "<string>",
  "endpointId": "<string>",
  "endpointName": "<string>",
  "environmentVars": {},
  "failureReason": "<string>",
  "id": "<string>",
  "image": "<string>",
  "maxConcurrency": 123,
  "metadata": {},
  "name": "<string>",
  "networkMode": "<string>",
  "organizationId": "<string>",
  "protocolConfiguration": "<string>",
  "roleArn": "<string>",
  "securityGroups": "<string>",
  "slug": "<string>",
  "status": "<string>",
  "subnets": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "agentRuntimeArn": "<string>",
  "awsRuntimeId": "<string>",
  "changeSequence": 123,
  "configMapName": "<string>",
  "configMapResourceVersion": "<string>",
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "endpointArn": "<string>",
  "endpointId": "<string>",
  "endpointName": "<string>",
  "environmentVars": {},
  "failureReason": "<string>",
  "id": "<string>",
  "image": "<string>",
  "maxConcurrency": 123,
  "metadata": {},
  "name": "<string>",
  "networkMode": "<string>",
  "organizationId": "<string>",
  "protocolConfiguration": "<string>",
  "roleArn": "<string>",
  "securityGroups": "<string>",
  "slug": "<string>",
  "status": "<string>",
  "subnets": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json

An orchestrator agent runtime defines an agent processing environment.

​
agentRuntimeArn
string | null
​
awsRuntimeId
string | null
​
changeSequence
integer<int32>
​
configMapName
string | null
​
configMapResourceVersion
string | null
​
createdBy
string
​
createdOn
string<date-time>
​
description
string
​
endpointArn
string | null
​
endpointId
string | null
​
endpointName
string | null
​
environmentVars
object
​
failureReason
string | null
​
id
string
​
image
string
​
maxConcurrency
integer<int32> | null
​
metadata
object
​
name
string
​
networkMode
string | null
​
organizationId
string
​
protocolConfiguration
string | null
​
roleArn
string
​
securityGroups
string | null
​
slug
string
​
status
string
​
subnets
string | null
​
updatedOn
string<date-time>
​
uuid
string

Response

Updated OrchestratorAgentRuntime

An orchestrator agent runtime defines an agent processing environment.

​
agentRuntimeArn
string | null
​
awsRuntimeId
string | null
​
changeSequence
integer<int32>
​
configMapName
string | null
​
configMapResourceVersion
string | null
​
createdBy
string
​
createdOn
string<date-time>
​
description
string
​
endpointArn
string | null
​
endpointId
string | null
​
endpointName
string | null
​
environmentVars
object
​
failureReason
string | null
​
id
string
​
image
string
​
maxConcurrency
integer<int32> | null
​
metadata
object
​
name
string
​
networkMode
string | null
​
organizationId
string
​
protocolConfiguration
string | null
​
roleArn
string
​
securityGroups
string | null
​
slug
string
​
status
string
​
subnets
string | null
​
updatedOn
string<date-time>
​
uuid
string