audit/destinations/{id}

Endpoint

/v2/audit/destinations/{id}

GET

Retrieves the configuration for the specified audit log destination.

Parameters

Name	Description	Required
`id`	The audit log destination ID.	Yes

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",
            "LOCAL"
          ],
          "description": "type:\n * `CLOUDWATCH` - AUDIT_DESTINATION_CLOUDWATCH,\n * `LOCAL` - AUDIT_DESTINATION_LOCAL,\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"
        },
        "log_format": {
          "type": "string",
          "enum": [
            "csv",
            "json"
          ],
          "description": "log_format:\n * `csv` - SYSLOG_AUDIT_FORMAT_CSV,\n * `json` - SYSLOG_AUDIT_FORMAT_JSON"
        },
        "log_group_name": {
          "description": "log_group_name",
          "type": "string"
        },
        "region": {
          "description": "region",
          "type": "string"
        }
      }
    }
  }
}

PUT

Replaces the configuration for the specified audit log destination.

Parameters

Name	Description	Required
`id`	The audit log destination ID.	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_audit_destination_config",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "SYSLOG",
        "CLOUDWATCH",
        "LOCAL"
      ],
      "description": "type:\n * `CLOUDWATCH` - AUDIT_DESTINATION_CLOUDWATCH,\n * `LOCAL` - AUDIT_DESTINATION_LOCAL,\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"
    },
    "log_format": {
      "type": "string",
      "enum": [
        "csv",
        "json"
      ],
      "description": "log_format:\n * `csv` - SYSLOG_AUDIT_FORMAT_CSV,\n * `json` - SYSLOG_AUDIT_FORMAT_JSON"
    },
    "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",
            "LOCAL"
          ],
          "description": "type:\n * `CLOUDWATCH` - AUDIT_DESTINATION_CLOUDWATCH,\n * `LOCAL` - AUDIT_DESTINATION_LOCAL,\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"
        },
        "log_format": {
          "type": "string",
          "enum": [
            "csv",
            "json"
          ],
          "description": "log_format:\n * `csv` - SYSLOG_AUDIT_FORMAT_CSV,\n * `json` - SYSLOG_AUDIT_FORMAT_JSON"
        },
        "log_group_name": {
          "description": "log_group_name",
          "type": "string"
        },
        "region": {
          "description": "region",
          "type": "string"
        }
      }
    }
  }
}

DELETE

Deletes the specified audit log destination.

Parameters

Name	Description	Required
`id`	The audit log destination ID.	Yes
`If-Match`	ETag for expected version	No

Response

Codes

Code	Description
200	Return value on success

PATCH

Modifies the configuration for the specified audit log destination.

Parameters

Name	Description	Required
`id`	The audit log destination ID.	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "audit_destination_config_delta",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "enabled",
      "type": "boolean"
    }
  }
}

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",
            "LOCAL"
          ],
          "description": "type:\n * `CLOUDWATCH` - AUDIT_DESTINATION_CLOUDWATCH,\n * `LOCAL` - AUDIT_DESTINATION_LOCAL,\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"
        },
        "log_format": {
          "type": "string",
          "enum": [
            "csv",
            "json"
          ],
          "description": "log_format:\n * `csv` - SYSLOG_AUDIT_FORMAT_CSV,\n * `json` - SYSLOG_AUDIT_FORMAT_JSON"
        },
        "log_group_name": {
          "description": "log_group_name",
          "type": "string"
        },
        "region": {
          "description": "region",
          "type": "string"
        }
      }
    }
  }
}