System

Configure system webhook

patch/system/config/webhook/{name}

Request

Base URL
/v1 (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared. Required headers: X-Auth-Token
TypeScript
https://skmtc.dev/neuvector/apis/neuvector-api/docs/system/config/webhook/:name/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

System webhook name

Query parameters

scope'fed' | 'local'

When set the scope to be fed, it will update the fed level webhook. When set the scope to be local, it will update the local webhook. If there is no query string 'scope', it will use 'local' as the default value.

Headers

X-Auth-Tokenstring required

Request body

Example request

{
  "config": {
    "name": "slack-webhook",
    "url": "https://neuvector.slack.com/archives/C8AU75GKE",
    "enable": true,
    "type": "Slack",
    "cfg_type": "user_created"
  }
}

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.