Endpoint

/v2/audit/destinations/

GET

Lists all configured audit log destinations.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_audit_destination_list",
  "type": "object",
  "properties": {
    "destinations": {
      "type": "array",
      "items": {
        "description": "destinations",
        "type": "object",
        "properties": {
          "id": {
            "description": "id",
            "type": "string"
          },
          "config": {
            "description": "config",
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "SYSLOG",
                  "CLOUDWATCH"
                ],
                "description": "type:\n * `CLOUDWATCH` - AUDIT_DESTINATION_CLOUDWATCH,\n * `SYSLOG` - AUDIT_DESTINATION_SYSLOG"
              },
              "name": {
                "description": "name",
                "type": "string"
              },
              "enabled": {
                "description": "enabled",
                "type": "boolean"
              },
              "server_address": {
                "description": "server_address",
                "type": "string"
              },
              "server_port": {
                "description": "server_port",
                "type": "number"
              },
              "format": {
                "description": "format",
                "type": "string"
              },
              "local_enabled": {
                "description": "local_enabled",
                "type": "boolean"
              },
              "log_group_name": {
                "description": "log_group_name",
                "type": "string"
              },
              "region": {
                "description": "region",
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

POST

Creates a new audit log destination.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_audit_destination_post",
  "type": "object",
  "properties": {
    "config": {
      "description": "config",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "SYSLOG",
            "CLOUDWATCH"
          ],
          "description": "type:\n * `CLOUDWATCH` - AUDIT_DESTINATION_CLOUDWATCH,\n * `SYSLOG` - AUDIT_DESTINATION_SYSLOG"
        },
        "name": {
          "description": "name",
          "type": "string"
        },
        "enabled": {
          "description": "enabled",
          "type": "boolean"
        },
        "server_address": {
          "description": "server_address",
          "type": "string"
        },
        "server_port": {
          "description": "server_port",
          "type": "number"
        },
        "format": {
          "description": "format",
          "type": "string"
        },
        "local_enabled": {
          "description": "local_enabled",
          "type": "boolean"
        },
        "log_group_name": {
          "description": "log_group_name",
          "type": "string"
        },
        "region": {
          "description": "region",
          "type": "string"
        }
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_audit_destination",
  "type": "object",
  "properties": {
    "id": {
      "description": "id",
      "type": "string"
    },
    "config": {
      "description": "config",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "SYSLOG",
            "CLOUDWATCH"
          ],
          "description": "type:\n * `CLOUDWATCH` - AUDIT_DESTINATION_CLOUDWATCH,\n * `SYSLOG` - AUDIT_DESTINATION_SYSLOG"
        },
        "name": {
          "description": "name",
          "type": "string"
        },
        "enabled": {
          "description": "enabled",
          "type": "boolean"
        },
        "server_address": {
          "description": "server_address",
          "type": "string"
        },
        "server_port": {
          "description": "server_port",
          "type": "number"
        },
        "format": {
          "description": "format",
          "type": "string"
        },
        "local_enabled": {
          "description": "local_enabled",
          "type": "boolean"
        },
        "log_group_name": {
          "description": "log_group_name",
          "type": "string"
        },
        "region": {
          "description": "region",
          "type": "string"
        }
      }
    }
  }
}