HyperoruDocumentation
Api referenceFindings

Get Finding

Reference for Get Finding in the Hyperoru v1 API, including request, response, and authentication details.

GET/v1/workspaces/{workspace_id}/findings/{finding_id}

Get Finding. Returns a typed response and a request ID for operational support.

Authorization

hyperoru_session<token>

Opaque HttpOnly customer session. Mutations also require X-CSRF-Token.

In: cookie

Path Parameters

workspace_id*Workspace Id
Formatuuid
finding_id*Finding Id
Formatuuid

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/findings/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "analyst_confirmed": true,
  "audit_id": "78c04fa6-cfb4-46a0-9aa5-3681ba4f3897",
  "commit_sha": "string",
  "confidence": "string",
  "description": "string",
  "exception": {},
  "exploit": {},
  "first_seen_at": "2019-08-24T14:15:22Z",
  "hypothesis": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "last_seen_at": "2019-08-24T14:15:22Z",
  "locations": [
    {}
  ],
  "mappings": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  "reachability": "string",
  "recommendation": "string",
  "repository_id": "b349ae61-b973-4c6c-a5e0-89183ba99ff3",
  "risk_severity": "string",
  "risk_total": "string",
  "rule_id": "string",
  "scanner_severity": "string",
  "score_breakdown": [
    {}
  ],
  "sla_due_at": "2019-08-24T14:15:22Z",
  "stable_fingerprint": "string",
  "state": "new",
  "title": "string",
  "tool": "string",
  "tool_version": "string"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.hyperoru.com/problems/validation_failed"
}

Finding Risk Summary

Previous Page

Update Finding

Next Page