Skip to main content
PATCH
/
v1
/
agents
/
{agent_uuid}
Patch Agent
curl --request PATCH \
  --url https://api.example.com/v1/agents/{agent_uuid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "endpoint_url": "<string>",
  "auth_header_name": "<string>",
  "auth_header_value": "<string>",
  "trigger_on_sources": [
    "<string>"
  ],
  "trigger_on_severities": [
    "<string>"
  ],
  "trigger_filter": {},
  "timeout_seconds": 150,
  "retry_count": 5,
  "is_active": true,
  "documentation": "<string>"
}
'
{
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "endpoint_url": "<string>",
    "auth_header_name": "<string>",
    "trigger_on_sources": [
      "<string>"
    ],
    "trigger_on_severities": [
      "<string>"
    ],
    "trigger_filter": {},
    "timeout_seconds": 123,
    "retry_count": 123,
    "is_active": true,
    "documentation": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {}
}

Path Parameters

agent_uuid
string<uuid>
required

Body

application/json
name
string | null
description
string | null
endpoint_url
string | null
auth_header_name
string | null
auth_header_value
string | null
trigger_on_sources
string[] | null
trigger_on_severities
string[] | null
trigger_filter
Trigger Filter · object
timeout_seconds
integer | null
Required range: 1 <= x <= 300
retry_count
integer | null
Required range: 0 <= x <= 10
is_active
boolean | null
documentation
string | null

Response

Successful Response

data
AgentRegistrationResponse · object
required
meta
Meta · object