Generate applied policy report

POST

/api/v1/projects/{projectId}/policies/report

const url = 'https://localhost:10001/api/v1/projects/example/policies/report';
const options = {
  method: 'POST',
  headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'},
  body: '{"format":"pdf","paper":"a4","policyCids":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://localhost:10001/api/v1/projects/example/policies/report \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "format": "pdf", "paper": "a4", "policyCids": [ "example" ] }'

Fetches the policy manifest for the project and renders it to a report document via the pdfgen service

Authorizations

BearerAuth

Parameters

Path Parameters

projectId

required

string

Project ID, UUID (urn:uuid optional), or slug:my-project

Request Body

Policy report request

application/json

object

format

Pdf returns a PDF, else a zip

string

Example

pdf

paper

Pdfgen default when omitted

string

Example

a4

policyCids

required

At least one CID is required

Array<string>

>= 1 items

Responses

200

Rendered policy report document

file

400

Bad request - Invalid project ID, request body, or missing policy CIDs

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body

401

Unauthorized - Authentication required

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body

403

Forbidden - No project access or insufficient permissions

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body

404

Project not found

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body

500

Internal server error

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body

502

Bad gateway - pdfgen report generation failed

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

Invalid request body