Get a rule's help page

GET

/v1/rules/{id}/doc

const url = 'http://localhost:8080/v1/rules/example/doc';
const options = {method: 'GET'};

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

curl --request GET \
  --url http://localhost:8080/v1/rules/example/doc

Returns the Markdown help page shipped inside the image for a rule (text/markdown), the in-product documentation the workstation links from a finding. Any staff role or an API key with status:read. 404 when the rule is not in the active ruleset or no page is shipped for it.

Get a rule's help page

Parameters

Path Parameters

Responses

200