> For the complete documentation index, see [llms.txt](https://docs.n8n.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.n8n.io/connect/n8n-api/audit.md).

# Audit

Operations about security audit

## Generate an audit

> Generate a security audit for your n8n instance.

```json
{"openapi":"3.0.0","info":{"title":"n8n Public API","version":"1.1.1"},"tags":[{"name":"Audit","description":"Operations about security audit"}],"servers":[{"url":"/api/v1","description":"Current n8n instance (self-hosted built-in playground)"},{"url":"{url}/api/v1","description":"Self-hosted n8n instance","variables":{"url":{"default":"https://example.com"}}}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"CookieAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-N8N-API-KEY"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"CookieAuth":{"type":"apiKey","in":"cookie","name":"n8n-auth"}},"schemas":{"auditVersion.generated":{"type":"object","properties":{"name":{"type":"string"},"nodes":{"type":"array","items":{}},"createdAt":{"type":"string"},"description":{"type":"string"},"documentationUrl":{"type":"string"},"hasBreakingChange":{"type":"boolean"},"hasSecurityFix":{"type":"boolean","nullable":true},"hasSecurityIssue":{"type":"boolean","nullable":true},"securityIssueFixVersion":{"type":"string","nullable":true}},"required":["name","nodes","createdAt","description","documentationUrl","hasBreakingChange","hasSecurityFix","hasSecurityIssue","securityIssueFixVersion"]}},"responses":{"badRequest":{"description":"The request is invalid or provides malformed data."},"unauthorized":{"description":"Unauthorized"},"forbidden":{"description":"Forbidden"},"unsupportedMediaType":{"description":"Unsupported media type."},"internalServerError":{"description":"Internal server error."}}},"paths":{"/audit":{"post":{"operationId":"generateAudit","tags":["Audit"],"summary":"Generate an audit","description":"Generate a security audit for your n8n instance.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"additionalOptions":{"type":"object","properties":{"daysAbandonedWorkflow":{"type":"integer","description":"Days for a workflow to be considered abandoned if not executed"},"categories":{"type":"array","items":{"type":"string","enum":["credentials","database","nodes","filesystem","instance"]}}}}}}}}},"responses":{"200":{"description":"Operation successful.","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"Credentials Risk Report":{"type":"object","properties":{"risk":{"type":"string","enum":["credentials","database","nodes","filesystem","instance"]},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"recommendation":{"type":"string"},"location":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["node"]},"workflowId":{"type":"string"},"workflowName":{"type":"string"},"nodeId":{"type":"string"},"nodeName":{"type":"string"},"nodeType":{"type":"string"}},"required":["kind","workflowId","workflowName","nodeId","nodeName","nodeType"]},{"type":"object","properties":{"kind":{"type":"string","enum":["credential"]},"id":{"type":"string"},"name":{"type":"string"}},"required":["kind","id","name"]},{"type":"object","properties":{"kind":{"type":"string","enum":["community"]},"nodeType":{"type":"string"},"packageUrl":{"type":"string"}},"required":["kind","nodeType","packageUrl"]},{"type":"object","properties":{"kind":{"type":"string","enum":["custom"]},"nodeType":{"type":"string"},"filePath":{"type":"string"}},"required":["kind","nodeType","filePath"]}],"type":"object"}},"settings":{"type":"object","additionalProperties":{}},"nextVersions":{"type":"array","items":{"$ref":"#/components/schemas/auditVersion.generated"}}},"required":["title","description","recommendation"]}}},"required":["risk","sections"]},"Database Risk Report":{"type":"object","properties":{"risk":{"type":"string","enum":["credentials","database","nodes","filesystem","instance"]},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"recommendation":{"type":"string"},"location":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["node"]},"workflowId":{"type":"string"},"workflowName":{"type":"string"},"nodeId":{"type":"string"},"nodeName":{"type":"string"},"nodeType":{"type":"string"}},"required":["kind","workflowId","workflowName","nodeId","nodeName","nodeType"]},{"type":"object","properties":{"kind":{"type":"string","enum":["credential"]},"id":{"type":"string"},"name":{"type":"string"}},"required":["kind","id","name"]},{"type":"object","properties":{"kind":{"type":"string","enum":["community"]},"nodeType":{"type":"string"},"packageUrl":{"type":"string"}},"required":["kind","nodeType","packageUrl"]},{"type":"object","properties":{"kind":{"type":"string","enum":["custom"]},"nodeType":{"type":"string"},"filePath":{"type":"string"}},"required":["kind","nodeType","filePath"]}],"type":"object"}},"settings":{"type":"object","additionalProperties":{}},"nextVersions":{"type":"array","items":{"$ref":"#/components/schemas/auditVersion.generated"}}},"required":["title","description","recommendation"]}}},"required":["risk","sections"]},"Filesystem Risk Report":{"type":"object","properties":{"risk":{"type":"string","enum":["credentials","database","nodes","filesystem","instance"]},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"recommendation":{"type":"string"},"location":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["node"]},"workflowId":{"type":"string"},"workflowName":{"type":"string"},"nodeId":{"type":"string"},"nodeName":{"type":"string"},"nodeType":{"type":"string"}},"required":["kind","workflowId","workflowName","nodeId","nodeName","nodeType"]},{"type":"object","properties":{"kind":{"type":"string","enum":["credential"]},"id":{"type":"string"},"name":{"type":"string"}},"required":["kind","id","name"]},{"type":"object","properties":{"kind":{"type":"string","enum":["community"]},"nodeType":{"type":"string"},"packageUrl":{"type":"string"}},"required":["kind","nodeType","packageUrl"]},{"type":"object","properties":{"kind":{"type":"string","enum":["custom"]},"nodeType":{"type":"string"},"filePath":{"type":"string"}},"required":["kind","nodeType","filePath"]}],"type":"object"}},"settings":{"type":"object","additionalProperties":{}},"nextVersions":{"type":"array","items":{"$ref":"#/components/schemas/auditVersion.generated"}}},"required":["title","description","recommendation"]}}},"required":["risk","sections"]},"Nodes Risk Report":{"type":"object","properties":{"risk":{"type":"string","enum":["credentials","database","nodes","filesystem","instance"]},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"recommendation":{"type":"string"},"location":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["node"]},"workflowId":{"type":"string"},"workflowName":{"type":"string"},"nodeId":{"type":"string"},"nodeName":{"type":"string"},"nodeType":{"type":"string"}},"required":["kind","workflowId","workflowName","nodeId","nodeName","nodeType"]},{"type":"object","properties":{"kind":{"type":"string","enum":["credential"]},"id":{"type":"string"},"name":{"type":"string"}},"required":["kind","id","name"]},{"type":"object","properties":{"kind":{"type":"string","enum":["community"]},"nodeType":{"type":"string"},"packageUrl":{"type":"string"}},"required":["kind","nodeType","packageUrl"]},{"type":"object","properties":{"kind":{"type":"string","enum":["custom"]},"nodeType":{"type":"string"},"filePath":{"type":"string"}},"required":["kind","nodeType","filePath"]}],"type":"object"}},"settings":{"type":"object","additionalProperties":{}},"nextVersions":{"type":"array","items":{"$ref":"#/components/schemas/auditVersion.generated"}}},"required":["title","description","recommendation"]}}},"required":["risk","sections"]},"Instance Risk Report":{"type":"object","properties":{"risk":{"type":"string","enum":["credentials","database","nodes","filesystem","instance"]},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"recommendation":{"type":"string"},"location":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["node"]},"workflowId":{"type":"string"},"workflowName":{"type":"string"},"nodeId":{"type":"string"},"nodeName":{"type":"string"},"nodeType":{"type":"string"}},"required":["kind","workflowId","workflowName","nodeId","nodeName","nodeType"]},{"type":"object","properties":{"kind":{"type":"string","enum":["credential"]},"id":{"type":"string"},"name":{"type":"string"}},"required":["kind","id","name"]},{"type":"object","properties":{"kind":{"type":"string","enum":["community"]},"nodeType":{"type":"string"},"packageUrl":{"type":"string"}},"required":["kind","nodeType","packageUrl"]},{"type":"object","properties":{"kind":{"type":"string","enum":["custom"]},"nodeType":{"type":"string"},"filePath":{"type":"string"}},"required":["kind","nodeType","filePath"]}],"type":"object"}},"settings":{"type":"object","additionalProperties":{}},"nextVersions":{"type":"array","items":{"$ref":"#/components/schemas/auditVersion.generated"}}},"required":["title","description","recommendation"]}}},"required":["risk","sections"]}}},{"type":"array","items":{},"maxItems":0}]}}}},"400":{"$ref":"#/components/responses/badRequest"},"401":{"$ref":"#/components/responses/unauthorized"},"403":{"$ref":"#/components/responses/forbidden"},"415":{"$ref":"#/components/responses/unsupportedMediaType"},"500":{"$ref":"#/components/responses/internalServerError"}}}}}}
```