v1
latestOpenAPI 3.0.32026-07-22194221292.5 KBagents
Update agent
Updates an agent's configuration and triggers a new deployment. Changes to runtime settings, environment variables, or scaling parameters will be applied on the next deployment.
put/agents/{agentName}
Request body
Example request
{
"events": [
{
"message": "Deployment successful",
"revision": "rev-abc123",
"status": "DEPLOYED",
"time": "2025-01-15T10:30:00Z",
"type": "deployment"
}
],
"metadata": {
"displayName": "My Resource",
"externalId": "my-session-123",
"name": "my-resource"
},
"spec": {
"enabled": true,
"region": "us-pdx-1",
"repository": {
"type": "github",
"url": "https://github.com/my-org/my-agent"
},
"revision": {
"active": "rev-abc123",
"canaryPercent": 10,
"traffic": 100
},
"runtime": {
"envs": [
{
"name": "MY_ENV_VAR",
"secret": true,
"value": "my-value"
}
],
"generation": "mk3",
"maxScale": 10,
"memory": 2048
},
"triggers": [
{
"configuration": {
"authenticationType": "blaxel",
"callbackUrl": "https://myapp.com/webhook",
"path": "/invoke",
"retry": 3,
"schedule": "0 * * * *",
"timeout": 300
},
"enabled": true,
"id": "trigger-1",
"type": "http"
}
],
"volumes": [
{
"mountPath": "/mnt/data",
"name": "my-volume"
}
]
}
}Response
successful operation
Example response
{
"events": [
{
"message": "Deployment successful",
"revision": "rev-abc123",
"status": "DEPLOYED",
"time": "2025-01-15T10:30:00Z",
"type": "deployment"
}
],
"metadata": {
"displayName": "My Resource",
"externalId": "my-session-123",
"name": "my-resource"
},
"spec": {
"enabled": true,
"region": "us-pdx-1",
"repository": {
"type": "github",
"url": "https://github.com/my-org/my-agent"
},
"revision": {
"active": "rev-abc123",
"canaryPercent": 10,
"traffic": 100
},
"runtime": {
"envs": [
{
"name": "MY_ENV_VAR",
"secret": true,
"value": "my-value"
}
],
"generation": "mk3",
"maxScale": 10,
"memory": 2048
},
"triggers": [
{
"configuration": {
"authenticationType": "blaxel",
"callbackUrl": "https://myapp.com/webhook",
"path": "/invoke",
"retry": 3,
"schedule": "0 * * * *",
"timeout": 300
},
"enabled": true,
"id": "trigger-1",
"type": "http"
}
],
"volumes": [
{
"mountPath": "/mnt/data",
"name": "my-volume"
}
]
}
}