Skip to content

Developer portal

GET /tenant/compliance/posture

Map scan findings to compliance frameworks for posture reporting.

GET /tenant/compliance/postureAuth: viewer | operator | admin

Summary

Map scan findings to compliance frameworks for posture reporting.

Example

Response

{
  "status": "success",
  "frameworks": {
    "soc2": {
      "coveragePct": 91
    }
  }
}

Try it live

Paste your tenant API key to call the live API with your credentials. Leave blank to use the public sandbox key when configured, or click “Show example response” for the static fixture below.

Query parameters

FieldTypeRequiredDescription
scan_idstringYes

Scan identifier.

Response

FieldTypeRequiredDescription
frameworksobjectYes

Framework mappings and coverage stats.

Errors

CodeMeaningTypical causeSuggested fix
401UnauthorizedMissing or invalid API key in Authorization, x-api-key, or query param.Send Bearer <key> or x-api-key with a valid tenant token.
403ForbiddenValid key but insufficient role (viewer attempting write) or wrong admin key.Use operator or admin role key; check RBAC matrix.
404Not foundScan, schedule, share link, or resource id does not exist or expired.Verify id and tenant scope; share links expire per expiresHours.
422Unprocessable entityInvalid payload shape, unsupported scenario, or infeasible constraints.Fix field errors in response detail; relax constraints and retry.
429Too many requestsPer-key rate limit exceeded (default 300 requests per minute) or public endpoint limit.Backoff with jitter; cache results; request higher limit for production.
500Internal server errorUnexpected backend failure; includes requestId in response.Retry with exponential backoff; contact support with requestId if persistent.
503Service unavailablePersistence disabled, auth DB unreachable, or admin API not configured.Retry shortly; schedules require Postgres persistence enabled.

See the full errors reference.