{ "opencollection": "1.0.0", "info": { "name": "external/applications/applications.proto ApplicationsService ReportingService API", "version": "version not set" }, "items": [ { "info": { "name": "ReportingService", "type": "folder" }, "items": [ { "info": { "name": "List Controls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v0/compliance/reporting/controls" }, "docs": "Lists controls from the last run, with optional filtering.\nSupports filtering,pagination but not sorting.\nLimited to 100 results by default.\n\nAuthorization Action:\n```\ncompliance:controlItems:list\n```" }, { "info": { "name": "List Controls Search", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v0/compliance/reporting/controls/search" }, "docs": "Lists controls from the last run, with optional filtering.\nSupports filtering,pagination but not sorting.\nLimited to 100 results by default.\nGets the summary of each control.\n\nThe API supports date range filters when `end_time` is the current time\nand `start_time` is any time in last 90 days. In case, the `end_time` is any\ndate other than the current date, the API would return data only for the `end_time`.\n\nExample:\n```\n{\"filters\":\n[\n{\"type\":\"start_time\",\"values\":[\"2019-09-09T00:00:00Z\"]},\n{\"typ" }, { "info": { "name": "Show Node Header Info From Report ID", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v0/compliance/reporting/nodeheader/id/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier." } ] }, "docs": "Show specific details about node, report and metadate provided the report ID.\nSupports filtering, but not pagination or sorting.\n\nAuthorization Action:\n```\ncompliance:nodeheader:get\n```" }, { "info": { "name": "Show Node by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v0/compliance/reporting/nodes/id/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier." } ] }, "docs": "Show a specific node by ID.\nSupports filtering by profile or control.\nDoes not support pagination or sorting.\n\nAuthorization Action:\n```\ncompliance:reportNodes:get\n```" }, { "info": { "name": "List Nodes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v0/compliance/reporting/nodes/search" }, "docs": "List all nodes, with optional filtering, pagination, and sorting.\nMax return payload size is 4MB, use pagination to fetch remaining data.\n| Sort parameter | Sort value |\n| --- | --- |\n| environment | environment.lower |\n| latest_report.controls.failed.critical | controls_sums.failed.critical |\n| latest_report.controls.failed.total | controls_sums.failed.total |\n| latest_report.end_time (default) | end_time |\n| latest_report.status | status |\n| name | node_name.lower |\n| platform | platform.full " }, { "info": { "name": "List Profiles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v0/compliance/reporting/profiles" }, "docs": "List all profiles in use, with optional filtering.\nSupports pagination, filtering, and sorting.\nValid sort fields: name, title\n\nThe API supports date range filters when `end_time` is the current time\nand `start_time` is any time in last 90 days. In case, the `end_time` is any\ndate other than the current date, the API would return data only for the `end_time`.\n\nExample:\n```\n{\"filters\":\n[\n{\"type\":\"start_time\",\"values\":[\"2019-09-09T00:00:00Z\"]},\n{\"type\":\"end_time\",\"values\":[\"2019-09-11T23:59:59Z\"]}" }, { "info": { "name": "List Report IDs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v0/compliance/reporting/report-ids" }, "docs": "List all IDs for the latest report for each node, with optional filtering.\nSupports filtering, but not pagination or sorting.\nIncluding more than one value for `profile_id`, or `profile_name` is not allowed.\nIncluding values for both `profile_id` and `profile_name` in one request is not allowed.\nMax return payload size is 4MB.\n\nAuthorization Action:\n```\ncompliance:reportids:list\n```" }, { "info": { "name": "List Control Info", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v0/compliance/reporting/reportcontrols/id/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier." } ] }, "docs": "Lists controls from the last run, with optional filtering.\nSupports filtering and pagination. Maximum 100 search can be \nmade when specifying the pagination from and size. Sum of from+size\nshould be less that 100. By default 10 results will be returned.\nAuthorization Action:\n```\ncompliance:ControlElements:list\n```" }, { "info": { "name": "Export reports", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v0/compliance/reporting/reportmanager/export" }, "docs": "Export multiple reports.\nSupports filtering by profile or control. API returns an acknowledgement ID.\n\nAuthorization Action:\n```\ncompliance:reports:list\n```" }, { "info": { "name": "List Reports", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v0/compliance/reporting/reports" }, "docs": "Makes a list of reports. Adding a filter makes a list of all node reports that meet the filter criteria.\nSupports pagination, filtering, and sorting.\nMax return payload size is 4MB, use pagination to fetch remaining data.\n\nValid sort fields: latest_report.controls.failed.critical, latest_report.controls.failed.total, latest_report.end_time, latest_report.status, node_name\n\nExample:\n```\n{\"filters\":\n[\n{\"type\":\"start_time\",\"values\":[\"2019-09-09T00:00:00Z\"]},\n{\"type\":\"end_time\",\"values\":[\"2019-09-11" }, { "info": { "name": "Show Report by ID", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v0/compliance/reporting/reports/id/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier." } ] }, "docs": "Show a specific report by ID. Supports filtering, but not pagination or sorting.\nIncluding more than one value for `profile_id`, or `profile_name` is not allowed.\nIncluding values for both `profile_id` and `profile_name` in one request is not allowed.\n\nAuthorization Action:\n```\ncompliance:reports:get\n```" }, { "info": { "name": "List Reporting Suggestions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v0/compliance/reporting/suggestions" }, "docs": "Get suggestions for compliance reporting resources based on matching text substrings.\nSupports filtering, but not pagination or sorting.\n`type` parameter is required. It must be one of the parameters from the following table.\n\n| Suggestion type parameter | Suggestion type value |\n| --- | --- |\n| chef_server | source_fqdn |\n| chef_tags | chef_tags |\n| control | profiles.controls.title |\n| control_tag_key | profiles.controls.string_tags.key |\n| control_tag_value | profiles.controls.string_tags.val" } ] } ], "bundled": true }