Rapid7 · JSON Structure

Rapid7 Structure

Structural overview of the Rapid7 API surface; extracted from openapi/.

Type: Properties: 0
SecurityVulnerability ManagementSIEMXDRCloud SecuritySOARApplication Security

Rapid7 Structure is a JSON Structure definition published by Rapid7.

Meta-schema:

JSON Structure

rapid7-structure.json Raw ↑
{
  "provider": "Rapid7",
  "providerId": "rapid7",
  "kind": "json-structure",
  "description": "Structural overview of the Rapid7 API surface; extracted from openapi/.",
  "schemaCount": 0,
  "operationCount": 329,
  "schemas": [],
  "operations": [
    {
      "method": "GET",
      "path": "/api/3",
      "operationId": "resources",
      "summary": "Resources",
      "tags": [
        "Root"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/administration/commands",
      "operationId": "executeCommand",
      "summary": "Console Commands",
      "tags": [
        "Administration"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/administration/info",
      "operationId": "getInfo",
      "summary": "Information",
      "tags": [
        "Administration"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/administration/license",
      "operationId": "getLicense",
      "summary": "License",
      "tags": [
        "Administration"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/administration/license",
      "operationId": "activateLicense",
      "summary": "License",
      "tags": [
        "Administration"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/administration/properties",
      "operationId": "getProperties",
      "summary": "Properties",
      "tags": [
        "Administration"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/administration/settings",
      "operationId": "getSettings",
      "summary": "Settings",
      "tags": [
        "Administration"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/agents",
      "operationId": "getAgents",
      "summary": "Agents",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/asset_groups",
      "operationId": "getAssetGroups",
      "summary": "Asset Groups",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/asset_groups",
      "operationId": "createAssetGroup",
      "summary": "Asset Groups",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/asset_groups/{id}",
      "operationId": "getAssetGroup",
      "summary": "Asset Group",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/asset_groups/{id}",
      "operationId": "updateAssetGroup",
      "summary": "Asset Group",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/asset_groups/{id}",
      "operationId": "deleteAssetGroup",
      "summary": "Asset Group",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/asset_groups/{id}/assets",
      "operationId": "getAssetGroupAssets",
      "summary": "Asset Group Assets",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/asset_groups/{id}/assets",
      "operationId": "updateAssetGroupAssets",
      "summary": "Asset Group Assets",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/asset_groups/{id}/assets",
      "operationId": "removeAllAssetsFromAssetGroup",
      "summary": "Asset Group Assets",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/asset_groups/{id}/assets/{assetId}",
      "operationId": "addAssetToAssetGroup",
      "summary": "Asset Group Asset",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/asset_groups/{id}/assets/{assetId}",
      "operationId": "removeAssetFromAssetGroup",
      "summary": "Asset Group Asset",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/asset_groups/{id}/search_criteria",
      "operationId": "getAssetGroupSearchCriteria",
      "summary": "Asset Group Search Criteria",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/asset_groups/{id}/search_criteria",
      "operationId": "setAssetGroupSearchCriteria",
      "summary": "Asset Group Search Criteria",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/asset_groups/{id}/tags",
      "operationId": "getAssetGroupTags",
      "summary": "Asset Group Tags",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/asset_groups/{id}/tags",
      "operationId": "setAssetGroupTags",
      "summary": "Asset Group Tags",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/asset_groups/{id}/tags",
      "operationId": "removeAllAssetGroupTags",
      "summary": "Asset Group Tags",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/asset_groups/{id}/tags/{tagId}",
      "operationId": "addAssetGroupTag",
      "summary": "Resources and operations for managing asset groups.",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/asset_groups/{id}/tags/{tagId}",
      "operationId": "removeAssetGroupTag",
      "summary": "Resources and operations for managing asset groups.",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/asset_groups/{id}/users",
      "operationId": "getAssetGroupUsers",
      "summary": "Asset Group Users",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/asset_groups/{id}/users",
      "operationId": "setAssetGroupUsers",
      "summary": "Asset Group Users",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/asset_groups/{id}/users/{userId}",
      "operationId": "addAssetGroupUser",
      "summary": "Asset Group User",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/asset_groups/{id}/users/{userId}",
      "operationId": "removeAssetGroupUser",
      "summary": "Asset Group User",
      "tags": [
        "Asset Group"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets",
      "operationId": "getAssets",
      "summary": "Assets",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/sites/{id}/assets",
      "operationId": "getSiteAssets",
      "summary": "Site Assets",
      "tags": [
        "Site"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/sites/{id}/assets",
      "operationId": "createAsset",
      "summary": "Assets",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/sites/{id}/assets",
      "operationId": "removeSiteAssets",
      "summary": "Site Assets",
      "tags": [
        "Site"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/assets/search",
      "operationId": "findAssets",
      "summary": "Asset Search",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{assetId}/policies",
      "operationId": "getPoliciesForAsset",
      "summary": "Policies For Asset",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{assetId}/policies/{policyId}/children",
      "operationId": "getAssetPolicyChildren",
      "summary": "Policy Rules or Groups Directly Under Policy For Asset",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{assetId}/policies/{policyId}/groups/{groupId}/children",
      "operationId": "getAssetPolicyGroupChildren",
      "summary": "Policy Rules or Groups Directly Under Policy Group For Asset",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{assetId}/policies/{policyId}/groups/{groupId}/rules",
      "operationId": "getPolicyGroupRulesWithAssetAssessment",
      "summary": "Policy Rules Under Policy Group For Asset",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{assetId}/policies/{policyId}/rules",
      "operationId": "getAssetPolicyRulesSummary",
      "summary": "Policy Rules For Asset",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}",
      "operationId": "getAsset",
      "summary": "Asset",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/assets/{id}",
      "operationId": "deleteAsset",
      "summary": "Asset",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/databases",
      "operationId": "getAssetDatabases",
      "summary": "Asset Databases",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/files",
      "operationId": "getAssetFiles",
      "summary": "Asset Files",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/policy_overrides",
      "operationId": "getAssetPolicyOverrides",
      "summary": "Asset Policy Overrides",
      "tags": [
        "Policy Override"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/services",
      "operationId": "getAssetServices",
      "summary": "Asset Services",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/services/{protocol}/{port}",
      "operationId": "getAssetService",
      "summary": "Asset Service",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/services/{protocol}/{port}/configurations",
      "operationId": "getAssetServiceConfigurations",
      "summary": "Asset Service Configurations",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/services/{protocol}/{port}/databases",
      "operationId": "getAssetServiceDatabases",
      "summary": "Asset Service Databases",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/services/{protocol}/{port}/user_groups",
      "operationId": "getAssetServiceUserGroups",
      "summary": "Asset Service User Groups",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/services/{protocol}/{port}/users",
      "operationId": "getAssetServiceUsers",
      "summary": "Asset Service Users",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/services/{protocol}/{port}/vulnerabilities",
      "operationId": "getAssetServiceVulnerabilities",
      "summary": "Asset Service Vulnerabilities",
      "tags": [
        "Vulnerability Result"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/services/{protocol}/{port}/web_applications",
      "operationId": "getAssetServiceWebApplications",
      "summary": "Asset Service Web Applications",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/services/{protocol}/{port}/web_applications/{webApplicationId}",
      "operationId": "getAssetServiceWebApplication",
      "summary": "Asset Service Web Application",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/software",
      "operationId": "getAssetSoftware",
      "summary": "Asset Software",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/tags",
      "operationId": "getAssetTags",
      "summary": "Asset Tags",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/assets/{id}/tags/{tagId}",
      "operationId": "addAssetTag",
      "summary": "Asset Tag",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/assets/{id}/tags/{tagId}",
      "operationId": "removeAssetTag",
      "summary": "Asset Tag",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/user_groups",
      "operationId": "getAssetUserGroups",
      "summary": "Asset User Groups",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/users",
      "operationId": "getAssetUsers",
      "summary": "Asset Users",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/vulnerabilities",
      "operationId": "getAssetVulnerabilities",
      "summary": "Asset Vulnerabilities",
      "tags": [
        "Vulnerability Result"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/vulnerabilities/{vulnerabilityId}",
      "operationId": "getAssetVulnerability",
      "summary": "Asset Vulnerability",
      "tags": [
        "Vulnerability Result"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/solution",
      "operationId": "getAssetVulnerabilitySolutions",
      "summary": "Asset Vulnerability Solution",
      "tags": [
        "Remediation"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/validations",
      "operationId": "getVulnerabilityValidations",
      "summary": "Asset Vulnerability Validations",
      "tags": [
        "Vulnerability Result"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/validations",
      "operationId": "createVulnerabilityValidation",
      "summary": "Asset Vulnerability Validations",
      "tags": [
        "Vulnerability Result"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/validations/{validationId}",
      "operationId": "getVulnerabilityValidation",
      "summary": "Asset Vulnerability Validation",
      "tags": [
        "Vulnerability Result"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/validations/{validationId}",
      "operationId": "deleteVulnerabilityValidation",
      "summary": "Asset Vulnerability Validation",
      "tags": [
        "Vulnerability Result"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/authentication_sources",
      "operationId": "getAuthenticationSources",
      "summary": "Authentication Sources",
      "tags": [
        "User"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/authentication_sources/{id}",
      "operationId": "getAuthenticationSource",
      "summary": "Authentication Source",
      "tags": [
        "User"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/authentication_sources/{id}/users",
      "operationId": "getAuthenticationSourceUsers",
      "summary": "Authentication Source Users",
      "tags": [
        "User"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/discovery_connections",
      "operationId": "getDiscoveryConnections",
      "summary": "Discovery Connections",
      "tags": [
        "Asset Discovery"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/discovery_connections/{id}",
      "operationId": "getDiscoveryConnection",
      "summary": "Discovery Connection",
      "tags": [
        "Asset Discovery"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/discovery_connections/{id}/connect",
      "operationId": "reconnectDiscoveryConnection",
      "summary": "Discovery Connection Reconnect",
      "tags": [
        "Asset Discovery"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/exploits",
      "operationId": "getExploits",
      "summary": "Exploits",
      "tags": [
        "Vulnerability"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/exploits/{id}",
      "operationId": "getExploit",
      "summary": "Exploit",
      "tags": [
        "Vulnerability"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/exploits/{id}/vulnerabilities",
      "operationId": "getExploitVulnerabilities",
      "summary": "Exploitable Vulnerabilities",
      "tags": [
        "Vulnerability"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/malware_kits",
      "operationId": "getMalwareKits",
      "summary": "Malware Kits",
      "tags": [
        "Vulnerability"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/malware_kits/{id}",
      "operationId": "getMalwareKit",
      "summary": "Malware Kit",
      "tags": [
        "Vulnerability"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/malware_kits/{id}/vulnerabilities",
      "operationId": "getMalwareKitVulnerabilities",
      "summary": "Malware Kit Vulnerabilities",
      "tags": [
        "Vulnerability"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/operating_systems",
      "operationId": "getOperatingSystems",
      "summary": "Operating Systems",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/operating_systems/{id}",
      "operationId": "getOperatingSystem",
      "summary": "Operating System",
      "tags": [
        "Asset"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies",
      "operationId": "getPolicies",
      "summary": "Policies",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{id}/children",
      "operationId": "getPolicyChildren",
      "summary": "Policy Rules or Groups Directly Under Policy",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}",
      "operationId": "getPolicy",
      "summary": "Policy",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/assets",
      "operationId": "getPolicyAssetResults",
      "summary": "Policy Asset Results",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/assets/{assetId}",
      "operationId": "getPolicyAssetResult",
      "summary": "Policy Asset Result",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/groups",
      "operationId": "getPolicyGroups",
      "summary": "Policy Groups",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/groups/{groupId}",
      "operationId": "getPolicyGroup",
      "summary": "Policy Group",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/groups/{groupId}/assets",
      "operationId": "getPolicyGroupAssetResults",
      "summary": "Assets Compliance For Policy Rules Under Policy Group",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/groups/{groupId}/assets/{assetId}",
      "operationId": "getPolicyGroupAssetResult",
      "summary": "Asset Compliance For Policy Rules Under Policy Group",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/groups/{groupId}/children",
      "operationId": "getPolicyGroupChildren",
      "summary": "Policy Rules or Groups Directly Under Policy Group",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/groups/{groupId}/rules",
      "operationId": "getDescendantPolicyRules",
      "summary": "Policy Rules Under Policy Group",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/rules",
      "operationId": "getPolicyRules",
      "summary": "Policy Rules",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/rules/disabled",
      "operationId": "getDisabledPolicyRules",
      "summary": "Disabled Policy Rules",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/rules/{ruleId}",
      "operationId": "getPolicyRule",
      "summary": "Policy Rule",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/rules/{ruleId}/assets",
      "operationId": "getPolicyRuleAssetResults",
      "summary": "Assets Compliance For Policy Rule",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/rules/{ruleId}/assets/{assetId}",
      "operationId": "getPolicyRuleAssetResult",
      "summary": "Asset Compliance For Policy Rule",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/rules/{ruleId}/assets/{assetId}/proof",
      "operationId": "getPolicyRuleAssetResultProof",
      "summary": "Policy Rule Proof For Asset",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/rules/{ruleId}/controls",
      "operationId": "getPolicyRuleControls",
      "summary": "Policy Rule Controls",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/rules/{ruleId}/rationale",
      "operationId": "getPolicyRuleRationale",
      "summary": "Policy Rule Rationale",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policies/{policyId}/rules/{ruleId}/remediation",
      "operationId": "getPolicyRuleRemediation",
      "summary": "Policy Rule Remediation",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policy/summary",
      "operationId": "getPolicySummary",
      "summary": "Policy Compliance Summaries",
      "tags": [
        "Policy"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policy_overrides",
      "operationId": "getPolicyOverrides",
      "summary": "Policy Overrides",
      "tags": [
        "Policy Override"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/policy_overrides",
      "operationId": "createPolicyOverride",
      "summary": "Policy Overrides",
      "tags": [
        "Policy Override"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policy_overrides/{id}",
      "operationId": "getPolicyOverride",
      "summary": "Policy Override",
      "tags": [
        "Policy Override"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/policy_overrides/{id}",
      "operationId": "deletePolicyOverride",
      "summary": "Policy Override",
      "tags": [
        "Policy Override"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/policy_overrides/{id}/expires",
      "operationId": "getPolicyOverrideExpiration",
      "summary": "Policy Override Expiration",
      "tags": [
        "Policy Override"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/policy_overrides/{id}/expires",
      "operationId": "setPolicyOverrideExpiration",
      "summary": "Policy Override Expiration",
      "tags": [
        "Policy Override"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/policy_overrides/{id}/{status}",
      "operationId": "setPolicyOverrideStatus",
      "summary": "Policy Override Status",
      "tags": [
        "Policy Override"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/privileges",
      "operationId": "getPrivileges",
      "summary": "Privileges",
      "tags": [
        "User"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/privileges/{id}",
      "operationId": "getPrivilege",
      "summary": "Privilege",
      "tags": [
        "User"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/privileges/{id}/users",
      "operationId": "getUsersWithPrivilege",
      "summary": "Users With Privilege",
      "tags": [
        "User"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/report_formats",
      "operationId": "getReportFormats",
      "summary": "Report Formats",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/report_templates",
      "operationId": "getReportTemplates",
      "summary": "Report Templates",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/report_templates/{id}",
      "operationId": "getReportTemplate",
      "summary": "Report Template",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/reports",
      "operationId": "getReports",
      "summary": "Reports",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/reports",
      "operationId": "createReport",
      "summary": "Reports",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/reports/{id}",
      "operationId": "getReport",
      "summary": "Report",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/reports/{id}",
      "operationId": "updateReport",
      "summary": "Report",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/reports/{id}",
      "operationId": "deleteReport",
      "summary": "Report",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/reports/{id}/generate",
      "operationId": "generateReport",
      "summary": "Report Generation",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/reports/{id}/history",
      "operationId": "getReportInstances",
      "summary": "Report Histories",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/reports/{id}/history/{instance}",
      "operationId": "getReportInstance",
      "summary": "Report History",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/reports/{id}/history/{instance}",
      "operationId": "deleteReportInstance",
      "summary": "Report History",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/reports/{id}/history/{instance}/output",
      "operationId": "downloadReport",
      "summary": "Report Download",
      "tags": [
        "Report"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/roles",
      "operationId": "getRoles",
      "summary": "Roles",
      "tags": [
        "User"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/roles/{id}",
      "operationId": "getRole",
      "summary": "Role",
      "tags": [
        "User"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/roles/{id}",
      "operationId": "updateRole",
      "summary": "Role",
      "tags": [
        "User"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/roles/{id}",
      "operationId": "deleteRole",
      "summary": "Role",
      "tags": [
        "User"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/roles/{id}/users",
      "operationId": "getRoleUsers",
      "summary": "Users With Role",
      "tags": [
        "User"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/scan_engine_pools",
      "operationId": "getScanEnginePools",
      "summary": "Engine Pools",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/scan_engine_pools",
      "operationId": "createScanEnginePool",
      "summary": "Engine Pools",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/scan_engine_pools/{id}",
      "operationId": "getEnginePool",
      "summary": "Engine Pool",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/scan_engine_pools/{id}",
      "operationId": "updateScanEnginePool",
      "summary": "Engine Pool",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/scan_engine_pools/{id}",
      "operationId": "removeScanEnginePool",
      "summary": "Engine Pool",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/scan_engine_pools/{id}/engines",
      "operationId": "getScanEnginePoolScanEngines",
      "summary": "Engine Pool Engines",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/scan_engine_pools/{id}/engines",
      "operationId": "setScanEnginePoolScanEngines",
      "summary": "Engine Pool Engines",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/scan_engine_pools/{id}/engines/{engineId}",
      "operationId": "addScanEnginePoolScanEngine",
      "summary": "Engine Pool Engines",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/scan_engine_pools/{id}/engines/{engineId}",
      "operationId": "removeScanEnginePoolScanEngine",
      "summary": "Engine Pool Engines",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/scan_engine_pools/{id}/sites",
      "operationId": "getScanEnginePoolSites",
      "summary": "Engine Pool Sites",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/scan_engines",
      "operationId": "getScanEngines",
      "summary": "Scan Engines",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/scan_engines",
      "operationId": "createScanEngine",
      "summary": "Scan Engines",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/scan_engines/shared_secret",
      "operationId": "getCurrentSharedSecret",
      "summary": "Scan Engine Shared Secret",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "POST",
      "path": "/api/3/scan_engines/shared_secret",
      "operationId": "createSharedSecret",
      "summary": "Scan Engine Shared Secret",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/scan_engines/shared_secret",
      "operationId": "deleteSharedSecret",
      "summary": "Scan Engine Shared Secret",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/scan_engines/shared_secret/time_to_live",
      "operationId": "getCurrentSharedSecretTimeToLive",
      "summary": "Scan Engine Shared Secret Time to live",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/scan_engines/{id}",
      "operationId": "getScanEngine",
      "summary": "Scan Engine",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "PUT",
      "path": "/api/3/scan_engines/{id}",
      "operationId": "updateScanEngine",
      "summary": "Scan Engine",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "DELETE",
      "path": "/api/3/scan_engines/{id}",
      "operationId": "deleteScanEngine",
      "summary": "Scan Engine",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/scan_engines/{id}/scan_engine_pools",
      "operationId": "getAssignedEnginePools",
      "summary": "Assigned Engine Pools",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/scan_engines/{id}/scans",
      "operationId": "getScanEngineScans",
      "summary": "Scan Engine Scans",
      "tags": [
        "Scan Engine"
      ]
    },
    {
      "method": "GET",
      "path": "/api/3/scan_engines/{id}/sites",
      "operationId": "getScanEngineSites",
      "summa

# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rapid7/refs/heads/main/json-structure/rapid7-structure.json