Endpoint

/v1/audit/cloudwatch/config

GET

Retrieves audit log CloudWatch configuration for the cluster.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "cloudwatch_audit_user_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "enabled",
      "type": "boolean"
    },
    "log_group_name": {
      "description": "log_group_name",
      "type": "string"
    },
    "region": {
      "description": "region",
      "type": "string"
    }
  }
}

PUT

Sets audit log CloudWatch configuration for the cluster.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "cloudwatch_audit_user_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "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": "cloudwatch_audit_user_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "enabled",
      "type": "boolean"
    },
    "log_group_name": {
      "description": "log_group_name",
      "type": "string"
    },
    "region": {
      "description": "region",
      "type": "string"
    }
  }
}

PATCH

Modifies audit log CloudWatch configuration for the cluster.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "cloudwatch_audit_user_config_delta",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "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": "cloudwatch_audit_user_config",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "enabled",
      "type": "boolean"
    },
    "log_group_name": {
      "description": "log_group_name",
      "type": "string"
    },
    "region": {
      "description": "region",
      "type": "string"
    }
  }
}