POST/v1/workspace/compliance/reports

Generate a compliance report

Admin only. A report is a name and the set of checks it runs; a report that asks nothing is refused. reviewWindowDays (90 by default) is how long a sign-off counts for and is read by the seat-review check. A second report under the same name is refused as a conflict.

Access class: workspace:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Request body

application/jsonrequired

bodyoptional

paramsobjectoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "active": true,
    "checks": [
      "string"
    ],
    "createdAt": "string",
    "createdBy": 1,
    "description": "string",
    "id": "",
    "lastRun": {
      "checksRun": [
        "string"
      ],
      "decisions": [
        "string"
      ],
      "failed": 1,
      "id": "",
      "outcome": "string",
      "passed": 1,
      "ranAt": "string",
      "ranBy": 1,
      "reportId": "",
      "reportName": "string",
      "standing": "string",
      "subjects": 1
    },
    "name": "string",
    "reviewWindowDays": 1,
    "updatedAt": "string"
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired

curl --request POST \ 'https://neo-app-api-prod-836053680024.us-central1.run.app/v1/workspace/compliance/reports' \ --header 'Content-Type: application/json' \ --data '{ "body": { "active": true, "checks": [ "string" ], "description": "string", "name": "string", "reviewWindowDays": 1 }, "params": {}, "query": {}}'

{ "data": { "active": true, "checks": [ "string" ], "createdAt": "string", "createdBy": 1, "description": "string", "id": "", "lastRun": { "checksRun": [ "string" ], "decisions": [ "string" ], "failed": 1, "id": "", "outcome": "string", "passed": 1, "ranAt": "string", "ranBy": 1, "reportId": "", "reportName": "string", "standing": "string", "subjects": 1 }, "name": "string", "reviewWindowDays": 1, "updatedAt": "string" }}