Endpoint

/v1/audit/syslog/config

GET

Retrieves audit log syslog configuration for the cluster.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "syslog_audit_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "Enable remote audit log.",
      "type": "boolean"
    },
    "server_address": {
      "description": "The IP address, hostname, or fully qualified domain name of your remote syslog server.",
      "type": "string"
    },
    "server_port": {
      "description": "server_port",
      "type": "number"
    },
    "local_enabled": {
      "description": "Enable per-node local audit log.",
      "type": "boolean"
    },
    "format": {
      "type": "string",
      "enum": [
        "csv",
        "json"
      ],
      "description": "Output syslog as CSV or JSON.:\n * `csv` - SYSLOG_AUDIT_FORMAT_CSV,\n * `json` - SYSLOG_AUDIT_FORMAT_JSON"
    }
  }
}

PUT

Modifies audit log syslog configuration for the cluster.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "syslog_audit_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "Enable remote audit log.",
      "type": "boolean"
    },
    "server_address": {
      "description": "The IP address, hostname, or fully qualified domain name of your remote syslog server.",
      "type": "string"
    },
    "server_port": {
      "description": "server_port",
      "type": "number"
    },
    "local_enabled": {
      "description": "Enable per-node local audit log.",
      "type": "boolean"
    },
    "format": {
      "type": "string",
      "enum": [
        "csv",
        "json"
      ],
      "description": "Output syslog as CSV or JSON.:\n * `csv` - SYSLOG_AUDIT_FORMAT_CSV,\n * `json` - SYSLOG_AUDIT_FORMAT_JSON"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "syslog_audit_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "Enable remote audit log.",
      "type": "boolean"
    },
    "server_address": {
      "description": "The IP address, hostname, or fully qualified domain name of your remote syslog server.",
      "type": "string"
    },
    "server_port": {
      "description": "server_port",
      "type": "number"
    },
    "local_enabled": {
      "description": "Enable per-node local audit log.",
      "type": "boolean"
    },
    "format": {
      "type": "string",
      "enum": [
        "csv",
        "json"
      ],
      "description": "Output syslog as CSV or JSON.:\n * `csv` - SYSLOG_AUDIT_FORMAT_CSV,\n * `json` - SYSLOG_AUDIT_FORMAT_JSON"
    }
  }
}

PATCH

Modifies audit log syslog configuration for the cluster.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "syslog_audit_config_delta",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "Enable remote audit log.",
      "type": "boolean"
    },
    "server_address": {
      "description": "The IP address, hostname, or fully qualified domain name of your remote syslog server.",
      "type": "string"
    },
    "server_port": {
      "description": "server_port",
      "type": "number"
    },
    "local_enabled": {
      "description": "Enable per-node local audit log.",
      "type": "boolean"
    },
    "format": {
      "type": "string",
      "enum": [
        "csv",
        "json"
      ],
      "description": "Output syslog as CSV or JSON.:\n * `csv` - SYSLOG_AUDIT_FORMAT_CSV,\n * `json` - SYSLOG_AUDIT_FORMAT_JSON"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "syslog_audit_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "Enable remote audit log.",
      "type": "boolean"
    },
    "server_address": {
      "description": "The IP address, hostname, or fully qualified domain name of your remote syslog server.",
      "type": "string"
    },
    "server_port": {
      "description": "server_port",
      "type": "number"
    },
    "local_enabled": {
      "description": "Enable per-node local audit log.",
      "type": "boolean"
    },
    "format": {
      "type": "string",
      "enum": [
        "csv",
        "json"
      ],
      "description": "Output syslog as CSV or JSON.:\n * `csv` - SYSLOG_AUDIT_FORMAT_CSV,\n * `json` - SYSLOG_AUDIT_FORMAT_JSON"
    }
  }
}