System

System get configure

get/system/config

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/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

scope'fed' | 'local'

When set the scope to be fed, it will return the fed system configures. When set the scope to be local, it will return the local system configures. If there is no query string 'scope', it will return all system configures.

Headers

X-Auth-Tokenstring required

Response

Success

Example response

{
  "config": {
    "new_service_policy_mode": "Discover",
    "unused_group_aging": 123,
    "syslog_ip": "10.1.0.14",
    "syslog_ip_proto": 6,
    "syslog_port": 514,
    "syslog_level": "INFO",
    "syslog_in_json": true,
    "auth_by_platform": true,
    "webhooks": [
      {
        "name": "slack-webhook",
        "url": "https://neuvector.slack.com/archives/C8AU75GKE",
        "enable": true,
        "type": "Slack",
        "cfg_type": "user_created"
      }
    ],
    "cluster_name": "cluster1",
    "controller_debug": [
      "all"
    ],
    "monitor_service_mesh": true,
    "registry_http_proxy_status": true,
    "registry_http_proxy": {
      "username": "username",
      "password": "password"
    },
    "registry_https_proxy": {
      "username": "username",
      "password": "password"
    },
    "ibmsa_ep_start": 1
  },
  "fed_config": {
    "webhooks": {
      "name": "slack-webhook",
      "url": "https://neuvector.slack.com/archives/C8AU75GKE",
      "enable": true,
      "type": "Slack",
      "cfg_type": "user_created"
    }
  }
}

Changes

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