Rapid7 · Schema

ErrorResponse

SecurityVulnerability ManagementSIEMXDRCloud SecuritySOARApplication Security

Properties

Name Type Description
message string A human-readable message describing the error that occurred.
correlation_id string An identifier that uniquely identifies the failed request.
View JSON Schema on GitHub

JSON Schema

rapid7-errorresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ErrorResponse",
  "title": "ErrorResponse",
  "required": [
    "message"
  ],
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message describing the error that occurred.",
      "example": "A human-readable message describing the error that occurred."
    },
    "correlation_id": {
      "type": "string",
      "description": "An identifier that uniquely identifies the failed request.",
      "example": "6b6503c8-2da9-41c0-94cb-2f34069e00cd"
    }
  }
}