Payload {
"alert": Alert,
"meta": {
"host": string,
"totalEndpoints": number,
"totalSensitiveEndpoints": number,
}
}
Alert {
"uuid": string,
"type": AlertType,
"status": "Open" | "Ignored" | "Closed",
"context": object,
"createdAt": Date,
"riskScore": RiskScore,
"updatedAt": Date,
"description": string,
"apiEndpoint": ApiEndpoint,
"apiEndpointUuid": string,
"organizationUuid": string,
}
ApiEndpoint {
"uuid": string,
"path": string,
"pathRegex": string,
"createdAt": Date,
"updatedAt": Date,
"firstDetected": Date,
"lastActive": Date,
"host": string,
"numberParams": number,
"method": RestMethod,
"riskScore": RiskScore,
"oldEndpointUuids": string[],
"dataFields": DataField[],
"isAuthenticatedDetected": boolean,
"isAuthenticatedUserSet": boolean,
"isGraphQl": boolean,
}
RiskScore {
"high",
"medium",
"low",
"none",
}
DataField {
"uuid": string,
"dataClasses": string[],
"falsePositives": string[],
"scannerIdentified": string[],
"dataType": DataType,
"dataTag": DataTag,
"dataSection": DataSection,
"createdAt": Date,
"updatedAt": Date,
"dataPath": string,
"apiEndpointUuid": string,
}
DataType {
"integer",
"number",
"string",
"boolean",
"object",
"array",
"unknown",
}
DataTag {
"PII"
}
DataSection {
"reqPath",
"reqQuery",
"reqHeaders",
"reqBody",
"resHeaders",
"resBody",
}
RestMethod {
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"CONNECT",
"OPTIONS",
"TRACE",
}
AlertType {
"New Endpoint Detected",
"PII Data Detected",
"Open API Spec Diff",
"Sensitive Data in Query Params",
"Sensitive Data in Path Params",
"Basic Authentication Detected",
"Endpoint not secured by SSL",
"Unauthenticated Endpoint returning Sensitive Data",
}