shuffle-cracked/app_gen/openapi-parsers/other/TIO-API-Vulnerability-Management.json

{"openapi":"3.0.0","info":{"title":"Vulnerability Management","version":"1.0.0"},"security":[{"cloud":[]}],"servers":[{"url":"https://cloud.tenable.com"}],"components":{"securitySchemes":{"cloud":{"type":"apiKey","in":"header","name":"X-ApiKeys","description":"Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY"}}},"x-samples-languages":["python","curl","node","powershell","ruby","javascript","objectivec","java","php","csharp","go","swift","kotlin"],"paths":{"/access-groups":{"post":{"summary":"Create access group","description":"Creates an access group.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"access-groups-create","tags":["Access Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the access group you want to create. This name must be:  \n* Unique within your Tenable.io instance.  \n* A maximum of 255 characters.  \n* Alphanumeric, but can include limited special characters (underscore, dash, parenthesis, brackets, colon).  \n  \n**Note:** You can add a maximum of 5,000 access groups to an individual container.","type":"string"},"all_assets":{"description":"This parameter must always be `false` or omitted from create requests to specify that the access group is a user-created group. If you submit a create request with this parameter set to `true`, the create request fails.","type":"boolean"},"all_users":{"description":"Specifies whether assets in the access group can be viewed by all or only some users in your organization:  \n* If `true`, all users in your organization have Can View access to the assets defined in the rules parameter. Tenable.io ignores any principal parameters in your request.  \n* If `false`, only specified users have Can View access to the assets defined in the rules parameter. You define which users or user groups have access in the principals parameter of the request.  \n  \nIf you omit this parameter, Tenable.io sets the parameter to `false` by default.","type":"boolean"},"rules":{"items":{"type":"object","properties":{"type":{"type":"string","description":"The type of asset rule. The asset rule type corresponds to the type of data you can specifiy in the terms parameter. For a complete list of supported rule types, use the <a href=\"/reference#access-groups-list-filters\">GET /access-groups/filters</a> endpoint."},"operator":{"type":"string","description":"The operator that specifies how Tenable.io matches the terms value to asset data. \n\nPossible operators include: \n - eq—Tenable.io matches the rule to assets based on an exact match of the specified term. Note: Tenable.io interprets the operator as `equals` for ipv4 rules that specify a single IP address, but interprets the operator as `contains` for ipv4 rules that specify an IP range or CIDR range.\n - match—Tenable.io matches the rule to assets based a partial match of the specified term.\n - starts—Tenable.io matches the rule to assets that start with the specified term.\n - ends—Tenable.io matches the rule to assets that end with the specified term.\n\nFor a complete list of operators by rule type, use the <a href=\"/reference#access-groups-list-rule-filters\">GET /access-groups/rules/filters</a> endpoint."},"terms":{"description":"The values that Tenable.io uses to match an asset to the rule. A term must correspond to the rule type.\n\nFor example:\n - If the rule type is `aws_account`, the term is an AWS account ID.\n - If the rule type is `fqdn`, the term is a hostname or a fully-qualified domain name (FQDN).\n - If the rule type is `ipv4`, the term is an individual IPv4 address, a range of IPv4 addresses (for example, 172.204.81.57-172.204.81.60), or a CIDR range (for example, 172.204.81.57/24). \n\nFor a complete list of supported values by rule type, use the <a href=\"/reference#access-groups-list-rule-filters\">GET /access-groups/rules/filters</a> endpoint.  \n\nIf you specify multiple terms values, Tenable.io includes an asset in the access group if the asset's attributes match any of the terms in the rule.\n<br >You can specify up to 100,000 terms per asset rule.","type":"array","items":{"type":"string"}}}},"description":"An array of asset rules. Tenable.io uses these rules to assign assets to the access group. You can specify a maximum of 1,000 rules for an individual access group. If you specify multiple rules for an access group, Tenable.io assigns an asset to the access group if the asset matches any of the rules. You can only add rules to access groups if the all\\_assets parameter is set to `false`.","type":"array"},"principals":{"items":{"type":"object","properties":{"type":{"type":"string","description":"(Required) The type of principal. Valid values include:\n - user—Grants access to the user you specify.\n - group—Grants access to all users assigned to the user group you specify."},"principal_id":{"type":"string","description":"The UUID of a user or user group. This parameter is required if the request omits the `principal_name` parameter."},"principal_name":{"type":"string","description":"The name of the user or user group. This parameter is required if the request omits the `principal_id` parameter. If a request includes both `principal_id` and `principal_name`, Tenable.io assigns the user or user group to the access group based on the `principal_id` parameter, and ignores the `principal_name` parameter in the request. "}}},"description":"An array of principals. Each principal represents a user or user group assigned to the access group. You cannot add an access group as a principal to another access group. \n  \nTenable.io handles data in this array based on the all\\_users parameter of the request:  \n* If all\\_users is `true`, Tenable.io ignores any principal data in the request. You can omit this parameter from the request.  \n* If all\\_users is `false`, Tenable.io adds the principal data to the access group.","type":"array"}},"required":["name","rules"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully creates an access group.","content":{"application/json":{"schema":{"type":"object","properties":{"container_uuid":{"type":"string","description":"The UUID of your Tenable.io instance."},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the access group was created."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the time and date on which the access group was last modified."},"id":{"type":"string","description":"The UUID of the access group."},"name":{"type":"string","description":"The name of the access group. This name must be:  \n* Unique within your Tenable.io instance.  \n* A maximum of 255 characters.  \n* Alphanumeric, but can include limited special characters (underscore, dash, parenthesis, brackets, colon)."},"all_assets":{"type":"boolean","description":"Specifies whether the access group is the system-provided All Assets access group: \n - If `true`, the access group is the All Assets access group. The only change you can make to this access group is to refine user membership in the group. For more information, see descriptions of the all_users and principals parameters for the <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> endpoint.\n - If `false`, the access group is a user-defined access group, and you can change all parameters for the group. This parameter is `false` for all access groups you create."},"all_users":{"type":"boolean","description":"Specifies whether assets in the access group can be viewed by all or only some users in your organization:\n - If `true`, all users in your organization have Can View access to the assets defined in the rules parameter. If `true` in a <a href=\"/reference#access-groups-create\">POST /access-groups</a> or <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> request, Tenable.io ignores any principal parameters in the request. \n - If `false`, only specified users have Can View access to the assets defined in the rules parameter. You define which users or user groups have access in the principals parameter of a <a href=\"/reference#access-groups-create\">POST /access-groups</a> or <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> request. \n\n**Note:** If a <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> endpoint request sets this parameter to `true` for an access group where the parameter was previously set to `false`, Tenable.io removes all principal data previously associated with the access group."},"status":{"type":"string","description":"The status of the process evaluating and assigning assets to the access group. Possible values are: \n - PROCESSING—Tenable.io is currently evaluating assets against the asset rules for the access group. For an indication of evaluation progress, see the `processing_percent_complete` attribute for the access group.\n - COMPLETED—Tenable.io has successfully completed its evaluation of assets against the asset rules for the group.\n - ERROR—Tenable.io encountered an error while evaluating assets against asset rules for the access group. Rule validation typically prevents this status from occurring. However, if you encounter an ERROR status, Tenable recommends that you delete the existing asset rules, then recreate the rules after a short time has elapsed."},"created_by_uuid":{"type":"string","description":"The UUID of the user who created the access group."},"created_by_name":{"type":"string","description":"The name of the user who created the access group."},"updated_by_uuid":{"type":"string","description":"The UUID of the user who last modified the access group."},"updated_by_name":{"type":"string","description":"The name of the user who last modified the access group."},"processing_percent_complete":{"type":"integer","description":"The percentage of assets that Tenable.io has evaluated against the asset rules for the access group."}}},"examples":{"response":{"value":{"container_uuid":"8f9d0b84-ede2-4954-a0c9-0bde292ac38e","created_at":"2018-08-15T18:17:04.827Z","updated_at":"2018-08-15T18:17:04.827Z","id":"385f4765-cd32-4191-b6ae-d0d4522e073f","name":"Headquarters","all_assets":false,"all_users":false,"status":"COMPLETED","rules":[{"type":"aws_account","operator":"eq","terms":["123456789012"]},{"type":"fqdn","operator":"eq","terms":["www.example.com"]},{"type":"ipv4","operator":"eq","terms":["172.204.81.57"]}],"principals":[{"type":"user","principal_id":"085abc65-d709-44b2-ad04-bfd2862ad5a1","principal_name":"user1@example.com"},{"type":"user","principal_id":"b1219ca2-2578-49ac-88db-8a35dd02cc7d","principal_name":"user2@example.com"}],"created_by_uuid":"b1219ca2-2578-49ac-88db-8a35dd02cc7d","updated_by_uuid":"b1219ca2-2578-49ac-88db-8a35dd02cc7d","updated_by_name":"user3@example.com","created_by_name":"user3@example.com","processing_percent_complete":100}}}}}},"400":{"description":"Returned if Tenable.io encountered any of the following error conditions:\n - max_entries—your request exceeds the maximum number of 5,000 access groups.\n - duplicate—an access group with the name you specified already exists.\n - protected—you attempted to set the all_assets parameter  to `true`, and you cannot create the system-provided access group, All Assets."},"403":{"description":"Returned if you do not have permission to create access groups."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List access groups","description":"Lists access groups without associated rules.<p>Requires BASIC [16] user permissions to list access groups to which you are assigned. Requires ADMINISTRATOR [64] permissions to list all access groups for your organization. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"access-groups-list","tags":["Access Groups"],"parameters":[{"description":"A filter condition in the following format: `field:operator:value`. For a list of possible fields and operators, use the <a href=\"/reference#access-groups-list-filters\">GET /access-groups/filters</a> endpoint. You can specify multiple `f` parameters, separated by ampersand (&) characters. If you specify multiple `f` parameters, use the `ft` parameter to specify how Tenable.io applies the multiple filter conditions.","name":"f","in":"query","schema":{"type":"string"}},{"description":"If multiple \\`f\\` parameters are present, specifies whether Tenable.io applies \\`AND\\` or \\`OR\\` to conditions. Supported values are `and` and `or`. If you omit this parameter when using multiple `f` parameters, Tenable.io applies `AND` by default.","name":"ft","in":"query","schema":{"type":"string"}},{"description":"The search value that Tenable.io applies across the wildcard fields. Wildcard fields are specified in the `wf` parameter.","name":"w","in":"query","schema":{"type":"string"}},{"description":"A comma-separated list of fields where Tenable.io applies the search value specified in the `w` parameter. For a list of supported wildcard fields, use the <a href=\"/reference#access-groups-list-filters\">GET /access-groups/filters</a> endpoint.","name":"wf","in":"query","schema":{"type":"string"}},{"description":"Maximum number of records requested (or service imposed limit if not in request).","name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"Offset from request (or zero).","name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The field or fields on which Tenable.io sorts the results. If you specify multiple fields, fields must be separated by commas. For a list of supported sort fields, use the <a href=\"/reference#access-groups-list-filters\">GET /access-groups/filters</a> endpoint.","name":"sort","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of access groups that you have permission to view.","content":{"application/json":{"schema":{"type":"object","properties":{"access_groups":{"type":"object","properties":{"container_uuid":{"type":"string","description":"The UUID of your Tenable.io instance."},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the access group was created."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the time and date on which the access group was last modified."},"id":{"type":"string","description":"The UUID of the access group."},"name":{"type":"string","description":"The name of the access group. This name must be:  \n* Unique within your Tenable.io instance.  \n* A maximum of 255 characters.  \n* Alphanumeric, but can include limited special characters (underscore, dash, parenthesis, brackets, colon)."},"all_assets":{"type":"boolean","description":"Specifies whether the access group is the system-provided All Assets access group: \n - If `true`, the access group is the All Assets access group. The only change you can make to this access group is to refine user membership in the group. For more information, see descriptions of the all_users and principals parameters for the <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> endpoint.\n - If `false`, the access group is a user-defined access group, and you can change all parameters for the group. This parameter is `false` for all access groups you create."},"all_users":{"type":"boolean","description":"Specifies whether assets in the access group can be viewed by all or only some users in your organization:\n - If `true`, all users in your organization have Can View access to the assets defined in the rules parameter. If `true` in a <a href=\"/reference#access-groups-create\">POST /access-groups</a> or <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> request, Tenable.io ignores any principal parameters in the request. \n - If `false`, only specified users have Can View access to the assets defined in the rules parameter. You define which users or user groups have access in the principals parameter of a <a href=\"/reference#access-groups-create\">POST /access-groups</a> or <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> request. \n\n**Note:** If a <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> endpoint request sets this parameter to `true` for an access group where the parameter was previously set to `false`, Tenable.io removes all principal data previously associated with the access group."},"status":{"type":"string","description":"The status of the process evaluating and assigning assets to the access group. Possible values are: \n - PROCESSING—Tenable.io is currently evaluating assets against the asset rules for the access group. For an indication of evaluation progress, see the `processing_percent_complete` attribute for the access group.\n - COMPLETED—Tenable.io has successfully completed its evaluation of assets against the asset rules for the group.\n - ERROR—Tenable.io encountered an error while evaluating assets against asset rules for the access group. Rule validation typically prevents this status from occurring. However, if you encounter an ERROR status, Tenable recommends that you delete the existing asset rules, then recreate the rules after a short time has elapsed."},"created_by_uuid":{"type":"string","description":"The UUID of the user who created the access group."},"created_by_name":{"type":"string","description":"The name of the user who created the access group."},"updated_by_uuid":{"type":"string","description":"The UUID of the user who last modified the access group."},"updated_by_name":{"type":"string","description":"The name of the user who last modified the access group."},"processing_percent_complete":{"type":"integer","description":"The percentage of assets that Tenable.io has evaluated against the asset rules for the access group."}}},"pagination":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of records matching your search criteria.","format":"int32"},"limit":{"type":"integer","description":"Maximum number of records requested (or service imposed limit if not in request).","format":"int32"},"offset":{"type":"integer","description":"Offset from request (or zero).","format":"int32"},"sort":{"description":"The fields you specified as sort fields in the request, which Tenable.io uses to sort the returned data.","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the field on which Tenable.io sorted the results.","type":"string"},"order":{"description":"The order in which Tenable.io sorted the results. Possible values are ascending (`asc`) or descending (`desc`).","type":"string"}}}}}}}},"examples":{"response":{"value":{"access_groups":[{"container_uuid":"8f9d0b84-ede2-4954-a0c9-0bde292ac38e","created_at":"2018-08-09T21:26:00.397Z","updated_at":"2018-08-09T21:26:00.397Z","id":"529d57cf-bbc6-435f-9b57-896bb40bba8c","name":"Atlanta Office","all_assets":false,"all_users":false,"status":"COMLETED","created_by_uuid":"b1219ca2-2578-49ac-88db-8a35dd02cc7d","updated_by_uuid":"b1219ca2-2578-49ac-88db-8a35dd02cc7d","updated_by_name":"user@example.com","created_by_name":"user@example.com","processing_percent_complete":100}],"pagination":{"offset":0,"limit":2,"total":7,"sort":[{"name":"allAssets","order":"desc"},{"name":"updatedAt","order":"asc"}]}}}}}}},"403":{"description":"Returned if you do not have permission to view access groups."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/access-groups/{id}":{"put":{"summary":"Update access group","description":"Modifies an access group. This method overwrites the existing data.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"access-groups-edit","tags":["Access Groups"],"parameters":[{"description":"The UUID for the access group you want to modify.","required":true,"name":"id","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the access group you want to modify.","type":"string"},"all_assets":{"description":"Specifies whether the access group you want to modify is the All Assets group or a user-defined group:  \n* If you want to refine membership in the All Assets access group (the only change you can make to the All Assets group), this parameter must be `true`. Tenable.io ignores any rules parameters in your request, but overwrrites existing principals parameters with those in the request based on the all\\_users and principals parameters in the request.  \n* If you want to modify a user-defined access group, this parameter must be `false`. Tenable.io overwrites the existing rules parameters with the rules parameters you specify in this request, and overwrites existing principals parameters based on the all\\_users and principals parameters in the request.","type":"boolean"},"all_users":{"description":"Specifies whether assets in the access group can be viewed by all or only some users in your organization:  \n* If `true`, all users in your organization have Can View access to the assets defined in the rules parameter. Tenable.io ignores any principal parameters in your request.  \n* If `false`, only specified users have Can View access to the assets defined in the rules parameter. You define which users or user groups have access in the principals parameter of the request.  \n  \nIf you omit this parameter, Tenable.io sets the parameter to `false` by default.","type":"boolean"},"rules":{"items":{"type":"object","properties":{"type":{"type":"string","description":"The type of asset rule. The asset rule type corresponds to the type of data you can specifiy in the terms parameter. For a complete list of supported rule types, use the <a href=\"/reference#access-groups-list-filters\">GET /access-groups/filters</a> endpoint."},"operator":{"type":"string","description":"The operator that specifies how Tenable.io matches the terms value to asset data. \n\nPossible operators include: \n - eq—Tenable.io matches the rule to assets based on an exact match of the specified term. Note: Tenable.io interprets the operator as `equals` for ipv4 rules that specify a single IP address, but interprets the operator as `contains` for ipv4 rules that specify an IP range or CIDR range.\n - match—Tenable.io matches the rule to assets based a partial match of the specified term.\n - starts—Tenable.io matches the rule to assets that start with the specified term.\n - ends—Tenable.io matches the rule to assets that end with the specified term.\n\nFor a complete list of operators by rule type, use the <a href=\"/reference#access-groups-list-rule-filters\">GET /access-groups/rules/filters</a> endpoint."},"terms":{"description":"The values that Tenable.io uses to match an asset to the rule. A term must correspond to the rule type.\n\nFor example:\n - If the rule type is `aws_account`, the term is an AWS account ID.\n - If the rule type is `fqdn`, the term is a hostname or a fully-qualified domain name (FQDN).\n - If the rule type is `ipv4`, the term is an individual IPv4 address, a range of IPv4 addresses (for example, 172.204.81.57-172.204.81.60), or a CIDR range (for example, 172.204.81.57/24). \n\nFor a complete list of supported values by rule type, use the <a href=\"/reference#access-groups-list-rule-filters\">GET /access-groups/rules/filters</a> endpoint.  \n\nIf you specify multiple terms values, Tenable.io includes an asset in the access group if the asset's attributes match any of the terms in the rule.\n<br >You can specify up to 100,000 terms per asset rule.","type":"array","items":{"type":"string"}}}},"description":"An array of asset rules. Tenable.io uses these rules to assign assets to the access group. You can specify a maximum of 1,000 rules for an individual access group. If you specify multiple rules for an access group, Tenable.io assigns an asset to the access group if the asset matches any of the rules. You can only add rules to access groups if the all\\_assets parameter is set to `false`.","type":"array"},"principals":{"items":{"type":"object","properties":{"type":{"type":"string","description":"(Required) The type of principal. Valid values include:\n - user—Grants access to the user you specify.\n - group—Grants access to all users assigned to the user group you specify."},"principal_id":{"type":"string","description":"The UUID of a user or user group. This parameter is required if the request omits the `principal_name` parameter."},"principal_name":{"type":"string","description":"The name of the user or user group. This parameter is required if the request omits the `principal_id` parameter. If a request includes both `principal_id` and `principal_name`, Tenable.io assigns the user or user group to the access group based on the `principal_id` parameter, and ignores the `principal_name` parameter in the request. "}}},"description":"An array of principals. Each principal represents a user or user group assigned to the access group. You cannot add an access group as a principal to another access group.","type":"array"}},"required":["name","rules"]}}}},"responses":{"200":{"description":"Returned if Tenable.io has either modified the existing access group successfully or created a new access group because it could not find an existing access group with the specified UUID.","content":{"application/json":{"schema":{"type":"object","properties":{"container_uuid":{"type":"string","description":"The UUID of your Tenable.io instance."},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the access group was created."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the time and date on which the access group was last modified."},"id":{"type":"string","description":"The UUID of the access group."},"name":{"type":"string","description":"The name of the access group. This name must be:  \n* Unique within your Tenable.io instance.  \n* A maximum of 255 characters.  \n* Alphanumeric, but can include limited special characters (underscore, dash, parenthesis, brackets, colon)."},"all_assets":{"type":"boolean","description":"Specifies whether the access group is the system-provided All Assets access group: \n - If `true`, the access group is the All Assets access group. The only change you can make to this access group is to refine user membership in the group. For more information, see descriptions of the all_users and principals parameters for the <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> endpoint.\n - If `false`, the access group is a user-defined access group, and you can change all parameters for the group. This parameter is `false` for all access groups you create."},"all_users":{"type":"boolean","description":"Specifies whether assets in the access group can be viewed by all or only some users in your organization:\n - If `true`, all users in your organization have Can View access to the assets defined in the rules parameter. If `true` in a <a href=\"/reference#access-groups-create\">POST /access-groups</a> or <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> request, Tenable.io ignores any principal parameters in the request. \n - If `false`, only specified users have Can View access to the assets defined in the rules parameter. You define which users or user groups have access in the principals parameter of a <a href=\"/reference#access-groups-create\">POST /access-groups</a> or <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> request. \n\n**Note:** If a <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> endpoint request sets this parameter to `true` for an access group where the parameter was previously set to `false`, Tenable.io removes all principal data previously associated with the access group."},"status":{"type":"string","description":"The status of the process evaluating and assigning assets to the access group. Possible values are: \n - PROCESSING—Tenable.io is currently evaluating assets against the asset rules for the access group. For an indication of evaluation progress, see the `processing_percent_complete` attribute for the access group.\n - COMPLETED—Tenable.io has successfully completed its evaluation of assets against the asset rules for the group.\n - ERROR—Tenable.io encountered an error while evaluating assets against asset rules for the access group. Rule validation typically prevents this status from occurring. However, if you encounter an ERROR status, Tenable recommends that you delete the existing asset rules, then recreate the rules after a short time has elapsed."},"rules":{"description":"An array of asset rules. Tenable.io uses these rules to assign assets to the access group. You can specify a maximum of 1,000 rules for an individual access group. If you specify multiple rules for an access group, Tenable.io assigns an asset to the access group if the asset matches any of the rules. You can only add rules to access groups if the all\\_assets parameter is set to `false`.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of asset rule. The asset rule type corresponds to the type of data you can specifiy in the terms parameter. For a complete list of supported rule types, use the <a href=\"/reference#access-groups-list-filters\">GET /access-groups/filters</a> endpoint."},"operator":{"type":"string","description":"The operator that specifies how Tenable.io matches the terms value to asset data. \n\nPossible operators include: \n - eq—Tenable.io matches the rule to assets based on an exact match of the specified term. Note: Tenable.io interprets the operator as `equals` for ipv4 rules that specify a single IP address, but interprets the operator as `contains` for ipv4 rules that specify an IP range or CIDR range.\n - match—Tenable.io matches the rule to assets based a partial match of the specified term.\n - starts—Tenable.io matches the rule to assets that start with the specified term.\n - ends—Tenable.io matches the rule to assets that end with the specified term.\n\nFor a complete list of operators by rule type, use the <a href=\"/reference#access-groups-list-rule-filters\">GET /access-groups/rules/filters</a> endpoint."},"terms":{"description":"The values that Tenable.io uses to match an asset to the rule. A term must correspond to the rule type.\n\nFor example:\n - If the rule type is `aws_account`, the term is an AWS account ID.\n - If the rule type is `fqdn`, the term is a hostname or a fully-qualified domain name (FQDN).\n - If the rule type is `ipv4`, the term is an individual IPv4 address, a range of IPv4 addresses (for example, 172.204.81.57-172.204.81.60), or a CIDR range (for example, 172.204.81.57/24). \n\nFor a complete list of supported values by rule type, use the <a href=\"/reference#access-groups-list-rule-filters\">GET /access-groups/rules/filters</a> endpoint.  \n\nIf you specify multiple terms values, Tenable.io includes an asset in the access group if the asset's attributes match any of the terms in the rule.\n<br >You can specify up to 100,000 terms per asset rule.","type":"array","items":{"type":"string"}}}}},"principals":{"description":"An array of principals. Each principal represents a user or user group assigned to the access group. You cannot add an access group as a principal to another access group.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"(Required) The type of principal. Valid values include:\n - user—Grants access to the user you specify.\n - group—Grants access to all users assigned to the user group you specify."},"principal_id":{"type":"string","description":"The UUID of a user or user group. This parameter is required if the request omits the `principal_name` parameter."},"principal_name":{"type":"string","description":"The name of the user or user group. This parameter is required if the request omits the `principal_id` parameter. If a request includes both `principal_id` and `principal_name`, Tenable.io assigns the user or user group to the access group based on the `principal_id` parameter, and ignores the `principal_name` parameter in the request. "}}}},"created_by_uuid":{"type":"string","description":"The UUID of the user who created the access group."},"created_by_name":{"type":"string","description":"The name of the user who created the access group."},"updated_by_uuid":{"type":"string","description":"The UUID of the user who last modified the access group."},"updated_by_name":{"type":"string","description":"The name of the user who last modified the access group."},"processing_percent_complete":{"type":"integer","description":"The percentage of assets that Tenable.io has evaluated against the asset rules for the access group."}}},"examples":{"response":{"value":{"container_uuid":"8f9d0b84-ede2-4954-a0c9-0bde292ac38e","created_at":"2018-08-15T18:17:04.827Z","updated_at":"2018-08-15T18:17:04.827Z","id":"385f4765-cd32-4191-b6ae-d0d4522e073f","name":"Headquarters","all_assets":false,"all_users":false,"status":"COMPLETED","rules":[{"type":"aws_account","operator":"eq","terms":["123456789012"]},{"type":"fqdn","operator":"eq","terms":["www.example.com"]},{"type":"ipv4","operator":"eq","terms":["172.204.81.57"]}],"principals":[{"type":"user","principal_id":"085abc65-d709-44b2-ad04-bfd2862ad5a1","principal_name":"user1@example.com"},{"type":"user","principal_id":"b1219ca2-2578-49ac-88db-8a35dd02cc7d","principal_name":"user2@example.com"}],"created_by_uuid":"b1219ca2-2578-49ac-88db-8a35dd02cc7d","updated_by_uuid":"b1219ca2-2578-49ac-88db-8a35dd02cc7d","updated_by_name":"user3@example.com","created_by_name":"user3@example.com","processing_percent_complete":100}}}}}},"400":{"description":"Returned if Tenable.io encountered any of the following error conditions:\n - incomplete—the body of your request did not include the required fields.\n - duplicate—an access group with the name you specified already exists.\n - protected—you attempted to update an access group where the `all_assets` parameter is set to `true`, and you cannot update the system-provided `All Assets` access group."},"403":{"description":"Returned if you do not have sufficient permissions to modify access groups."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete access group","description":"Deletes an access group.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"access-groups-delete","tags":["Access Groups"],"parameters":[{"description":"The UUID for the access group you want to delete.","required":true,"name":"id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deleted the access group you specified."},"403":{"description":"Returned if you do not have sufficient permissions to delete an access group."},"404":{"description":"Returned if Tenable.io could not find the access group you specified."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"Get access group details","description":"Returns details for a specific access group.<p>Requires BASIC [16] user permissions to view details for an access group to which you are assigned; however, details do not include principals information. Requires ADMINISTRATOR [64] to view details for any access group in your organization; in this case, details include principals information. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"access-groups-details","tags":["Access Groups"],"parameters":[{"description":"The UUID of the access group where you want to view details.","required":true,"name":"id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the access group details.","content":{"application/json":{"schema":{"type":"object","properties":{"container_uuid":{"type":"string","description":"The UUID of your Tenable.io instance."},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the access group was created."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the time and date on which the access group was last modified."},"id":{"type":"string","description":"The UUID of the access group."},"name":{"type":"string","description":"The name of the access group. This name must be:  \n* Unique within your Tenable.io instance.  \n* A maximum of 255 characters.  \n* Alphanumeric, but can include limited special characters (underscore, dash, parenthesis, brackets, colon)."},"all_assets":{"type":"boolean","description":"Specifies whether the access group is the system-provided All Assets access group: \n - If `true`, the access group is the All Assets access group. The only change you can make to this access group is to refine user membership in the group. For more information, see descriptions of the all_users and principals parameters for the <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> endpoint.\n - If `false`, the access group is a user-defined access group, and you can change all parameters for the group. This parameter is `false` for all access groups you create."},"all_users":{"type":"boolean","description":"Specifies whether assets in the access group can be viewed by all or only some users in your organization:\n - If `true`, all users in your organization have Can View access to the assets defined in the rules parameter. If `true` in a <a href=\"/reference#access-groups-create\">POST /access-groups</a> or <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> request, Tenable.io ignores any principal parameters in the request. \n - If `false`, only specified users have Can View access to the assets defined in the rules parameter. You define which users or user groups have access in the principals parameter of a <a href=\"/reference#access-groups-create\">POST /access-groups</a> or <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> request. \n\n**Note:** If a <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> endpoint request sets this parameter to `true` for an access group where the parameter was previously set to `false`, Tenable.io removes all principal data previously associated with the access group."},"status":{"type":"string","description":"The status of the process evaluating and assigning assets to the access group. Possible values are: \n - PROCESSING—Tenable.io is currently evaluating assets against the asset rules for the access group. For an indication of evaluation progress, see the `processing_percent_complete` attribute for the access group.\n - COMPLETED—Tenable.io has successfully completed its evaluation of assets against the asset rules for the group.\n - ERROR—Tenable.io encountered an error while evaluating assets against asset rules for the access group. Rule validation typically prevents this status from occurring. However, if you encounter an ERROR status, Tenable recommends that you delete the existing asset rules, then recreate the rules after a short time has elapsed."},"rules":{"description":"An array of asset rules. Tenable.io uses these rules to assign assets to the access group. You can specify a maximum of 1,000 rules for an individual access group. If you specify multiple rules for an access group, Tenable.io assigns an asset to the access group if the asset matches any of the rules. You can only add rules to access groups if the all\\_assets parameter is set to `false`.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of asset rule. The asset rule type corresponds to the type of data you can specifiy in the terms parameter. For a complete list of supported rule types, use the <a href=\"/reference#access-groups-list-filters\">GET /access-groups/filters</a> endpoint."},"operator":{"type":"string","description":"The operator that specifies how Tenable.io matches the terms value to asset data. \n\nPossible operators include: \n - eq—Tenable.io matches the rule to assets based on an exact match of the specified term. Note: Tenable.io interprets the operator as `equals` for ipv4 rules that specify a single IP address, but interprets the operator as `contains` for ipv4 rules that specify an IP range or CIDR range.\n - match—Tenable.io matches the rule to assets based a partial match of the specified term.\n - starts—Tenable.io matches the rule to assets that start with the specified term.\n - ends—Tenable.io matches the rule to assets that end with the specified term.\n\nFor a complete list of operators by rule type, use the <a href=\"/reference#access-groups-list-rule-filters\">GET /access-groups/rules/filters</a> endpoint."},"terms":{"description":"The values that Tenable.io uses to match an asset to the rule. A term must correspond to the rule type.\n\nFor example:\n - If the rule type is `aws_account`, the term is an AWS account ID.\n - If the rule type is `fqdn`, the term is a hostname or a fully-qualified domain name (FQDN).\n - If the rule type is `ipv4`, the term is an individual IPv4 address, a range of IPv4 addresses (for example, 172.204.81.57-172.204.81.60), or a CIDR range (for example, 172.204.81.57/24). \n\nFor a complete list of supported values by rule type, use the <a href=\"/reference#access-groups-list-rule-filters\">GET /access-groups/rules/filters</a> endpoint.  \n\nIf you specify multiple terms values, Tenable.io includes an asset in the access group if the asset's attributes match any of the terms in the rule.\n<br >You can specify up to 100,000 terms per asset rule.","type":"array","items":{"type":"string"}}}}},"principals":{"description":"An array of principals. Each principal represents a user or user group assigned to the access group. You cannot add an access group as a principal to another access group.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"(Required) The type of principal. Valid values include:\n - user—Grants access to the user you specify.\n - group—Grants access to all users assigned to the user group you specify."},"principal_id":{"type":"string","description":"The UUID of a user or user group. This parameter is required if the request omits the `principal_name` parameter."},"principal_name":{"type":"string","description":"The name of the user or user group. This parameter is required if the request omits the `principal_id` parameter. If a request includes both `principal_id` and `principal_name`, Tenable.io assigns the user or user group to the access group based on the `principal_id` parameter, and ignores the `principal_name` parameter in the request. "}}}},"created_by_uuid":{"type":"string","description":"The UUID of the user who created the access group."},"created_by_name":{"type":"string","description":"The name of the user who created the access group."},"updated_by_uuid":{"type":"string","description":"The UUID of the user who last modified the access group."},"updated_by_name":{"type":"string","description":"The name of the user who last modified the access group."},"processing_percent_complete":{"type":"integer","description":"The percentage of assets that Tenable.io has evaluated against the asset rules for the access group."}}},"examples":{"response":{"value":{"container_uuid":"7a818eb1-8351-4795-99b0-9610c8954cb3","created_at":"2018-11-27T21:17:18.883Z","updated_at":"2018-11-27T22:12:02.414Z","id":"d30542aa-84d4-4b38-9a74-6a4c665532b1","name":"Western Region","all_assets":false,"all_users":false,"version":2,"status":"COMPLETED","rules":[{"type":"ipv4","operator":"eq","terms":["172.204.81.57"],"principals":[{"type":"user","principal_id":"e7ecb50b-1330-4a8c-b8e5-ee00ec8c46f7","principal_name":"user1@example.com"},{"type":"user","principal_id":"a7162cb4-ebf7-4103-a250-34b1777cfbd0","principal_name":"user2@example.com"}],"created_by_uuid":"f3eda8e9-11f5-4ac8-966f-b758eed531c4","updated_by_uuid":"f3eda8e9-11f5-4ac8-966f-b758eed531c4","updated_by_name":"administrator@example.com","created_by_name":"administrator@example.com","processing_percent_complete":100}]}}}}}},"403":{"description":"Returned if you do not have permissions to view the access group details."},"404":{"description":"Returned if Tenable.io could not find the access group you specified."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/access-groups/filters":{"get":{"summary":"List access group filters","description":"Lists available filters for access groups.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"access-groups-list-filters","tags":["Access Groups"],"responses":{"200":{"description":"Returns a list of available filters for access groups. The response includes supported filter operators for each filter. Filter operators can include:\n - eq—filters on exact matches of the specified value\n - match—filters on partial matches of the specified value\n - date-lt —filters on dates earlier than the specified date\n - date-gt—filters on dates later than the specified date\n - date-eq—filters on dates equal to the specified date.\n\nThe sample below does not represent a complete list of supported filters.","content":{"application/json":{"schema":{"type":"object","properties":{"wildcard_fields":{"description":"The fields you can use as a wildcard (`wf` parameter) value in the <a href=\"/reference#access-groups-list\">GET /access-groups</a> endpoint.","type":"array","items":{"type":"string"}},"filters":{"description":"The filters and operators for each field you can use when constructing filter (`f` parameter) values in the <a href=\"/reference#access-groups-list\">GET /access-groups</a> endpoint.","type":"array","items":{"type":"object","properties":{"operators":{"description":"Corresponds to the operator component of the `f` parameter.","type":"array","items":{"type":"string"}},"control":{"description":"Indicates how the parameter appears in the Tenable.io user interface.","type":"string"},"name":{"description":"Corresponds to the field component of the `f` parameter.","type":"string"},"readable_name":{"description":"The name of the parameter as it appears in the Tenable.io user interface.","type":"string"}}}},"sort":{"description":"The fields you can use when constructing `sort` parameter values for the <a href=\"/reference#access-groups-list\">GET /access-groups</a> endpoint.","type":"array","items":{"type":"object","properties":{"sortable_fields":{"description":"The names of the fields you can use when constructing `sort` parameter values for the <a href=\"/reference#access-groups-list\">GET /access-groups</a> endpoint.","type":"string"}}}}}},"examples":{"response":{"value":{"wildcard_fields":["name","created_by_name","updated_by_name"],"filters":[{"operators":["eq","match"],"control":{"type":"entry"},"name":"name","readable_name":"Access Group Name"}],"sort":{"sortable_fields":["name","created_at","created_by_name","updated_at","updated_by_name"]}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/access-groups/rules/filters":{"get":{"summary":"List asset rule filters","description":"Lists available filters for asset rules.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"access-groups-list-rule-filters","tags":["Access Groups"],"responses":{"200":{"description":"Returns a list of filters. The sample below does not represent a complete list of supported filters.","content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"description":"An array specifying values to use when constructing an asset rule for the <a href=\"/reference#access-groups-create\">POST /access-groups</a> and <a href=\"/reference#access-groups-edit\">PUT /access-groups/{id}</a> methods.","type":"array","items":{"type":"object","properties":{"operators":{"description":"The operator that specifies how Tenable.io matches the terms value to asset data. Corresponds to the operator component of the rules parameter. Possible operators include:  \n*eq—Tenable.io matches the rule to assets based on an exact match of the specified term. Note: Tenable.io interprets the operator as `equals` for ipv4 rules that specify a single IP address, but interprets the operator as `contains` for ipv4 rules that specify an IP range or CIDR range.  \n* match—Tenable.io matches the rule to assets based a partial match of the specified term.  \n* starts—Tenable.io matches the rule to assets that start with the specified term.  \n* ends—Tenable.io matches the rule to assets that end with the specified term. For a complete list of operators by rule type, use the <a href=\"/reference#access-groups-list-filters\">GET /access-groups/filters</a> endpoint.","type":"array","items":{"type":"string"}},"control":{"description":"Indicates how the field appears in the Tenable.io user interface.","type":"string"},"name":{"description":"The name of the filter parameter. Corresponds to the asset rule type.","type":"string"},"readable_name":{"description":"The name of the field as it appears in the Tenable.io user interface.","type":"string"}}}}}},"examples":{"response":{"value":{"rules":[{"operators":["eq"],"name":"aws_account","readable_name":"AWS Account ID","placeholder":"Ex: 12345","control":{"type":"tag","regex":"^\\d+$"}},{"operators":["eq"],"name":"ipv4","readable_name":"IPv4 Address","placeholder":"Ex: 172.204.81.57","control":{"type":"tag","regex":"^(?=\\d+\\.\\d+\\.\\d+\\.\\d+(($|\\/)|($|-)))(([1-9]?\\d|1\\d\\d|2[0-4]\\d|25[0-5])\\.?){4}((\\/([0-9]|[1-2][0-9]|3[0-2]))|(-(([1-9]?\\d|1\\d\\d|2[0-4]\\d|25[0-5])\\.?){4}))?$"}},{"operators":["eq","match","starts","ends"],"name":"fqdn","readable_name":"FQDN/Hostname","placeholder":"Ex: company.com","control":{"type":"tag","regex":"^[a-zA-Z0-9-.*]+$"}}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agents/config":{"get":{"summary":"Get agent configuration","description":"Returns the configuration of agents associated with a specific scanner. Agent configuration controls agent settings for global agent software update enablement and agent auto-expiration.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-config-details","tags":["Agent Config"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the agent configuration.","content":{"application/json":{"schema":{"type":"object","properties":{"auto_unlink":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, agent auto-unlink is enabled. Enabling auto-unlink causes it to take effect against all agents retroactively."},"expiration":{"type":"integer","description":"The expiration time for agents, in days. If an agent has not communicated in the specified number of days, Tenable.io classifies the agent as expired and auto-unlinks the agent if auto_unlink.enabled is `true`. Valid values are 1-365.","format":"int32"}}},"software_update":{"type":"boolean","description":"If true, software updates are enabled for agents pursuant to any agent exclusions that are in effect. If false, software updates are disabled for all agents, even if no agent exclusions are in effect."}}},"examples":{"response":{"value":{"auto_unlink":{"expiration":"30","enabled":"false"},"software_update":"true"}}}}}},"403":{"description":"Returned if you do not have permission to view the agent configuration."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update agent configuration","description":"Updates the configuration of agents associated with a specific scanner. <p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-config-edit","tags":["Agent Config"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"software_update":{"type":"boolean","description":"If true, software updates are enabled for agents pursuant to any agent exclusions that are in effect. If false, software updates are disabled for all agents, even if no agent exclusions are in effect."},"auto_unlink":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, agent auto-unlink is enabled. Enabling auto-unlink causes it to take effect against all agents retroactively."},"expiration":{"type":"integer","description":"The expiration time for agents, in days. If an agent has not communicated in this number of days, it will be considered `expired` and auto-unlinked if auto\\_unlink.enabled is `true`. Valid values are 1-365.","format":"int32"}}}}}}}},"responses":{"200":{"description":"Returned if the agent configuration has been updated.","content":{"application/json":{"schema":{"type":"object","properties":{"auto_unlink":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If true, agent auto-unlink is enabled. Enabling auto-unlink causes it to take effect against all agents retroactively."},"expiration":{"type":"integer","description":"The expiration time for agents, in days. If an agent has not communicated in the specified number of days, Tenable.io classifies the agent as expired and auto-unlinks the agent if auto_unlink.enabled is `true`. Valid values are 1-365.","format":"int32"}}},"software_update":{"type":"boolean","description":"If true, software updates are enabled for agents pursuant to any agent exclusions that are in effect. If false, software updates are disabled for all agents, even if no agent exclusions are in effect."}}},"examples":{"response":{"value":{"auto_unlink":{"expiration":"30","enabled":"false"},"software_update":"true"}}}}}},"403":{"description":"Returned if you do not have permission to update the agent config."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to update the agent configuration.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agents/exclusions":{"post":{"summary":"Create agent exclusion","description":"Creates a new agent exclusion.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-exclusions-create","tags":["Agent Exclusions"],"parameters":[{"description":"The ID of the scanner","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the exclusion."},"description":{"type":"string","description":"The description of the exclusion."},"schedule":{"type":"object","required":["starttime","rrules","timezone"],"properties":{"enabled":{"type":"boolean","description":"If true, the exclusion is scheduled."},"starttime":{"type":"string","description":"The start time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"endtime":{"type":"string","description":"The end time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"timezone":{"type":"string","description":"The timezone for the exclusion as returned by [scans: timezones](/reference#scans-timezones)."},"rrules":{"type":"object","required":["freq"],"properties":{"freq":{"type":"string","description":"The frequency of the rule (ONETIME, DAILY, WEEKLY, MONTHLY, YEARLY).","enum":["ONETIME","DAILY","WEEKLY","MONTHLY","YEARLY"]},"interval":{"type":"integer","description":"The interval of the rule."},"byweekday":{"type":"string","description":"A comma separated string of days to repeat a WEEKLY freq rule on (SU,MO,TU,WE,TH,FR, or SA)."},"bymonthday":{"type":"integer","description":"The day of the month to repeat a MONTHLY freq rule on."}}}}}},"required":["name","schedule"]}}}},"responses":{"200":{"description":"Returned if the agent exclusion has been created.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the exclusion."},"name":{"type":"string","description":"The name of the exclusion."},"description":{"type":"string","description":"The description of the exclusion."},"creation_date":{"type":"integer","description":"The creation date of the exclusion in unixtime."},"last_modification_date":{"type":"integer","description":"The last modification date for the exclusion in unixtime."},"schedule":{"type":"object","required":["starttime","rrules","timezone"],"properties":{"enabled":{"type":"boolean","description":"If true, the exclusion is scheduled."},"starttime":{"type":"string","description":"The start time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"endtime":{"type":"string","description":"The end time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"timezone":{"type":"string","description":"The timezone for the exclusion as returned by [scans: timezones](/reference#scans-timezones)."},"rrules":{"type":"object","required":["freq"],"properties":{"freq":{"type":"string","description":"The frequency of the rule (ONETIME, DAILY, WEEKLY, MONTHLY, YEARLY).","enum":["ONETIME","DAILY","WEEKLY","MONTHLY","YEARLY"]},"interval":{"type":"integer","description":"The interval of the rule."},"byweekday":{"type":"string","description":"A comma separated string of days to repeat a WEEKLY freq rule on (SU,MO,TU,WE,TH,FR, or SA)."},"bymonthday":{"type":"integer","description":"The day of the month to repeat a MONTHLY freq rule on."}}}}}}},"examples":{"response":{"value":{"schedule":{"endtime":"2019-11-29 19:35:00","enabled":true,"rrules":{"freq":"DAILY","interval":8,"byweekday":"SU,MO","bymonthday":9},"timezone":"US/Pacific","starttime":"2018-11-29 19:35:00"},"last_modification_date":1543541807,"creation_date":1543541807,"description":"Router scan exclusion","name":"Routers","id":124234}}}}}},"400":{"description":"Returned if an argument is missing or invalid."},"403":{"description":"Returned if you do not have permission to create an exclusion."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to create the exclusion.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List agent exclusions","description":"Returns the list of current agent exclusions.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-exclusions-list","tags":["Agent Exclusions"],"parameters":[{"description":"The ID of the scanner","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the exclusions.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the exclusion."},"name":{"type":"string","description":"The name of the exclusion."},"description":{"type":"string","description":"The description of the exclusion."},"creation_date":{"type":"integer","description":"The creation date of the exclusion in unixtime."},"last_modification_date":{"type":"integer","description":"The last modification date for the exclusion in unixtime."},"schedule":{"type":"object","required":["starttime","rrules","timezone"],"properties":{"enabled":{"type":"boolean","description":"If true, the exclusion is scheduled."},"starttime":{"type":"string","description":"The start time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"endtime":{"type":"string","description":"The end time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"timezone":{"type":"string","description":"The timezone for the exclusion as returned by [scans: timezones](/reference#scans-timezones)."},"rrules":{"type":"object","required":["freq"],"properties":{"freq":{"type":"string","description":"The frequency of the rule (ONETIME, DAILY, WEEKLY, MONTHLY, YEARLY).","enum":["ONETIME","DAILY","WEEKLY","MONTHLY","YEARLY"]},"interval":{"type":"integer","description":"The interval of the rule."},"byweekday":{"type":"string","description":"A comma separated string of days to repeat a WEEKLY freq rule on (SU,MO,TU,WE,TH,FR, or SA)."},"bymonthday":{"type":"integer","description":"The day of the month to repeat a MONTHLY freq rule on."}}}}}}}},"examples":{"response":{"value":{"exclusions":[{"schedule":{"endtime":"2019-11-29 19:35:00","enabled":true,"rrules":{"freq":"DAILY","interval":8,"byweekday":"SU,MO","bymonthday":9},"timezone":"US/Pacific","starttime":"2018-11-29 19:35:00"},"last_modification_date":1543541807,"creation_date":1543541807,"description":"Router scan exclusion","name":"Routers","id":124234},{"schedule":{"endtime":"2019-11-29 19:35:00","enabled":true,"rrules":{"freq":"DAILY","interval":8,"byweekday":"TU","bymonthday":11},"timezone":"US/Central","starttime":"2018-11-29 19:35:00"},"last_modification_date":2543541809,"creation_date":2543541809,"description":"Workstation scan exclusion","name":"Workstation","id":222456}]}}}}}},"403":{"description":"Returned if you do not have permission to view the exclusions."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agents/exclusions/{exclusion_id}":{"put":{"summary":"Update agent exclusion","description":"Updates an agent exclusion.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-exclusions-edit","tags":["Agent Exclusions"],"parameters":[{"description":"The ID of the exclusion to edit.","required":true,"name":"exclusion_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the scanner","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the exclusion."},"description":{"type":"string","description":"The description of the exclusion."},"schedule":{"type":"object","required":["starttime","rrules","timezone"],"properties":{"enabled":{"type":"boolean","description":"If true, the exclusion is scheduled."},"starttime":{"type":"string","description":"The start time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"endtime":{"type":"string","description":"The end time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"timezone":{"type":"string","description":"The timezone for the exclusion as returned by [scans: timezones](/reference#scans-timezones)."},"rrules":{"type":"object","required":["freq"],"properties":{"freq":{"type":"string","description":"The frequency of the rule (ONETIME, DAILY, WEEKLY, MONTHLY, YEARLY).","enum":["ONETIME","DAILY","WEEKLY","MONTHLY","YEARLY"]},"interval":{"type":"integer","description":"The interval of the rule."},"byweekday":{"type":"string","description":"A comma separated string of days to repeat a WEEKLY freq rule on (SU,MO,TU,WE,TH,FR, or SA)."},"bymonthday":{"type":"integer","description":"The day of the month to repeat a MONTHLY freq rule on."}}}}}},"required":["schedule"]}}}},"responses":{"200":{"description":"Returned if the exclusion has been modified.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"schedule":{"endtime":"2019-11-29 19:35:00","enabled":true,"rrules":{"freq":"DAILY","interval":8,"byweekday":"SU,MO","bymonthday":9},"timezone":"US/Pacific","starttime":"2018-11-29 19:35:00"},"last_modification_date":1543541807,"creation_date":1543541807,"description":"Router scan exclusion","name":"Routers","id":124234}}}}}},"403":{"description":"Returned if you do not have permission to modify the exclusion."},"404":{"description":"Returned if Tenable.io cannot find the specified exclusion."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to change the exclusion.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete agent exclusion","description":"Deletes an agent exclusion.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-exclusions-delete","tags":["Agent Exclusions"],"parameters":[{"description":"The ID of the exclusion to delete.","required":true,"name":"exclusion_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the scanner","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the exclusion has been successfully deleted.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you do not have permission to delete the exclusion."},"404":{"description":"Returned if Tenable.io cannot find the specified exclusion."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"Get agent exclusion details","description":"Returns details for the specified agent exclusion.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-exclusions-details","tags":["Agent Exclusions"],"parameters":[{"description":"The ID of the exclusion.","required":true,"name":"exclusion_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the scanner","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the exclusion details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the exclusion."},"name":{"type":"string","description":"The name of the exclusion."},"description":{"type":"string","description":"The description of the exclusion."},"creation_date":{"type":"integer","description":"The creation date of the exclusion in unixtime."},"last_modification_date":{"type":"integer","description":"The last modification date for the exclusion in unixtime."},"schedule":{"type":"object","required":["starttime","rrules","timezone"],"properties":{"enabled":{"type":"boolean","description":"If true, the exclusion is scheduled."},"starttime":{"type":"string","description":"The start time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"endtime":{"type":"string","description":"The end time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"timezone":{"type":"string","description":"The timezone for the exclusion as returned by [scans: timezones](/reference#scans-timezones)."},"rrules":{"type":"object","required":["freq"],"properties":{"freq":{"type":"string","description":"The frequency of the rule (ONETIME, DAILY, WEEKLY, MONTHLY, YEARLY).","enum":["ONETIME","DAILY","WEEKLY","MONTHLY","YEARLY"]},"interval":{"type":"integer","description":"The interval of the rule."},"byweekday":{"type":"string","description":"A comma separated string of days to repeat a WEEKLY freq rule on (SU,MO,TU,WE,TH,FR, or SA)."},"bymonthday":{"type":"integer","description":"The day of the month to repeat a MONTHLY freq rule on."}}}}}}},"examples":{"response":{"value":{"schedule":{"endtime":"2019-11-29 19:35:00","enabled":true,"rrules":{"freq":"DAILY","interval":8,"byweekday":"SU,MO","bymonthday":9},"timezone":"US/Pacific","starttime":"2018-11-29 19:35:00"},"last_modification_date":1543541807,"creation_date":1543541807,"description":"Router scan exclusion","name":"Routers","id":124234}}}}}},"403":{"description":"Returned if you do not have permission to view the exclusion."},"404":{"description":"Returned if Tenable.io cannot find the specified exclusion."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agent-groups":{"post":{"summary":"Create agent group on scanner","description":"Creates an agent group on the scanner.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-groups-create","tags":["Agent Groups"],"parameters":[{"description":"The ID of the scanner to add the agent group to.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the agent group."}},"required":["name"]}}}},"responses":{"200":{"description":"Returned if the agent group has been created.","content":{"application/json":{"schema":{"type":"object","properties":{"agents":{"description":"The agents in the group. The agent records can be filtered, sorted, and paginated.","type":"array","items":{"type":"string"}},"creation_date":{"type":"integer","description":"The creation date of the agent group in unixtime."},"id":{"type":"integer","description":"The unique ID of the agent group."},"last_modification_date":{"type":"integer","description":"The last modification date for the agent group in unixtime."},"name":{"type":"string","description":"The name of the agent group."},"owner":{"type":"string","description":"The username for the owner of the agent group."},"owner_id":{"type":"string","description":"The unique ID of the owner of the agent group."},"owner_name":{"type":"string","description":"The name for the owner of the agent group."},"owner_uuid":{"type":"string","description":"The UUID of the owner of the agent group."},"pagination":{"type":"object","properties":{}},"shared":{"type":"integer","description":"The shared status of the agent group."},"user_permissions":{"type":"integer","description":"The sharing permissions for the agent group."},"uuid":{"type":"string","description":"The UUID of the agent group."}}},"examples":{"response":{"value":{"id":106592,"uuid":"8b05bd55-9105-48ec-9da1-2e10a2c9a4e0","name":"Western Region","creation_date":1544455100,"last_modification_date":1544455100,"timestamp":1544455100,"shared":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","user_permissions":0,"agents_count":0}}}}}},"400":{"description":"Returned if your request message contains an invalid parameter."},"403":{"description":"Returned if you do not have permission to create an agent group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to add the agent group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List agent groups for scanner","description":"Lists the agent groups for the scanner.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-groups-list","tags":["Agent Groups"],"parameters":[{"description":"The ID of the scanner to query for agent groups.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the agent groups list.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"agents":{"description":"The agents in the group. The agent records can be filtered, sorted, and paginated.","type":"array","items":{"type":"string"}},"creation_date":{"type":"integer","description":"The creation date of the agent group in unixtime."},"id":{"type":"integer","description":"The unique ID of the agent group."},"last_modification_date":{"type":"integer","description":"The last modification date for the agent group in unixtime."},"name":{"type":"string","description":"The name of the agent group."},"owner":{"type":"string","description":"The username for the owner of the agent group."},"owner_id":{"type":"string","description":"The unique ID of the owner of the agent group."},"owner_name":{"type":"string","description":"The name for the owner of the agent group."},"owner_uuid":{"type":"string","description":"The UUID of the owner of the agent group."},"pagination":{"type":"object","properties":{}},"shared":{"type":"integer","description":"The shared status of the agent group."},"user_permissions":{"type":"integer","description":"The sharing permissions for the agent group."},"uuid":{"type":"string","description":"The UUID of the agent group."}}}},"examples":{"response":{"value":{"groups":[{"id":106592,"uuid":"8b05bd55-9105-48ec-9da1-2e10a2c9a4e0","name":"slibs","creation_date":1544455100,"last_modification_date":1544455100,"timestamp":1544455100,"shared":1,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","user_permissions":128,"agents_count":0}]}}}}}},"403":{"description":"Returned if you do not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agent-groups/{group_id}":{"get":{"summary":"Get details for agent group","description":"Gets details for the agent group.  Agent records which belong to this group will also be returned. You can apply filtering, sorting, or pagination to the agent records.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-groups-details","tags":["Agent Groups"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the agent group to query.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The starting record to retrieve. If this parameter is not supplied, the default value is 0.","required":false,"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The number of records to retrieve. If this parameter is not supplied, a default of 50 records is used. The minimum supported limit is 1, and the maximum supported limit is 5000.","required":false,"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The sort order of the returned records. Sort can only be applied to the sortable\\_fields specified by the filter capabilities. There may be no more than max\\_sort\\_fields number of columns used in the sort, as specified by the filter capabilities. Sort is applied, in order, in the following format: `:\\[asc|desc\\],:\\[asc|desc\\]`. For example, `sort=field1:asc,field2:desc` would first sort by field1, ascending, then sort by field2, descending.","required":false,"name":"sort","in":"query","schema":{"type":"string"}},{"description":"Apply a filter in the format `::`. For example, `field1:match:sometext` would match any records where the value of field1 contains `sometext`. You can use multiple query filters.","required":false,"name":"f","in":"query","schema":{"type":"string"}},{"description":"Filter type. If the filter type is `and`, the record is only returned if all filters match. If the filter type is `or`, the record is returned if any of the filters match.","required":false,"name":"ft","in":"query","schema":{"type":"string"}},{"description":"Wildcard filter text. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the wildcard\\_fields' values matches against the filter string, then the record matches the wildcard filter. For a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters. For example, if `w=wild&f=field1:match:one&f=field2:match:two&ft=or`, the record would match if the value of any supported wildcard\\_fields contained `wild`, AND either field1's value contained `one` or field2's value contained `two`.","required":false,"name":"w","in":"query","schema":{"type":"string"}},{"description":"A comma delimited subset of wildcard\\_fields to search when applying the wildcard filter. For example, `field1,field2`. If `w` is provided, but `wf` is not, then all wildcard\\_fields' values are searched against the wildcard filter text.","required":false,"name":"wf","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the agent group details.","content":{"application/json":{"schema":{"type":"object","properties":{"agents":{"description":"The agents in the group. The agent records can be filtered, sorted, and paginated.","type":"array","items":{"type":"string"}},"creation_date":{"type":"integer","description":"The creation date of the agent group in unixtime."},"id":{"type":"integer","description":"The unique ID of the agent group."},"last_modification_date":{"type":"integer","description":"The last modification date for the agent group in unixtime."},"name":{"type":"string","description":"The name of the agent group."},"owner":{"type":"string","description":"The username for the owner of the agent group."},"owner_id":{"type":"string","description":"The unique ID of the owner of the agent group."},"owner_name":{"type":"string","description":"The name for the owner of the agent group."},"owner_uuid":{"type":"string","description":"The UUID of the owner of the agent group."},"pagination":{"type":"object","properties":{}},"shared":{"type":"integer","description":"The shared status of the agent group."},"user_permissions":{"type":"integer","description":"The sharing permissions for the agent group."},"uuid":{"type":"string","description":"The UUID of the agent group."}}},"examples":{"response":{"value":{"id":106592,"uuid":"8b05bd55-9105-48ec-9da1-2e10a2c9a4e0","name":"Western Region","creation_date":1544455100,"last_modification_date":1544455100,"timestamp":1544455100,"shared":1,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","user_permissions":128,"agents_count":0,"agents":[],"pagination":{"total":0,"limit":50,"offset":0,"sort":[{"name":"name","order":"asc"}]}}}}}}},"403":{"description":"Returned if you do not have permission to view the agent group."},"404":{"description":"Returned if Tenable.io cannot find the specified agent group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update name of agent group","description":"Changes the name of the agent group.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-groups-configure","tags":["Agent Groups"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the agent group to change.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name for the agent group."}},"required":["name"]}}}},"responses":{"200":{"description":"Returned if the configuration was changed.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"To do":"Add response sample here"}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified agent group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if an error occurred while saving the configuration.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete agent group from scanner","description":"Deletes an agent group from the scanner.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-groups-delete","tags":["Agent Groups"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the agent group to delete.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the agent group has been successfully deleted.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified agent group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to delete the agent group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agent-groups/{group_id}/agents/{agent_id}":{"put":{"summary":"Add agent to agent group","description":"Adds an agent to the agent group.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-groups-add-agent","tags":["Agent Groups"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the agent group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the agent to add.","required":true,"name":"agent_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the agent was added to the group.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"To do":"Add response sample here"}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified agent group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if an error occurred while attempting to add the agent.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete agent from agent group","description":"Deletes an agent from the agent group.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-groups-delete-agent","tags":["Agent Groups"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the agent group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the agent to remove.","required":true,"name":"agent_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the agent has been successfully removed from the agent group.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified agent."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to remove the agent from the agent group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agents":{"get":{"summary":"List agents for scanner","description":"Returns a list of agents for the specified scanner.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agents-list","tags":["Agents"],"parameters":[{"description":"The ID of the scanner to query for agents.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The starting record to retrieve. If you omit this parameter, Tenable.io uses the default value of 0.","required":false,"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The number of records to retrieve. If you omit this parameter, Tenable.io uses a default of 50 records. The minimum supported limit is 1, and the maximum supported limit is 5,000.","required":false,"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The sort order of the returned records. Sort can only be applied to the sortable\\_fields specified by the filter capabilities. There may be no more than max\\_sort\\_fields number of columns used in the sort, as specified by the filter capabilities. Sort is applied, in order, in the following format: `:\\[asc|desc\\],:\\[asc|desc\\]`. For example, `sort=field1:asc,field2:desc` would first sort by field1, ascending, then sort by field2, descending.","required":false,"name":"sort","in":"query","schema":{"type":"string"}},{"description":"Apply a filter in the format `::`. For example, `field1:match:sometext` would match any records where the value of field1 contains `sometext`. You can use multiple query filters.","required":false,"name":"f","in":"query","schema":{"type":"string"}},{"description":"Filter type. If the filter type is `and`, the record is only returned if all filters match. If the filter type is `or`, the record is returned if any of the filters match.","required":false,"name":"ft","in":"query","schema":{"type":"string"}},{"description":"Wildcard filter text. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the wildcard\\_fields' values matches against the filter string, then the record matches the wildcard filter. For a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters. For example, if `w=wild&f=field1:match:one&f=field2:match:two&ft=or`, the record would match if the value of any supported wildcard\\_fields contained `wild`, AND either field1's value contained `one` or field2's value contained `two`.","required":false,"name":"w","in":"query","schema":{"type":"string"}},{"description":"A comma-delimited subset of wildcard\\_fields to search when applying the wildcard filter. For example, `field1,field2`. If `w` is provided, but `wf` is not, then all wildcard\\_fields' values are searched against the wildcard filter text.","required":false,"name":"wf","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of agents.","content":{"application/json":{"schema":{"type":"object","properties":{"agents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the agent."},"uuid":{"type":"string","description":"The UUID of the agent. Note: This value corresponds to the ID of the asset where the agent is installed. You can use this attribute to match agent data to asset data."},"name":{"type":"string","description":"The name of the agent."},"platform":{"type":"string","description":"The platform of the agent."},"distro":{"type":"string","description":"The agent software distribution."},"ip":{"type":"string","description":"The IP address of the agent."},"last_scanned":{"type":"integer","description":"The Unix timestamp when the agent last scanned the asset."},"plugin_feed_id":{"type":"string","description":"The currently loaded plugin set of the agent (null if the agent has no plugin set loaded)."},"core_build":{"type":"string","description":"Build number for the agent."},"core_version":{"type":"string","description":"Build version for the agent."},"linked_on":{"type":"integer","description":"The Unix timestamp when the link from Tenable.io to the agent was established."},"last_connect":{"type":"integer","description":"The Unix timestamp when the agent last communicated with Tenable.io."},"status":{"type":"string","description":"\"on\", \"off\", or \"init\".  \"on\" means that the agent has connected recently, and is therefore likely ready to scan.  \"off\" means that the agent has not been seen recently and should be considered offline.  \"init\" means that the agent is online, but it is still processing plugin updates and is not ready to scan.","enum":["on","off","init"]},"groups":{"description":"Array of groups to which the agent belongs. Groups are returned in the form {\"name\": \"group name\", \"id\": \"group id\"}.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the agent group to which the agent belongs."},"id":{"type":"integer","description":"The unique ID of the agent group to which the agent belongs."}}}}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of records which match any applied filters. This number may be approximate."},"offset":{"type":"integer","description":"The index of the first record retrieved."},"limit":{"type":"integer","description":"The number of records returned with this response."},"sort":{"description":"The sorting parameters applied to response, in order of application.","type":"array","items":{"type":"string"}}}}}},"examples":{"response":{"value":{"agents":[{"id":157,"uuid":"c6ce4255-b386-4e71-be64-0d06434bac5d","name":"GRD-LPTP","platform":"WINDOWS","distro":"win-x86-64","ip":"172.204.81.57","last_scanned":1515620036,"plugin_feed_id":"201801081515","core_build":"106","core_version":"7.0.0","linked_on":1456775443,"last_connect":1515674073,"status":"off","groups":[{"name":"CodyAgents","id":8},{"name":"Agent Group A","id":3316}]},{"id":14569,"uuid":"bce54c02-392d-4305-bc83-e1e1d8130afd","name":"scr-lce.lab.tenablesecurity.com","platform":"LINUX","distro":"es7-x86-64","ip":"172.204.81.57","plugin_feed_id":"201805161620","core_build":"13","core_version":"7.0.3","linked_on":1508329832,"last_connect":1526565530,"status":"off","groups":[{"name":"SC Research","id":1167}]},{"id":14570,"uuid":"0657efe4-0ba0-423a-ac5f-52a6e23d2e11","name":"scr-sc5.lab.tenablesecurity.com","platform":"LINUX","distro":"es7-x86-64","ip":"172.204.81.57","plugin_feed_id":"201805161620","core_build":"13","core_version":"7.0.3","linked_on":1508329886,"last_connect":1526565624,"status":"off","groups":[{"name":"SC Research","id":1167}]}],"pagination":{"total":3,"limit":50,"offset":0,"sort":[{"name":"name","order":"asc"}]}}}}}}},"403":{"description":"Returned if you do not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agent-groups/{agent_group_id}/agents":{"get":{"summary":"List agents for agent group","description":"Returns a list of agents for the specified agent group.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agent-group-list-agents","tags":["Agents"],"parameters":[{"description":"The ID of the scanner to query for agents. You can find the ID by using the [GET /scanners](/reference#scanners-list) endpoint.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the agent group to query for agents. You can find the ID by using the [GET /scanners/{scanner_id}/agent-groups](/reference#agent-groups-list) endpoint.","required":true,"name":"agent_group_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The starting record to retrieve. If you omit this parameter, Tenable.io uses the default value of 0.","required":false,"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The number of records to retrieve. If you omit this parameter, Tenable.io uses a default of 50 records. The minimum supported limit is 1, and the maximum supported limit is 5,000.","required":false,"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The sort order of the returned records. Sort can only be applied to the sortable\\_fields specified by the filter capabilities. There may be no more than max\\_sort\\_fields number of columns used in the sort, as specified by the filter capabilities. Sort is applied, in order, in the following format: `:\\[asc|desc\\],:\\[asc|desc\\]`. For example, `sort=field1:asc,field2:desc` would first sort by field1, ascending, then sort by field2, descending.","required":false,"name":"sort","in":"query","schema":{"type":"string"}},{"description":"Apply a filter in the format `::`. For example, `field1:match:sometext` would match any records where the value of field1 contains `sometext`. You can use multiple query filters.","required":false,"name":"f","in":"query","schema":{"type":"string"}},{"description":"Filter type. If the filter type is `and`, the record is only returned if all filters match. If the filter type is `or`, the record is returned if any of the filters match.","required":false,"name":"ft","in":"query","schema":{"type":"string"}},{"description":"Wildcard filter text. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the wildcard\\_fields' values matches against the filter string, then the record matches the wildcard filter. For a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters. For example, if `w=wild&f=field1:match:one&f=field2:match:two&ft=or`, the record would match if the value of any supported wildcard\\_fields contained `wild`, AND either field1's value contained `one` or field2's value contained `two`.","required":false,"name":"w","in":"query","schema":{"type":"string"}},{"description":"A comma-delimited subset of wildcard\\_fields to search when applying the wildcard filter. For example, `field1,field2`. If `w` is provided, but `wf` is not, then all wildcard\\_fields' values are searched against the wildcard filter text.","required":false,"name":"wf","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of agents for an agent group.","content":{"application/json":{"schema":{"type":"object","properties":{"agents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the agent."},"uuid":{"type":"string","description":"The UUID of the agent. Note: This value corresponds to the ID of the asset where the agent is installed. You can use this attribute to match agent data to asset data."},"name":{"type":"string","description":"The name of the agent."},"platform":{"type":"string","description":"The platform of the agent."},"distro":{"type":"string","description":"The agent software distribution."},"ip":{"type":"string","description":"The IP address of the agent."},"last_scanned":{"type":"integer","description":"The Unix timestamp when the agent last scanned the asset."},"plugin_feed_id":{"type":"string","description":"The currently loaded plugin set of the agent (null if the agent has no plugin set loaded)."},"core_build":{"type":"string","description":"Build number for the agent."},"core_version":{"type":"string","description":"Build version for the agent."},"linked_on":{"type":"integer","description":"The Unix timestamp when the link from Tenable.io to the agent was established."},"last_connect":{"type":"integer","description":"The Unix timestamp when the agent last communicated with Tenable.io."},"status":{"type":"string","description":"\"on\", \"off\", or \"init\".  \"on\" means that the agent has connected recently, and is therefore likely ready to scan.  \"off\" means that the agent has not been seen recently and should be considered offline.  \"init\" means that the agent is online, but it is still processing plugin updates and is not ready to scan.","enum":["on","off","init"]},"groups":{"description":"Array of groups to which the agent belongs. Groups are returned in the form {\"name\": \"group name\", \"id\": \"group id\"}.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the agent group to which the agent belongs."},"id":{"type":"integer","description":"The unique ID of the agent group to which the agent belongs."}}}}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of records which match any applied filters. This number may be approximate."},"offset":{"type":"integer","description":"The index of the first record retrieved."},"limit":{"type":"integer","description":"The number of records returned with this response."},"sort":{"description":"The sorting parameters applied to response, in order of application.","type":"array","items":{"type":"string"}}}}}},"examples":{"response":{"value":{"agents":[{"id":20,"uuid":"07e496f5-d2dc-4232-9733-12e5f7d05ae3","name":"Codys-MacBook-Pro.local","platform":"DARWIN","distro":"macosx","ip":"10.31.100.110","last_scanned":1545272687,"plugin_feed_id":"201812281741","core_build":"1","core_version":"7.2.1","linked_on":1452106253,"last_connect":1546264939,"status":"off","groups":[{"name":"Agent Group A","id":8},{"name":"Agent Group B","id":31},{"name":"Agent Group C","id":3315}],"supports_remote_logs":false},{"id":65,"uuid":"22f00428-3095-d55f-e620-aa7392c862757b06b5e32a5e47a1","name":"DC02","platform":"WINDOWS","distro":"win-x86-64","ip":"10.31.114.10","last_scanned":1478743235,"plugin_feed_id":"0","linked_on":1453821446,"status":"off","groups":[{"name":"Agent Group A","id":8},{"name":"Agent Group B","id":31},{"name":"Agent Group C","id":3316}],"supports_remote_logs":false},{"id":643,"uuid":"84b8e813-fad6-d1a5-e9f6-ac641d3b0b012596d192e3cf57f8","name":"DESKTOP-PSNDJQ6","platform":"WINDOWS","distro":"win-x86-64","ip":"172.16.0.3","last_scanned":1477011651,"plugin_feed_id":"0","linked_on":1468619962,"status":"off","groups":[{"name":"Agent Group A","id":8},{"name":"Agent Group C","id":3316}],"supports_remote_logs":false}],"pagination":{"total":3,"limit":50,"offset":0,"sort":[{"name":"name","order":"asc"}]}}}}}}},"400":{"description":"Returned if you specify invalid query parameters, for example:\n- invalid filter field name\n- invalid filter operator\n- invalid filter value\n- invalid wildcard filter field name\n- invalid filter type\n- invalid sort parameter","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"The description of the cause of the Tenable.io error."}}},"examples":{"response":{"value":{"error":"Bad value for date filter"}}}}}},"403":{"description":"Returned if you do not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agents/{agent_id}":{"get":{"summary":"Get agent details","description":"Returns the specified agent details for the specified scanner.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agents-get","tags":["Agents"],"parameters":[{"description":"The ID of the scanner to query for agents.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the agent to query.","required":true,"name":"agent_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the agent details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the agent."},"uuid":{"type":"string","description":"The UUID of the agent. Note: This value corresponds to the ID of the asset where the agent is installed. You can use this attribute to match agent data to asset data."},"name":{"type":"string","description":"The name of the agent."},"platform":{"type":"string","description":"The platform of the agent."},"distro":{"type":"string","description":"The agent software distribution."},"ip":{"type":"string","description":"The IP address of the agent."},"last_scanned":{"type":"integer","description":"The Unix timestamp when the agent last scanned the asset."},"plugin_feed_id":{"type":"string","description":"The currently loaded plugin set of the agent (null if the agent has no plugin set loaded)."},"core_build":{"type":"string","description":"Build number for the agent."},"core_version":{"type":"string","description":"Build version for the agent."},"linked_on":{"type":"integer","description":"The Unix timestamp when the link from Tenable.io to the agent was established."},"last_connect":{"type":"integer","description":"The Unix timestamp when the agent last communicated with Tenable.io."},"status":{"type":"string","description":"\"on\", \"off\", or \"init\".  \"on\" means that the agent has connected recently, and is therefore likely ready to scan.  \"off\" means that the agent has not been seen recently and should be considered offline.  \"init\" means that the agent is online, but it is still processing plugin updates and is not ready to scan.","enum":["on","off","init"]},"groups":{"description":"Array of groups to which the agent belongs. Groups are returned in the form {\"name\": \"group name\", \"id\": \"group id\"}.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the agent group to which the agent belongs."},"id":{"type":"integer","description":"The unique ID of the agent group to which the agent belongs."}}}}}},"examples":{"response":{"value":{"id":643,"uuid":"84b8e813-fad6-d1a5-e9f6-ac641d3b0b012596d192e3cf57f8","name":"DESKTOP-PSNDJQ6","platform":"WINDOWS","distro":"win-x86-64","ip":"172.204.81.57","last_scanned":1477011651,"plugin_feed_id":"0","linked_on":1468619962,"status":"off","groups":[{"name":"CodyAgents","id":8},{"name":"Agent Group A","id":3316}]}}}}}},"403":{"description":"Returned if you do not have permission to view the agent."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete agent","description":"Deletes an agent.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"agents-delete","tags":["Agents"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the agent to delete.","required":true,"name":"agent_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io succesfully deleted the agent.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified agent."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to delete the agent.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agent-groups/{group_id}/agents/_bulk/add":{"post":{"summary":"Add agents to group","description":"Creates a bulk operation task to add agents to a group.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"bulk-add-agents","tags":["Agent Bulk Operations"],"parameters":[{"description":"The ID of the scanner for the agent group.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID or UUID of the agent group.","required":true,"name":"group_id","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"items":{"type":"string"},"description":"Array of agent IDs or UUIDs to add to the group","type":"array"}},"required":["items"]},"example":{"items":[20,10,65]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully creates the bulk operation task.","content":{"application/json":{"schema":{"type":"object","properties":{"task_id":{"type":"string","description":"The UUID of the task."},"container_uuid":{"type":"string","description":"The UUID of the container where the task is operating."},"status":{"type":"string","description":"State of the task.  \"NEW\" means that the task was created, but has not yet started running.  \"RUNNING\" means that the task is in progress.  \"COMPLETED\" means that the task is done.  \"FAILED\" means that there was an error completing the task.  \"STALE\" means that the task has not been updated in a long time.","enum":["NEW","RUNNING","COMPLETED","FAILED","STALE"]},"message":{"type":"string","description":"An informative, human-readable message about the state of the task."},"start_time":{"type":"integer","description":"Start time of the task in unix time milliseconds."},"end_time":{"type":"integer","description":"End time of the task in unix time milliseconds, if the task is finished."},"last_update_time":{"type":"integer","description":"Last time progress was made on executing the task in unix time milliseconds."},"total_work_units":{"type":"integer","description":"Total amount of work which the task will attempt to complete."},"total_work_units_completed":{"type":"integer","description":"Total amount of work that the task has completed."},"completion_percentage":{"type":"integer","description":"total_work_units_completed divided by total_work_units."}}},"examples":{"response":{"value":{"task_id":"14a27fad-8a0e-4769-ac87-4da6370a871a","container_uuid":"5043dfa2-7864-4785-aff7-80026f36efcb","status":"RUNNING","message":"Starting...","start_time":1544032287496,"last_update_time":1544032287501,"total_work_units":3,"total_work_units_completed":0,"completion_percentage":0}}}}}},"400":{"description":"Returned if your request message contains an invalid parameter."},"403":{"description":"Returned if you do not have permission to create a bulk operation task."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to create the bulk operation task.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agent-groups/{group_id}/agents/_bulk/{task_uuid}":{"get":{"summary":"Check agent group operation status","description":"Check the status of a bulk operation on an agent group.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"bulk-task-agent-group-status","tags":["Agent Bulk Operations"],"parameters":[{"description":"The ID of the scanner for the agent group.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID or UUID of the agent group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The UUID of the task","required":true,"name":"task_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the bulk operation task status information.","content":{"application/json":{"schema":{"type":"object","properties":{"task_id":{"type":"string","description":"The UUID of the task."},"container_uuid":{"type":"string","description":"The UUID of the container where the task is operating."},"status":{"type":"string","description":"State of the task.  \"NEW\" means that the task was created, but has not yet started running.  \"RUNNING\" means that the task is in progress.  \"COMPLETED\" means that the task is done.  \"FAILED\" means that there was an error completing the task.  \"STALE\" means that the task has not been updated in a long time.","enum":["NEW","RUNNING","COMPLETED","FAILED","STALE"]},"message":{"type":"string","description":"An informative, human-readable message about the state of the task."},"start_time":{"type":"integer","description":"Start time of the task in unix time milliseconds."},"end_time":{"type":"integer","description":"End time of the task in unix time milliseconds, if the task is finished."},"last_update_time":{"type":"integer","description":"Last time progress was made on executing the task in unix time milliseconds."},"total_work_units":{"type":"integer","description":"Total amount of work which the task will attempt to complete."},"total_work_units_completed":{"type":"integer","description":"Total amount of work that the task has completed."},"completion_percentage":{"type":"integer","description":"total_work_units_completed divided by total_work_units."}}},"examples":{"response":{"value":{"task_id":"14a27fad-8a0e-4769-ac87-4da6370a871a","container_uuid":"5043dfa2-7864-4785-aff7-80026f36efcb","status":"COMPLETED","message":"3 items completed, 0 failed.","start_time":1544032287496,"last_update_time":1544032287521,"end_time":1544032287521,"total_work_units":3,"total_work_units_completed":3,"completion_percentage":100}}}}}},"403":{"description":"Returned if you do not have permission to view the bulk operation task."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agents/_bulk/{task_uuid}":{"get":{"summary":"Check agent operation status","description":"Check the status of a bulk operation on agents.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"bulk-task-agent-status","tags":["Agent Bulk Operations"],"parameters":[{"description":"The ID of the scanner for the agent group.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The UUID of the task","required":true,"name":"task_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the bulk operation task status information.","content":{"application/json":{"schema":{"type":"object","properties":{"task_id":{"type":"string","description":"The UUID of the task."},"container_uuid":{"type":"string","description":"The UUID of the container where the task is operating."},"status":{"type":"string","description":"State of the task.  \"NEW\" means that the task was created, but has not yet started running.  \"RUNNING\" means that the task is in progress.  \"COMPLETED\" means that the task is done.  \"FAILED\" means that there was an error completing the task.  \"STALE\" means that the task has not been updated in a long time.","enum":["NEW","RUNNING","COMPLETED","FAILED","STALE"]},"message":{"type":"string","description":"An informative, human-readable message about the state of the task."},"start_time":{"type":"integer","description":"Start time of the task in unix time milliseconds."},"end_time":{"type":"integer","description":"End time of the task in unix time milliseconds, if the task is finished."},"last_update_time":{"type":"integer","description":"Last time progress was made on executing the task in unix time milliseconds."},"total_work_units":{"type":"integer","description":"Total amount of work which the task will attempt to complete."},"total_work_units_completed":{"type":"integer","description":"Total amount of work that the task has completed."},"completion_percentage":{"type":"integer","description":"total_work_units_completed divided by total_work_units."}}},"examples":{"response":{"value":{"task_id":"14a27fad-8a0e-4769-ac87-4da6370a871a","container_uuid":"5043dfa2-7864-4785-aff7-80026f36efcb","status":"COMPLETED","message":"3 items completed, 0 failed.","start_time":1544032287496,"last_update_time":1544032287521,"end_time":1544032287521,"total_work_units":3,"total_work_units_completed":3,"completion_percentage":100}}}}}},"403":{"description":"Returned if you do not have permission to view the bulk operation task."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agent-groups/{group_id}/agents/_bulk/remove":{"post":{"summary":"Remove agents from group","description":"Creates a bulk operation task to remove agents from a group.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"bulk-remove-agents","tags":["Agent Bulk Operations"],"parameters":[{"description":"The ID of the scanner for the agent group.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID or UUID of the agent group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"items":{"type":"string"},"description":"Array of agent IDs or UUIDs to remove from the group","type":"array"}},"required":["items"]},"example":{"items":[20,10,65]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully creates the bulk operation task.","content":{"application/json":{"schema":{"type":"object","properties":{"task_id":{"type":"string","description":"The UUID of the task."},"container_uuid":{"type":"string","description":"The UUID of the container where the task is operating."},"status":{"type":"string","description":"State of the task.  \"NEW\" means that the task was created, but has not yet started running.  \"RUNNING\" means that the task is in progress.  \"COMPLETED\" means that the task is done.  \"FAILED\" means that there was an error completing the task.  \"STALE\" means that the task has not been updated in a long time.","enum":["NEW","RUNNING","COMPLETED","FAILED","STALE"]},"message":{"type":"string","description":"An informative, human-readable message about the state of the task."},"start_time":{"type":"integer","description":"Start time of the task in unix time milliseconds."},"end_time":{"type":"integer","description":"End time of the task in unix time milliseconds, if the task is finished."},"last_update_time":{"type":"integer","description":"Last time progress was made on executing the task in unix time milliseconds."},"total_work_units":{"type":"integer","description":"Total amount of work which the task will attempt to complete."},"total_work_units_completed":{"type":"integer","description":"Total amount of work that the task has completed."},"completion_percentage":{"type":"integer","description":"total_work_units_completed divided by total_work_units."}}},"examples":{"response":{"value":{"task_id":"de5a64f6-b391-4aef-b0bc-1249fdb9750d","container_uuid":"5043dfa2-7864-4785-aff7-80026f36efcb","status":"RUNNING","start_time":1544032937522,"last_update_time":1544032937522}}}}}},"400":{"description":"Returned if your request message contains an invalid parameter."},"403":{"description":"Returned if you do not have permission to create a bulk operation task."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to create the bulk operation task.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/agents/_bulk/unlink":{"post":{"summary":"Delete agents","description":"Creates a bulk operation task to unlink (delete) agents.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"bulk-unlink-agents","tags":["Agent Bulk Operations"],"parameters":[{"description":"The ID of the scanner to remove the agents from.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"items":{"type":"string"},"description":"Array of agent IDs or UUIDs to unlink (delete).","type":"array"}},"required":["items"]},"example":{"items":[20,10,65]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully creates the bulk operation task.","content":{"application/json":{"schema":{"type":"object","properties":{"task_id":{"type":"string","description":"The UUID of the task."},"container_uuid":{"type":"string","description":"The UUID of the container where the task is operating."},"status":{"type":"string","description":"State of the task.  \"NEW\" means that the task was created, but has not yet started running.  \"RUNNING\" means that the task is in progress.  \"COMPLETED\" means that the task is done.  \"FAILED\" means that there was an error completing the task.  \"STALE\" means that the task has not been updated in a long time.","enum":["NEW","RUNNING","COMPLETED","FAILED","STALE"]},"message":{"type":"string","description":"An informative, human-readable message about the state of the task."},"start_time":{"type":"integer","description":"Start time of the task in unix time milliseconds."},"end_time":{"type":"integer","description":"End time of the task in unix time milliseconds, if the task is finished."},"last_update_time":{"type":"integer","description":"Last time progress was made on executing the task in unix time milliseconds."},"total_work_units":{"type":"integer","description":"Total amount of work which the task will attempt to complete."},"total_work_units_completed":{"type":"integer","description":"Total amount of work that the task has completed."},"completion_percentage":{"type":"integer","description":"total_work_units_completed divided by total_work_units."}}},"examples":{"response":{"value":{"task_id":"aed90273-b535-438e-9d85-30899636bbdd","container_uuid":"5043dfa2-7864-4785-aff7-80026f36efcb","status":"NEW"}}}}}},"400":{"description":"Returned if your request message contains an invalid parameter."},"403":{"description":"Returned if you do not have permission create a bulk operation task."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to create the bulk operation task.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/assets":{"get":{"summary":"List assets","description":"Lists up to 5,000 assets.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"assets-list-assets","tags":["Assets"],"responses":{"200":{"description":"Returns a list of assets.","content":{"application/json":{"schema":{"type":"object","description":"The list of assets with details, and the total assets count.","properties":{"assets":{"type":"array","description":"A list of assets with details.","items":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the asset."},"has_agent":{"type":"boolean","description":"A value specifying whether a Nessus agent scan detected the asset (`true`)."},"last_seen":{"type":"string","description":"The ISO timestamp of the scan that most recently detected the asset."},"last_scan_target":{"type":"string","description":"The IPv4 address, IPv6 address, or FQDN that the scanner last used to evaluate the asset."},"sources":{"type":"array","description":"The sources of the scans that identified the asset.","items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity that reported the asset details. Sources can include sensors, connectors, and API imports. Source names can be customized by your organization (for example, you specify a name when you import asset records). If your organization does not customize source names, system-generated names include:\n - AWS—You obtained the asset data from an Amazon Web Services connector.\n - NESSUS_AGENT—You obtained the asset data obtained from a Nessus agent scan.\n - PVS—You obtained the asset data from a Nessus Network Monitor (NNM) scan.\n - NESSUS_SCAN—You obtained the asset data from a Nessus scan.\n - WAS—You obtained the asset data from a  Web Application Scanning scan."},"first_seen":{"type":"string","description":"The ISO timestamp when the source first reported the asset."},"last_seen":{"type":"string","description":"The ISO timestamp when the source last reported the asset."}}}}},"acr_score":{"type":"integer","description":"The Asset Criticality Rating (ACR) for the asset. Tenable assigns an ACR to each asset on your network to represent the asset's relative risk as an integer from 1 to 10. This attribute is only present in assets if Lumin is added to your Tenable.io instance. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*."},"acr_drivers":{"type":"array","description":"The key drivers that Tenable uses to calculate an asset's Tenable-provided ACR. This attribute is only present in assets if Lumin is added to your Tenable.io instance. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*.","items":{"type":"object","description":"Information about an asset characteristic that factored into the ACR score calculation.","properties":{"driver_name":{"type":"string","description":"The type of characteristic."},"driver_value":{"type":"array","description":"The characteristic value.","items":{"type":"string"}}}}},"exposure_score":{"type":"integer","description":"The Asset Exposure Score (AES) for the asset. This attribute is only present in assets if Lumin is added to your Tenable.io instance. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*."},"scan_frequency":{"type":"array","description":"Information about how often scans ran against the asset during specified intervals. This attribute is only present in assets if Lumin is added to your Tenable.io instance.","items":{"type":"object","description":"Information about how often scans ran against asset during a specified interval.","properties":{"interval":{"type":"integer","description":"The number of days over which Tenable searches for scans involving the asset."},"frequency":{"type":"integer","description":"The number of times that a scan ran against the asset during the specified interval."},"licensed":{"type":"boolean","description":"Indicates whether the asset was licensed at the time of the identified scans."}}}},"ipv4":{"description":"A list of IPv4 addresses for the asset.","type":"array","items":{"type":"string"}},"ipv6":{"description":"A list of IPv6 addresses for the asset.","type":"array","items":{"type":"string"}},"fqdn":{"description":"A list of fully-qualified domain names (FQDNs) for the asset.","type":"array","items":{"type":"string"}},"netbios_name":{"type":"array","description":"The NetBIOS name for the asset.","items":{"type":"string"}},"operating_system":{"type":"array","description":"The operating system installed on the asset.","items":{"type":"string"}},"agent_name":{"type":"array","description":"The names of any Nessus agents that scanned and identified the asset.","items":{"type":"string"}},"aws_ec2_name":{"type":"array","description":"The name of the virtual machine instance in AWS EC2.","items":{"type":"string"}},"mac_address":{"type":"array","description":"A list of MAC addresses for the asset.","items":{"type":"string"}}}}},"total":{"type":"integer","description":"The total number of assets in your Tenable.io instance."}}},"examples":{"response":{"value":{"assets":[{"id":"f56168ed-b719-4273-b58c-a340a09ffbce","has_agent":false,"last_seen":"2018-11-28T15:00:57.000Z","last_scan_target":"172.204.81.57","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T15:00:57.000Z","last_seen":"2018-11-28T15:00:57.000Z"}],"acr_score":8,"acr_drivers":[{"driver_name":"device_type","driver_value":["general_purpose"]},{"driver_name":"device_capability","driver_value":["pci"]},{"driver_name":"internet_exposure","driver_value":["internal"]}],"exposure_score":753,"scan_frequency":[{"interval":90,"frequency":3,"licensed":false},{"interval":30,"frequency":1,"licensed":false},{"interval":60,"frequency":1,"licensed":false}],"ipv4":["172.204.81.57"],"ipv6":[],"fqdn":["kubernetes.ad.demo.io"],"netbios_name":["kubernetes.ad.demo.io"],"operating_system":["Linux Kernel 3.10.0-862.14.4.el7.x86_64 on CentOS Linux release 7.5.1804 (Core)"],"agent_name":[],"aws_ec2_name":[],"mac_address":[]},{"id":"ed1c8fb3-68be-4c98-b5ef-88dd30f18ee9","has_agent":false,"last_seen":"2018-11-28T15:00:57.000Z","last_scan_target":"172.204.81.58","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T14:59:23.000Z","last_seen":"2018-11-28T15:00:57.000Z"}],"ipv4":["172.204.81.58"],"ipv6":[],"fqdn":["scanner.ad.demo.io"],"netbios_name":["scanner"],"operating_system":["Linux Kernel 4.4.0-104-generic on Ubuntu 16.04"],"agent_name":[],"aws_ec2_name":[],"mac_address":[]},{"id":"ee094cf6-e352-4f34-a65d-a3503b0ad199","has_agent":false,"last_seen":"2018-11-28T15:00:57.000Z","last_scan_target":"172.204.81.59","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T14:59:23.000Z","last_seen":"2018-11-28T15:00:57.000Z"}],"ipv4":["172.204.81.59"],"ipv6":[],"fqdn":["shane.ad.demo.io"],"netbios_name":["SHANE"],"operating_system":["Microsoft Windows 10 Pro"],"agent_name":[],"aws_ec2_name":[],"mac_address":[]},{"id":"33e32354-7f48-488c-88a5-49a63550b62a","has_agent":false,"last_seen":"2018-11-28T15:00:57.000Z","last_scan_target":"172.204.81.60","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T14:59:23.000Z","last_seen":"2018-11-28T15:00:57.000Z"}],"ipv4":["172.204.81.60"],"ipv6":[],"fqdn":["archie.ad.demo.io"],"netbios_name":["ARCHIE"],"operating_system":["Microsoft Windows 10 Pro"],"agent_name":[],"aws_ec2_name":[],"mac_address":[]}],"total":4}}}}}},"403":{"description":"Returned if you do not have permission to list assets."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/assets/{asset_uuid}":{"get":{"summary":"Get asset details","description":"Returns details of the specified asset.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"assets-asset-info","tags":["Assets"],"parameters":[{"description":"The UUID of the asset.","required":true,"name":"asset_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns details of the specified asset.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the asset."},"has_agent":{"type":"boolean","description":"A value specifying whether a Nessus agent scan detected the asset."},"created_at":{"type":"string","description":"The time and date when Tenable.io created the asset record."},"updated_at":{"type":"string","description":"The time and date when the asset record was last updated."},"first_seen":{"type":"string","description":"The time and date when a scan first identified the asset."},"last_seen":{"type":"string","description":"The time and date of the scan that most recently identified the asset."},"last_scan_target":{"type":"string","description":"The IPv4 address, IPv6 address, or FQDN that the scanner last used to evaluate the asset."},"last_authenticated_scan_date":{"type":"string","description":"The time and date of the last credentialed scan run on the asset."},"last_licensed_scan_date":{"type":"string","description":"The time and date of the last scan that identified the asset as licensed. Tenable.io categorizes an asset as licensed if a scan of that asset has returned results from a non-discovery plugin within the last 90 days."},"sources":{"type":"array","description":"The sources of the scans that identified the asset.","items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity that reported the asset details. Sources can include sensors, connectors, and API imports. Source names can be customized by your organization (for example, you specify a name when you import asset records). If your organization does not customize source names, system-generated names include:\n - AWS—You obtained the asset data from an Amazon Web Services connector.\n - NESSUS_AGENT—You obtained the asset data obtained from a Nessus agent scan.\n - PVS—You obtained the asset data from a Nessus Network Monitor (NNM) scan.\n - NESSUS_SCAN—You obtained the asset data from a Nessus scan.\n - WAS—You obtained the asset data from a  Web Application Scanning scan."},"first_seen":{"type":"string","description":"The ISO timestamp when the source first reported the asset."},"last_seen":{"type":"string","description":"The ISO timestamp when the source last reported the asset."}}}}},"tags":{"type":"array","description":"Category tags assigned to the asset in Tenable.io.","items":{"type":"object","properties":{"tag_uuid":{"type":"string","description":"The UUID of the tag."},"tag_key":{"type":"string","description":"The tag category (the first half of the category:value pair)."},"tag_value":{"type":"string","description":"The tag value (the second half of the category:value pair)."},"added_by":{"type":"string","description":"The UUID of the user who assigned the tag to the asset."},"added_at":{"type":"string","description":"The ISO timestamp when the tag was assigned to the asset."}}}},"acr_score":{"type":"integer","description":"The Asset Criticality Rating (ACR) for the asset. Tenable assigns an ACR to each asset on your network to represent the asset's relative risk as an integer from 1 to 10. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*."},"acr_drivers":{"type":"array","description":"The key drivers that Tenable uses to calculate an asset's Tenable-provided ACR. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*.","items":{"type":"object","description":"Information about an asset characteristic that factored into the ACR score calculation.","properties":{"driver_name":{"type":"string","description":"The type of characteristic."},"driver_value":{"type":"array","description":"The characteristic value.","items":{"type":"string"}}}}},"exposure_score":{"type":"integer","description":"The Asset Exposure Score (AES) for the asset. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*."},"scan_frequency":{"type":"array","description":"Information about how often scans ran against the asset during specified intervals.","items":{"type":"object","description":"Information about how often scans ran against asset during a specified interval.","properties":{"interval":{"type":"integer","description":"The number of days over which Tenable searches for scans involving the asset."},"frequency":{"type":"integer","description":"The number of times that a scan ran against the asset during the specified interval."},"licensed":{"type":"boolean","description":"Indicates whether the asset was licensed at the time of the identified scans."}}}},"network_id":{"type":"array","description":"The ID of the network object to which the asset belongs. For more information, see [Manage Networks](/docs/manage-networks-tio).","items":{"type":"string"}},"ipv4":{"type":"array","description":"The IPv4 addresses that scans have associated with the asset record.","items":{"type":"string"}},"ipv6":{"type":"array","description":"The IPv6 addresses that scans have associated with the asset record.","items":{"type":"string"}},"fqdn":{"type":"array","description":"The fully-qualified domain names that scans have associated with the asset record.","items":{"type":"string"}},"mac_address":{"type":"array","description":"The MAC addresses that scans have associated with the asset record.","items":{"type":"string"}},"netbios_name":{"type":"array","description":"The NetBIOS names that scans have associated with the asset record.","items":{"type":"string"}},"operating_system":{"type":"array","description":"The operating systems that scans have associated with the asset record.","items":{"type":"string"}},"system_type":{"type":"array","description":"The system types as reported by Plugin ID 54615. Possible values include `router`, `general-purpose`, `scan-host`, and `embedded`.","items":{"type":"string"}},"hostname":{"type":"array","description":"The hostnames that scans have associated with the asset record.","items":{"type":"string"}},"agent_name":{"type":"array","description":"The names of any Nessus agents that scanned and identified the asset.","items":{"type":"string"}},"bios_uuid":{"type":"array","description":"The BIOS UUID that scans have associated with the asset.","items":{"type":"string"}},"aws_ec2_instance_id":{"type":"array","description":"The unique identifier of the Linux instance in Amazon EC2. For more information, see the Amazon Elastic Compute Cloud Documentation.","items":{"type":"string"}},"aws_ec2_instance_ami_id":{"type":"array","description":"The unique identifier of the Linux AMI image in Amazon Elastic Compute Cloud (Amazon EC2). For more information, see the Amazon Elastic Compute Cloud Documentation.","items":{"type":"string"}},"aws_owner_id":{"type":"array","description":"The canonical user identifier for the AWS account associated with the virtual machine instance. For example, `79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be`. For more information, see AWS Account Identifiers in the AWS documentation.","items":{"type":"string"}},"aws_availability_zone":{"type":"array","description":"The availability zone where Amazon Web Services hosts the virtual machine instance, for example, `us-east-1a`. Availability zones are subdivisions of AWS regions. For more information, see Regions and Availability Zones in the AWS documentation.","items":{"type":"string"}},"aws_region":{"type":"array","description":"The region where AWS hosts the virtual machine instance, for example, `us-east-1`. For more information, see Regions and Availability Zones in the AWS documentation.","items":{"type":"string"}},"aws_vpc_id":{"type":"array","description":"The unique identifier for the public cloud that hosts the AWS virtual machine instance. For more information, see the Amazon Virtual Private Cloud User Guide.","items":{"type":"string"}},"aws_ec2_instance_group_name":{"type":"array","description":"The virtual machine instance's group in AWS.","items":{"type":"string"}},"aws_ec2_instance_state_name":{"type":"array","description":"The state of the virtual machine instance in AWS at the time of the scan.","items":{"type":"string"}},"aws_ec2_instance_type":{"type":"array","description":"The type of instance in AWS EC2.","items":{"type":"string"}},"aws_subnet_id":{"type":"array","description":"The unique identifier of the AWS subnet where the virtual machine instance was running at the time of the scan.","items":{"type":"string"}},"aws_ec2_product_code":{"type":"array","description":"The product code associated with the AMI used to launch the virtual machine instance in AWS EC2.","items":{"type":"string"}},"aws_ec2_name":{"type":"array","description":"The name of the virtual machine instance in AWS EC2.","items":{"type":"string"}},"azure_vm_id":{"type":"array","description":"The unique identifier of the Microsoft Azure virtual machine instance. For more information, see \"Accessing and Using Azure VM Unique ID\" in the Microsoft Azure documentation.","items":{"type":"string"}},"azure_resource_id":{"type":"array","description":"The unique identifier of the resource in the Azure Resource Manager. For more information, see the Azure Resource Manager Documentation.","items":{"type":"string"}},"gcp_project_id":{"type":"array","description":"The customized name of the project to which the virtual machine instance belongs in Google Cloud Platform (GCP). For more information, see \"Creating and Managing Projects\" in the GCP documentation.","items":{"type":"string"}},"gcp_zone":{"type":"array","description":"The zone where the virtual machine instance runs in GCP. For more information, see \"Regions and Zones\" in the GCP documentation.","items":{"type":"string"}},"gcp_instance_id":{"type":"array","description":"The unique identifier of the virtual machine instance in GCP.","items":{"type":"string"}},"ssh_fingerprint":{"type":"array","description":"The SSH key fingerprints that scans have associated with the asset record.","items":{"type":"string"}},"mcafee_epo_guid":{"type":"array","description":"The unique identifier of the asset in McAfee ePolicy Orchestrator (ePO). For more information, see the McAfee documentation.","items":{"type":"string"}},"mcafee_epo_agent_guid":{"type":"array","description":"The unique identifier of the McAfee ePO agent that identified the asset. For more information, see the McAfee documentation.","items":{"type":"string"}},"qualys_asset_id":{"type":"array","description":"The Asset ID of the asset in Qualys. For more information, see the Qualys documentation.","items":{"type":"string"}},"qualys_host_id":{"type":"array","description":"The Host ID of the asset in Qualys. For more information, see the Qualys documentation.","items":{"type":"string"}},"servicenow_sysid":{"type":"array","description":"The unique record identifier of the asset in ServiceNow. For more information, see the ServiceNow documentation.","items":{"type":"string"}},"installed_software":{"type":"array","description":"A list of Common Platform Enumeration (CPE) values that represent software applications a scan identified as present on an asset. This attribute supports the CPE 2.2 format. For more information, see the \"Component Syntax\" section of the [CPE Specification, Version 2.2](https://cpe.mitre.org/files/cpe-specification_2.2.pdf). For assets identified in Tenable scans, this attribute contains data only if a scan using [Nessus Plugin ID 45590](https://www.tenable.com/plugins/nessus/45590) has evaluated the asset.\n\n**Note:** If no scan detects an application within 30 days of the scan that originally detected the application, Tenable.io considers the detection of that application expired. As a result, the next time a scan evaluates the asset, Tenable.io removes the expired application from the installed_software attribute. This activity is logged as a `remove` type of `attribute_change` update in the asset activity log.","items":{"type":"string"}}}},"examples":{"response":{"value":{"id":"e60cf974-5b18-4ad1-aa1e-c897e46bd683","has_agent":false,"created_at":"2018-11-28T15:00:42.659Z","updated_at":"2018-11-28T17:28:46.984Z","first_seen":"2018-11-28T15:00:25.000Z","last_seen":"2018-11-28T17:28:28.000Z","last_scan_target":"172.204.81.57","last_authenticated_scan_date":null,"last_licensed_scan_date":"2018-11-28T17:28:28.000Z","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T15:00:25.000Z","last_seen":"2018-11-28T17:28:28.000Z"}],"tags":[],"acr_score":8,"acr_drivers":[{"driver_name":"device_type","driver_value":["general_purpose"]},{"driver_name":"device_capability","driver_value":["pci"]},{"driver_name":"internet_exposure","driver_value":["internal"]}],"exposure_score":753,"scan_frequency":[{"interval":90,"frequency":3,"licensed":false},{"interval":30,"frequency":1,"licensed":false},{"interval":60,"frequency":1,"licensed":false}],"network_id":["00000000-0000-0000-0000-000000000000"],"ipv4":["172.204.81.57"],"ipv6":[],"fqdn":[],"mac_address":["00:50:56:a6:4c:0a"],"netbios_name":[],"operating_system":["Linux Kernel 3.10, Linux Kernel 3.5, Linux Kernel 3.8, Linux Kernel 3.9"],"system_type":["general-purpose"],"tenable_uuid":[],"hostname":[],"agent_name":[],"bios_uuid":[],"aws_ec2_instance_id":[],"aws_ec2_instance_ami_id":[],"aws_owner_id":[],"aws_availability_zone":[],"aws_region":[],"aws_vpc_id":[],"aws_ec2_instance_group_name":[],"aws_ec2_instance_state_name":[],"aws_ec2_instance_type":[],"aws_subnet_id":[],"aws_ec2_product_code":[],"aws_ec2_name":[],"azure_vm_id":[],"azure_resource_id":[],"gcp_project_id":[],"gcp_zone":[],"gcp_instance_id":[],"ssh_fingerprint":[],"mcafee_epo_guid":[],"mcafee_epo_agent_guid":[],"qualys_asset_id":[],"qualys_host_id":[],"servicenow_sysid":[],"installed_software":["cpe:/a:apple:itunes:12.8","cpe:/a:apple:quicktime:7.7.3","cpe:/a:openbsd:openssh:6.9","cpe:/a:google:chrome"],"bigfix_asset_id":[]}}}}}},"403":{"description":"Returned if you do not have permission to view information about an asset."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/api/v2/assets/bulk-jobs/acr":{"post":{"summary":"Update ACR","description":"Overwrites the Tenable-provided Asset Criticality Rating (ACR) for the specified assets. Tenable assigns an ACR to each asset on your network to represent the asset's relative risk as an integer from 1 to 10. For more information about ACR, see [Lumin metrics](http://docs.tenable.com/cloud/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*. <p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"assets-bulk-update-acr","tags":["Assets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["acr_score","asset"],"description":"Parameters to update the ACR for an asset. For a request body example, see \"Update ACR for assets\" in [Bulk Asset Operations](/docs/bulk-asset-operations).","properties":{"acr_score":{"type":"integer","description":"The ACR score you want to assign to the asset. The ACR must be an integer from 1 to 10. "},"reason":{"type":"array","description":"The reasons you are updating the ACR for the assets. Supported values include:\n\n - Business Critical\n - In Scope For Compliance\n - Existing Mitigation Control\n - Dev only \n - Key drivers does not match \n - Other\n\nThis parameter corresponds to the **Overwrite Reasoning** parameter when editing an ACR in the Tenable.io Lumin user interface. For more information, see [Edit an ACR](https://docs.tenable.com/cloud/Content/Analysis/LuminEditACR.htm).","items":{"type":"string","enum":["Business Critical","In Scope For Compliance","Existing Mitigation Control","Dev only","Key drivers does not match","Other"]}},"note":{"type":"string","description":"Any notes you want to add to clarify the circumstances behind the update. This parameter corresponds to the **Note** parameter when editing an ACR in the Tenable.io Lumin user interface. For more information, see [Edit an ACR](https://docs.tenable.com/cloud/Content/Analysis/LuminEditACR.htm).  "},"asset":{"type":"array","description":"The identifiers of the assets to update to the specified ACR. At least one asset object is required in this array.","items":{"type":"object","description":"Each object can contain a single instance of the properties described below. You can combine multiple instances of this object, each containing a different single property.","properties":{"id":{"type":"string","description":"The UUID for a specific asset."},"fqdn":{"type":"array","description":"Fully-qualified domain names (FQDNs) associated with the asset or assets.","items":{"type":"string"}},"mac_address":{"type":"array","description":"MAC addresses associated with the asset or assets.","items":{"type":"string"}},"netbios_name":{"type":"string","description":"The NetBIOS name for the asset."},"ipv4":{"type":"array","description":"IPv4 addresses associated with the asset or assets.","items":{"type":"string"}}}}}}}}}}},"responses":{"202":{"description":"Returned if Tenable.io successfully queues the update request."},"404":{"description":"Returned if your request is improperly formatted."}},"security":[{"cloud":[]}]}},"/api/v2/assets/bulk-jobs/move-to-network":{"post":{"summary":"Move assets","description":"Moves assets from the specified network to another network. You can use this endpoint to move assets from the default network to a user-defined network, from a user-defined network to the default network, and from one user-defined network to another user-defined network. This request creates an asynchronous job in Tenable.io.\n\nFor information about the assets move workflow and payload examples, see [Bulk Asset Operations](/docs/bulk-asset-operations).<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"assets-bulk-move","tags":["Assets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source","destination","targets"],"description":"The parameters for moving assets from one network to another.","properties":{"source":{"type":"string","example":"00000000-0000-0000-0000-000000000000","description":"The UUID of the network currently associated with the assets. Use the [GET /networks](/reference#networks-list) endpoint with the name attribute as filter to find the UUID of the network."},"destination":{"type":"string","description":"The UUID of the network to associate with the specified assets. Use the [GET /networks](/reference#networks-list) endpoint with the name filter to find the UUID of the network. ","example":"11f04eb9-7c78-46c8-9025-fae048390f59"},"targets":{"type":"string","description":"The IPv4 addresses of the assets to move. The addresses can be represented as a comma-separated list, a range, or CIDR, for example `1.1.1.1, 2.2.2.2-2.2.2.200, 3.3.3.0/24`.","example":"172.204.81.57-172.204.81.69"}}}}}},"responses":{"202":{"description":"Returns the number of moved assets.","content":{"application/json":{"schema":{"type":"object","description":"Bulk operations results. Contains the number of assets affected by the operation (moved or deleted).","properties":{"asset_count":{"type":"integer","description":"The number of assets affected by the operation. "}}},"examples":{"response":{"value":{"data":{"asset_count":512}}}}}}},"400":{"description":"Returned if Tenable.io cannot find the specified assets."},"403":{"description":"Returned if you do not have permission to move assets."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/api/v2/assets/bulk-jobs/delete":{"post":{"summary":"Bulk delete assets","description":"Deletes the specified assets. This request creates an asynchronous delete job in Tenable.io.\n\nFor information about the assets bulk delete workflow and payload examples, see [Bulk Asset Operations](/docs/bulk-asset-operations).<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"assets-bulk-delete","tags":["Assets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"The query for selecting the assets to delete. Must include one or more filters. A filter must include an asset attribute, an operator, and a value. To get the list of supported filters, use the [GET /filters/workbenches/assets](/reference#filters-assets-filter) endpoint. Sets of multiple filters must be specified inside `and` or `or` arrays.\n\n**Note:** You can also nest conditions, for example, specify a set of `or` sub-conditions for a condition inside the `and` array.","properties":{"field":{"type":"string","description":"The name of the asset attribute to match. Asset attributes can include tags, for example, `tag.city`."},"operator":{"type":"string","description":"The operator to apply to the matched value, for example, `eq` (equals), `neq` (does not equal), or `contains`."},"value":{"type":"string","description":"The asset attribute value to match."},"and":{"type":"array","description":"To select assets that match all of multiple conditions, specify the conditions inside the `and` array.","items":{"type":"object","description":"The query for selecting the assets to delete. Includes an asset attribute, an operator, and a value. To get the list of supported filters, use the [GET /filters/workbenches/assets](/reference#filters-assets-filter) endpoint.","properties":{"field":{"type":"string","description":"The name of the asset attribute to match. Asset attributes can include tags, for example, `tag.city`."},"operator":{"type":"string","description":"The operator to apply to the matched value, for example, `eq` (equals), `neq` (does not equal), or `contains`."},"value":{"type":"string","description":"The asset attribute value to match."}}}},"or":{"type":"array","description":"To select assets that match any of multiple conditions, specify the conditions inside the `or` array.","items":{"type":"object","description":"The query for selecting the assets to delete. Includes an asset attribute, an operator, and a value. To get the list of supported filters, use the [GET /filters/workbenches/assets](/reference#filters-assets-filter) endpoint.","properties":{"field":{"type":"string","description":"The name of the asset attribute to match. Asset attributes can include tags, for example, `tag.city`."},"operator":{"type":"string","description":"The operator to apply to the matched value, for example, `eq` (equals), `neq` (does not equal), or `contains`."},"value":{"type":"string","description":"The asset attribute value to match."}}}}}}}}},"responses":{"202":{"description":"Returns the number of deleted assets.","content":{"application/json":{"schema":{"type":"object","description":"Bulk operations results. Contains the number of assets affected by the operation (moved or deleted).","properties":{"asset_count":{"type":"integer","description":"The number of assets affected by the operation. "}}},"examples":{"response":{"value":{"data":{"asset_count":512}}}}}}},"400":{"description":"Returned if you specify an invalid asset query, for example, using a malformed IPv4 address."},"403":{"description":"Returned if you do not have permission to delete assets in bulk."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"503":{"description":"Returned if Tenable.io is unavailable or not ready to process the request. Wait a moment and try your request again."}},"security":[{"cloud":[]}]}},"/import/assets":{"post":{"summary":"Import assets","description":"Imports asset data in JSON format.\n\nThe request size cannot exceed 5 MB. For example, if the average asset record you want to import is about 2 KB, you can import approximately 2,500 assets in a single request.\n\n**Note:** This endpoint does not support the network_id attribute in asset objects for import. Tenable.io automatically assigns imported assets to the default network object. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio).<p>Requires SCAN OPERATOR [24] user permissions and CAN CONFIGURE [64] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"assets-import","tags":["Assets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assets":{"type":"array","description":"An array of asset objects to import. Each asset object requires a value for at least one of the following properties: fqdn, ipv4, netbios\\_name, mac\\_address.\n\nFor an example of this request body, see [Add Asset Data to Tenable.io](/docs/add-asset-data-to-tenableio). For the complete list of importable asset attributes, see [Common Asset Attributes](/docs/common-asset-attributes#section-asset-attribute-definitions).","example":"[{\"ipv4\":\"172.204.81.57\",\"operating_system\":\"Windows 7 x64\"}]","items":{"type":"object","properties":{"mac_address":{"type":"array","description":"A list of MAC addresses for the asset.","items":{"type":"string"}},"netbios_name":{"type":"string","description":"The NetBIOS name for the asset."},"fqdn":{"type":"array","description":"A list of FQDNs for the asset.","items":{"type":"string"}},"ip_address":{"type":"array","description":"A list of IPv4 addresses for the asset. Tenable.io supports this legacy field for backwards compatibility, but for new requests, this field should be replaced by the ipv4 field.","items":{"type":"string"}},"ipv4":{"type":"array","description":"A list of IPv4 addresses for the asset.","items":{"type":"string"}},"ipv6":{"type":"array","description":"A list of IPv6 addresses for the asset.","items":{"type":"string"}},"hostname":{"type":"array","description":"A list of hostnames for the asset.","items":{"type":"string"}},"operating_system":{"type":"string","description":"The operating system installed on the asset."},"ssh_fingerprint":{"type":"string","description":"The SSH key fingerprints that scans have associated with the asset record."},"bios_uuid":{"type":"string","description":"The BIOS UUID of the asset."},"manufacturer_tpm_id":{"type":"string","description":"The manufacturer's unique identifier of the Trusted Platform Module (TPM) associated with the asset."},"mcafee_epo_guid":{"type":"string","description":"The unique identifier of the asset in McAfee ePolicy Orchestrator (ePO). For more information, see the McAfee documentation."},"mcafee_epo_agent_guid":{"type":"string","description":"The unique identifier of the McAfee ePO agent that identified the asset. For more information, see the McAfee documentation."},"symantec_ep_hardware_key":{"type":"string","description":"The hardware key for the asset in Symantec Endpoint Protection."},"qualys_asset_id":{"type":"string","description":"The Asset ID of the asset in Qualys. For more information, see the Qualys documentation."},"qualys_host_id":{"type":"string","description":"The Host ID of the asset in Qualys. For more information, see the Qualys documentation."},"servicenow_sys_id":{"type":"string","description":"The unique record identifier of the asset in ServiceNow. For more information, see the ServiceNow documentation."},"gcp_project_id":{"type":"string","description":"The customized name of the project to which the virtual machine instance belongs in Google Cloud Platform (GCP). For more information see \"Creating and Managing Projects\" in the GCP documentation."},"gcp_zone":{"type":"string","description":"The zone where the virtual machine instance runs in GCP. For more information, see \"Regions and Zones\" in the GCP documentation."},"gcp_instance_id":{"type":"string","description":"The unique identifier of the virtual machine instance in GCP."},"azure_vm_id":{"type":"string","description":"The unique identifier of the Microsoft Azure virtual machine instance. For more information, see \"Accessing and Using Azure VM Unique ID\" in the Microsoft Azure documentation."},"azure_resource_id":{"type":"string","description":"The unique identifier of the resource in the Azure Resource Manager. For more information, see the Azure Resource Manager Documentation."},"aws_availability_zone":{"type":"string","description":"The availability zone where Amazon Web Services hosts the virtual machine instance, for example, `us-east-1a`. Availability zones are subdivisions of AWS regions. For more information, see \"Regions and Availability Zones\" in the AWS documentation."},"aws_ec2_instance_id":{"type":"string","description":"The unique identifier of the Linux instance in Amazon EC2. For more information, see the Amazon Elastic Compute Cloud Documentation."},"aws_ec2_instance_ami_id":{"type":"string","description":"The unique identifier of the Linux AMI image in Amazon Elastic Compute Cloud (Amazon EC2). For more information, see the Amazon Elastic Compute Cloud Documentation."},"aws_ec2_instance_group_name":{"type":"string","description":"The virtual machine instance's group in AWS."},"aws_ec2_instance_state_name":{"type":"string","description":"The state of the virtual machine instance in AWS at the time of the scan."},"aws_ec2_instance_type":{"type":"string","description":"The type of instance in AWS EC2."},"aws_ec2_name":{"type":"string","description":"The name of the virtual machine instance in AWS EC2."},"aws_ec2_product_code":{"type":"string","description":"The product code associated with the AMI used to launch the virtual machine instance in AWS EC2."},"aws_owner_id":{"type":"string","description":"The canonical user identifier for the AWS account associated with the asset. For more information, see \"AWS Account Identifiers\" in the AWS documentation."},"aws_region":{"type":"string","description":"The region where AWS hosts the virtual machine instance, for example, `us-east-1`. For more information, see \"Regions and Availability Zones\" in the AWS documentation."},"aws_subnet_id":{"type":"string","description":"The unique identifier of the AWS subnet where the virtual machine instance was running at the time of the scan."},"aws_vpc_id":{"type":"string","description":"The unique identifier of the public cloud that hosts the AWS virtual machine instance. For more information, see the Amazon Virtual Private Cloud User Guide."},"installed_software":{"type":"array","description":"A list of Common Platform Enumeration (CPE) values that represent software applications a scan identified as present on an asset. The strings in this array must be valid CPE 2.2 values. For more information, see the \"Component Syntax\" section of the [CPE Specification, Version 2.2](https://cpe.mitre.org/files/cpe-specification_2.2.pdf).\n\n**Note:** If no scan detects an application within 30 days of the scan that originally detected the application, Tenable.io considers the detection of that application expired. As a result, the next time a scan evaluates the asset, Tenable.io removes the expired application from the installed_software attribute. This activity is logged as a `remove` type of `attribute_change` update in the asset activity log.","items":{"type":"string"}},"bigfix_asset_id":{"type":"array","items":{"type":"string"},"description":"The unique identifiers of the asset in IBM BigFix. For more information, see the IBM BigFix documentation."}}}},"source":{"type":"string","description":"A user-defined name for the source of the asset records you want to import.","example":"Custom Import"}},"required":["assets","source"]}}}},"responses":{"200":{"description":"Returns the import job UUID.","content":{"application/json":{"schema":{"type":"object","properties":{"asset_import_job_uuid":{"type":"string","description":"The asset import job UUID."}}},"examples":{"response":{"value":{"asset_import_job_uuid":"a90cf974-7b14-4ad1-aa1e-b897e46af689"}}}}}},"400":{"description":"Returned if you submitted a bad request."},"403":{"description":"Returned if you do not have permission to import assets."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/import/asset-jobs":{"get":{"summary":"List asset import jobs","description":"Lists asset import jobs.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"assets-list-import-jobs","tags":["Assets"],"responses":{"200":{"description":"Returns a list of asset import jobs.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"job_id":{"type":"string","description":"The UUID of the asset import job."},"container_id":{"type":"string","description":"The UUID of your Tenable.io container."},"source":{"type":"string","description":"A name for the source of the asset records that you define in the asset import request."},"batches":{"type":"integer","description":"The number of batches in the asset import job.","format":"int32"},"uploaded_assets":{"type":"integer","description":"The number of assets from the import job that Tenable.io successfully imported.","format":"int32"},"failed_assets":{"type":"integer","description":"The number of assets from the import job that Tenable.io failed to import."},"start_time":{"type":"integer","description":"The Unix timestamp when Tenable.io started processing the import job.","format":"int32"},"last_update_time":{"type":"integer","description":"The Unix timestamp when Tenable.io performed an action on the import job.","format":"int32"},"end_time":{"type":"integer","description":"The Unix timestamp when Tenable.io completed processing the import job.","format":"int32"},"status":{"type":"string","description":"The status of the import job. Possible values include: COMPLETED, ERROR."},"status_message":{"type":"string","description":"The description of why a job failed."}}}},"examples":{"response":{"value":{"asset_import_jobs":[{"job_id":"fd7646b5-2c7a-433e-8f2b-f3281b7726ef","container_id":"36f234c4-4ae3-4353-9324-8ad3dcc7fcc5","source":"test1","batches":1,"uploaded_assets":0,"failed_assets":0,"start_time":1544480303548,"last_update_time":1544484511492,"end_time":1544484511492,"status":"ERROR","status_message":"Job failed by exceeding time limit"},{"job_id":"15759fd1-3483-4467-b04f-1bff11141c37","container_id":"36f234c4-4ae3-4353-9324-8ad3dcc7fcc5","source":"test2","batches":1,"uploaded_assets":0,"failed_assets":0,"start_time":1544480429785,"last_update_time":1544484511496,"end_time":1544484511496,"status":"ERROR","status_message":"Job failed by exceeding time limit"}]}}}}}},"403":{"description":"Returned if you do not have permission to list asset import jobs."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/import/asset-jobs/{asset_import_job_uuid}":{"get":{"summary":"Get import job information","description":"Gets information about the specified import job.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"assets-import-job-info","tags":["Assets"],"parameters":[{"description":"The UUID of the asset import job.","required":true,"name":"asset_import_job_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns information about the specified import job.","content":{"application/json":{"schema":{"type":"object","properties":{"job_id":{"type":"string","description":"The UUID of the asset import job."},"container_id":{"type":"string","description":"The UUID of your Tenable.io container."},"source":{"type":"string","description":"A name for the source of the asset records that you define in the asset import request."},"batches":{"type":"integer","description":"The number of batches in the asset import job.","format":"int32"},"uploaded_assets":{"type":"integer","description":"The number of assets from the import job that Tenable.io successfully imported.","format":"int32"},"failed_assets":{"type":"integer","description":"The number of assets from the import job that Tenable.io failed to import."},"start_time":{"type":"integer","description":"The Unix timestamp when Tenable.io started processing the import job.","format":"int32"},"last_update_time":{"type":"integer","description":"The Unix timestamp when Tenable.io performed an action on the import job.","format":"int32"},"end_time":{"type":"integer","description":"The Unix timestamp when Tenable.io completed processing the import job.","format":"int32"},"status":{"type":"string","description":"The status of the import job. Possible values include: COMPLETED, ERROR."},"status_message":{"type":"string","description":"The description of why a job failed."}}},"examples":{"response":{"value":{"job_id":"fd7646b5-2c7a-433e-8f2b-f3281b7726ef","container_id":"36f234c4-4ae3-4353-9324-8ad3dcc7fcc5","source":"test","batches":1,"uploaded_assets":0,"failed_assets":0,"start_time":1544480303548,"last_update_time":1544480303569,"end_time":1544480303548,"status":"IN_PROGRESS","status_message":"Example message."}}}}}},"403":{"description":"Returned if you do not have permission to list asset import jobs."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/audit-log/v1/events":{"get":{"summary":"View audit log","description":"This endpoint requests a list of events. Events can include the following:\n - audit.log.view—The system received and processed an audit-log request.\n - session.create—The system created a session for the user. This event can be triggered by user login or authentication using an API key.\n - session.delete—The session expired, or the user ended the session.\n - session.impersonation.end—An administrator ended a session where they impersonated another user.\n - session.impersonation.start—An administrator started a session where they impersonated another user.\n - user.authenticate.api-keys—The user authenticated a session start using an API key.\n - user.authenticate.mfa—The two-factor authentication challenge was successful, and login allowed.\n - user.authenticate.password—The user authenticated a session start using a password.\n - user.create—An administrator created a new user account.\n - user.delete—An administrator deleted the user account.\n - user.impersonation.end—An administrator stopped impersonating another user.\n - user.impersonation.start—An administrator started impersonating another user.\n - user.logout—The user logged out of the session.\n - user.update—Either an administrator or the user updated the user account.\n\nYou can specify various filters to limit the events that are returned, as well as the number of events. By default, a maximum of 50 events is returned.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"audit-log-events","tags":["Audit Log"],"parameters":[{"description":"A filter condition in the `field.operator:value` format. Filter conditions can include:\n* date.gt:&lt;YYYY-MM-DD>—Tenable.io returns events only if the date when the events occurred is after the date you specify. For example: `f=date.gt:2017-12-31`\n* date.lt:&lt;YYYY-MM-DD>—Tenable.io returns events only if the date when the events occurred is before the date you specify. For example: `f=date.lt:2017-12-31`\n* actor_id.match:&lt;UUID>—Tenable.io returns only the events with a matching actor UUID. For example: `f=actor_id.match:6000a811-8422-4096-83d3-e4d44f44b97d`\n* target_id.match:&lt;UUID>—Tenable.io returns only the events with a matching target UUID. For example: `f=target_id.match:6000a811-8422-4096-83d3-e4d44f44b97d`\n\nYou can specify multiple `f` parameters, separated by ampersand (&) characters. For example: `?f=date.gt:2018-12-31&f=date.lt:2019-06-01&f=actor_id.match:50f84b7f-d1d3-4182-bb46-79cf5c51812e&limit=5000`","required":false,"name":"f","in":"query","schema":{"type":"string"}},{"description":"Sets the limit for how many events Tenable.io should return by the call. By default, this value is 50. For example: `limit=5000`","required":false,"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the audit log.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the event."},"action":{"type":"string","description":"The action that was taken by the user."},"crud":{"type":"string","description":"Indicates whether the action taken was creating (c), reading (r), updating (u), or deleting (d) an entity."},"is_failure":{"type":"boolean","description":"Indicates whether the action the user took succeeded or failed. Tenable.io logs an event regardless of whether a user action succeeds."},"received":{"type":"string","description":"The date and time the event occured in ISO 8601 format."},"description":{"type":"string","description":"A description of the event."},"actor":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the user that took the action."},"name":{"type":"string","description":"The username of the user that took the action."}}},"is_anonymous":{"type":"boolean","description":"Indicates whether the action was performed anonymously."},"target":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the target entity. For example, a user UUID."},"name":{"type":"string","description":"The name of the target entity. For example, a username."},"type":{"type":"string","description":"The type of entity that was the target of the action. For example, a user."}}},"fields":{"type":"object","properties":{"pair":{"type":"object","properties":{"key":{"type":"string","description":"A key. The exact string varies based on the action that was taken."},"value":{"type":"string","description":"A value that corresponds to a key. The value varies based on the request of the action that was taken."}}}}}}}},"examples":{"response":{"value":{"events":[{"id":"a4e9177aa45c48c9d46a2f24c5f97b24","action":"user.authenticate.password","crud":"u","is_failure":true,"received":"2018-08-06T23:09:40Z","description":null,"actor":{"id":"50f84b7f-d1d3-4182-bb46-79cf5c51806e","name":"user2@example.com"},"is_anonymous":null,"target":{"id":"50f84b7f-d1d3-4182-bb46-79cf5c51806e","name":"user2@example.com","type":"User"},"fields":[{"key":"message","value":"Invalid credentials."},{"key":"sessionToken","value":"-"},{"key":"X-Forwarded-For","value":"172.204.81.57, 172.204.81.57"},{"key":"X-Request-Uuid","value":"71a6630e83148694260ad838ddff5dce:dd19f39e7ec84ba80dec:8d7f958f8c3b770767af"}]},{"id":"9ed34e87d3474ff985759d14ss703e4c","action":"session.create","crud":"c","is_failure":false,"received":"2018-08-06T23:33:01Z","description":null,"actor":{"id":null,"name":null},"is_anonymous":true,"target":{"id":"50f84b7f-d1d3-4182-bb46-79cf5c51816e","name":"user2@example.com","type":"User"},"fields":[{"key":"X-Access-Type","value":"Created by username"}]},{"id":"dca7681afaf24048baff7b4e90b668d7","action":"session.delete","crud":"d","is_failure":false,"received":"2018-08-06T23:40:57Z","description":null,"actor":{"id":"50f84b7f-d1d3-4182-bb46-79cf5c51816e","name":"user2@example.com"},"is_anonymous":null,"target":{"id":"bcce340","name":null,"type":"Session"},"fields":[{"key":"message","value":"session timeout"}]},{"id":"a2498a85cb5740a28e532814c0ba8369","action":"user.impersonation.start","crud":"u","is_failure":false,"received":"2018-08-14T09:23:12Z","description":null,"actor":{"id":"92907192-57db-407e-98ff-053de7f12bab","name":"monitoring@example.com"},"is_anonymous":null,"target":{"id":"50f84b7f-d1d3-4182-bb46-79cd5c51806e","name":"user2@example.com","type":"User"},"fields":[{"key":"sessionToken","value":"-"},{"key":"X-Access-Type","value":"apikey"},{"key":"X-Forwarded-For","value":"172.204.81.57"},{"key":"X-Request-Uuid","value":"63e024e7fe25ed24ce1c7142781527ac:43cf99b77f783a962a1a"}]},{"id":"eaac53481de04f67bc7eeea07d2fb0f5","action":"session.delete","crud":"d","is_failure":false,"received":"2018-08-08T01:40:07Z","description":null,"actor":{"id":"50f84b7f-d1d3-4182-bb46-79cf9c51806e","name":"user2@example.com"},"is_anonymous":null,"target":{"id":"12d024e","name":null,"type":"Session"},"fields":[{"key":"message","value":"session timeout"}]}],"pagination":{"total":5,"limit":50}}}}}}},"403":{"description":"Returned if you do not have permission to view the audit log."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/credentials":{"post":{"summary":"Create managed credential","description":"Creates a managed credential object that you can use when configuring and running scans. You can grant other users the permission to use the managed credential object in scans and to edit the managed credential configuration.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"credentials-create","tags":["Credentials"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the managed credential. This name must be unique within your Tenable.io instance.","type":"string"},"description":{"description":"The description of the managed credential object.","type":"string"},"type":{"description":"The type of credential object. For a list of supported credential types, use the GET /credentials/types endpoint.","type":"string"},"settings":{"description":"The configuration settings for the credential. The parameters of this object vary depending on the credential type. For more information, see [Determine Settings for a Credential Type](/docs/determine-settings-for-credential-type).","type":"object","properties":{}},"permissions":{"description":"A list of user permissions for the managed credential.","type":"array","items":{"type":"object","properties":{"grantee_uuid":{"type":"string","description":"The UUID of the user or user group granted permissions for the managed credential.   \n\nThis parameter is required when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential."},"type":{"type":"string","description":"A value specifying whether the grantee is a user (`user`) or a user group (`group`).  \n\nThis parameter is required when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential.","enum":["user","group"]},"permissions":{"type":"integer","description":"A value specifying the permissions granted to the user or user group for the credential. Possible values are:\n - 32—The user can view credential information and use the credential in scans. Corresponds to the **Can Use** permission in the user interface.\n - 64—The user can view and edit credential settings, delete the credential, and use the credential in scans. Corresponds to the **Can Edit** permission in the user interface.  \n\nThis parameter is required when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential."},"name":{"type":"string","description":"The name of the user or user group that you want to grant permissions for the managed credential.  \n\nThis parameter is optional when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential."}}}}},"required":["name","type","settings","permissions"]},"example":{"name":"Windows devices (Headquarters)","description":"Use for scans of Windows devices located at headquarters.","type":"Windows","settings":{"domain":"","username":"user@example.com","auth_method":"Password","password":"aJ^deq34Rc"},"permissions":[{"grantee_uuid":"08d242c3-9553-4ccc-835d-0c17ed942cdq","type":"user","permissions":64,"name":"user@example.com"}]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully creates a managed credential object.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the new managed credential object."}}},"examples":{"response":{"value":{"uuid":"cc43b17c-ee05-4369-95f7-af8f9bd8cad1"}}}}}},"400":{"description":"Returned if Tenable.io encounters invalid JSON in request body."},"401":{"description":"Returned if Tenable.io cannot authenticate the user account that submitted the request."},"403":{"description":"Returned if you do not have permission to create managed credential objects."},"409":{"description":"Returned if a managed credential object with the same name already exists."},"415":{"description":"Returned if the request payload is in an unsupported format."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List managed credentials","description":"Lists managed credentials where you have been assigned at least CAN USE (32) permissions.   \n\n**Note:** This endpoint does not list scan-specific or policy-specific credentials (that is, credentials stored in either a scan or a policy). To view a list of scan-specific or policy-specific credentials, use the editor details endpoint (GET /editor/{type}/{id}). <p>Requires CAN USE [32] credential permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"credentials-list","tags":["Credentials"],"parameters":[{"description":"A filter condition in the following format: `field:operator:value`. For managed credentials, you can only filter on the `name` field, using the following operators: \n* eq—The name of the returned credential is equal to the text you specify. \n* neq—The returned list of managed credentials excludes the credential object where the name is equal to the text you specify. \n* match—The returned list includes managed credentials where the name contains the text you specify at least partially.\n\nYou can specify multiple `f` parameters, separated by ampersand (&) characters. If you specify multiple `f` parameters, use the `ft` parameter to specify how Tenable.io applies the multiple filter conditions.","required":false,"name":"f","in":"query","schema":{"type":"string"}},{"description":"The operator that Tenable.io applies if multiple \\`f\\` parameters are present. The `OR` operator is the only supported value. If you omit this parameter and multiple `f` parameters are present, Tenable.io applies the `OR` operator by default.","required":false,"name":"ft","in":"query","schema":{"type":"string"}},{"description":"Maximum number of objects requested (or service imposed limit if not in request). Must be in the int32 format.","required":false,"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"Offset from request (or zero). Must be in the int32 format.","required":false,"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"An array of objects specifyfing the sort order for the returned data.","required":false,"name":"sort","in":"query","schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The field on which Tenable.io sorts the results."},"order":{"type":"string","description":"The direction of the sort order. Supported values are `asc` (ascending) and `desc` (descending)."}}}}},{"description":"The UUID of a scan owner. This parameter limits the returned data to managed credentials assigned to scans owned by the specified user.","name":"referrer_owner_uuid","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of managed credentials.","content":{"application/json":{"schema":{"type":"object","properties":{"credentials":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the managed credential object."},"name":{"type":"string","description":"The name of the managed credential object. You specify the name when you create or update the managed credential."},"description":{"type":"string","description":"The definition of the managed credential object. You can specify the description when you create or update the managed credential."},"category":{"type":"object","properties":{"id":{"type":"string","description":"The system name that uniquely identifies the credential category."},"name":{"type":"string","description":"The display name for the credential category in the user interface."}}},"type":{"type":"object","properties":{"id":{"type":"string","description":"The system name that uniquely identifies the credential type."},"name":{"type":"string","description":"The display name for the credential type in the user interface."}}},"created_date":{"type":"string","description":"The date (in Unix time) when the managed credential object was created."},"created_by":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the user who created the credential."},"display_name":{"type":"string","description":"The name of the user who created the credential."}}},"last_used_by":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the user who last used the credential in a scan."},"display_name":{"type":"string","description":"The name of the user who last used the credential in a scan."}}},"permissions":{"type":"integer","description":"A value specifying the permissions granted to the user or user group for the credential. For possible values, see \"Credential Roles\" in <a href=\"/docs/permissions\">Permissions</a>."},"user_permissions":{"type":"integer","description":"The permissions for the managed credential that are assigned to the user account submitting the API request. For possible values, see \"Credential Roles\" in <a href=\"/docs/permissions\">Permissions</a>."}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of objects matching your search criteria. Must be in the int32 format."},"limit":{"type":"integer","description":"Maximum number of objects requested (or service imposed limit if not in request). Must be in the int32 format."},"offset":{"type":"integer","description":"Offset from request (or zero). Must be in the int32 format."},"sort":{"description":"An array of objects representing the fields you specified as sort fields in the request message, which Tenable.io uses to sort the returned data.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The field on which Tenable.io sorts the results."},"order":{"type":"string","description":"The direction of the sort order. Supported values are `asc` (ascending) and `desc` (descending)."}}}}}}}},"examples":{"response":{"value":{"credentials":[{"uuid":"aa43b17c-ee05-4369-95f7-af8f9bd8cad0","name":"Windows devices (Headquarters)","description":"Use for scans of Windows devices located at headquarters.","category":{"id":"Host","name":"Host"},"type":{"id":"Windows","name":"Windows"},"created_date":1551295980,"created_by":{"id":15,"display_name":"user@example.com"},"last_used_by":{"id":null,"display_name":null},"permission":32,"user_permissions":32}],"pagination":{"total":1,"limit":50,"offset":0,"sort":[{"name":"created_date","order":"desc"}]}}}}}}},"400":{"description":"Returned if the query parameters in your request were invalid."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/credentials/{uuid}":{"get":{"summary":"Get managed credential details","description":"Returns details of the specified managed credential object.<p>Requires CAN USE [32] credential permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"credentials-details","tags":["Credentials"],"parameters":[{"description":"The UUID of the managed credential for which you want to view details.","required":true,"name":"uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the details of the specified managed credential object.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the managed credential object. You specify the name when you create or update the managed credential."},"description":{"type":"string","description":"The definition of the managed credential object. You specify the description when you create or update the managed credential."},"category":{"type":"object","properties":{"id":{"type":"string","description":"The system name that uniquely identifies the credential category."},"name":{"type":"string","description":"The display name for the credential category in the user interface."}}},"type":{"type":"object","properties":{"id":{"type":"string","description":"The system name that uniquely identifies the credential type."},"name":{"type":"string","description":"The display name for the credential type in the user interface."}}},"ad_hoc":{"type":"boolean","description":"A value specifying how a user creates a managed credential in the user interface. If `true`, the user created the credential during the scan configuration. If `false`, the user created the credential independently from scan configuration."},"user_permissions":{"type":"integer","description":"The permissions for the managed credential that are assigned to the user account submitting the API request. For possible values, see \"Credential Roles\" in <a href=\"/docs/permissions\">Permissions</a>."},"settings":{"description":"The configuration settings for the credential. The parameters of this object vary depending on the credential type. For more information, see [Determine Settings for a Credential Type](/docs/determine-settings-for-credential-type).","type":"object","properties":{}},"permissions":{"type":"array","items":{"type":"object","properties":{"grantee_uuid":{"type":"string","description":"The UUID of the user or user group granted permissions for the managed credential.   \n\nThis parameter is required when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential."},"type":{"type":"string","description":"A value specifying whether the grantee is a user (`user`) or a user group (`group`).  \n\nThis parameter is required when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential.","enum":["user","group"]},"permissions":{"type":"integer","description":"A value specifying the permissions granted to the user or user group for the credential. Possible values are:\n - 32—The user can view credential information and use the credential in scans. Corresponds to the **Can Use** permission in the user interface.\n - 64—The user can view and edit credential settings, delete the credential, and use the credential in scans. Corresponds to the **Can Edit** permission in the user interface.  \n\nThis parameter is required when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential."},"name":{"type":"string","description":"The name of the user or user group that you want to grant permissions for the managed credential.  \n\nThis parameter is optional when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential."}}}}}},"examples":{"response":{"value":{"name":"Windows devices (Headquarters)","description":"Use for scans of Windows devices located at headquarters.","category":{"id":"Host","name":"Host"},"type":{"id":"Windows","name":"Windows"},"ad_hoc":false,"user_permissions":64,"settings":{"domain":"","username":"user@example.com","auth_method":"Password","password":"********"},"permissions":[{"grantee_uuid":"e7fcb50b-1330-4a8c-b8e5-ee00ec8c56f8","type":"user","permissions":64,"name":"user1@tenable.com"},{"grantee_uuid":"08d242c3-9557-4ccc-835d-0c17ed942cde","type":"user","permissions":64,"name":"user2@example.com"},{"grantee_uuid":"9be14fe3-16f4-49e3-a015-234b8918b8de","type":"user","permissions":32,"name":"user3@example.com"}]}}}}}},"403":{"description":"Returned if you do not have sufficient permissions to view the specified managed credential object."},"404":{"description":"Returned if Tenable.io cannot find a managed credential object with the specified UUID."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}},"504":{"description":"Returned if Tenable.io is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":504,"error":"Gateway Timeout","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update managed credential","description":"Updates a managed credential object. \n\n**Note:** You cannot use this endpoint to update the credential type. If you create a managed credential with the incorrect type, create a new managed credential with the correct credential type, and delete the incorrect managed credential.<p>Requires CAN EDIT [64] credential permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"credentials-update","tags":["Credentials"],"parameters":[{"description":"The UUID of the managed credential object you want to update.","required":true,"name":"uuid","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The new name of the managed credential object. This name must be unique within your Tenable.io instance.","type":"string"},"description":{"description":"The new description of the managed credential object.","type":"string"},"ad_hoc":{"description":"A value specifying if the credential is managed (`false`) versus stored in a scan or policy configuration (`true`). You can only set this parameter from `true` to `false`. You cannot set this parameter to `true`. If you omit this parameter, the value defaults to `false`.","type":"boolean"},"settings":{"description":"The configuration settings for the credential. The parameters of this object vary depending on the credential type. For more information, see [Determine Settings for a Credential Type](/docs/determine-settings-for-credential-type).","type":"object","properties":{}},"permissions":{"description":"User permissions for the managed credential.","type":"array","items":{"type":"object","properties":{"grantee_uuid":{"type":"string","description":"The UUID of the user or user group granted permissions for the managed credential.   \n\nThis parameter is required when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential."},"type":{"type":"string","description":"A value specifying whether the grantee is a user (`user`) or a user group (`group`).  \n\nThis parameter is required when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential.","enum":["user","group"]},"permissions":{"type":"integer","description":"A value specifying the permissions granted to the user or user group for the credential. Possible values are:\n - 32—The user can view credential information and use the credential in scans. Corresponds to the **Can Use** permission in the user interface.\n - 64—The user can view and edit credential settings, delete the credential, and use the credential in scans. Corresponds to the **Can Edit** permission in the user interface.  \n\nThis parameter is required when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential."},"name":{"type":"string","description":"The name of the user or user group that you want to grant permissions for the managed credential.  \n\nThis parameter is optional when assigning CAN USE (32) or CAN EDIT (64) permissions for a managed credential."}}}}},"required":["settings","permissions"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully updates the managed credential object.","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"boolean"}}},"examples":{"response":{"value":{"updated":true}}}}}},"400":{"description":"Returned if Tenable.io encounters invalid JSON in the request body."},"401":{"description":"Returned if Tenable.io cannot authenticate the user account that submitted the request."},"403":{"description":"Returned if you do not have permission to update the specified managed credential object."},"404":{"description":"Returned if Tenable.io could not find the specified managed credential object, either because the object does not exist or because the object has been deleted."},"409":{"description":"Returned if a managed credential object with the same name already exists."},"415":{"description":"Returned if the request payload is in an unsupported format."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete managed credential","description":"Deletes the specified managed credential object. When you delete a managed credential object, Tenable.io also removes the credential from any scan that uses the credential.<P>Requires CAN EDIT [64] credential permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"credentials-delete","tags":["Credentials"],"parameters":[{"description":"The UUID for the managed credential object you want to delete.","required":true,"name":"uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deletes the specified managed credential object.","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"}}},"examples":{"response":{"value":{"deleted":true}}}}}},"401":{"description":"Returned if Tenable.io cannot authenticate the user account that submitted the request."},"403":{"description":"Returned if you do not have sufficient permissions to delete the specified managed credential object."},"404":{"description":"Returned if Tenable.io could not find the managed credential object you specified."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/credentials/types":{"get":{"summary":"List credential types","description":"Lists all credential types supported for managed credentials in Tenable.io. For more information about using the data returned by this endpoint to create managed credentials, see [Determine Settings for a Credential Type](/docs/determine-settings-for-credential-type). <p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"credentials-list-credential-types","tags":["Credentials"],"responses":{"200":{"description":"Returns a list of supported credential types and associated settings.","content":{"application/json":{"schema":{"type":"object","properties":{"credentials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The system name that uniquely identifies the category in Tenable.io."},"category":{"type":"string","description":"The display name for the category in the user interface."},"default_expand":{"type":"boolean","description":"A value specifying whether the list of credential types in the category appears as expanded by default in the user interface."},"types":{"description":"Supported configuration settings for an individual credential type.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The system name that uniquely identifies the credential type."},"name":{"type":"string","description":"The display name for the credential type in the user interface."},"max":{"type":"integer","description":"The maximum number of instances of this credential type that Tenable.io supports for an individual scan or policy."},"configuration":{"description":"The configuration settings for a credential type. For a definition of object attributes, see [Determine Settings for a Credential Type](docs/determine-settings-for-credential-type).","type":"array","items":{"type":"object","description":"The configuration settings for the credential. The parameters of this object vary depending on the credential type. For a list of possible configuration parameters, use the GET /credentials/types endpoint.","properties":{"type":{"type":"string","description":"The parameter input type. This attribute reflects how the user interface prompts for parameter input. Possible values include: \n - password—Prompts for input via text box.\n - text—Prompts for input via text box.\n - select—Prompts for input via selectable options.\n - file—Prompts user to upload file of input data.\n - toggle—Prompts user to toggle an option on or off.\n - checkbox—Prompts user to select options via checkboxes. Checkboxes can represent enabling a single option or can allow users to select from multiple, mutually-exclusive options."},"name":{"type":"string","description":"The display name for the credential configuration in the user interface."},"required":{"type":"boolean","description":"A value specifying whether the configuration parameter is required (`true`) or optional (`false`). If this attribute is absent, the parameter is optional."},"id":{"type":"string","description":"The system name for the credential parameter. Use this value as the parameter name in request messages configuring credentials."},"placeholder":{"type":"string","description":"An example of the parameter value. This value appears as example text in the user interface.  \n\nThis attribute is only present for credential parameters that require text input in the user interface."},"options":{"description":"The supported options for the credential parameter.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The display name of the option in the user interface."},"id":{"type":"string","description":"The system name for the option."},"inputs":{"type":"array","description":"The additional inputs that are required if the user selects this option in the user interface. If the inputs parameter is empty (`\\[\\]`), selecting the option does not require additional user input.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of input prompt in the user interface. Possible values include:\n - password—Prompts for input via text box.\n - text—Prompts for input via text box.\n - select—Prompts for input via selectable options.\n - file—Prompts user to upload file of input data.\n - toggle—Prompts user to select one of two mutually-exclusive options in toggle format.\n - checkbox—Prompts user to select options via checkboxes. Checkboxes can represent enabling a single option or can allow users to select from multiple, mutually-exclusive options.\n - key-value— Prompts for text entry of a key-value pair via two text boxes."},"name":{"type":"string","description":"The display name of the option in the user interface."},"required":{"type":"boolean","description":"A value specifying whether the input is required (`true`) or optional (`false`)."},"placeholder":{"type":"string","description":"An example of the input value. This value appears as example text in the user interface.  \n\nThis attribute is only present for credential parameters that require text input in the interface.   \n\nIn cases where the input type is `key-value`, this attribute can be an array of strings."},"regex":{"type":"string","description":"A regular expression defining the valid input for the parameter in the user interface."},"hint":{"type":"string","description":"Helpful information about the input required, for example, \"PEM formatted certificate\". Hints appear in the user interface, but can contain information that is relevant to API requests."},"callback":{"type":"string","description":"Not supported as a parameter in managed credentials."},"default-row-count":{"type":"integer","description":"The number of text box rows that appear by default when the input type is `key-value`."},"hide-values":{"type":"boolean","description":"A value specifying whether the user interface hides the value by default when the input type is `key-value`. If `true`, dots appear instead of characters as you type the value in the user interface."},"id":{"type":"string","description":"The system name for the input. Use this value as the input name in request messages when configuring credentials."}}}}}}},"default":{"type":"string","description":"The option that appears as selected by default in the user interface."},"alt_ids":{"type":"string","description":"Not supported as a parameter in managed credentials."},"preferences":{"description":"Not supported as a parameter in managed credentials.","type":"array","items":{"type":"string"}}}}},"expand_settings":{"type":"boolean","description":"A value specifying whether the configuration settings appear expanded by default in the user interface."}}}}}}}}},"examples":{"response":{"value":{"credentials":[{"id":"Cloud Services","category":"Cloud Services","default_expand":false,"types":[{"id":"Amazon AWS","name":"Amazon AWS","max":1,"configuration":[{"type":"password","name":"AWS Access Key ID","required":true,"id":"access_key_id"},{"type":"password","name":"AWS Secret Key","required":true,"id":"secret_key"}],"expand_settings":true},{"id":"Microsoft Azure","name":"Microsoft Azure","max":1,"configuration":[{"type":"text","name":"Username","required":true,"id":"username"},{"type":"password","name":"Password","required":true,"id":"password"},{"type":"text","name":"Client Id","required":true,"id":"client_id"}],"expand_settings":true},{"id":"Office 365","name":"Office 365","max":1,"configuration":[{"type":"text","name":"Username","required":true,"id":"username"},{"type":"password","name":"Password","required":true,"id":"password"},{"type":"text","name":"Client Id","required":true,"id":"client_id"},{"type":"password","name":"Client Secret","required":true,"id":"client_secret"}]}]}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/credentials/file":{"post":{"summary":"Upload credentials file","description":"Uploads a file for use with a managed credential (for example, as a private key file for an SSH credential). For more information about using this file, see [Create a Managed Credential](https://developer.tenable.com/docs/create-managed-credential). <p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"credentials-file-upload","tags":["Credentials"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"Filedata":{"type":"string","description":"The file to upload.","format":"binary"}}}}}},"responses":{"200":{"description":"Returns the name of the successfully uploaded file.","content":{"application/json":{"schema":{"type":"object","properties":{"fileuploaded":{"type":"string","description":"The name of the uploaded file. If the file with the same name already exists, Tenable.io appends an underscore with a number, for example ssh_private_key_1.txt. Use this attribute value when referencing the file for subsequent requests."}}},"examples":{"response":{"value":{"fileuploaded":"ssh_private_key_1.txt"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io cannot upload the file.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/editor/{type}/{id}":{"get":{"summary":"Get configuration details","description":"Gets the configuration details for the scan or policy.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"editor-details","tags":["Editor"],"parameters":[{"description":"The type of object (scan or policy).","required":true,"name":"type","in":"path","schema":{"type":"string","enum":["scan","policy"]}},{"description":"The unique ID of the object.","required":true,"name":"id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the object data. Note that the fields can vary depending on the template used for the scan or policy.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string"},"user_permissions":{"type":"integer"},"filter_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The short name of the filter."},"readable_name":{"type":"string","description":"The long name of the filter."},"operators":{"description":"The comparison options for the filter.","type":"array","items":{"type":"object"}},"control":{"type":"object","properties":{"type":{"type":"string","description":"The input type (entry or dropdown)."},"readable_regest":{"type":"string","description":"The placeholder for the input."},"regex":{"type":"string","description":"A regex for checking the value of the input."},"options":{"description":"A list of options if the input is a dropdown.","type":"array","items":{"type":"object"}}}}}}},"settings":{"description":"Scan or policy settings organized into the Basic, Discovery, Assessment, Report, and Advanced configuration categories.","type":"object","properties":{"basic":{"type":"object","description":"The Basic scan settings are used to specify certain organizational and security-related aspects of the scan or policy, including the name of the scan, its targets, whether the scan is scheduled, and who has access to the scan, among other settings."},"discovery":{"type":"object","description":"The Discovery settings relate to discovery and port scanning, including port ranges and methods."},"assessment":{"type":"object","description":"You can use Assessment settings to configure how a scan identifies vulnerabilities, as well as what vulnerabilities are identified. This includes identifying malware, assessing the vulnerability of a system to brute force attacks, and the susceptibility of web applications."},"advanced":{"type":"object","description":"The Advanced settings provide increased control over scan efficiency and the operations of a scan, as well as the ability to enabled plugin debugging."}}},"credentials":{"description":"Credentials that grant the scanner access to the target system without requiring an agent. Credentialed scans can perform a wider variety of checks than non-credentialed scans, which can result in more accurate scan results. This facilitates scanning of a very large network to determine local exposures or compliance violations. You can configure credentials for Cloud Services, Database, Host, Miscellaneous, Mobile Device Management, and Plaintext Authentication.","type":"object","properties":{}},"compliance":{"description":"Plugins options enables you to select security checks by Plugin Family or individual plugins checks.","type":"object","properties":{}},"plugins":{"description":"The settings for compliance audit checks.","type":"object","properties":{}}}},"examples":{"response":{"value":{"is_was":null,"user_permissions":128,"owner":"user2@example.com","title":"Custom Scan","is_agent":null,"uuid":"ab4bacd2-05f6-425c-9d79-3ba3940ad1c24e51e1f403febe40","settings":{"basic":{"inputs":[{"type":"entry","name":"Name","id":"name","default":"KitchenSinkScan","required":true},{"type":"textarea","name":"Description","id":"description","default":null},{"type":"select","id":"include_aggregate","name":"Scan results","default":true,"options":[{"name":"Show in dashboard","value":"true"}]},{"type":"select","id":"folder_id","name":"Folder","default":9,"options":[{"name":"My Scans","id":9},{"name":"Trash","id":8}]},{"type":"select","id":"use_dashboard","name":"Dashboard","default":false,"options":[{"name":"Enabled","value":"true"},{"name":"Disabled","value":"false"}]}],"title":"Basic","groups":[{"title":"Permissions","name":"permissions","acls":[{"permissions":0,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"user2@example.com","name":"user2@example.com","id":2,"type":"user"}]}],"sections":[]}},"filter_attributes":[{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"NUMBER","type":"entry","regex":"^[0-9]+$","maxlength":18},"name":"bid","readable_name":"Bugtraq ID"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_framework_canvas","readable_name":"CANVAS Exploit Framework"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["CANVAS","D2ExploitPack","White_Phosphorus"]},"name":"canvas_package","readable_name":"CANVAS Package"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"Cert VU reference (ie: 10031)","type":"entry","regex":"^[0-9]+$","maxlength":18},"name":"cert","readable_name":"CERT Vulnerability ID"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_framework_core","readable_name":"CORE Exploit Framework"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"cpe","readable_name":"CPE"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"CVE-YYYY-ID (ie: CVE-2011-0018)","type":"entry","regex":"^(CVE|CAN)-(1999|20[01][0-9])-[0-9]{4,}$"},"name":"cve","readable_name":"CVE"},{"operators":["lt","gt","eq","neq","match","nmatch"],"control":{"readable_regex":"7.5","type":"entry","regex":"^[0-9]+(\\.[0-9]+)?$"},"name":"cvss_base_score","readable_name":"CVSS Base Score"},{"operators":["lt","gt","eq","neq","match","nmatch"],"control":{"readable_regex":"4.2","type":"entry","regex":"^[0-9]+(\\.[0-9]+)$"},"name":"cvss_temporal_score","readable_name":"CVSS Temporal Score"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":"^CVSS2#E:(U|POC|F|H|ND)/RL:(OF|T|W|U|ND)/RC:(UC|UR|C|ND)$"},"name":"cvss_temporal_vector","readable_name":"CVSS Temporal Vector"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":"^CVSS2#AV:(L|A|N)/AC:(H|M|L)/Au:(N|S|M)/C:(N|P|C)/I:(N|P|C)/A:(N|P|C)$"},"name":"cvss_vector","readable_name":"CVSS Vector"},{"operators":["lt","gt","eq","neq","match","nmatch"],"control":{"readable_regex":"7.5","type":"entry","regex":"^[0-9]+(\\.[0-9]+)?$"},"name":"cvss3_base_score","readable_name":"CVSS v3.0 Base Score"},{"operators":["lt","gt","eq","neq","match","nmatch"],"control":{"readable_regex":"4.2","type":"entry","regex":"^[0-9]+(\\.[0-9]+)$"},"name":"cvss3_temporal_score","readable_name":"CVSS v3.0 Temporal Score"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":"^CVSS:3.0/E:(U|POC|F|H|ND)/RL:(OF|T|W|U|ND)/RC:(UC|UR|C|ND)$"},"name":"cvss3_temporal_vector","readable_name":"CVSS v3.0 Temporal Vector"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":"^CVSS:3.0/AV:(N|A|L|P)/AC:(L|H)/PR:(N,L,H)/UI:(N|R)/S:(U|C)/C:(H|L|N)/I:(H|L|N)/A:(H|L|N)$"},"name":"cvss3_vector","readable_name":"CVSS v3.0 Vector"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"CWE reference (ie: 200)","type":"entry","regex":"^([0-9]+)$"},"name":"cwe","readable_name":"CWE"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"default_account","readable_name":"Default/Known Accounts"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_framework_d2_elliot","readable_name":"Elliot Exploit Framework"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"d2_elliot_name","readable_name":"Elliot Exploit Name"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_available","readable_name":"Exploit Available"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"NUMBER","type":"entry","regex":"^[0-9]+$","maxlength":18},"name":"edb-id","readable_name":"Exploit Database ID"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_framework_exploithub","readable_name":"ExploitHub"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["Exploits are available","No exploit is required","No known exploits are available"]},"name":"exploitability_ease","readable_name":"Exploitability Ease"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploited_by_malware","readable_name":"Exploited By Malware"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploited_by_nessus","readable_name":"Exploited By Nessus"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"IAVA reference (ie: 2011-A-0151)","type":"entry","regex":"^[0-9]+-[A-Za-z]-[0-9]+$"},"name":"iava","readable_name":"IAVA ID"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"IAVB reference (ie: 2011-B-0151)","type":"entry","regex":"^[0-9]+-[A-Za-z]-[0-9]+$"},"name":"iavb","readable_name":"IAVB ID"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"IAVM Severity (ie: IV)","type":"entry","regex":"^[ivIV]+"},"name":"stig_severity","readable_name":"IAVM Severity"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"IAVT reference (ie: 2011-A-0151)","type":"entry","regex":"^[0-9]+-[A-Za-z]-[0-9]+$"},"name":"iavt","readable_name":"IAVT ID"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"in_the_news","readable_name":"In The News"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"malware","readable_name":"Malware"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_framework_metasploit","readable_name":"Metasploit Exploit Framework"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"metasploit_name","readable_name":"Metasploit Name"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"MS0X-YZT","type":"entry","regex":"^MS[0-9]+-[0-9]+$"},"name":"msft","readable_name":"Microsoft Bulletin"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"NUMBER","type":"entry","regex":"^[0-9]+$","maxlength":18},"name":"osvdb","readable_name":"OSVDB ID"},{"operators":["date-lt","date-gt","date-eq","date-neq"],"control":{"readable_regex":"YYYY/MM/DD","type":"datefield","regex":"^[0-9]{4}/[0-9]{2}/[0-9]{2}$"},"name":"patch_publication_date","readable_name":"Patch Publication Date"},{"operators":["match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"description","readable_name":"Plugin Description"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"NUMBER","type":"entry","regex":"^[0-9, ]+$","maxlength":9},"name":"plugin_id","readable_name":"Plugin ID"},{"operators":["date-lt","date-gt","date-eq","date-neq"],"control":{"readable_regex":"YYYY/MM/DD","type":"datefield","regex":"^[0-9]{4}/[0-9]{2}/[0-9]{2}$"},"name":"plugin_modification_date","readable_name":"Plugin Modification Date"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"plugin_name","readable_name":"Plugin Name"},{"operators":["date-lt","date-gt","date-eq","date-neq"],"control":{"readable_regex":"YYYY/MM/DD","type":"datefield","regex":"^[0-9]{4}/[0-9]{2}/[0-9]{2}$"},"name":"plugin_publication_date","readable_name":"Plugin Publication Date"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["local","remote"]},"name":"plugin_type","readable_name":"Plugin Type"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["None","Low","Medium","High","Critical"]},"name":"risk_factor","readable_name":"Risk Factor"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"NUMBER","type":"entry","regex":"^[0-9]+$","maxlength":18},"name":"secunia","readable_name":"Secunia ID"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"see_also","readable_name":"See Also"},{"operators":["match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"solution","readable_name":"Solution"},{"operators":["match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"synopsis","readable_name":"Synopsis"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"unsupported_by_vendor","readable_name":"Unsupported By Vendor"},{"operators":["date-lt","date-gt","date-eq","date-neq"],"control":{"readable_regex":"YYYY/MM/DD","type":"datefield","regex":"^[0-9]{4}/[0-9]{2}/[0-9]{2}$"},"name":"vuln_publication_date","readable_name":"Vulnerability Publication Date"}],"name":"custom"}}}}}},"403":{"description":"Returned if you do not have permission to open the object."},"404":{"description":"Returned if Tenable.io cannot find the specified object."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/editor/{type}/templates":{"get":{"summary":"List templates","description":"Lists scan or policy templates.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"editor-list-templates","tags":["Editor"],"parameters":[{"description":"The type of templates to retrieve (scan or policy).","required":true,"name":"type","in":"path","schema":{"type":"string","enum":["scan","policy"]}}],"responses":{"200":{"description":"Returns the template list.","content":{"application/json":{"schema":{"type":"array","description":"The list of available templates.","items":{"type":"object","description":"Templates are used to create scans or policies with predefined parameters.","properties":{"unsupported":{"type":"boolean","description":"If true, template is not supported."},"cloud_only":{"type":"boolean","description":"If true, template is only available on the cloud."},"desc":{"type":"string","description":"The description of the template."},"subscription_only":{"type":"boolean","description":"If true, the template is only available for subscribers."},"is_was":{"type":"boolean","description":"If true, the template is for Web Application Scanning."},"title":{"type":"string","description":"The long name of the template."},"is_agent":{"type":"boolean","description":"If true, the template is for agent scans."},"uuid":{"type":"string","description":"The UUID for the template."},"manager_only":{"type":"boolean","description":"If true, can only be used by manager."},"name":{"type":"string","description":"The short name of the template."}}}},"examples":{"response":{"value":{"templates":[{"unsupported":false,"cloud_only":false,"desc":"A full system scan suitable for any host.","order":null,"subscription_only":false,"is_was":null,"title":"Basic Network Scan","is_agent":null,"uuid":"731a8e52-3ea6-a291-ec0a-d2ff0619c19d7bd788d6be818b65","manager_only":false,"name":"basic"},{"unsupported":false,"cloud_only":false,"desc":"Audit systems connected via Nessus Agents.","order":null,"subscription_only":false,"is_was":null,"title":"Policy Compliance Auditing","is_agent":true,"uuid":"523c833f-e434-a05f-5a52-0c0c2c160b7cd9c901634c382c2d","manager_only":false,"name":"agent_compliance"},{"unsupported":false,"cloud_only":false,"desc":"Scan for malware on systems connected via Nessus Agents.","order":null,"subscription_only":false,"is_was":null,"title":"Malware Scan","is_agent":true,"uuid":"fc2fa8b3-028b-83e8-2ebd-4705d0de38bc621fbb0e783517bc","manager_only":false,"name":"agent_malware"}]}}}}}},"403":{"description":"Returned if you do not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/editor/{type}/templates/{template_uuid}":{"get":{"summary":"Get template details","description":"Gets details for the specified template.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"editor-template-details","tags":["Editor"],"parameters":[{"description":"The type of template to retrieve (scan or policy).","required":true,"name":"type","in":"path","schema":{"type":"string","enum":["scan","policy"]}},{"description":"The UUID for the template.","required":true,"name":"template_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the template details. Note that the fields can vary for different template types.","content":{"application/json":{"schema":{"type":"object","properties":{"is_was":{"type":"boolean","description":"If `true`, the template is for Web Application Scanning. For Vulnerability Management, this value is always `null`."},"title":{"type":"string","description":"The long name of the template."},"name":{"type":"string","description":"The short name of the template."},"is_agent":{"type":"boolean","description":"If `true`, the template is for agent scans."},"filter_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The short name of the filter."},"readable_name":{"type":"string","description":"The long name of the filter."},"operators":{"description":"The comparison options for the filter.","type":"array","items":{"type":"object"}},"control":{"type":"object","properties":{"type":{"type":"string","description":"The input type (entry or dropdown)."},"readable_regest":{"type":"string","description":"The placeholder for the input."},"regex":{"type":"string","description":"A regex for checking the value of the input."},"options":{"description":"A list of options if the input is a dropdown.","type":"array","items":{"type":"object"}}}}}}},"settings":{"description":"Scan or policy settings organized into the Basic, Discovery, Assessment, Report, and Advanced configuration categories.","type":"object","properties":{"basic":{"type":"object","description":"The Basic scan settings are used to specify certain organizational and security-related aspects of the scan or policy, including the name of the scan, its targets, whether the scan is scheduled, and who has access to the scan, among other settings."},"discovery":{"type":"object","description":"The Discovery settings relate to discovery and port scanning, including port ranges and methods."},"assessment":{"type":"object","description":"You can use Assessment settings to configure how a scan identifies vulnerabilities, as well as what vulnerabilities are identified. This includes identifying malware, assessing the vulnerability of a system to brute force attacks, and the susceptibility of web applications."},"advanced":{"type":"object","description":"The Advanced settings provide increased control over scan efficiency and the operations of a scan, as well as the ability to enabled plugin debugging."}}},"credentials":{"description":"Credentials that grant the scanner access to the target system without requiring an agent. Credentialed scans can perform a wider variety of checks than non-credentialed scans, which can result in more accurate scan results. This facilitates scanning of a very large network to determine local exposures or compliance violations. You can configure credentials for Cloud Services, Database, Host, Miscellaneous, Mobile Device Management, and Plaintext Authentication.","type":"object","properties":{}},"compliance":{"description":"Plugins options enables you to select security checks by Plugin Family or individual plugins checks.","type":"object","properties":{}},"plugins":{"description":"The settings for compliance audit checks.","type":"object","properties":{}}}},"examples":{"response":{"value":{"is_was":null,"user_permissions":null,"owner":null,"title":"Host Discovery","is_agent":null,"uuid":"bbd4f805-3966-d464-b2d1-0079eb89d69708c3a05ec2812bcf","settings":{"basic":{"inputs":[{"type":"entry","name":"Name","id":"name","required":true},{"type":"textarea","name":"Description","id":"description"},{"type":"select","id":"include_aggregate","name":"Scan results","default":true,"options":[{"name":"Keep private","value":"false"},{"name":"Show in dashboard","value":"true"}]},{"type":"select","id":"folder_id","name":"Folder","options":[{"name":"My Scans","id":9},{"name":"Trash","id":8}]},{"type":"select","id":"use_dashboard","name":"Dashboard","default":false,"options":[{"name":"Enabled","value":"true"},{"name":"Disabled","value":"false"}]},{"type":"select","id":"scanner_id","name":"Scanner","default":null,"options":[{"id":"00000000-0000-0000-0000-00000000000000000000000000001","name":"US Cloud Scanner","type":"local","network_name":"Default","linked":true,"status":"on"},{"id":"1b895828-62a9-5084-8bc5-d4864a927fb10523d1e84e3fef44","name":"AP Singapore Cloud Scanners","type":"local","network_name":"Default","linked":true,"status":"on"},{"id":"cdf44a84-b547-b66c-d997-920aa1e897cc7165fe2e344196bb","name":"Demo Scanner","type":"local","network_name":"Default","linked":true,"status":"on"},{"id":"06ab826a-301d-7829-d2c4-37f400c0f949ea8cce60f523eeef","name":"EU Frankfurt Cloud Scanners","type":"local","network_name":"Default","linked":true,"status":"on"},{"id":"15e29fb5-c378-4803-37f7-67752912247e812e6cf942b4fd2e","name":"US East Cloud Scanners","type":"local","network_name":"Default","linked":true,"status":"on"},{"id":"37b315c1-f31f-cc8e-7e78-585c609fc1d7eba88f8d1e7d24b3","name":"US West Cloud Scanners","type":"local","network_name":"Default","linked":true,"status":"on"}]},{"type":"multi_select","deprecated_by":"target_groups","id":"asset_lists","name":"Target Groups","default":[],"options":[{"acls":[{"permissions":64,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"system","name":"nessus_ms_agent","id":1,"type":"user"},{"permissions":64,"owner":0,"display_name":"user@example.com","name":"user@example.com","id":2,"type":"user"}],"default_list":0,"type":"system","members":"host.domain.com, host1.domain.com","name":"modified_test_group_yet_again_and-again","owner":"nessus_ms_agent","shared":1,"user_permissions":64,"last_modification_date":1533583518,"creation_date":1533577166,"owner_id":1,"id":13},{"acls":[{"permissions":64,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"system","name":"nessus_ms_agent","id":1,"type":"user"},{"permissions":64,"owner":0,"display_name":"user@example.com","name":"user@example.com","id":2,"type":"user"}],"default_list":0,"type":"system","members":"testtest1","name":"test group","owner":"nessus_ms_agent","shared":1,"user_permissions":64,"last_modification_date":1533580228,"creation_date":1533246042,"owner_id":1,"id":12}]},{"type":"textarea","id":"text_targets","name":"Targets","placeholder":"Example: 172.204.81.57-172.204.81.60, 172.156.65.8/24, test.com","required":true},{"type":"file","id":"file_targets","name":"Upload Targets"}],"title":"Basic","groups":[{"title":"Schedule","name":"schedule"},{"inputs":[{"type":"textarea","name":"Email Recipient(s)","placeholder":"Example: me@example.com, you@example.com"}],"title":"Notifications","name":"email","filters":[]},{"title":"Permissions","name":"permissions","acls":null}],"sections":[]},"discovery":{"inputs":null,"modes":{"id":"discovery_mode","name":"mode","type":"ui_radio","default":"Host enumeration","options":[{"desc":"<ul><li>General Settings:<ul><li>Always test the local Nessus host</li></ul></li><li>Ping hosts using:<ul><li>TCP</li><li>ARP</li><li>ICMP (2 retries)</li></ul></li></ul>","name":"Host enumeration"},{"desc":"<ul><li>General Settings:<ul><li>Always test the local Nessus host</li></ul></li><li>Ping hosts using:<ul><li>TCP</li><li>ARP</li><li>ICMP</li></ul></li></ul>","name":"OS Identification"},{"desc":"<ul><li>General Settings:<ul><li>Always test the local Nessus host</li></ul></li><li>Port Scanner Settings:<ul><li>Scan common ports</li><li>Use netstat if credentials are provided</li><li>Use SYN scanner if necessary</li></ul></li><li>Ping hosts using:<ul><li>TCP</li><li>ARP</li><li>ICMP (2 retries)</li></ul></li></ul>","name":"Port scan (common ports)"},{"desc":"<ul><li>General Settings:<ul><li>Always test the local Nessus host</li></ul></li><li>Port Scanner Settings:<ul><li>Scan all ports (1-65535)</li><li>Use netstat if credentials are provided</li><li>Use SYN scanner if necessary</li></ul></li><li>Ping hosts using:<ul><li>TCP</li><li>ARP</li><li>ICMP (2 retries)</li></ul></li></ul>","name":"Port scan (all ports)"},{"desc":"<ul><li>Choose your own discovery settings.</li></ul>","name":"Custom"}]},"title":"Discovery","groups":[{"inputs":[{"type":"ui_checkbox","name":"Ping the remote host","id":"ping_the_remote_host","default":"yes","options":[{"inputs":null,"name":"no"},{"inputs":null,"name":"yes","sections":[{"inputs":[{"type":"checkbox","id":"fast_network_discovery","label":"Use fast network discovery","default":"no","hint":"If a host responds to ping, Nessus attempts to avoid false positives, performing additional tests to verify the response did not come from a proxy or load balancer. Fast network discovery bypasses those additional tests."}],"title":"General Settings","name":"general"},{"inputs":[{"type":"checkbox","id":"arp_ping","label":"ARP","default":"yes"},{"name":"TCP","inputs":[{"type":"medium-entry","name":"Destination ports","id":"tcp_ping_dest_ports","default":"built-in"}],"type":"ui_group","id":"tcp_ping","default":"yes"},{"name":"ICMP","inputs":[{"type":"checkbox","id":"icmp_unreach_means_host_down","label":"Assume ICMP unreachable from the gateway means the host is down","default":"no"},{"type":"medium-entry","name":"Maximum number of retries","id":"icmp_ping_retries","default":"2","regex":"^\\d+$"}],"type":"ui_group","id":"icmp_ping","default":"yes"},{"type":"checkbox","id":"udp_ping","label":"UDP","default":"no"}],"title":"Ping Methods","name":"protocols"}]}]}],"title":"Host Discovery","name":"host_discovery","sections":[{"inputs":[{"type":"checkbox","id":"scan_network_printers","label":"Scan Network Printers","default":"no"},{"type":"checkbox","id":"scan_netware_hosts","label":"Scan Novell Netware hosts","default":"no"},{"type":"checkbox","id":"scan_ot_devices","label":"Scan Operational Technology devices","default":"no"}],"title":"Fragile Devices","name":"fragile_devices"},{"inputs":[{"type":"file","name":"List of MAC addresses","id":"wol_mac_addresses","callback":"wol_mac_upload"},{"type":"medium-entry","name":"Boot time wait (in minutes)","id":"wol_wait_time","default":"5","regex":"^\\d+$"}],"title":"Wake-on-LAN","name":"wol"},{"inputs":[{"type":"radio","name":"Network Type","id":"network_type","options":["Mixed (use RFC 1918)","Private LAN","Public WAN (Internet)"],"default":"Mixed (use RFC 1918)"}],"title":"Network Type","name":"network_type"}]},{"inputs":null,"title":"Port Scanning","name":"network_discovery","sections":[{"inputs":[{"type":"checkbox","id":"unscanned_closed","label":"Consider unscanned ports as closed","default":"no"},{"type":"medium-entry","id":"portscan_range","label":"Port scan range:","default":"default"}],"title":"Ports","name":"ports"},{"inputs":[{"id":"tcp_scanner","type":"ui_group","inputs":[{"type":"radio-group","id":"tcp_firewall_detection","label":"Override automatic firewall detection","default":"Automatic (normal)","options":["Automatic (normal)","Do not detect RST rate limitation (soft)","Ignore closed ports (aggressive)","Disabled (softer)"],"optionsLabels":["","Use soft detection","Use aggressive detection","Disable detection"]}],"no_windows":true,"no_darwin":true,"default":"no","name":"TCP"},{"name":"SYN","inputs":[{"type":"radio-group","id":"syn_firewall_detection","label":"Override automatic firewall detection","default":"Automatic (normal)","options":["Automatic (normal)","Do not detect RST rate limitation (soft)","Ignore closed ports (aggressive)","Disabled (softer)"],"optionsLabels":["","Use soft detection","Use aggressive detection","Disable detection"]}],"type":"ui_group","id":"syn_scanner","default":"yes"},{"type":"checkbox","id":"udp_scanner","label":"UDP","default":"no","hint":"Due to the nature of the protocol, it is generally not possible for a port scanner to tell the difference between open and filtered UDP ports.  Enabling the UDP port scanner may dramatically increase the scan time and produce unreliable results. Consider using the netstat or SNMP port enumeration options instead if possible."}],"title":"Network Port Scanners","name":"network_scanners"}]}],"sections":[]},"report":{"inputs":null,"modes":[{"desc":"<ul><li>Report processing:<ul><li>Normal report verbosity</li><li>Silent dependencies</li></ul></li><li>Report output:<ul><li>Allow users to edit scan results</li></ul></li></ul>","id":"default","name":"Default","default":true},{"desc":"<ul><li>Report output:<ul><li>Allow users to edit scan results</li></ul></li></ul>","id":"default_output","name":"Default","default":true},{"desc":"<ul><li>Choose your own report settings.</li></ul>","custom":true,"id":"custom","name":"Custom"}],"title":"Report","groups":[],"sections":[{"inputs":[{"type":"checkbox","id":"reverse_lookup","label":"Designate hosts by their DNS name","default":"no"},{"type":"checkbox","id":"log_live_hosts","label":"Display hosts that respond to ping","default":"yes"},{"type":"checkbox","id":"display_unreachable_hosts","label":"Display unreachable hosts","default":"no"}],"title":"Output","name":"report_output"}]}},"filter_attributes":[{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"NUMBER","type":"entry","regex":"^[0-9]+$","maxlength":18},"name":"bid","readable_name":"Bugtraq ID"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_framework_canvas","readable_name":"CANVAS Exploit Framework"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["CANVAS","D2ExploitPack","White_Phosphorus"]},"name":"canvas_package","readable_name":"CANVAS Package"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"Cert VU reference (ie: 10031)","type":"entry","regex":"^[0-9]+$","maxlength":18},"name":"cert","readable_name":"CERT Vulnerability ID"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_framework_core","readable_name":"CORE Exploit Framework"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"cpe","readable_name":"CPE"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"CVE-YYYY-ID (ie: CVE-2011-0018)","type":"entry","regex":"^(CVE|CAN)-(1999|20[01][0-9])-[0-9]{4,}$"},"name":"cve","readable_name":"CVE"},{"operators":["lt","gt","eq","neq","match","nmatch"],"control":{"readable_regex":"7.5","type":"entry","regex":"^[0-9]+(\\.[0-9]+)?$"},"name":"cvss_base_score","readable_name":"CVSS Base Score"},{"operators":["lt","gt","eq","neq","match","nmatch"],"control":{"readable_regex":"4.2","type":"entry","regex":"^[0-9]+(\\.[0-9]+)$"},"name":"cvss_temporal_score","readable_name":"CVSS Temporal Score"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":"^CVSS2#E:(U|POC|F|H|ND)/RL:(OF|T|W|U|ND)/RC:(UC|UR|C|ND)$"},"name":"cvss_temporal_vector","readable_name":"CVSS Temporal Vector"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":"^CVSS2#AV:(L|A|N)/AC:(H|M|L)/Au:(N|S|M)/C:(N|P|C)/I:(N|P|C)/A:(N|P|C)$"},"name":"cvss_vector","readable_name":"CVSS Vector"},{"operators":["lt","gt","eq","neq","match","nmatch"],"control":{"readable_regex":"7.5","type":"entry","regex":"^[0-9]+(\\.[0-9]+)?$"},"name":"cvss3_base_score","readable_name":"CVSS v3.0 Base Score"},{"operators":["lt","gt","eq","neq","match","nmatch"],"control":{"readable_regex":"4.2","type":"entry","regex":"^[0-9]+(\\.[0-9]+)$"},"name":"cvss3_temporal_score","readable_name":"CVSS v3.0 Temporal Score"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":"^CVSS:3.0/E:(U|POC|F|H|ND)/RL:(OF|T|W|U|ND)/RC:(UC|UR|C|ND)$"},"name":"cvss3_temporal_vector","readable_name":"CVSS v3.0 Temporal Vector"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":"^CVSS:3.0/AV:(N|A|L|P)/AC:(L|H)/PR:(N,L,H)/UI:(N|R)/S:(U|C)/C:(H|L|N)/I:(H|L|N)/A:(H|L|N)$"},"name":"cvss3_vector","readable_name":"CVSS v3.0 Vector"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"CWE reference (ie: 200)","type":"entry","regex":"^([0-9]+)$"},"name":"cwe","readable_name":"CWE"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"default_account","readable_name":"Default/Known Accounts"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_framework_d2_elliot","readable_name":"Elliot Exploit Framework"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"d2_elliot_name","readable_name":"Elliot Exploit Name"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_available","readable_name":"Exploit Available"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"NUMBER","type":"entry","regex":"^[0-9]+$","maxlength":18},"name":"edb-id","readable_name":"Exploit Database ID"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_framework_exploithub","readable_name":"ExploitHub"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["Exploits are available","No exploit is required","No known exploits are available"]},"name":"exploitability_ease","readable_name":"Exploitability Ease"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploited_by_malware","readable_name":"Exploited By Malware"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploited_by_nessus","readable_name":"Exploited By Nessus"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"IAVA reference (ie: 2011-A-0151)","type":"entry","regex":"^[0-9]+-[A-Za-z]-[0-9]+$"},"name":"iava","readable_name":"IAVA ID"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"IAVB reference (ie: 2011-B-0151)","type":"entry","regex":"^[0-9]+-[A-Za-z]-[0-9]+$"},"name":"iavb","readable_name":"IAVB ID"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"IAVM Severity (ie: IV)","type":"entry","regex":"^[ivIV]+"},"name":"stig_severity","readable_name":"IAVM Severity"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"IAVT reference (ie: 2011-A-0151)","type":"entry","regex":"^[0-9]+-[A-Za-z]-[0-9]+$"},"name":"iavt","readable_name":"IAVT ID"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"in_the_news","readable_name":"In The News"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"malware","readable_name":"Malware"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"exploit_framework_metasploit","readable_name":"Metasploit Exploit Framework"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"metasploit_name","readable_name":"Metasploit Name"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"MS0X-YZT","type":"entry","regex":"^MS[0-9]+-[0-9]+$"},"name":"msft","readable_name":"Microsoft Bulletin"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"NUMBER","type":"entry","regex":"^[0-9]+$","maxlength":18},"name":"osvdb","readable_name":"OSVDB ID"},{"operators":["date-lt","date-gt","date-eq","date-neq"],"control":{"readable_regex":"YYYY/MM/DD","type":"datefield","regex":"^[0-9]{4}/[0-9]{2}/[0-9]{2}$"},"name":"patch_publication_date","readable_name":"Patch Publication Date"},{"operators":["match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"description","readable_name":"Plugin Description"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"NUMBER","type":"entry","regex":"^[0-9, ]+$","maxlength":9},"name":"plugin_id","readable_name":"Plugin ID"},{"operators":["date-lt","date-gt","date-eq","date-neq"],"control":{"readable_regex":"YYYY/MM/DD","type":"datefield","regex":"^[0-9]{4}/[0-9]{2}/[0-9]{2}$"},"name":"plugin_modification_date","readable_name":"Plugin Modification Date"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"plugin_name","readable_name":"Plugin Name"},{"operators":["date-lt","date-gt","date-eq","date-neq"],"control":{"readable_regex":"YYYY/MM/DD","type":"datefield","regex":"^[0-9]{4}/[0-9]{2}/[0-9]{2}$"},"name":"plugin_publication_date","readable_name":"Plugin Publication Date"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["local","remote"]},"name":"plugin_type","readable_name":"Plugin Type"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["None","Low","Medium","High","Critical"]},"name":"risk_factor","readable_name":"Risk Factor"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"NUMBER","type":"entry","regex":"^[0-9]+$","maxlength":18},"name":"secunia","readable_name":"Secunia ID"},{"operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"see_also","readable_name":"See Also"},{"operators":["match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"solution","readable_name":"Solution"},{"operators":["match","nmatch"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"name":"synopsis","readable_name":"Synopsis"},{"operators":["eq","neq"],"control":{"type":"dropdown","list":["true","false"]},"name":"unsupported_by_vendor","readable_name":"Unsupported By Vendor"},{"operators":["date-lt","date-gt","date-eq","date-neq"],"control":{"readable_regex":"YYYY/MM/DD","type":"datefield","regex":"^[0-9]{4}/[0-9]{2}/[0-9]{2}$"},"name":"vuln_publication_date","readable_name":"Vulnerability Publication Date"}],"name":"discovery"}}}}}},"403":{"description":"Returned if you do not have permission to open the template."},"404":{"description":"Returned if Tenable.io cannot find the specified template."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/editor/policy/{policy_id}/families/{family_id}/plugins/{plugin_id}":{"get":{"summary":"Get plugin details","description":"Gets the details of the plugin associated with the scan or policy.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"editor-plugin-description","tags":["Editor"],"parameters":[{"description":"The ID of the policy to look up.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the family to lookup within the policy.","required":true,"name":"family_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the plugin to lookup within the family.","required":true,"name":"plugin_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the plugin output.","content":{"application/json":{"schema":{"type":"object","properties":{"plugindescription":{"description":"The detailed information for a Tenable.io plugin.","type":"object","properties":{"severity":{"type":"string","description":"The severity level of the vulnerabilities targeted by the plugin"},"pluginname":{"type":"string","description":"The name of the plugin."},"pluginattributes":{"type":"object","description":"The attributes of the plugin, including synopsis, description, solution, and risk information."},"pluginfamily":{"type":"string","description":"The name of the plugin family."},"pluginid":{"type":"integer","description":"The ID of the plugin."}}}}},"examples":{"response":{"value":{"plugindescription":{"severity":null,"pluginname":"Ubuntu 10.04 LTS / 10.10 / 11.04 / 11.10 : clamav vulnerability (USN-1258-1)","pluginattributes":{"synopsis":"The remote Ubuntu host is missing a security-related patch.","description":"Stephane Chazelas discovered the bytecode engine of ClamAV improperly handled recursion under certain circumstances. This could allow a remote attacker to craft a file that could cause ClamAV to crash, resulting in a denial of service.\n\nNote that Tenable Network Security has extracted the preceding description block directly from the Ubuntu security advisory. Tenable has attempted to automatically clean and format it as much as possible without introducing additional issues.","risk_information":{"cvss_vector":"CVSS2#AV:N/AC:M/Au:N/C:N/I:N/A:P","risk_factor":"Medium","cvss_base_score":"4.3","cvss_temporal_score":"3.2","cvss_temporal_vector":"CVSS2#E:U/RL:OF/RC:C"},"ref_information":{"ref":[{"name":"bid","values":{"value":["50183"]},"url":"http://www.securityfocus.com/bid/"},{"name":"usn","values":{"value":["1258-1"]},"ext":"/","url":"http://www.ubuntu.com/usn/usn-"},{"name":"cve","values":{"value":["CVE-2011-3627"]},"url":"http://web.nvd.nist.gov/view/vuln/detail?vulnId="}]},"plugin_name":"Ubuntu 10.04 LTS / 10.10 / 11.04 / 11.10 : clamav vulnerability (USN-1258-1)","see_also":["https://usn.ubuntu.com/1258-1/"],"fname":"ubuntu_USN-1258-1.nasl","usn":"1258-1","plugin_information":{"plugin_version":"1.8","plugin_id":56777,"plugin_type":"local","plugin_publication_date":"2011/11/11","plugin_family":"Ubuntu Local Security Checks","plugin_modification_date":"2018/12/01"},"solution":"Update the affected libclamav6 package.","vuln_information":{"cpe":"cpe:/o:canonical:ubuntu_linux:10.04:-:lts\ncpe:/o:canonical:ubuntu_linux:10.10\ncpe:/o:canonical:ubuntu_linux:11.04\ncpe:/o:canonical:ubuntu_linux:11.10","exploitability_ease":"No known exploits are available","exploit_available":"false","patch_publication_date":"2011/11/10"}},"pluginfamily":"Ubuntu Local Security Checks","pluginid":"56777"}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/editor/{type}/{object_id}/audits/{file_id}":{"get":{"summary":"Download audit file","description":"Downloads the specified custom audit file associated with the scan or policy. The file ID can be found in the scan or policy details using the /editor/{type}/{object_id} endpoint.<p>Requires CAN EDIT [32] policy permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"editor-audits","tags":["Editor"],"parameters":[{"description":"The type of template to retrieve (scan or policy).","required":true,"name":"type","in":"path","schema":{"type":"string","enum":["scan","policy"]}},{"description":"The unique ID of the object.","required":true,"name":"object_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the file to export.","required":true,"name":"file_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the audit file.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"},"examples":{"response":{"value":"#\r\n# (C) 2013-2017 Tenable, Inc.\r\n#\r\n# This script is released under the Tenable Subscription License and\r\n# may not be used from within scripts released under another license\r\n# without authorization from Tenable Network Security, Inc.\r\n#\r\n# See the following licenses for details:\r\n#\r\n# http://static.tenable.com/prod_docs/Nessus_6_SLA_and_Subscription_Agreement.pdf\r\n#\r\n# @PROFESSIONALFEED@\r\n# $Revision: 1.0 $\r\n# $Date: 2018/01/02 $\r\n#\r\n# Description:\r\n#\r\n# This document consists of a list of general Red Hat Linux best practices as suggested by the IT-Grundschutz BSI-Standard 100-2.\r\n# Tenable has made a best effort to map the settings specified in the standard to a proprietary\r\n# .audit format that will be used by the Unix compliance module to perform the audit.\r\n#\r\n# See Also :\r\n# https://www.bsi.bund.de/cae/servlet/contentblob/471430/publicationFile/28223/standard_100-2_e_pdf.pdf\r\n# https://www.bsi.bund.de/SharedDocs/Downloads/EN/BSI/Grundschutz/download/it-grundschutz-kataloge_2005_pdf_en_zip.zip?__blob=publicationFile\r\n#\r\n#<ui_metadata>\r\n#<display_name>BSI-100-2 Red Hat Linux 2005</display_name>\r\n#<spec> [the rest of the audit spec file]..."}}}}},"403":{"description":"Returned if you do not have permission to export the audit file."},"404":{"description":"Returned if Tenable.io cannot find the specified audit file."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/exclusions":{"post":{"summary":"Create exclusion","description":"Creates a new exclusion.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exclusions-create","tags":["Exclusions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the exclusion."},"description":{"type":"string","description":"The description of the exclusion."},"members":{"type":"string","description":"The targets that you want excluded from scans. Specify multiple targets as a comma-separated string. Targets can be in the following formats:\n - an individual IPv4 address (192.168.1.1)\n - a range of IPv4 addresses (192.168.1.1-192.168.1.255)\n - CIDR notation (192.168.2.0/24)\n - a fully-qualified domain name (FQDN) (host.domain.com)"},"schedule":{"type":"object","description":"The schedule parameters for the exclusion.","properties":{"enabled":{"type":"boolean","description":"If `true`, the exclusion schedule is active."},"starttime":{"type":"string","description":"The start time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"endtime":{"type":"string","description":"The end time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"timezone":{"type":"string","description":"The timezone for the exclusion as returned by [scans: timezones](/reference#scans-timezones)."},"rrules":{"type":"object","description":"The recurrence rules for the exclusion.","properties":{"freq":{"type":"string","description":"The frequency of the rule (ONETIME, DAILY, WEEKLY, MONTHLY, YEARLY)."},"interval":{"type":"integer","description":"The interval of the rule."},"byweekday":{"type":"string","description":"A comma-separated string of days to repeat a WEEKLY freq rule on (SU,MO,TU,WE,TH,FR, or SA)."},"bymonthday":{"type":"integer","description":"The day of the month to repeat a MONTHLY freq rule on."}}}}},"network_id":{"type":"string","description":"The ID of the network object associated with scanners where Tenable.io applies the exclusion. The default network ID is `00000000-0000-0000-0000-000000000000`. To determine the ID of a custom network, use the [GET /networks](/reference#networks-list) endpoint. If you omit this parameter from the request message, Tenable.io automatically assigns the exclusion to the default network. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."}},"required":["name","members"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully creates the exclusion.","content":{"application/json":{"schema":{"type":"object","properties":{"schedule":{"type":"object","description":"The schedule parameters for the exclusion.","properties":{"enabled":{"type":"boolean","description":"If `true`, the exclusion schedule is active."},"starttime":{"type":"string","description":"The start time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"endtime":{"type":"string","description":"The end time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"timezone":{"type":"string","description":"The timezone for the exclusion as returned by [scans: timezones](/reference#scans-timezones)."},"rrules":{"type":"object","description":"The recurrence rules for the exclusion.","properties":{"freq":{"type":"string","description":"The frequency of the rule (ONETIME, DAILY, WEEKLY, MONTHLY, YEARLY)."},"interval":{"type":"integer","description":"The interval of the rule."},"byweekday":{"type":"string","description":"A comma-separated string of days to repeat a WEEKLY freq rule on (SU,MO,TU,WE,TH,FR, or SA)."},"bymonthday":{"type":"integer","description":"The day of the month to repeat a MONTHLY freq rule on."}}}}},"id":{"type":"integer","description":"The unique ID of the exclusion."},"name":{"type":"string","description":"The name of the exclusion."},"description":{"type":"string","description":"The description of the exclusion."},"members":{"type":"string","description":"The targets that you want excluded from scans. Specify multiple targets as a comma-separated string. Targets can be in the following formats:\n - an individual IPv4 address (192.168.1.1)\n - a range of IPv4 addresses (192.168.1.1-192.168.1.255)\n - CIDR notation (192.168.2.0/24)\n - a fully-qualified domain name (FQDN) (host.domain.com)"},"creation_date":{"type":"integer","description":"The creation date of the exclusion in Unix time."},"network_id":{"type":"string","description":"The ID of the network object associated with scanners where Tenable.io applies the exclusion. The default network ID is `00000000-0000-0000-0000-000000000000`. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"last_modification_date":{"type":"integer","description":"The last modification date for the exclusion in Unix time."}}},"examples":{"response":{"value":{"schedule":{"endtime":null,"enabled":false,"rrules":null,"timezone":null,"starttime":null},"network_id":"00000000-0000-0000-0000-000000000000","last_modification_date":1544459404,"creation_date":1544459404,"members":"192.168.1.1-192.168.1.255,192.168.2.0/24,host.domain.com","description":null,"name":"Western Region","id":1}}}}}},"400":{"description":"Returned if your request message contains invalid parameters."},"403":{"description":"Returned if you do not have permission to create an exclusion."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to create the exclusion.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List exclusions","description":"Lists exclusions for your Tenable.io scans.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exclusions-list","tags":["Exclusions"],"responses":{"200":{"description":"Returns the exclusions.","content":{"application/json":{"schema":{"type":"array","description":"A list of exclusion objects.","items":{"type":"object","properties":{"schedule":{"type":"object","description":"The schedule parameters for the exclusion.","properties":{"enabled":{"type":"boolean","description":"If `true`, the exclusion schedule is active."},"starttime":{"type":"string","description":"The start time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"endtime":{"type":"string","description":"The end time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"timezone":{"type":"string","description":"The timezone for the exclusion as returned by [scans: timezones](/reference#scans-timezones)."},"rrules":{"type":"object","description":"The recurrence rules for the exclusion.","properties":{"freq":{"type":"string","description":"The frequency of the rule (ONETIME, DAILY, WEEKLY, MONTHLY, YEARLY)."},"interval":{"type":"integer","description":"The interval of the rule."},"byweekday":{"type":"string","description":"A comma-separated string of days to repeat a WEEKLY freq rule on (SU,MO,TU,WE,TH,FR, or SA)."},"bymonthday":{"type":"integer","description":"The day of the month to repeat a MONTHLY freq rule on."}}}}},"id":{"type":"integer","description":"The unique ID of the exclusion."},"name":{"type":"string","description":"The name of the exclusion."},"description":{"type":"string","description":"The description of the exclusion."},"members":{"type":"string","description":"The targets that you want excluded from scans. Specify multiple targets as a comma-separated string. Targets can be in the following formats:\n - an individual IPv4 address (192.168.1.1)\n - a range of IPv4 addresses (192.168.1.1-192.168.1.255)\n - CIDR notation (192.168.2.0/24)\n - a fully-qualified domain name (FQDN) (host.domain.com)"},"creation_date":{"type":"integer","description":"The creation date of the exclusion in Unix time."},"network_id":{"type":"string","description":"The ID of the network object associated with scanners where Tenable.io applies the exclusion. The default network ID is `00000000-0000-0000-0000-000000000000`. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"last_modification_date":{"type":"integer","description":"The last modification date for the exclusion in Unix time."}}}},"examples":{"response":{"value":{"exclusions":[{"schedule":{"endtime":null,"enabled":false,"rrules":null,"timezone":null,"starttime":null},"network_id":"00000000-0000-0000-0000-000000000000","last_modification_date":1544459404,"creation_date":1544459404,"members":"192.168.1.1-192.168.1.255,192.168.2.0/24,host.domain.com","description":null,"name":"Western Region","id":1}]}}}}}},"403":{"description":"Returned if you do not have permission to view the exclusions."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/exclusions/import":{"post":{"summary":"Import exclusion","description":"Import exclusions from an [exclusion import file](/docs/import-file-formats) that you have previously uploaded via the [POST /file/upload](/reference#file-upload) endpoint.\n\n**Note:** This endpoint does not support the network_id attribute in exclusion objects for import. Tenable.io automatically assigns imported exclusions to the default network object. To assign imported exclusions to a custom network, use the [PUT /exclusions/exclusion_id](/reference#exclusions-edit) endpoint after import. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio).<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exclusions-import","tags":["Exclusions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"The name of the file to import as provided by the response from <a href=\"/reference#file\">file: upload</a>."}},"required":["file"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully imports the exclusion file.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to import the exclusion.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/exclusions/{exclusion_id}":{"get":{"summary":"Get exclusion details","description":"Returns exclusion details.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exclusions-details","tags":["Exclusions"],"parameters":[{"description":"The ID of the exclusion.","required":true,"name":"exclusion_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the exclusion details.","content":{"application/json":{"schema":{"type":"object","properties":{"schedule":{"type":"object","description":"The schedule parameters for the exclusion.","properties":{"enabled":{"type":"boolean","description":"If `true`, the exclusion schedule is active."},"starttime":{"type":"string","description":"The start time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"endtime":{"type":"string","description":"The end time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"timezone":{"type":"string","description":"The timezone for the exclusion as returned by [scans: timezones](/reference#scans-timezones)."},"rrules":{"type":"object","description":"The recurrence rules for the exclusion.","properties":{"freq":{"type":"string","description":"The frequency of the rule (ONETIME, DAILY, WEEKLY, MONTHLY, YEARLY)."},"interval":{"type":"integer","description":"The interval of the rule."},"byweekday":{"type":"string","description":"A comma-separated string of days to repeat a WEEKLY freq rule on (SU,MO,TU,WE,TH,FR, or SA)."},"bymonthday":{"type":"integer","description":"The day of the month to repeat a MONTHLY freq rule on."}}}}},"id":{"type":"integer","description":"The unique ID of the exclusion."},"name":{"type":"string","description":"The name of the exclusion."},"description":{"type":"string","description":"The description of the exclusion."},"members":{"type":"string","description":"The targets that you want excluded from scans. Specify multiple targets as a comma-separated string. Targets can be in the following formats:\n - an individual IPv4 address (192.168.1.1)\n - a range of IPv4 addresses (192.168.1.1-192.168.1.255)\n - CIDR notation (192.168.2.0/24)\n - a fully-qualified domain name (FQDN) (host.domain.com)"},"creation_date":{"type":"integer","description":"The creation date of the exclusion in Unix time."},"network_id":{"type":"string","description":"The ID of the network object associated with scanners where Tenable.io applies the exclusion. The default network ID is `00000000-0000-0000-0000-000000000000`. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"last_modification_date":{"type":"integer","description":"The last modification date for the exclusion in Unix time."}}},"examples":{"response":{"value":{"schedule":{"endtime":null,"enabled":false,"rrules":null,"timezone":null,"starttime":null},"network_id":"00000000-0000-0000-0000-000000000000","last_modification_date":1544459404,"creation_date":1544459404,"members":"192.168.1.1-192.168.1.255,192.168.2.0/24,host.domain.com","description":null,"name":"Western Region","id":1}}}}}},"403":{"description":"Returned if you do not have permission to view the exclusion."},"404":{"description":"Returned if Tenable.io cannot find the specified exclusion."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update an exclusion","description":"Updates an exclusion.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exclusions-edit","tags":["Exclusions"],"parameters":[{"description":"The ID of the exclusion to update.","required":true,"name":"exclusion_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the exclusion."},"description":{"type":"string","description":"The description of the exclusion."},"members":{"type":"string","description":"The targets that you want excluded from scans. Specify multiple targets as a comma-separated string. Targets can be in the following formats:\n - an individual IPv4 address (192.168.1.1)\n - a range of IPv4 addresses (192.168.1.1-192.168.1.255)\n - CIDR notation (192.168.2.0/24)\n - a fully-qualified domain name (FQDN) (host.domain.com)"},"schedule":{"type":"object","description":"The schedule parameters for the exclusion.","properties":{"enabled":{"type":"boolean","description":"If `true`, the exclusion schedule is active."},"starttime":{"type":"string","description":"The start time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"endtime":{"type":"string","description":"The end time of the exclusion formatted as `YYYY-MM-DD HH:MM:SS`."},"timezone":{"type":"string","description":"The timezone for the exclusion as returned by [scans: timezones](/reference#scans-timezones)."},"rrules":{"type":"object","description":"The recurrence rules for the exclusion.","properties":{"freq":{"type":"string","description":"The frequency of the rule (ONETIME, DAILY, WEEKLY, MONTHLY, YEARLY)."},"interval":{"type":"integer","description":"The interval of the rule."},"byweekday":{"type":"string","description":"A comma-separated string of days to repeat a WEEKLY freq rule on (SU,MO,TU,WE,TH,FR, or SA)."},"bymonthday":{"type":"integer","description":"The day of the month to repeat a MONTHLY freq rule on."}}}}},"network_id":{"type":"string","description":"The ID of the network object associated with scanners where Tenable.io applies the exclusion. The default network ID is `00000000-0000-0000-0000-000000000000`. To determine the ID of a custom network, use the [GET /networks](/reference#networks-list) endpoint. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."}}}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully modifies the exclusion.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you do not have permission to modify the exclusion."},"404":{"description":"Returned if Tenable.io cannot find the specified exclusion."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to change the exclusion.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete an exclusion","description":"Deletes an exclusion.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exclusions-delete","tags":["Exclusions"],"parameters":[{"description":"The ID of the exclusion to delete.","required":true,"name":"exclusion_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deletes the exclusion.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you do not have permission to delete the exclusion."},"404":{"description":"Returned if Tenable.io cannot find the specified exclusion."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/vulns/export":{"post":{"summary":"Export vulnerabilities","description":"Exports vulnerabilities that match the request criteria. \n\n**Important!**\nFor more information on using this endpoint, see guidelines and limitations described in [Retrieve Vulnerability Data from Tenable.io](/docs/retrieve-vulnerability-data-from-tenableio).<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exports-vulns-request-export","tags":["Exports"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"num_assets":{"type":"integer","description":"The maximum number of vulnerabilities per exported chunk. Note that this number does not represent the number of assets per chunk. Instead, it is equal to the number of assets times the number of vulnerabilities on each asset. The range of supported chunk sizes is a minimum of 50 (the default size) to a maximum of 5,000. If you specify a value outside this range, the system uses the upper- or lower-bound value.","format":"int32"},"filters":{"type":"object","description":"Specifies filters for exported vulnerabilities. For example filters, see <a href=\"/docs/refine-vulnerability-export-requests\">Refine Vulnerability Export Requests</a>.","properties":{"cidr_range":{"description":"Restricts search for vulnerabilities to assets assigned an IP address within the specified CIDR range. For example, 0.0.0.0/0 restricts the search to 0.0.0.1 and 255.255.255.254.","type":"string"},"first_found":{"type":"integer","description":"Returns vulnerabilities that were first found between the specified date (in Unix time) and now.","format":"int64"},"last_found":{"type":"integer","description":"Returns vulnerabilities that were last found between the specified date (in Unix time) and now.","format":"int64"},"last_fixed":{"type":"integer","description":"Returns vulnerabilities that were fixed between the specified date (in Unix time) and now.","format":"int64"},"plugin_family":{"items":{"type":"string"},"description":"The plugin family of the exported vulnerabilities. This filter is case-sensitive. If your request omits this parameter, the export includes all vulnerabilities, regardless of plugin family. For a list of supported plugin family values, use the /plugins/families endpoint.","type":"array"},"network_id":{"type":"string","description":"The ID of the network object associated with scanners that detected the vulnerabilities you want to export. The default network ID is `00000000-0000-0000-0000-000000000000`. To determine the ID of a custom network, use the [GET /networks](/reference#networks-list) endpoint. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"severity":{"items":{"type":"string"},"description":"The severity of the vulnerabilities to include in the export. Defaults to all severity levels. The severity of a vulnerability is defined using the Common Vulnerability Scoring System (CVSS) base score. Supported array values are:\n - info—The vulnerability has a CVSS score of 0.\n - low—The vulnerability has a CVSS score between 0.1 and 3.9.\n - medium—The vulnerability has a CVSS score between 4.0 and 6.9.\n - high—The vulnerability has a CVSS score between 7.0 and 9.9.\n - critical—The vulnerability has a CVSS score of 10.0.","type":"array"},"since":{"type":"integer","description":"The start date (in Unix time) for the range of data you want to export. Use this filter in conjunction with the state filter as follows:\n - If the state filter is set to `open`, the export includes data for vulnerabilities that were first seen on or after the since date you specify.\n - If the state filter is set to `reopened`, the export includes data for vulnerabilities that were last seen on or after the since date you specify.\n - If the state filter is set to `fixed`, the export includes data for vulnerabilities that were fixed on or after the since date you specify.\n - If you do not include the state filter in your request, the export includes data for open vulnerabilities that were first seen on or after the since date you specify, AND reopened vulnerabilities that were last seen on or after the since date you specify.\n**Note:** This filter cannot be used in conjunction with the `first_found`, `last_found`, or `last_fixed` filters.","format":"int64"},"state":{"items":{"type":"string"},"description":"The state of the vulnerabilities you want the export to include. Supported, case-insensitive values are:\n - open—The vulnerability is currently present on a host.\n - reopened—The vulnerability was previously marked as fixed on a host, but has returned.\n - fixed—The vulnerability was present on a host, but is no longer detected.\n\nThis parameter is required if your request includes `first_found`, `last_found`, or `last_fixed` parameters. If your request omits this parameter, the export includes default states `open` and `reopened` only.","type":"array"},"tag.<category>":{"items":{"type":"string"},"description":"Returns vulnerabilities on assets with the specified asset tags. The filter is defined as \"tag\", a period (\".\"), and the tag category name. The value of the filter is an array of tag values. For more information about tags, see the <a href=\"https://docs.tenable.com/cloud/Content/Settings/TagFormatAndApplication.htm\" target=\"_blank\">Tenable.io Vulnerability Management User Guide</a>.","type":"array"},"vpr_score":{"description":"Returns vulnerabilities with the specified Vulnerability Priority Rating (VPR) score or scores. You can combine properties in this object to specify VPR ranges. For example, to export vulnerabilities greater than or equal to 9.0 but lesser than or equal to 9.9, the object would contain a `gte` property of 9.0 and an `lte` property of 9.9. \n\nFor more information about VPR, see <a href=\"https://docs.tenable.com/cloud/Content/Analysis/RiskMetrics.htm\" target=\"_blank\">Severity vs. VPR</a> in the <i>Tenable.io Vulnerability Management User Guide</i>.","type":"object","properties":{"eq":{"type":"array","items":{"type":"integer"},"description":"Returns vulnerabilities with a VPR equal to the specified score or scores. This property cannot be combined with the following range operators: `lt`, `gt`, `lte`, or `gte`."},"neq":{"type":"array","items":{"type":"integer"},"description":"Returns vulnerabilities with a VPR not equal to the specified score or scores. This property can be combined with the `eq` property."},"gt":{"type":"integer","description":"Returns vulnerabilities with a VPR greater than the specified score. This property cannot be combined with the `eq` property."},"gte":{"type":"integer","description":"Returns vulnerabilities with a VPR greater than or equal to the specified score. This property cannot be combined with the `eq` property."},"lt":{"type":"integer","description":"Returns vulnerabilities with a VPR lesser than the specified score. This property cannot be combined with the `eq` property."},"lte":{"type":"integer","description":"Returns vulnerabilities with a VPR lesser than or equal to the specified score. This property cannot be combined with the `eq` property."}}}}}},"required":["num_assets"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully queues an export request.","content":{"application/json":{"schema":{"type":"object","properties":{"export_uuid":{"type":"string","description":"The UUID of the vulnerabilities export job."}}},"examples":{"response":{"value":{"export_uuid":"73376c41-1508-46b7-8587-483d159cd956"}}}}}},"400":{"description":"Returned if your request message contains an invalid filter."},"403":{"description":"Returned if you do not have permission to export vulnerabilities."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/vulns/export/{export_uuid}/status":{"get":{"summary":"Get vulnerabilities export status","description":"Returns the status of a vulnerability export request. Tenable.io processes the chunks in parallel, so the chunks may not complete in order. <p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exports-vulns-export-status","tags":["Exports"],"parameters":[{"description":"The UUID for the export request.","required":true,"name":"export_uuid","in":"path","schema":{"type":"string","description":"The unique identifier of an export request. This value corresponds to the value returned in the <a href=\"#exports-vulns-request-export\">/vulns/export</a> response message."}}],"responses":{"200":{"description":"Returns the status of the specified export job.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The status of the export request. Possible values include:\n - QUEUED—Tenable.io has queued the export request until it completes other requests currently in process.\n - PROCESSING—Tenable.io has started processing the export request.\n - FINISHED—Tenable.io has completed processing the export request. The list of chunks is complete.\n - CANCELLED—An administrator has cancelled the export request.\n - ERROR—Tenable.io encountered an error while processing the export request. Tenable recommends that you retry the request. If the status persists on retry, contact Support."},"chunks_available":{"type":"array","description":"A list of completed chunks available for download.","items":{"type":"integer","format":"int32"}},"chunks_failed":{"type":"array","description":"A list of chunks for which the export process failed. If a chunk fails processing, submit the export request again. If the chunk continues to fail, contact Support.","items":{"type":"integer","format":"int32"}},"chunks_cancelled":{"type":"array","description":"A list of chunks for which the export process was cancelled. If a chunk fails processing, Tenable.io automatically cancels all subsequent chunks queued for export in the same request. ","items":{"type":"integer","format":"int32"}}}},"examples":{"response":{"value":{"status":"PROCESSING","chunks_available":[1,2,3,4,5,6,8],"chunks_failed":[],"chunks_cancelled":[]}}}}}},"403":{"description":"Returned if you do not have permission to view the export status."},"404":{"description":"Returned if Tenable.io cannot find an export job with the specified UUID."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/vulns/export/{export_uuid}/chunks/{chunk_id}":{"get":{"summary":"Download vulnerabilities chunk","description":"Downloads exported vulnerabilities chunk by ID as a JSON file. The response content type is `application/octet-stream`.\nChunks are available for download for up to 24 hours after they have been created. Tenable.io returns a 404 message for expired chunks.\nExport chunks do not include an attribute if that attribute is empty in the vulnerability record.<ul>A successful response message contains attributes that correspond CVSS codes; these codes are described fully in the following documents:<li>CVSSv2 codes in [A Complete Guide to the Common Vulnerability Scoring System, Version 2.0](https://www.first.org/cvss/v2/guide)</li><li>CVSSv3 codes in the [Common Vulnerability Scoring System v3.0: Specification Document](https://www.first.org/cvss/specification-document).</li><ul><br><p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exports-vulns-download-chunk","tags":["Exports"],"parameters":[{"description":"The UUID of the export request.","required":true,"name":"export_uuid","in":"path","schema":{"type":"string"}},{"description":"The ID of the chunk you want to export.","required":true,"name":"chunk_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if file is downloaded successfully.","content":{"application/json":{"schema":{"type":"object","description":"A chunk of vulnerabilities information.","properties":{"asset":{"type":"array","description":"Information about the asset where the scan detected the vulnerability.","items":{"type":"object","properties":{"agent_uuid":{"type":"string","description":"The UUID of the agent that performed the scan where the vulnerability was found."},"bios_uuid":{"type":"string","description":"The BIOS UUID of the asset where the vulnerability was found."},"device_type":{"type":"string","description":"The type of asset where the vulnerability was found."},"fqdn":{"type":"string","description":"The fully-qualified domain name of the asset where a scan found the vulnerability."},"hostname":{"type":"string","description":"The host name of the asset where a scan found the vulnerability."},"uuid":{"type":"string","description":"The UUID of the asset where a scan found the vulnerability."},"ipv6":{"type":"string","description":"The IPv6 address of the asset where a scan found the vulnerability."},"last_authenticated_results":{"type":"string","description":"The last date credentials were used successfully to scan the asset."},"last_unauthenticated_results":{"type":"string","description":"The last date when the asset was scanned without using credentials"},"mac_address":{"type":"string","description":"The MAC address of the asset where a scan found the vulnerability."},"netbios_name":{"type":"string","description":"The NETBIOS name of the asset where a scan found the vulnerability."},"netbios_workgroup":{"type":"string","description":"The NETBIOS workgroup of the asset where a scan found the vulnerability."},"operating_system":{"type":"string","description":"The operating system of the asset where a scan found the vulnerability."},"network_id":{"type":"string","description":"The ID of the network object associated with scanners that identified the asset. The default network ID is `00000000-0000-0000-0000-000000000000`. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"tracked":{"type":"boolean","description":"A value specifying whether Tenable.io tracks the asset in the asset management system. Tenable.io still assigns untracked assets identifiers in scan results, but these identifiers change with each new scan of the asset. This parameter is relevant to PCI-type scans and in certain cases where there is not enough information in a scan to identify the asset. Untracked assets appear in the scan history, but do not appear in workbenches or reports."}}}},"output":{"type":"string","description":"The text output of the Nessus scanner."},"plugin":{"type":"array","description":"Information about the plugin that detected the vulnerability.","items":{"type":"object","properties":{"bid":{"type":"integer","description":"The Bugtraq ID for the plugin."},"canvas_package":{"type":"string","description":"The name of the CANVAS exploit pack that includes the vulnerability."},"checks_for_default_account":{"type":"boolean","description":"A value specifying whether the plugin checks for default accounts."},"checks_for_malware":{"type":"boolean","description":"A value specifying whether the plugin checks for malware."},"cpe":{"type":"string","description":"The Common Platform Enumeration (CPE) number for the plugin."},"cve":{"type":"string","description":"The Common Vulnerability and Exposure (CVE) ID for the plugin."},"cvss3_base_score":{"type":"string","description":"The CVSSv3 base score (intrinsic and fundamental characteristics of a vulnerability that are constant over time and user environments)."},"cvss3_temporal_score":{"type":"string","description":"The CVSSv3 temporal score (characteristics of a vulnerability that change over time but not among user environments)."},"cvss3_temporal_vector":{"type":"array","description":"CVSSv3 temporal metrics for the vulnerability.","items":{"type":"object","properties":{"Exploitability":{"type":"string","description":"The CVSSv2 Exploit Maturity Code (E) for the vulnerability the plugin covers. Possible values include: \n - Unproven—Corresponds to the Unproven (U) value for the E metric\n - Proof-of-concept—Corresponds to the Proof-of-Concept (POC) value for the E metric\n - Functional—Corresponds to the Functional (F) value for the E metric\n - High—Corresponds to the High (H) value for the E metric\n - Not-defined—Corresponds to the Not Defined (ND) value for the E metric"},"RemediationLevel":{"type":"string","description":"The CVSSv3 Remediation Level (RL) temporal metric for the vulnerability the plugin covers. Possible values include: \n - O—Official Fix\n - T—Temporary Fix\n - W—Workaround\n - U—Unavailable\n - X—Not Defined"},"ReportConfidence":{"type":"string","description":"The CVSSv3 Report Confidence (RC) temporal metric for the vulnerability the plugin covers. Possible values include: \n - U—Unknown\n - R—Reasonable\n - C—Confirmed\n - X—Not Defined"}}}},"cvss3_vector":{"type":"array","description":"Additional CVSSv3 metrics for the vulnerability.","items":{"type":"object","properties":{"AccessComplexity":{"type":"string","description":"The CVSSv3 Access Complexity (AC) metric for the vulnerability the plugin covers. Possible values include: \n - H—High\n - M—Medium\n - L—Low"},"AccessVector":{"type":"string","description":"The CVSSv2 Attack Vector (AV) metric for the vulnerability the plugin covers. Possible values include:\n - Network—Corresponds to the Network (N) value for the AV metric. \n - Adjacent Network—Corresponds to the Adjacent Network (A) value for the AV metric. \n - Local—Corresponds to the Local (L) value for the AV metric"},"Authentication":{"type":"string","description":"The CVSSv2 Authentication (Au) metric for the vulnerability the plugin covers. Possible values include:\n - None required—Corresponds to the None (N) value for the Au metric. \n - Requires-single-instance—Corresponds to the Single (S) value for the Au metric. \n - Requires-multiple-instances—Corresponds to the Multiple (M) value for the Au metric"},"Availability-Impact":{"type":"string","description":"The CVSSv2 availability impact metric for the vulnerability the plugin covers. Possible values include: \n - H—High\n - L—Low\n - N—None"},"Confidentiality-Impact":{"type":"string","description":"The CVSSv3 confidentiality impact metric of the vulnerability the plugin covers to the vulnerable component. Possible values include: \n - H—High\n - L—Low\n - N—None"},"Integrity-Impact":{"type":"string","description":"The CVSSv3 integrity impact metric for the vulnerability the plugin covers. Possible values include:\n - H—High\n - L—Low\n - N—None"}}}},"cvss_base_score":{"type":"string","description":"The CVSSv2 base score (intrinsic and fundamental characteristics of a vulnerability that are constant over time and user environments)."},"cvss_temporal_score":{"type":"string","description":"The CVSSv2 temporal score (characteristics of a vulnerability that change over time but not among user environments)."},"cvss_temporal_vector":{"type":"array","description":"CVSSv2 temporal metrics for the vulnerability.","items":{"type":"object","properties":{"Exploitability":{"type":"string","description":"The CVSSv2 Exploitability (E) temporal metric for the vulnerability the plugin covers. Possible values include:\n - U—Unproven\n - POC—Proof-of-Concept\n - F—Functional\n - H—High\n - ND—Not Defined"},"RemediationLevel":{"type":"string","description":"The CVSSv2 Remediation Level (RL) temporal metric for the vulnerability the plugin covers. Possible values include: \n - OF—Official Fix\n - TF—Temporary Fix\n - W—Workaround\n - U—Unavailable\n - ND—Not Defined"},"ReportConfidence":{"type":"string","description":"The CVSSv2 Report Confidence (RC) temporal metric for the vulnerability the plugin covers. Possible values include: \n - UC—Unconfirmed\n - UR—Uncorroborated\n - C—Confirmed\n - ND—Not Defined"}}}},"cvss_vector":{"type":"array","description":"Additional CVSSv2 metrics for the vulnerability.","items":{"type":"object","properties":{"AccessComplexity":{"type":"string","description":"The CVSSv2 Access Complexity (AC) metric for the vulnerability the plugin covers. Possible values include:\n - H—High\n - M—Medium\n - L—Low"},"AccessVector":{"type":"string","description":"The CVSSv2 Access Vector (AV) metric for the vulnerability the plugin covers. Possible values include: \n - L—Local\n - A—Adjacent Network\n - N—Network"},"Authentication":{"type":"string","description":"The CVSSv2 Authentication (Au) metric for the vulnerability the plugin covers. Possible values include: \n - N—None\n - S—Single\n - M—Multiple"},"Availability-Impact":{"type":"string","description":"The CVSSv2 availability impact metric for the vulnerability the plugin covers. Possible values include: \n - N—None\n - P—Partial\n - C—Complete"},"Confidentiality-Impact":{"type":"string","description":"The CVSSv2 confidentiality impact metric for the vulnerability the plugin covers. Possible values include: \n - N—None\n - P—Partial\n - C—Complete"},"Integrity-Impact":{"type":"string","description":"The CVSSv2 integrity impact metric for the vulnerability the plugin covers. Possible values include: \n - N—None\n - P—Partial\n - C—Complete"}}}},"d2_elliot_name":{"type":"string","description":"The name of the exploit in the D2 Elliot Web Exploitation framework."},"description":{"type":"string","description":"Full text description of the vulnerability."},"exploit_available":{"type":"boolean","description":"A value specifying whether a public exploit exists for the vulnerability."},"exploit_framework_canvas":{"type":"boolean","description":"A value specifying whether an exploit exists in the Immunity CANVAS framework."},"exploit_framework_core":{"type":"boolean","description":"A value specifying whether  an exploit exists in the CORE Impact framework."},"exploit_framework_d2_elliot":{"type":"boolean","description":"A value specifying whether  an exploit exists in the D2 Elliot Web Exploitation framework."},"exploit_framework_exploithub":{"type":"boolean","description":"A value specifying whether  an exploit exists in the ExploitHub framework."},"exploit_framework_metasploit":{"type":"boolean","description":"A value specifying whether  an exploit exists in the Metasploit framework."},"exploitability_ease":{"type":"string","description":"Description of how easy it is to exploit the issue."},"exploited_by_malware":{"type":"boolean","description":"The vulnerability discovered by this plugin is known to be exploited by malware."},"exploited_by_nessus":{"type":"boolean","description":"A value specifying whether Nessus exploited the vulnerability during the process of identification."},"exploithub_sku":{"type":"string","description":"The SKU number of the exploit in the ExploitHub framework."},"family":{"type":"string","description":"The family to which plugin belongs."},"family_id":{"type":"integer","description":"The ID of the plugin family."},"has_patch":{"type":"boolean","description":"A value specifying whether the vendor has published a patch for the vulnerability."},"id":{"type":"integer","description":"The ID of the plugin that identified the vulnerability."},"in_the_news":{"type":"boolean","description":"A value specifying whether this plugin has received media attention (for example, ShellShock, Meltdown)."},"metasploit_name":{"type":"string","description":"The name of the related exploit in the Metasploit framework."},"ms_bulletin":{"type":"string","description":"The Microsoft security bulletin that the plugin covers."},"name":{"type":"string","description":"The name of the plugin that identified the vulnerability."},"patch_publication_date":{"type":"string","description":"The date on which the vendor published a patch for the vulnerability."},"modification_date":{"type":"string","description":"The date on which the plugin was last modified."},"publication_date":{"type":"string","description":"The date on which the plugin was published."},"risk_factor":{"type":"string","description":"The risk factor associated with the plugin. Possible values are: Low, Medium, High, or Critical."},"see_also":{"type":"string","description":"Links to external websites that contain helpful information about the vulnerability."},"solution":{"type":"string","description":"Remediation information for the vulnerability."},"stig_severity":{"type":"string","description":"Security Technical Implementation Guide (STIG) severity code for the vulnerability."},"synopsis":{"type":"string","description":"Brief description of the plugin or vulnerability."},"type":{"type":"string","description":"The general type of plugin check (for example, `local` or `remote`)."},"unsupported_by_vendor":{"type":"boolean","description":"Software found by this plugin is unsupported by the software's vendor (for example, Windows 95 or Firefox 3)."},"usn":{"type":"string","description":"Ubuntu security notice that the plugin covers."},"version":{"type":"string","description":"The version of the plugin used to perform the check."},"vuln_publication_date":{"type":"string","description":"The publication date of the plugin."},"xrefs":{"type":"string","description":"External references (for example, OSVDB, Secunia, or MS Advisory)."},"vpr":{"type":"object","description":"Information about the Vulnerability Priority Rating (VPR) for the vulnerability.","properties":{"score":{"type":"integer","description":"The Vulnerability Priority Rating (VPR) for the vulnerability. If a plugin is designed to detect multiple vulnerabilities, the VPR represents the highest value calculated for a vulnerability associated with the plugin. For more information, see <a href=\"https://docs.tenable.com/cloud/Content/Analysis/RiskMetrics.htm\" target=\"_blank\">Severity vs. VPR</a> in the <i>Tenable.io Vulnerability Management User Guide</i>.","format":"int32"},"drivers":{"type":"object","description":"The key drivers Tenable uses to calculate a vulnerability's VPR. For more information, see <a href=\"/docs/vpr-drivers-tio\">Vulnerability Priority Rating Drivers</a>.","properties":{}},"updated":{"type":"string","description":"The ISO timestamp when Tenable.io last imported the VPR for this vulnerability. Tenable.io imports a VPR value the first time you scan a vulnerability on your network. Then, Tenable.io automatically re-imports new and updated VPR values daily."}}}}}},"port":{"type":"array","description":"Information about the port the scanner used to connect to the asset.","items":{"type":"object","properties":{"port":{"type":"string","description":"The port the scanner used to communicate with the asset."},"protocol":{"type":"string","description":"The protocol the scanner used to communicate with the asset."},"service":{"type":"string","description":"The service the scanner used to communicate with the asset."}}}},"recast_reason":{"type":"string","description":"The text that appears in the Comment field of the recast rule in the Tenable.io user interface."},"recast_rule_uuid":{"type":"string","description":"The UUID of the recast rule that applies to the plugin."},"scan":{"type":"array","description":"Information about the latest scan that detected the vulnerability.","items":{"type":"object","properties":{"completed_at":{"type":"string","description":"The ISO timestamp when the scan completed."},"schedule_uuid":{"type":"string","description":"The schedule UUID for the scan that found the vulnerability."},"started_at":{"type":"string","description":"The ISO timestamp when the scan started."},"uuid":{"type":"string","description":"The UUID of the scan that found the vulnerability."}}}},"severity":{"type":"string","description":"The severity of the vulnerability as defined using the Common Vulnerability Scoring System (CVSS) base score. Possible values include `info` (CVSS score of 0), `low` (CVSS score between 0.1 and 3.9), `medium` (CVSS score between 4.0 and 6.9), `high` (CVSS score between 7.0 and 9.9), and `critical` (CVSS score of 10.0)."},"severity_id":{"type":"integer","format":"int32","description":"The code for the severity assigned when a user recast the risk associated with the vulnerability. Possible values include: \n - 0—The vulnerability has a CVSS score of 0, which corresponds to the \"info\" severity level.\n - 1—The vulnerability has a CVSS score between 0.1 and 3.9, which corresponds to the \"low\" severity level.\n - 2—The vulnerability has a CVSS score between 4.0 and 6.9, which corresponds to the \"medium\" severity level.\n - 3—The vulnerability has a CVSS score between 7.0 and 9.9, which corresponds to the \"high\" severity level.\n - 4—The vulnerability has a CVSS score of 10.0, which corresponds to the \"critical\" severity level."},"severity_default_id":{"type":"integer","format":"int32","description":"The code for the severity originally assigned to a vulnerability before a user recast the risk associated with the vulnerability. Possible values are the same as for the `severity_id` attribute."},"severity_modification_type":{"type":"string","description":"The type of modification a user made to the vulnerability's severity. Possible values include: \n - none—No modification has been made.\n - recasted—A user in the Tenable.io user interface has recast the risk associated with the vulnerability. \n - accepted—A user in the Tenable.io user interface has accepted the risk associated with the vulnerability. \n\nFor more information about recast and accept rules, see the <i>Tenable.io Vulnerability Management User Guide</i>."},"first_found":{"type":"string","description":"The ISO date when a scan first detected the vulnerability on the asset."},"last_fixed":{"type":"string","description":"The ISO date when a scan no longer detects the previously detected vulnerability on the asset."},"last_found":{"type":"string","description":"The ISO date when a scan last detected the vulnerability on the asset."},"state":{"type":"string","description":"The state of the vulnerability as determined by the Tenable.io state service. Possible values include: \n - open—The vulnerability is currently present on an asset. \n - reopened—The vulnerability was previously marked as fixed on an asset, but has been detected again by a new scan. \n - fixed—The vulnerability was present on an asset, but is no longer detected."}}},"examples":{"response":{"value":{"asset":{"fqdn":"example.com","hostname":"172.106.217.225","uuid":"150dee8f-6090-4a9c-907c-54a1c39ddab0","ipv4":"172.156.65.8","operating_system":["Apple Mac OS X 10.5.8"],"network_id":"00000000-0000-0000-0000-000000000000","tracked":true},"output":"The observed version of Google Chrome is : \n Chrome/21.0.1180.90","plugin":{"cve":["CVE-2016-1620","CVE-2016-1614","CVE-2016-1613","CVE-2016-1612","CVE-2016-1618","CVE-2016-1617","CVE-2016-1616","CVE-2016-1615","CVE-2016-1619"],"cvss_base_score":9.3,"cvss_temporal_score":6.9,"cvss_temporal_vector":{"exploitability":"Unproven","remediation_level":"Official-fix","report_confidence":"Confirmed","raw":"E:U/RL:OF/RC:C"},"cvss_vector":{"access_complexity":"Medium","access_vector":"Network","authentication":"None required","availability_impact":"Complete","confidentiality_impact":"Complete","integrity_impact":"Complete","raw":"AV:N/AC:M/Au:N/C:C/I:C/A:C"},"description":"The version of Google Chrome on the remote host is prior to 48.0.2564.82 and is affected by the following vulnerabilities: \n\n - An unspecified vulnerability exists in Google V8 when handling compatible receiver checks hidden behind receptors.  An attacker can exploit this to have an unspecified impact.  No other details are available. (CVE-2016-1612)\n - A use-after-free error exists in `PDFium` due to improper invalidation of `IPWL_FocusHandler` and `IPWL_Provider` upon destruction.  An attacker can exploit this to dereference already freed memory, resulting in the execution of arbitrary code. (CVE-2016-1613)\n - An unspecified vulnerability exists in `Blink` that is related to the handling of bitmaps.  An attacker can exploit this to access sensitive information.  No other details are available. (CVE-2016-1614)\n - An unspecified vulnerability exists in `omnibox` that is related to origin confusion.  An attacker can exploit this to have an unspecified impact.  No other details are available. (CVE-2016-1615)\n - An unspecified vulnerability exists that allows an attacker to spoof a displayed URL.  No other details are available. (CVE-2016-1616)\n - An unspecified vulnerability exists that is related to history sniffing with HSTS and CSP. No other details are available. (CVE-2016-1617)\n - A flaw exists in `Blink` due to the weak generation of random numbers by the ARC4-based random number generator.  An attacker can exploit this to gain access to sensitive information.  No other details are available. (CVE-2016-1618)\n - An out-of-bounds read error exists in `PDFium` in file `fx_codec_jpx_opj.cpp` in the `sycc4{22,44}_to_rgb()` functions. An attacker can exploit this to cause a denial of service by crashing the application linked using the library. (CVE-2016-1619)\n - Multiple vulnerabilities exist, the most serious of which allow an attacker to execute arbitrary code via a crafted web page. (CVE-2016-1620)\n - A flaw in `objects.cc` is triggered when handling cleared `WeakCells`, which may allow a context-dependent attacker to have an unspecified impact. No further details have been provided. (CVE-2016-2051)","family":"Web Clients","family_id":1000020,"has_patch":false,"id":9062,"name":"Google Chrome &lt; 48.0.2564.82 Multiple Vulnerabilities","risk_factor":"HIGH","see_also":["http://googlechromereleases.blogspot.com/2016/01/beta-channel-update_20.html"],"solution":"Update the Chrome browser to 48.0.2564.82 or later.","synopsis":"The remote host is utilizing a web browser that is affected by multiple vulnerabilities.","vpr":{"score":5.9,"drivers":{"age_of_vuln":{"lower_bound":366,"upper_bound":730},"exploit_code_maturity":"UNPROVEN","cvss_impact_score_predicted":false,"cvss3_impact_score":5.9,"threat_intensity_last28":"VERY_LOW","threat_sources_last28":["No recorded events"],"product_coverage":"LOW"},"updated":"2019-02-07T10:08:58Z"}},"port":{"port":0,"protocol":"TCP"},"scan":{"completed_at":"2018-05-23T20:59:47Z","schedule_uuid":"413765fb-e941-7eea-ca8b-0a79182a2806e1b6640fe8a2217b","started_at":"2018-05-23T20:59:47Z","uuid":"e2c070ae-ec37-d9ff-f003-2e89b7e5e1ab8af3a9957a077904"},"severity":"high","severity_id":3,"severity_default_id":3,"severity_modification_type":"NONE","first_found":"2018-05-23T20:59:47Z","last_found":"2018-05-23T20:59:47Z","state":"OPEN"}}}}}},"400":{"description":"Returned if the chunk ID is invalid or the chunk is not ready for download."},"403":{"description":"Returned if you do not have permission to export vulnerabilities."},"404":{"description":"Returned if Tenable.io cannot find a chunk with the specified UUID."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/vulns/export/{export_uuid}/cancel":{"post":{"summary":"Cancel vuln export","description":"Cancels the specified export job. If you cancel an export job, Tenable.io finishes any chunk that is currently processing, terminates the processing of any unprocessed chunks, and updates the job status to `CANCELLED`. If a cancelled job includes completed chunks, you can download those chunks for three days after cancellation. <p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exports-vulns-export-cancel","tags":["Exports"],"parameters":[{"description":"The UUID for the export request.","required":true,"name":"export_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully cancels the specified export request.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Text describing the export job status, `CANCELLED`."}}},"examples":{"response":{"value":{"status":"CANCELLED"}}}}}},"400":{"description":"Returned if Tenable.io cannot cancel the request."},"401":{"description":"Returned if Tenable.io cannot find an export job for the specified UUID."},"403":{"description":"Returned if you do not have permission to cancel export jobs."},"404":{"description":"Returned if Tenable.io cannot find an export with the specified UUID."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/vulns/export/status":{"get":{"summary":"Get vuln export jobs","description":"Retrieves a list of vulnerability export jobs. This list includes the 1,000 most recent export jobs regardless of status. However, this list includes completed jobs only if the job completed in the previous three days. <p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exports-vulns-export-status-recent","tags":["Exports"],"responses":{"200":{"description":"Returns a list of recent vulnerability export jobs.","content":{"application/json":{"schema":{"type":"object","properties":{"exports":{"type":"array","items":{"description":"Information about the export job.","type":"object","properties":{"uuid":{"type":"string","description":"The UUID for the export request."},"status":{"type":"string","description":"The status of the export request. Possible values include:\n - QUEUED—Tenable.io has queued the export request until it completes other requests currently in process.\n - PROCESSING—Tenable.io has started processing the export request.\n - FINISHED—Tenable.io has completed processing the export request. The list of chunks is complete.\n - CANCELLED—An administrator has cancelled the export request.\n - ERROR—Tenable.io encountered an error while processing the export request. Tenable recommends that you retry the request. If the status persists on retry, contact Support."},"chunks_available":{"type":"array","description":"A list of completed chunks available for download.","items":{"type":"integer"}},"total_chunks":{"type":"integer","description":"The total number of chunks associated with the export job as a whole."},"finished_chunks":{"type":"integer","description":"The number of chunks that have been processed and are available for download."},"filters":{"type":"object","description":"The filters used in the export job request. For a list of possible filters, see the [POST /vulns/export](/reference#exports-vulns-export-request-export) and [POST /assets/export](/reference#exports-assets-request-export) endpoints.","properties":{}},"num_assets_per_chunk":{"type":"integer","description":"The number of assets contained in each export chunk."},"created":{"type":"integer","description":"The Unix timestamp when the export job was created."}}}}}},"examples":{"response":{"value":{"exports":[{"uuid":"5174760d-c669-4185-b8ee-e99148be1a37","status":"FINISHED","total_chunks":0,"finished_chunks":0,"filters":{"state":["OPEN","REOPENED"],"tags":{},"cidr_range":"172.204.81.57/24","since":0,"first_found":0,"last_found":0,"last_fixed":0},"num_assets_per_chunk":0,"created":1566420439782},{"uuid":"9ec1b0d5-26f1-4078-9929-9eccd8a2e514","status":"FINISHED","total_chunks":5,"finished_chunks":5,"filters":{"since":0,"first_found":0,"last_found":0,"last_fixed":0},"num_assets_per_chunk":5,"created":1566418722831}]}}}}}},"400":{"description":"Returned if your request message is invalid."},"403":{"description":"Returned if you do not have permissions for the request."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/assets/export":{"post":{"summary":"Export assets","description":"Exports all assets that match the request criteria.\n\n**Important!**\nFor more information on using this endpoint, see guidelines and limitations described in [Retrieve Vulnerability Data from Tenable.io](/docs/retrieve-vulnerability-data-from-tenableio).<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exports-assets-request-export","tags":["Exports"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"chunk_size":{"type":"integer","description":"Specifies the number of assets per exported chunk. The range is 100-10000. If you specify a value outside of that range, Tenable.io returns a 400 error. Using smaller chunks size can improve performance.","format":"int32"},"filters":{"type":"object","description":"Specifies filters for exported assets. To return all assets, omit the filters object. If your request specifies multiple filters, the system combines the filters using the AND search operator.","properties":{"created_at":{"type":"integer","description":"Returns all assets created later than the date specified. The specified date must be in the Unix timestamp format.","format":"int64"},"updated_at":{"type":"integer","description":"Returns all assets updated later than the date specified. The specified date must be in the Unix timestamp format.","format":"int64"},"terminated_at":{"type":"integer","description":"Returns all assets terminated later than the date specified. The specified date must be in the Unix timestamp format.","format":"int64"},"deleted_at":{"type":"integer","description":"Returns all assets deleted later than the date specified. The specified date must in the Unix timestamp format.","format":"int64"},"first_scan_time":{"type":"integer","description":"Returns all assets with a first scan time later than the date specified. The specified date must be in the Unix timestamp format.","format":"int64"},"last_authenticated_scan_time":{"type":"integer","description":"Returns all assets with a last credentialed scan time later than the date specified. The specified date must be in the Unix timestamp format.","format":"int64"},"last_assessed":{"type":"integer","description":"Returns all assets with a last assessed time later than the date specified. Tenable.io considers an asset assessed if it has been scanned by a credentialed or non-credentialed scan. The specified date must be in the Unix timestamp format.","format":"int64"},"servicenow_sysid":{"type":"boolean","description":"If `true`, returns all assets that have a ServiceNow Sys ID, regardless of value. If `false`, returns all assets that do not have a ServiceNow Sys ID."},"sources":{"items":{"type":"string"},"description":"Returns assets that have the specified source. An asset source is the entity that reported the asset details. Sources can include sensors, connectors, and API imports. If your request specifies multiple sources, Tenable.io returns all assets that have been seen by any of the specified sources.\n\nThe items in the sources array must correspond to the names of the sources as defined in your organization's implementation of Tenable.io. Commonly used names include:\n - AWS—You obtained the asset data from an Amazon Web Services connector.\n - NESSUS_AGENT—You obtained the asset data obtained from a Nessus agent scan.\n - PVS—You obtained the asset data from a Nessus Network Monitor (NNM) scan.\n - NESSUS_SCAN—You obtained the asset data from a Nessus scan.\n - WAS—You obtained the asset data from a  Web Application Scanning scan.","type":"array"},"has_plugin_results":{"type":"boolean","description":"If `true`, Tenable.io returns all assets that have plugin results. If `false`, Tenable.io returns all assets that do not have plugin results. An asset may not have plugin results if the asset details originated from a connector, an API import, or a discovery scan, rather than a vulnerabilities scan."},"tag.<category>":{"type":"string","description":"Returns all assets with the specified tag. The filter is defined as \"tag\", a period (\".\"), and the tag category name. The value of the filter is the tag value. For more information about tags, see [Tenable.io Vulnerability Management User Guide](https://docs.tenable.com/cloud/Content/Settings/TagFormatAndApplication.htm)."},"network_id":{"type":"string","description":"The ID of the network object associated with scanners that identified the assets you want to export. The default network ID is `00000000-0000-0000-0000-000000000000`. To determine the ID of a custom network, use the [GET /networks](/reference#networks-list) endpoint. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."}}}},"required":["chunk_size"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully queues an export request.","content":{"application/json":{"schema":{"type":"object","properties":{"export_uuid":{"type":"string"}}},"examples":{"response":{"value":{"export_uuid":"5091ab8e-fb57-41d1-8166-9422f3b39aea"}}}}}},"400":{"description":"Returned if your request message contains any invalid filters or is itself invalid."},"403":{"description":"Returned if you do not have permission to export assets."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/assets/export/{export_uuid}/status":{"get":{"summary":"Get assets export status","description":"Returns the status of an assets export request. Tenable.io processes the chunks in parallel, so the chunks may not complete in order. <p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exports-assets-export-status","tags":["Exports"],"parameters":[{"description":"The UUID for the export request.","required":true,"name":"export_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the status of the specified export job.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The status of the export request. Possible values include:\n - QUEUED—Tenable.io has queued the export request until it completes other requests currently in process.\n - PROCESSING—Tenable.io has started processing the export request.\n - FINISHED—Tenable.io has completed processing the export request. The list of chunks is complete.\n - CANCELLED—An administrator has cancelled the export request.\n - ERROR—Tenable.io encountered an error while processing the export request. Tenable recommends that you retry the request. If the status persists on retry, contact Support."},"chunks_available":{"type":"array","description":"A comma-separated list of completed chunks available for download.","items":{"type":"integer","format":"int32"}}}},"examples":{"response":{"value":{"status":"FINISHED","chunks_available":[1,2,3,4]}}}}}},"403":{"description":"Returned if you do not have permission to view the export status."},"404":{"description":"Returned if Tenable.io cannot find an export with the specified UUID."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/assets/export/{export_uuid}/chunks/{chunk_id}":{"get":{"summary":"Download assets chunk","description":"Downloads exported assets chunk by ID. Tenable.io processes the chunks in parallel, so the chunks may not complete in order. Chunks are available for download for up to 24 hours after they have been created. Tenable.io returns a 404 message for expired chunks. <p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exports-assets-download-chunk","tags":["Exports"],"parameters":[{"description":"The UUID of the export request.","required":true,"name":"export_uuid","in":"path","schema":{"type":"string"}},{"description":"The ID of the asset chunk you want to export.","required":true,"name":"chunk_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the file is downloaded successfully. The response body excludes an attribute if the attribute is empty in the asset record.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the asset in Tenable.io."},"has_agent":{"type":"boolean","description":"Specifies whether a Nessus agent scan identified the asset."},"has_plugin_results":{"type":"boolean","description":"Specifies whether the asset has plugin results associated with it."},"created_at":{"type":"string","description":"The time and date when Tenable.io created the asset record."},"terminated_at":{"type":"string","description":"The time and date when a user terminated the Amazon Web Service (AWS) virtual machine instance of the asset."},"terminated_by":{"type":"string","description":"The user who terminated the AWS instance of the asset."},"updated_at":{"type":"string","description":"The time and date when the asset record was last updated."},"deleted_at":{"type":"string","description":"The time and date when a user deleted the asset record. When a user deletes an asset record, Tenable.io retains the record until the asset ages out of the license count."},"deleted_by":{"type":"string","description":"The user who deleted the asset record."},"first_seen":{"type":"string","description":"The time and date when a scan first identified the asset."},"last_seen":{"type":"string","description":"The time and date of the scan that most recently identified the asset."},"first_scan_time":{"type":"string","description":"The time and date of the first scan run against the asset."},"last_scan_time":{"type":"string","description":"The time and date of the last scan run against the asset."},"last_authenticated_scan_date":{"type":"string","description":"The time and date of the last credentialed scan run on the asset."},"last_licensed_scan_date":{"type":"string","description":"The time and date of the last scan that identified the asset as licensed. Tenable.io categorizes an asset as licensed if a scan of that asset has returned results from a non-discovery plugin within the last 90 days."},"azure_vm_id":{"type":"string","description":"The unique identifier of the Microsoft Azure virtual machine instance. For more information, see \"Accessing and Using Azure VM Unique ID\" in the Microsoft Azure documentation."},"azure_resource_id":{"type":"string","description":"The unique identifier of the resource in the Azure Resource Manager. For more information, see the Azure Resource Manager Documentation."},"gcp_project_id":{"type":"string","description":"The unique identifier of the virtual machine instance in Google Cloud Platform (GCP)."},"gcp_zone":{"type":"string","description":"The customized name of the project to which the virtual machine instance belongs in GCP. For more information see \"Creating and Managing Projects\" in the GCP documentation."},"gcp_instance_id":{"type":"string","description":"The zone where the virtual machine instance runs in GCP. For more information, see \"Regions and Zones\" in the GCP documentation."},"aws_ec2_instance_ami_id":{"type":"string","description":"The unique identifier of the Linux AMI image in Amazon Elastic Compute Cloud (Amazon EC2). For more information, see the Amazon Elastic Compute Cloud Documentation."},"aws_ec2_instance_id":{"type":"string","description":"The unique identifier of the Linux instance in Amazon EC2. For more information, see the Amazon Elastic Compute Cloud Documentation."},"agent_uuid":{"type":"string","description":"The unique identifier of the Nessus agent that identified the asset."},"bios_uuid":{"type":"string","description":"The BIOS UUID of the asset."},"network_id":{"type":"string","description":"The ID of the network object associated with scanners that identified the asset. The default network ID is `00000000-0000-0000-0000-000000000000`. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"network_name":{"type":"string","description":"The ID of the network object associated with scanners that identified the asset. The default network name is `Default`. All other network names are user-defined. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"aws_owner_id":{"type":"string","description":"The canonical user identifier for the AWS account associated with the virtual machine instance. For example, `79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be`. For more information, see AWS Account Identifiers in the AWS documentation."},"aws_availability_zone":{"type":"string","description":"The availability zone where Amazon Web Services hosts the virtual machine instance, for example, `us-east-1a``. Availability zones are subdivisions of AWS regions. For more information, see \"Regions and Availability Zones\" in the AWS documentation."},"aws_region":{"type":"string","description":"The region where AWS hosts the virtual machine instance, for example, `us-east-1`. For more information, see \"Regions and Availability Zones\" in the AWS documentation."},"aws_vpc_id":{"type":"string","description":"The unique identifier for the virtual public cloud that hosts the AWS virtual machine instance. For more information, see the Amazon Virtual Private Cloud User Guide."},"aws_ec2_instance_group_name":{"type":"string","description":"The virtual machine instance's group in AWS."},"aws_ec2_instance_state_name":{"type":"string","description":"The state of the virtual machine instance in AWS at the time of the scan."},"aws_ec2_instance_type":{"type":"string","description":"The type of instance in AWS EC2."},"aws_subnet_id":{"type":"string","description":"The unique identifier of the AWS subnet where the virtual machine instance was running at the time of the scan."},"aws_ec2_product_code":{"type":"string","description":"The product code associated with the AMI used to launch the virtual machine instance in AWS EC2."},"aws_ec2_name":{"type":"string","description":"The name of the virtual machine instance in AWS EC2."},"mcafee_epo_guid":{"type":"string","description":"The unique identifier of the asset in McAfee ePolicy Orchestrator (ePO). For more information, see the McAfee documentation."},"mcafee_epo_agent_guid":{"type":"string","description":"The unique identifier of the McAfee ePO agent that identified the asset. For more information, see the McAfee documentation."},"servicenow_sysid":{"type":"string","description":"The unique record identifier of the asset in ServiceNow. For more information, see the ServiceNow documentation."},"bigfix_asset_id":{"type":"string","description":"The unique identifiers of the asset in IBM BigFix. For more information, see the IBM BigFix documentation."},"agent_names":{"type":"array","description":"The names of any Nessus agents that scanned and identified the asset.","items":{"type":"string"}},"installed_software":{"type":"array","description":"A list of Common Platform Enumeration (CPE) values that represent software applications a scan identified as present on an asset. This attribute supports the CPE 2.2 format. For more information, see the \"Component Syntax\" section of the [CPE Specification, Version 2.2](https://cpe.mitre.org/files/cpe-specification_2.2.pdf). For assets identified in Tenable scans, this attribute contains data only if a scan using [Nessus Plugin ID 45590](https://www.tenable.com/plugins/nessus/45590) has evaluated the asset.\n\n**Note:** If no scan detects an application within 30 days of the scan that originally detected the application, Tenable.io considers the detection of that application expired. As a result, the next time a scan evaluates the asset, Tenable.io removes the expired application from the installed_software attribute. This activity is logged as a `remove` type of `attribute_change` update in the asset activity log.","items":{"type":"string"}},"ipv4s":{"type":"array","description":"The IPv4 addresses that scans have associated with the asset record.","items":{"type":"string"}},"ipv6s":{"type":"array","description":"The IPv6 addresses that scans have associated with the asset record.","items":{"type":"string"}},"fqdns":{"type":"array","description":"The fully-qualified domain names that scans have associated with the asset record.","items":{"type":"string"}},"mac_addresses":{"type":"array","description":"The MAC addresses that scans have associated with the asset record.","items":{"type":"string"}},"netbios_names":{"type":"array","description":"The NetBIOS names that scans have associated with the asset record.","items":{"type":"string"}},"operating_systems":{"type":"array","description":"The operating systems that scans have associated with the asset record.","items":{"type":"string"}},"system_types":{"type":"array","description":"The system types as reported by Plugin ID 54615. Possible values include `router`, `general-purpose`, `scan-host`, and `embedded`.","items":{"type":"string"}},"hostnames":{"type":"array","description":"The hostnames that scans have associated with the asset record.","items":{"type":"string"}},"ssh_fingerprints":{"type":"array","description":"The SSH key fingerprints that scans have associated with the asset record.","items":{"type":"string"}},"qualys_asset_ids":{"type":"array","description":"The Asset ID of the asset in Qualys. For more information, see the Qualys documentation.\n\n**Note:** Tenable is enabling Qualys asset import for customers in a rolling fashion. For more information, contact your Tenable representative.","items":{"type":"string"}},"qualys_host_ids":{"type":"array","description":"The Host ID of the asset in Qualys. For more information, see the Qualys documentation.\n\n**Note:** Tenable is enabling Qualys asset import for customers in a rolling fashion. For more information, contact your Tenable representative.","items":{"type":"string"}},"manufacturer_tpm_ids":{"type":"array","description":"The manufacturer's unique identifiers of the Trusted Platform Module (TPM) associated with the asset.","items":{"type":"string"}},"symantec_ep_hardware_keys":{"type":"array","description":"The hardware keys for the asset in Symantec Endpoint Protection.","items":{"type":"string"}},"sources":{"type":"array","description":"The sources of the scans that identified the asset.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity that reported the asset details. Sources can include sensors, connectors, and API imports. Source names can be customized by your organization (for example, you specify a name when you import asset records). If your organization does not customize source names, system-generated names include:\n - AWS—You obtained the asset data from an Amazon Web Services connector.\n - NESSUS_AGENT—You obtained the asset data obtained from a Nessus agent scan.\n - PVS—You obtained the asset data from a Nessus Network Monitor (NNM) scan.\n - NESSUS_SCAN—You obtained the asset data from a Nessus scan.\n - WAS—You obtained the asset data from a  Web Application Scanning scan."},"first_seen":{"type":"string","description":"The ISO timestamp when the source first reported the asset."},"last_seen":{"type":"string","description":"The ISO timestamp when the source last reported the asset."}}}},"tags":{"type":"array","description":"Category tags assigned to the asset in Tenable.io.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the tag."},"key":{"type":"string","description":"The tag category (the first half of the category:value pair)."},"value":{"type":"string","description":"The tag value (the second half of the category:value pair)."},"added_by":{"type":"string","description":"The UUID of the user who assigned the tag to the asset."},"added_at":{"type":"string","description":"The ISO timestamp when the tag was assigned to the asset."}}}},"network_interfaces":{"type":"array","description":"The network interfaces that scans identified on the asset.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the interface."},"mac_address":{"type":"array","description":"The MAC addresses of the interface.","items":{"type":"string"}},"ipv4":{"type":"array","description":"One or more IPv4 addresses belonging to the interface.","items":{"type":"string"}},"ipv6":{"type":"array","description":"One or more IPv6 addresses belonging to the interface.","items":{"type":"string"}},"fqdn":{"type":"array","description":"One or more FQDN belonging to the interface.","items":{"type":"string"}}}}}}},"examples":{"response":{"value":{"id":"60d5a1e7-aec0-45d3-b196-c2356b1567b9","has_agent":false,"has_plugin_results":true,"created_at":"2017-12-14T20:40:44.535Z","terminated_at":null,"terminated_by":null,"updated_at":"2018-02-23T22:27:58.599Z","deleted_at":null,"deleted_by":null,"first_seen":"2017-12-14T20:40:23.447Z","last_seen":"2018-02-23T22:27:52.869Z","first_scan_time":"2017-12-14T20:40:23.447Z","last_scan_time":"2018-02-23T22:27:52.869Z","last_authenticated_scan_date":null,"last_licensed_scan_date":"2018-02-23T22:27:52.869Z","azure_vm_id":null,"azure_resource_id":null,"gcp_project_id":null,"gcp_zone":null,"gcp_instance_id":null,"aws_ec2_instance_ami_id":null,"aws_ec2_instance_id":null,"agent_uuid":null,"bios_uuid":null,"aws_owner_id":null,"aws_availability_zone":null,"aws_region":null,"aws_vpc_id":null,"aws_ec2_instance_group_name":null,"aws_ec2_instance_state_name":null,"aws_ec2_instance_type":null,"aws_subnet_id":null,"aws_ec2_product_code":null,"aws_ec2_name":null,"mcafee_epo_guid":null,"mcafee_epo_agent_guid":null,"servicenow_sysid":null,"bigfix_asset_id":null,"agent_names":[],"installed_software":["cpe:/a:apple:itunes:12.8","cpe:/a:apple:quicktime:7.7.3","cpe:/a:openbsd:openssh:6.9","cpe:/a:google:chrome"],"ipv4s":["172.1.2.57"],"ipv6s":[],"fqdns":["172-1-2-57.lightspeed.hstntx.sbcglobal.net"],"mac_addresses":[],"netbios_names":[],"operating_systems":[],"system_types":[],"hostnames":[],"ssh_fingerprints":[],"qualys_asset_ids":[],"qualys_host_ids":[],"manufacturer_tpm_ids":[],"symantec_ep_hardware_keys":[],"sources":[{"name":"NESSUS_SCAN","first_seen":"2017-12-14T20:40:23.447Z","last_seen":"2018-02-23T22:27:52.869Z"}],"tags":[{"uuid":"6ee5761f-5c99-434b-aecb-e09b755921b7","key":"Geographic Area","value":"APAC","added_by":"e7ecb50b-1330-4a8c-b8e5-ee00ec8c46f8","added_at":"2018-02-13T14:53:13.817Z"}],"network_interfaces":[{"name":"enccw0.0.1234","mac_address":["00-00-5E-00-53-00","00-00-5E-00-53-FF"],"ipv4":["172.204.81.57","172.82.157.177"],"ipv6":["2001:DB8:1234:1234/32"],"fqdn":["example.com"]}]}}}}}},"400":{"description":"Returned if the chunk ID is invalid or the chunk is not ready for download."},"403":{"description":"Returned if you do not have permission to export assets."},"404":{"description":"Returned if Tenable.io cannot find a chunk with the specified UUID, or if the chunk with the specified UUID has expired."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/assets/export/{export_uuid}/cancel":{"post":{"summary":"Cancel asset export","description":"Cancels the specified export job. If you cancel an export job, Tenable.io finishes any chunk that is currently processing, terminates the processing of any unprocessed chunks, and updates the job status to `CANCELLED`. If a cancelled job includes completed chunks, you can download those chunks for three days after cancellation.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exports-assets-export-cancel","tags":["Exports"],"parameters":[{"description":"The UUID for the export request.","required":true,"name":"export_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully cancels the specified export request.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Text describing the export job status, `CANCELLED`."}}},"examples":{"response":{"value":{"status":"CANCELLED"}}}}}},"400":{"description":"Returned if your request message is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP error code."},"message":{"type":"string","description":"Text describing the error condition Tenable.io encountered. Possible values include:\n\n - Cannot cancel a completed job\n - Export UUID is invalid"}}},"examples":{"response":{"value":{"status":400,"message":"Cannot cancel a completed job"}}}}}},"404":{"description":"Returned if Tenable.io cannot find an export job with the specified UUID.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP error code."},"message":{"type":"string","description":"Text describing the error condition Tenable.io encountered."}}},"examples":{"response":{"value":{"status":404,"message":"Job with UUID: {export_uuid} not found"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/assets/export/status":{"get":{"summary":"Get asset export jobs","description":"Retrieves a list of asset export jobs. This list includes the 1,000 most recent export jobs regardless of status. However, this list includes completed jobs only if the job completed in the previous three days. <p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"exports-assets-export-status-recent","tags":["Exports"],"responses":{"200":{"description":"Returns a list of recent asset export jobs.","content":{"application/json":{"schema":{"type":"object","properties":{"exports":{"type":"array","items":{"description":"Information about the export job.","type":"object","properties":{"uuid":{"type":"string","description":"The UUID for the export request."},"status":{"type":"string","description":"The status of the export request. Possible values include:\n - QUEUED—Tenable.io has queued the export request until it completes other requests currently in process.\n - PROCESSING—Tenable.io has started processing the export request.\n - FINISHED—Tenable.io has completed processing the export request. The list of chunks is complete.\n - CANCELLED—An administrator has cancelled the export request.\n - ERROR—Tenable.io encountered an error while processing the export request. Tenable recommends that you retry the request. If the status persists on retry, contact Support."},"chunks_available":{"type":"array","description":"A list of completed chunks available for download.","items":{"type":"integer"}},"total_chunks":{"type":"integer","description":"The total number of chunks associated with the export job as a whole."},"finished_chunks":{"type":"integer","description":"The number of chunks that have been processed and are available for download."},"filters":{"type":"object","description":"The filters used in the export job request. For a list of possible filters, see the [POST /vulns/export](/reference#exports-vulns-export-request-export) and [POST /assets/export](/reference#exports-assets-request-export) endpoints.","properties":{}},"num_assets_per_chunk":{"type":"integer","description":"The number of assets contained in each export chunk."},"created":{"type":"integer","description":"The Unix timestamp when the export job was created."}}}}}},"examples":{"response":{"value":{"exports":[{"uuid":"9ec1b0d5-26f1-4079-9839-9eccf8a2e513","status":"FINISHED","filters":{"since":0,"first_found":0,"last_found":0,"last_fixed":0},"total_chunks":5,"finished_chunks":5,"num_assets_per_chunk":5,"created":1566418722831}]}}}}}},"400":{"description":"Returned if your request message is invalid."},"403":{"description":"Returned if you do not have permissions for the request."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/file/upload":{"post":{"summary":"Upload file","description":"Uploads a file.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"file-upload","tags":["File"],"parameters":[{"description":"Send value of `1` when uploading an encrypted file.","required":false,"name":"no_enc","in":"query","schema":{"type":"integer","format":"int32","enum":[0,1]}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"Filedata":{"type":"string","description":"The file to upload.","format":"binary"}}}}}},"responses":{"200":{"description":"Returns the name of the successfully uploaded file.","content":{"application/json":{"schema":{"type":"object","properties":{"fileuploaded":{"type":"string","description":"The name of the uploaded file. If the file with the same name already exists, Tenable.io appends an underscore with a number, for example scan-targets_1.txt. Use this attribute value when referencing the file for subsequent requests."}}},"examples":{"response":{"value":{"fileuploaded":"scan_targets.txt"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io cannot upload the file.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/filters/scans/agents":{"get":{"summary":"List agent filters","description":"Lists the filtering, sorting, and pagination capabilities available for agent records on endpoints that support them.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"filters-agents-filters","tags":["Filters"],"responses":{"200":{"description":"Returns the filtering, sorting, and pagination capabilities.","content":{"application/json":{"schema":{"type":"object","properties":{"wildcard_fields":{"description":"Array of strings which represent each field which supports \"wildcard\" search. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the supported fields' values matches against the filter string, then the record matches the wildcard filter. Note that for a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters.","type":"array","items":{"type":"string"}},"filters":{"type":"array","description":"A list of filters available for the record type.","items":{"type":"object","properties":{"name":{"type":"string","description":"The field name to be used in request query strings when applying the filter."},"readable_name":{"type":"string","description":"The filter's display label."},"control":{"type":"object","properties":{"readable_regex":{"type":"string","description":"Provides a human-readable \"hint\" which describes what the filter string should look like."},"type":{"type":"string","description":"The type of UI control which represents the filter."},"regex":{"type":"string","description":"A regex which can be used by a user interface to validate input."}}},"operators":{"description":"Strings which represent the comparison operations which can be used for the filter.","type":"array","items":{"type":"string"}}}}},"sort":{"type":"object","description":"The sorting parameters supported for data returned by the endpoint.","properties":{"max_sort_fields":{"type":"integer","description":"Maximum number of fields that may be specified for sorting. If this is parameter is not present, any number of fields may be used."},"sortable_fields":{"description":"Fields by which the returned list of records may be sorted.","type":"array","items":{"type":"string"}}}}}},"examples":{"response":{"value":{"wildcard_fields":["core_version","distro","groups"],"filters":[{"name":"core_version","readable_name":"Version","operators":["eq","neq","match","nmatch"],"control":{"readable_regex":"X.Y.Z","type":"entry","regex":".*"}},{"name":"distro","readable_name":"Distro","operators":["match","nmatch"],"control":{"readable_regex":"Distro Name (e.g. es7-x86-64)","type":"entry","regex":".*"}},{"name":"groups","readable_name":"Member of Group","operators":["eq","neq"],"control":{"type":"dropdown","list":[{"name":"None","id":-1},{"name":"slibs","id":106592}]}}],"sort":{"sortable_fields":["core_version","distro","ip","last_connect","last_scanned","name","platform","plugin_feed_id"]}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/filters/workbenches/assets":{"get":{"summary":"List asset filters","description":"Lists the filtering, sorting, and pagination capabilities available for assets on endpoints that support them. For more information about these filters, see [Workbench Filters](/docs/workbench-filters].<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"filters-assets-filter","tags":["Filters"],"responses":{"200":{"description":"Returns the filtering, sorting, and pagination capabilities.","content":{"application/json":{"schema":{"type":"object","properties":{"wildcard_fields":{"description":"Array of strings which represent each field which supports \"wildcard\" search. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the supported fields' values matches against the filter string, then the record matches the wildcard filter. Note that for a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters.","type":"array","items":{"type":"string"}},"filters":{"type":"array","description":"A list of filters available for the record type.","items":{"type":"object","properties":{"name":{"type":"string","description":"The field name to be used in request query strings when applying the filter."},"readable_name":{"type":"string","description":"The filter's display label."},"control":{"type":"object","properties":{"readable_regex":{"type":"string","description":"Provides a human-readable \"hint\" which describes what the filter string should look like."},"type":{"type":"string","description":"The type of UI control which represents the filter."},"regex":{"type":"string","description":"A regex which can be used by a user interface to validate input."}}},"operators":{"description":"Strings which represent the comparison operations which can be used for the filter.","type":"array","items":{"type":"string"}}}}},"sort":{"type":"object","description":"The sorting parameters supported for data returned by the endpoint.","properties":{"max_sort_fields":{"type":"integer","description":"Maximum number of fields that may be specified for sorting. If this is parameter is not present, any number of fields may be used."},"sortable_fields":{"description":"Fields by which the returned list of records may be sorted.","type":"array","items":{"type":"string"}}}}}},"examples":{"response":{"value":{"filters":[{"control":{"list":[{"name":"AWS Connector","value":"AWS"},{"name":"Agent","value":"NESSUS_AGENT"},{"name":"Microsoft Azure","value":"AZURE"},{"name":"NNM","value":"PVS"},{"name":"Nessus","value":"NESSUS_SCAN"},{"name":"Qualys Connector","value":"QUALYS"},{"name":"Web Application Scan","value":"WAS"}],"type":"dropdown_multi"},"name":"sources","operators":["set-has","set-hasnot","set-hasonly"],"readable_name":"Source"},{"control":{"list":["true","false"],"type":"dropdown"},"name":"belongs_to_access_group","operators":["eq"],"readable_name":"Belongs to Access Group"},{"control":{"list":[{"name":"Headquarters","value":"Headquarters"},{"name":"Los Angeles","value":"Los Angeles"},{"name":"New York","value":"New York"}],"type":"dropdown_multi"},"name":"tag.Location","operators":["set-has","set-hasnot"],"readable_name":"Location"}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/filters/workbenches/vulnerabilities":{"get":{"summary":"List vulnerability filters","description":"Returns the filters available for the Vulnerabilities Workbench. For more information about these filters, see [Workbench Filters](/docs/workbench-filters].<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-vulnerabilities-filters","tags":["Filters"],"responses":{"200":{"description":"Returns the filters object.","content":{"application/json":{"schema":{"type":"object","properties":{"wildcard_fields":{"description":"Array of strings which represent each field which supports \"wildcard\" search. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the supported fields' values matches against the filter string, then the record matches the wildcard filter. Note that for a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters.","type":"array","items":{"type":"string"}},"filters":{"type":"array","description":"A list of filters available for the record type.","items":{"type":"object","properties":{"name":{"type":"string","description":"The field name to be used in request query strings when applying the filter."},"readable_name":{"type":"string","description":"The filter's display label."},"control":{"type":"object","properties":{"readable_regex":{"type":"string","description":"Provides a human-readable \"hint\" which describes what the filter string should look like."},"type":{"type":"string","description":"The type of UI control which represents the filter."},"regex":{"type":"string","description":"A regex which can be used by a user interface to validate input."}}},"operators":{"description":"Strings which represent the comparison operations which can be used for the filter.","type":"array","items":{"type":"string"}}}}},"sort":{"type":"object","description":"The sorting parameters supported for data returned by the endpoint.","properties":{"max_sort_fields":{"type":"integer","description":"Maximum number of fields that may be specified for sorting. If this is parameter is not present, any number of fields may be used."},"sortable_fields":{"description":"Fields by which the returned list of records may be sorted.","type":"array","items":{"type":"string"}}}}}},"examples":{"response":{"value":{"filters":[{"name":"host.id","readable_name":"Asset ID","control":{"type":"entry","regex":"[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}(,[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})*","readable_regex":"01234567-abcd-ef01-2345-6789abcdef01"},"operators":["eq","neq","match","nmatch"],"group_name":null},{"name":"plugin.attributes.bid","readable_name":"Bugtraq ID","control":{"type":"entry","regex":"^[0-9]+(,[0-9]+)*","readable_regex":"NUMBER","maxlength":18},"operators":["eq","neq","match","nmatch"],"group_name":null},{"name":"plugin.attributes.exploit_framework_canvas","readable_name":"CANVAS Exploit Framework","control":{"type":"dropdown","list":["true","false"]},"operators":["eq","neq"],"group_name":null}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/filters/credentials":{"get":{"summary":"List credential filters","description":"Returns the filtering, sorting, and pagination capabilities available for scan credentials on endpoints that support them. <p>Requires BASIC (16) user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"credentials-filters","tags":["Filters"],"responses":{"200":{"description":"Returns the filtering, sorting, and pagination capabilities for scan credentials.","content":{"application/json":{"schema":{"type":"object","properties":{"wildcard_fields":{"description":"Array of strings which represent each field which supports \"wildcard\" search. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the supported fields' values matches against the filter string, then the record matches the wildcard filter. Note that for a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters.","type":"array","items":{"type":"string"}},"filters":{"type":"array","description":"A list of filters available for the record type.","items":{"type":"object","properties":{"name":{"type":"string","description":"The field name to be used in request query strings when applying the filter."},"readable_name":{"type":"string","description":"The filter's display label."},"control":{"type":"object","properties":{"readable_regex":{"type":"string","description":"Provides a human-readable \"hint\" which describes what the filter string should look like."},"type":{"type":"string","description":"The type of UI control which represents the filter."},"regex":{"type":"string","description":"A regex which can be used by a user interface to validate input."}}},"operators":{"description":"Strings which represent the comparison operations which can be used for the filter.","type":"array","items":{"type":"string"}}}}},"sort":{"type":"object","description":"The sorting parameters supported for data returned by the endpoint.","properties":{"max_sort_fields":{"type":"integer","description":"Maximum number of fields that may be specified for sorting. If this is parameter is not present, any number of fields may be used."},"sortable_fields":{"description":"Fields by which the returned list of records may be sorted.","type":"array","items":{"type":"string"}}}}}},"examples":{"response":{"value":{"wildcard_fields":["name","description","type"],"filters":[{"name":"name","readable_name":"Credential Name","control":{"readable_regex":"TEXT","type":"entry","regex":".*"},"operators":["eq","neq","match","nmatch"]},{"name":"type","readable_name":"Credential Type","control":{"type":"dropdown_multi","list":[{"id":"Windows","name":"Windows"}]},"operators":["eq","neq"]},{"name":"created_date","readable_name":"Created Date","control":{"type":"datefield","regex":"^[0-9]{4}/[0-9]{2}/[0-9]{2}$","readable_regex":"YYYY/MM/DD"},"operators":["date-lt","date-gt","date-eq","date-neq"]}],"sort":{"sortable_fields":["name","type","created_date"]}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/filters/scans/reports":{"get":{"summary":"List scan filters","description":"Lists the filtering, sorting, and pagination capabilities available for scan records on endpoints that support them.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"filters-scan-filters","tags":["Filters"],"responses":{"200":{"description":"Returns the filtering, sorting, and pagination capabilities.","content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","description":"A list of filters available for the record type.","items":{"type":"object","properties":{"name":{"type":"string","description":"The field name to be used in request query strings when applying the filter."},"readable_name":{"type":"string","description":"The filter's display label."},"control":{"type":"object","properties":{"readable_regex":{"type":"string","description":"Provides a human-readable \"hint\" which describes what the filter string should look like."},"type":{"type":"string","description":"The type of UI control which represents the filter."},"regex":{"type":"string","description":"A regex which can be used by a user interface to validate input."}}},"operators":{"description":"Strings which represent the comparison operations which can be used for the filter.","type":"array","items":{"type":"string"}}}}}}},"examples":{"response":{"value":{"filters":[{"name":"host.id","readable_name":"Asset ID","control":{"type":"entry","regex":"[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}(,[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})*","readable_regex":"01234567-abcd-ef01-2345-6789abcdef01"},"operators":["eq","neq","match","nmatch"],"group_name":null},{"name":"plugin.attributes.exploit_framework_canvas","readable_name":"CANVAS Exploit Framework","control":{"type":"dropdown","list":["true","false"]},"operators":["eq","neq"],"group_name":null},{"name":"plugin.name","readable_name":"Plugin Name","control":{"type":"entry","regex":".*","readable_regex":"TEXT"},"operators":["eq","neq","match","nmatch"],"group_name":null}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/filters/scans/reports/history":{"get":{"summary":"List scan history filters","description":"Lists the filtering, sorting, and pagination capabilities available for scan history records on endpoints that support them.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"filters-scan-history-filters","tags":["Filters"],"responses":{"200":{"description":"Returns the filtering, sorting, and pagination capabilities.","content":{"application/json":{"schema":{"type":"object","properties":{"wildcard_fields":{"description":"Array of strings which represent each field which supports \"wildcard\" search. Wildcard search is a mechanism where multiple fields of a record are filtered against one specific filter string. If any one of the supported fields' values matches against the filter string, then the record matches the wildcard filter. Note that for a record to be returned, it must pass the wildcard filter (if there is one) AND the set of standard filters.","type":"array","items":{"type":"string"}},"filters":{"type":"array","description":"A list of filters available for the record type.","items":{"type":"object","properties":{"name":{"type":"string","description":"The field name to be used in request query strings when applying the filter."},"readable_name":{"type":"string","description":"The filter's display label."},"control":{"type":"object","properties":{"readable_regex":{"type":"string","description":"Provides a human-readable \"hint\" which describes what the filter string should look like."},"type":{"type":"string","description":"The type of UI control which represents the filter."},"regex":{"type":"string","description":"A regex which can be used by a user interface to validate input."}}},"operators":{"description":"Strings which represent the comparison operations which can be used for the filter.","type":"array","items":{"type":"string"}}}}},"sort":{"type":"object","description":"The sorting parameters supported for data returned by the endpoint.","properties":{"max_sort_fields":{"type":"integer","description":"Maximum number of fields that may be specified for sorting. If this is parameter is not present, any number of fields may be used."},"sortable_fields":{"description":"Fields by which the returned list of records may be sorted.","type":"array","items":{"type":"string"}}}}}},"examples":{"response":{"value":{"wildcard_fields":[],"filters":[{"name":"start_date","readable_name":"Start Date","operators":["date-gt","date-lt","date-eq","date-neq"],"control":{"readable_regex":"YYYY/MM/DD","type":"datefield","regex":"^[0-9]{4}/[0-9]{2}/[0-9]{2}$"}},{"name":"end_date","readable_name":"End Date","operators":["date-gt","date-lt","date-eq","date-neq"],"control":{"readable_regex":"YYYY/MM/DD","type":"datefield","regex":"^[0-9]{4}/[0-9]{2}/[0-9]{2}$"}},{"name":"status","readable_name":"Scan Status","operators":["eq","neq","nmatch","match"],"control":{"readable_regex":"TEXT","type":"entry","regex":".*"}}],"sort":{"sortable_fields":["start_date","end_date","status"]}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/folders":{"post":{"summary":"Create folder","description":"Creates a new folder for the current user.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"folders-create","tags":["Folders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the folder.\n**Note:** Tenable.io does not allow the following special characters in folder names: `( ) [ ] : ; = + / |  ? , ^ % & $`"}},"required":["name"]}}}},"responses":{"200":{"description":"Returns the new folder ID.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the created folder."}}},"examples":{"response":{"value":{"id":55}}}}}},"400":{"description":"Returned if the folder name is invalid."},"403":{"description":"Returned if you do not have permission to create a folder."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to create the folder.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List folders","description":"Lists the current user's scan folders.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"folders-list","tags":["Folders"],"responses":{"200":{"description":"Returns the folder list.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the folder."},"name":{"type":"string","description":"The name of the folder."},"type":{"type":"string","description":"The type of the folder (main, trash, custom)."},"default_tag":{"type":"integer","description":"Whether or not the folder is the default (1 or 0)."},"custom":{"type":"integer","description":"The custom status of the folder (1 or 0)."},"unread_count":{"type":"integer","description":"The number of unread scans in the folder."}}}},"examples":{"response":{"value":{"folders":[{"unread_count":0,"custom":0,"default_tag":0,"type":"trash","name":"Trash","id":18},{"unread_count":6,"custom":0,"default_tag":1,"type":"main","name":"My Scans","id":19},{"unread_count":0,"custom":1,"default_tag":0,"type":"custom","name":"Linux Scans","id":50},{"unread_count":0,"custom":1,"default_tag":0,"type":"custom","name":"Daily Scans","id":55}]}}}}}},"403":{"description":"Returned if you do not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/folders/{folder_id}":{"put":{"summary":"Rename folder","description":"Renames a folder for the current user.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"folders-edit","tags":["Folders"],"parameters":[{"description":"The ID of the folder to edit.","required":true,"name":"folder_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the folder.\n**Note:** Tenable.io does not allow the following special characters in folder names: `( ) [ ] : ; = + / |  ? , ^ % & $`"}},"required":["name"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully renames the folder.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you attempt to rename a system folder."},"404":{"description":"Returned if Tenable.io cannot find the specified folder."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to rename the folder.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete folder","description":"Deletes a folder.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"folders-delete","tags":["Folders"],"parameters":[{"description":"The ID of the folder to delete.","required":true,"name":"folder_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deletes the folder.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you attempt to delete a system folder."},"404":{"description":"Returned if Tenable.io cannot find the specified folder."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to delete the folder.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/networks":{"post":{"summary":"Create network","description":"Creates a network object that you associate with scanners and scanner groups. \n\n**Note:** You cannot add AWS assets to network objects. For AWS assets, use the network segmentation provided by AWS instead.<p>Requires ADMINISTRATOR [64] user permissions.</p>","operationId":"networks-create","tags":["Networks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the network object. This name must be unique within your Tenable.io instance, cannot duplicate the name of a previously deleted network, and cannot be `default`.  \n  \n**Note:** You can add a maximum of 50,000 network objects to an individual Tenable.io instance.","type":"string"},"description":{"description":"The description of the network object.","type":"string"}},"required":["name"]},"example":{"name":"Area 51","description":"classified"}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully creates a network object.","content":{"application/json":{"schema":{"type":"object","properties":{"owner_uuid":{"type":"string","description":"The UUID of the owner of the network object. The owner of the network object does not have any additional permissions above administrator permissions."},"created":{"type":"integer","description":"The date (in Unix milliseconds) when the network object was created."},"modified":{"type":"integer","description":"The date (in Unix milliseconds) when the network object was last updated."},"uuid":{"type":"string","description":"The UUID of the network object."},"name":{"type":"string","description":"The name of the network object."},"description":{"type":"string","description":"The description of the network object."},"is_default":{"type":"boolean","description":"Indicates whether the network object is the default network object. The default network object is a system-generated object that contains any scanners and scanner groups not yet assigned to a custom network object. You cannot update or delete the default network object."},"created_by":{"type":"string","description":"The UUID of the user who created the network object."},"modified_by":{"type":"string","description":"The UUID of the user who last updated the network object."},"deleted_at":{"type":"integer","description":"The date (in Unix time) when the network object was deleted. This attribute is present for deleted network objects only. To view deleted network objects, use the `includeDeleted` parameter on the [/GET networks](/reference#networks-list) endpoint."},"created_in_seconds":{"type":"integer","description":"The date (in Unix seconds) when the network object was created."},"modified_in_seconds":{"type":"integer","description":"The date (in Unix seconds) when the network object was last updated."}}},"examples":{"response":{"value":{"owner_uuid":"08d242c3-9553-4ccc-835d-0c17ed942cdf","created":1557526802865,"modified":1557526802865,"scanner_count":0,"uuid":"1b17ee49-8f17-4c8f-8536-bff9aff73429","name":"Headquarters","description":"Network devices at Columbia, MD location","is_default":false,"created_by":"18d242c3-9553-4ccc-835d-0d17ed942cef","modified_by":"18d242c3-9553-4ccc-835d-0d17ed942cef","created_in_seconds":1557526802,"modified_in_seconds":1557526802}}}}}},"400":{"description":"Returned if Tenable.io encounters invalid JSON in request body."},"401":{"description":"Returned if Tenable.io cannot authenticate the user account that submitted the request."},"403":{"description":"Returned if you do not have permission to create network objects."},"409":{"description":"Returned if a network object with the same name already exists."},"415":{"description":"Returned if the request payload is in an unsupported format."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List networks","description":"Lists network objects for your organization.<p>Requires ADMINISTRATOR [64] user permissions.</p>","operationId":"networks-list","tags":["Networks"],"parameters":[{"description":"A filter condition in the following format: `field:operator:value`. For network objects, you can only filter on the `name` field, using the following operators: \n* eq—The name of the returned network object is equal to the text you specify. \n* neq—The returned list of network objects excludes the network object where the name is equal to the text you specify. \n* match—The returned list includes network objects where the name contains the text you specify at least partially.\n\nYou can specify multiple `f` parameters, separated by ampersand (&) characters. If you specify multiple `f` parameters, use the `ft` parameter to specify how Tenable.io applies the multiple filter conditions.","required":false,"name":"f","in":"query","schema":{"type":"string"}},{"description":"The operator that Tenable.io applies if multiple \\`f\\` parameters are present. The `OR` operator is the only supported value. If you omit this parameter and multiple `f` parameters are present, Tenable.io applies the `OR` operator by default.","required":false,"name":"ft","in":"query","schema":{"type":"string"}},{"description":"Maximum number of objects requested (or service imposed limit if not in request).","required":false,"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"Offset from request (or zero).","required":false,"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"Objects that specify the sort order for the returned data.","required":false,"name":"sort","in":"query","schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The field on which Tenable.io sorts the results."},"order":{"type":"string","description":"The direction of the sort order. Supported values are `asc` (ascending) and `desc` (descending)."}}}}},{"description":"Indicates whether Tenable.io includes deleted network objects in the response message. Deleted network objects contain the additional attribute, `deleted\\_at`, which specifies the date (in Unix time) when the network object was deleted.","name":"includeDeleted","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns a list of network objects.","content":{"application/json":{"schema":{"type":"object","properties":{"networks":{"type":"array","items":{"type":"object","properties":{"owner_uuid":{"type":"string","description":"The UUID of the owner of the network object. The owner of the network object does not have any additional permissions above administrator permissions."},"created":{"type":"integer","description":"The date (in Unix milliseconds) when the network object was created."},"modified":{"type":"integer","description":"The date (in Unix milliseconds) when the network object was last updated."},"uuid":{"type":"string","description":"The UUID of the network object."},"name":{"type":"string","description":"The name of the network object."},"description":{"type":"string","description":"The description of the network object."},"is_default":{"type":"boolean","description":"Indicates whether the network object is the default network object. The default network object is a system-generated object that contains any scanners and scanner groups not yet assigned to a custom network object. You cannot update or delete the default network object."},"created_by":{"type":"string","description":"The UUID of the user who created the network object."},"modified_by":{"type":"string","description":"The UUID of the user who last updated the network object."},"deleted_at":{"type":"integer","description":"The date (in Unix time) when the network object was deleted. This attribute is present for deleted network objects only. To view deleted network objects, use the `includeDeleted` parameter on the [/GET networks](/reference#networks-list) endpoint."},"created_in_seconds":{"type":"integer","description":"The date (in Unix seconds) when the network object was created."},"modified_in_seconds":{"type":"integer","description":"The date (in Unix seconds) when the network object was last updated."}}}},"pagination":{"type":"array","items":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of objects matching your search criteria.","format":"int32"},"limit":{"type":"integer","description":"Maximum number of objects requested (or service imposed limit if not in request).","format":"int32"},"offset":{"type":"integer","description":"Offset from request (or zero).","format":"int32"},"sort":{"description":"An array of the fields you specified as sort fields in the request, which Tenable.io uses to sort the returned data.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The field on which Tenable.io sorts the results."},"order":{"type":"string","description":"The direction of the sort order. Supported values are `asc` (ascending) and `desc` (descending)."}}}}}}}}},"examples":{"response":{"value":{"networks":[{"owner_uuid":"c31d1cd4-6e77-4a15-a10d-54e854e3cfa9","created":154474408527,"modified":154474408527,"scanner_count":10,"uuid":"00000000-0000-0000-0000-000000000000","name":"Default","is_default":true,"created_by":"c31d1cd4-6e77-4a15-a10d-54e854e3cfa9","modified_by":"c31d1cd4-6e77-4a15-a10d-54e854e3cfa9","created_in_seconds":1544744085,"modified_in_seconds":1544744085},{"owner_uuid":"08d242c3-9553-4ccc-835d-0c17ed942cdf","created":1557526802865,"modified":1557526802865,"scanner_count":1,"uuid":"1b17ee49-8f17-4c8f-8536-bff9aff73429","name":"Headquarters","description":"Network devices at Columbia, MD location","is_default":false,"created_by":"18d242c3-9553-4ccc-835d-0d17ed942cef","modified_by":"18d242c3-9553-4ccc-835d-0d17ed942cef","created_in_seconds":1557526802,"modified_in_seconds":1557526802}],"pagination":{"total":2,"limit":50,"offset":0,"sort":[{"name":"name","order":"asc"}]}}}}}}},"400":{"description":"Returned if the query parameters in your request were invalid."},"403":{"description":"Returned if you do not have sufficient permissions to list network objects."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/networks/{network_id}":{"get":{"summary":"Get network details","description":"Returns the details of the specified network object.<p>Requires ADMINISTRATOR [64] user permissions.</p>","operationId":"networks-details","tags":["Networks"],"parameters":[{"description":"The UUID of the network object for which you want to view details.","required":true,"name":"network_id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the details of the specified network object.","content":{"application/json":{"schema":{"type":"object","properties":{"owner_uuid":{"type":"string","description":"The UUID of the owner of the network object. The owner of the network object does not have any additional permissions above administrator permissions."},"created":{"type":"integer","description":"The date (in Unix milliseconds) when the network object was created."},"modified":{"type":"integer","description":"The date (in Unix milliseconds) when the network object was last updated."},"uuid":{"type":"string","description":"The UUID of the network object."},"name":{"type":"string","description":"The name of the network object."},"description":{"type":"string","description":"The description of the network object."},"is_default":{"type":"boolean","description":"Indicates whether the network object is the default network object. The default network object is a system-generated object that contains any scanners and scanner groups not yet assigned to a custom network object. You cannot update or delete the default network object."},"created_by":{"type":"string","description":"The UUID of the user who created the network object."},"modified_by":{"type":"string","description":"The UUID of the user who last updated the network object."},"deleted_at":{"type":"integer","description":"The date (in Unix time) when the network object was deleted. This attribute is present for deleted network objects only. To view deleted network objects, use the `includeDeleted` parameter on the [/GET networks](/reference#networks-list) endpoint."},"created_in_seconds":{"type":"integer","description":"The date (in Unix seconds) when the network object was created."},"modified_in_seconds":{"type":"integer","description":"The date (in Unix seconds) when the network object was last updated."}}},"examples":{"response":{"value":{"owner_uuid":"08d242c3-9553-4ccc-835d-0c17ed942cdf","created":1557526802865,"modified":1557526802865,"scanner_count":0,"uuid":"1b17ee49-8f17-4c8f-8536-bff9aff73429","name":"Headquarters","description":"Network devices at Columbia, MD location","is_default":false,"created_by":"18d242c3-9553-4ccc-835d-0d17ed942cef","modified_by":"18d242c3-9553-4ccc-835d-0d17ed942cef","created_in_seconds":1557526802,"modified_in_seconds":1557526802}}}}}},"404":{"description":"Returned if Tenable.io cannot find a network object with the specified UUID."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update network","description":"Updates the name or description of a network object.<p>Requires ADMINISTRATOR [64] user permissions.</p>","operationId":"networks-update","tags":["Networks"],"parameters":[{"description":"The UUID of the network object you want to update. You cannot update the default network object.","required":true,"name":"network_id","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The new name of the network object. This name must be unique within your Tenable.io instance, cannot duplicate the name of a previously deleted network, and cannot be `default`","type":"string"},"description":{"description":"The new description of the network object.","type":"string"}}}}}},"responses":{"200":{"description":"Returns successfully updated details of the network object.","content":{"application/json":{"schema":{"type":"object","properties":{"owner_uuid":{"type":"string","description":"The UUID of the owner of the network object. The owner of the network object does not have any additional permissions above administrator permissions."},"created":{"type":"integer","description":"The date (in Unix milliseconds) when the network object was created."},"modified":{"type":"integer","description":"The date (in Unix milliseconds) when the network object was last updated."},"uuid":{"type":"string","description":"The UUID of the network object."},"name":{"type":"string","description":"The name of the network object."},"description":{"type":"string","description":"The description of the network object."},"is_default":{"type":"boolean","description":"Indicates whether the network object is the default network object. The default network object is a system-generated object that contains any scanners and scanner groups not yet assigned to a custom network object. You cannot update or delete the default network object."},"created_by":{"type":"string","description":"The UUID of the user who created the network object."},"modified_by":{"type":"string","description":"The UUID of the user who last updated the network object."},"deleted_at":{"type":"integer","description":"The date (in Unix time) when the network object was deleted. This attribute is present for deleted network objects only. To view deleted network objects, use the `includeDeleted` parameter on the [/GET networks](/reference#networks-list) endpoint."},"created_in_seconds":{"type":"integer","description":"The date (in Unix seconds) when the network object was created."},"modified_in_seconds":{"type":"integer","description":"The date (in Unix seconds) when the network object was last updated."}}},"examples":{"response":{"value":{"owner_uuid":"08d242c3-9553-4ccc-835d-0c17ed942cdf","created":1557526802865,"modified":1557526802865,"scanner_count":0,"uuid":"1b17ee49-8f17-4c8f-8536-bff9aff73429","name":"Columbia office","description":"Network devices at Columbia, MD location","is_default":false,"created_by":"18d242c3-9553-4ccc-835d-0d17ed942cef","modified_by":"18d242c3-9553-4ccc-835d-0d17ed942cef","created_in_seconds":1557526802,"modified_in_seconds":1557526802}}}}}},"400":{"description":"Returned if Tenable.io encounters invalid JSON in the request body or if you attempted to change the default network object."},"401":{"description":"Returned if Tenable.io cannot authenticate the user account that submitted the request."},"403":{"description":"Returned if you do not have permission to update the specified network object."},"404":{"description":"Returned if Tenable.io could not find the specified network object, either because the object does not exist or because the object has been deleted."},"409":{"description":"Returned if a network object with the same name already exists."},"415":{"description":"Returned if the request payload is in an unsupported format."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete network","description":"Deletes the specified network object. Before you delete a network object, consider moving assets to a different network using the [bulk asset move](/reference#assets-bulk-move) endpoint. If you delete a network object, Tenable.io:\n - Returns the scanners and scanner groups associated with the deleted object to the default network object.\n - Retains any asset records for the deleted network until the assets age out of your licensed assets count. \n\n**Note:** You can view deleted network objects using the `includeDeleted` filter in a [/GET networks](/reference#networks-list) request. <p>Requires ADMINISTRATOR [64] user permissions.</p>","operationId":"networks-delete","tags":["Networks"],"parameters":[{"description":"UUID for the network object you want to delete. You cannot delete the default network object.","required":true,"name":"network_id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deleted the specified network object.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"400":{"description":"Returned if you attempted to delete the default network object."},"401":{"description":"Returned if Tenable.io cannot authenticate the user account that submitted the request."},"403":{"description":"Returned if you do not have sufficient permissions to delete the specified network object."},"404":{"description":"Returned if Tenable.io could not find the network object you specified."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/networks/{network_id}/scanners/{scanner_uuid}":{"post":{"summary":"Assign scanners","description":"<ul>Associates a scanner or scanner group with a network object. Use this endpoint to:<li>Assign a scanner or scanner group to a custom network object.</li><li>Return a scanner or scanner group to the default network object.</li></ul><br><p>Requires ADMINISTRATOR [64] user permissions.</p><p></p>","operationId":"networks-assign-scanner","tags":["Networks"],"parameters":[{"description":"The UUID of the network object where you want to assign a scanner or scanner group.","required":true,"name":"network_id","in":"path","schema":{"type":"string"}},{"description":"The UUID of the scanner or scanner group you want to assign to the network object. To get UUID values, use the [GET /networks/{network_id}/assignable-scanners](/reference#networks-list-assignable-scanners) endpoint.","required":true,"name":"scanner_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully assigned the scanner or scanner group to the network object.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"400":{"description":"Returned if you attempt to assign an AWS scanner to the network object. For AWS assets, use network segmentation processes offered by AWS instead."},"401":{"description":"Returned if Tenable.io cannot authenticate the user account that submitted the request."},"403":{"description":"Returned if you do not have sufficient permissions to assign a scanner or scanner group to the specified network object."},"404":{"description":"Returned if Tenable.io could not find either the network object, the scanner object, or the scanner group object you specified."},"409":{"description":"Returned if Tenable.io determines that assigning the scanner or scanner group causes a network conflict. A response message with this code includes a response body under the following conditions:  \n* The scanner you attempted to assign is a member of more than one scanner group.  \n* The scanner group you attempted to assign contains one or more scanners that belong to another scanner group.","content":{"application/json":{"schema":{"type":"object","properties":{"conflicts":{"type":"array","items":{"type":"object","properties":{"scanner_uuid":{"type":"string","description":"The UUID of the scanner involved in the conflict."},"scanner_groups":{"description":"A list of scanner groups involved in the conflict.","type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the scanner group."},"name":{"type":"string","description":"The name of the scanner group."}}}}}}}}},"examples":{"response":{"value":{"conflicts":[{"scanner_uuid":"94b4be1a-d658-20a8-131b-ac0fa06f04b5db3eac57471272de","scanner_groups":[{"uuid":"32a3d0d2-3c41-432e-8479-7da815a09b23","name":"Northeast sector"}]}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/networks/{network_id}/scanners":{"get":{"summary":"List network scanners","description":"Lists all scanners and scanner groups belonging to the specified network object.<p>Requires ADMINISTRATOR [64] user permissions.</p>","operationId":"networks-list-scanners","tags":["Networks"],"parameters":[{"description":"The UUID of the network object for which you want to list assigned scanners and scanner groups.","required":true,"name":"network_id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of scanners and scanner groups for the specified network object.","content":{"application/json":{"schema":{"type":"object","description":"A list of scanners and scanner groups.","properties":{"scanners":{"type":"array","items":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The date on which the scanner was linked to the Tenable.io instance.","format":"int32"},"distro":{"type":"string","description":"The scanner software distribution."},"engine_build":{"type":"string","description":"The build of the engine running on the scanner."},"engine_version":{"type":"string","description":"The version of the engine running on the scanner."},"group":{"type":"boolean","description":"Indicates whether the object represents a single scanner (`false`) or a scanner group (`true`)."},"id":{"type":"integer","description":"The unique ID of the scanner.","format":"int32"},"key":{"type":"string","description":"An alpha-numeric sequence of characters used when linking a scanner to Tenable.io."},"last_connect":{"type":"integer","description":"The Unix timestamp when the scanner last connected to the Tenable.io instance.","format":"int32"},"last_modification_date":{"type":"integer","description":"The Unix timestamp when the scanner was last updated."},"linked":{"type":"integer","description":"Indicates if the scanner is enabled (`1`) or not disabled (`0`)."},"loaded_plugin_set":{"type":"string","description":"The current plugin set on the scanner."},"name":{"type":"string","description":"The user-defined name of the scanner."},"num_hosts":{"type":"integer","description":"The number of hosts that the scanner's analysis have discovered."},"num_scans":{"type":"integer","description":"The number of scan tasks the scanner is currently executing."},"num_sessions":{"type":"integer","description":"The number of active sessions between the scanner and hosts."},"num_tcp_sessions":{"type":"integer","description":"The number of active TCP sessions between the scanner and hosts."},"owner":{"type":"string","description":"The scanner owner."},"owner_id":{"type":"integer","description":"The ID of the scanner owner."},"owner_name":{"type":"string","description":"The name of the scanner owner."},"owner_uuid":{"type":"string","description":"The UUID of the scanner owner."},"platform":{"type":"string","description":"The platform of the scanner."},"pool":{"type":"boolean","description":"Indicates whether the scanner is part of a scanner group."},"report_frequency":{"type":"integer","description":"The frequency (in seconds) at which the scanner polls the Tenable.io instance."},"settings":{"type":"object","description":""},"scan_count":{"type":"integer","description":"The current number of scans currently running on the scanner."},"source":{"type":"string","description":"Historical attribute. Always `service`."},"status":{"type":"string","description":"The scanner's current status. Possible values are:\n - on—The scanner has connected in the last five minutes.\n - off—The scanner has not connected in the last five minutes."},"timestamp":{"type":"integer","description":"Equivalent to the last_modification_date."},"type":{"type":"string","description":"The type of scanner (local or remote)."},"uuid":{"type":"string","description":"The UUID of the scanner."},"remote_uuid":{"type":"string","description":"The UUID of the Nessus installation on the scanner."},"supports_remote_logs":{"type":"boolean","description":"Indicates whether the scanner supports remote logging."}}}}}},"examples":{"response":{"value":{"scanners":[{"creation_date":1521065518,"distro":"2.6.32-504.8.1.el6.x86_64","engine_build":"201710101","engine_version":"NNM 5.4.0","group":false,"id":215898,"key":"bd98a384ff0e91c8f94fa7f786f8827c1eb7b28dffcfb9895f9d85bd8f0a7d53","last_connect":1524524576,"last_modification_date":1524523493,"linked":1,"loaded_plugin_set":"201803271415","name":"NNM-540","num_hosts":0,"num_scans":0,"num_sessions":0,"num_tcp_sessions":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"c31d1cd4-6e77-4a15-a10d-54e854e3cfa9","platform":"LINUX","pool":false,"report_frequency":3600,"settings":{},"scan_count":0,"source":"service","status":"off","timestamp":1524523493,"type":"managed_pvs","uuid":"34f9ddc5-eed0-4b87-80b2-1b2b6ccec8f8","remote_uuid":"131658d2-9a1a-3daa-5ca5-196f200a3e3f9b9a533780bda648","supports_remote_logs":false}]}}}}}},"401":{"description":"Returned if Tenable.io cannot authenticate the user account that submitted the request."},"403":{"description":"Returned if you do not have sufficient permissions to list scanners and scanner groups for the specified network object."},"404":{"description":"Returned if Tenable.io could not find the network object you specified."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"post":{"summary":"Bulk assign scanners","description":"Bulk assigns scanners and scanner groups to a custom network. The data in this request payload overwrites the full list of specified scanners and scanner groups previously assigned to the specified network object. If the payload excludes scanners or scanner groups previously assigned to the specified network object, Tenable.io returns those scanners and scanner groups to the default network. You cannot use this endpoint to bulk return scanners and scanner groups from multiple custom networks to the default network.<p>Requires ADMINISTRATOR [64] user permissions.</p>","operationId":"networks-assign-scanner-bulk","tags":["Networks"],"parameters":[{"description":"The UUID of the network object where you want to bulk assign scanners and scanner groups.","required":true,"name":"network_id","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scanner_uuids":{"description":"A list of UUIDs for the scanners and scanner groups you want to bulk move to a network object. To get values for this list, use the [GET /networks/{network_id}/assignable-scanners](/reference#networks-list-assignable-scanners) endpoint.","type":"array","items":{"type":"string"}}},"required":["scanner_uuids"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully assigned the scanners and scanner groups to the network object.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"400":{"description":"Returned if you attempt to assign an AWS scanner to the network object. For AWS assets, use network segmentation processes offered by AWS instead."},"401":{"description":"Returned if Tenable.io cannot authenticate the user account that submitted the request."},"403":{"description":"Returned if you do not have sufficient permissions to assign a scanner or scanner group to the specified network object."},"404":{"description":"Returned if Tenable.io could not find either the network object, the scanner object, or the scanner group object you specified."},"409":{"description":"Returned if Tenable.io determines that assigning the scanner or scanner group causes a network conflict. A response message with this code includes a response body under the following conditions:  \n* A scanner you attempted to assign is a member of more than one scanner group.  \n* A scanner group you attempted to assign contains one or more scanners that belong to another scanner group.","content":{"application/json":{"schema":{"type":"object","properties":{"conflicts":{"type":"array","items":{"type":"object","properties":{"scanner_uuid":{"type":"string","description":"The UUID of the scanner involved in the conflict."},"scanner_groups":{"description":"A list of scanner groups involved in the conflict.","type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the scanner group."},"name":{"type":"string","description":"The name of the scanner group."}}}}}}}}},"examples":{"response":{"value":{"conflicts":[{"scanner_uuid":"94b4be1a-d658-20a8-131b-ac0fa06f04b5db3eac57471272de","scanner_groups":[{"uuid":"32a3d0d2-3c41-432e-8479-7da815a09b23","name":"Northeast sector"}]}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/networks/{network_id}/assignable-scanners":{"get":{"summary":"List assignable scanners","description":"Lists all scanners and scanner groups not yet assigned to a custom network object. This list includes all scanner groups within the default network AND any scanners within the default network that do not belong to a scanner group.<p>Requires ADMINISTRATOR [64] user permissions.</p>","operationId":"networks-list-assignable-scanners","tags":["Networks"],"parameters":[{"description":"The UUID of the default network object.","required":true,"name":"network_id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of assignable scanners and scanner groups in the default network object.","content":{"application/json":{"schema":{"type":"object","description":"A list of scanners and scanner groups.","properties":{"scanners":{"type":"array","items":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The date on which the scanner was linked to the Tenable.io instance.","format":"int32"},"distro":{"type":"string","description":"The scanner software distribution."},"engine_build":{"type":"string","description":"The build of the engine running on the scanner."},"engine_version":{"type":"string","description":"The version of the engine running on the scanner."},"group":{"type":"boolean","description":"Indicates whether the object represents a single scanner (`false`) or a scanner group (`true`)."},"id":{"type":"integer","description":"The unique ID of the scanner.","format":"int32"},"key":{"type":"string","description":"An alpha-numeric sequence of characters used when linking a scanner to Tenable.io."},"last_connect":{"type":"integer","description":"The Unix timestamp when the scanner last connected to the Tenable.io instance.","format":"int32"},"last_modification_date":{"type":"integer","description":"The Unix timestamp when the scanner was last updated."},"linked":{"type":"integer","description":"Indicates if the scanner is enabled (`1`) or not disabled (`0`)."},"loaded_plugin_set":{"type":"string","description":"The current plugin set on the scanner."},"name":{"type":"string","description":"The user-defined name of the scanner."},"num_hosts":{"type":"integer","description":"The number of hosts that the scanner's analysis have discovered."},"num_scans":{"type":"integer","description":"The number of scan tasks the scanner is currently executing."},"num_sessions":{"type":"integer","description":"The number of active sessions between the scanner and hosts."},"num_tcp_sessions":{"type":"integer","description":"The number of active TCP sessions between the scanner and hosts."},"owner":{"type":"string","description":"The scanner owner."},"owner_id":{"type":"integer","description":"The ID of the scanner owner."},"owner_name":{"type":"string","description":"The name of the scanner owner."},"owner_uuid":{"type":"string","description":"The UUID of the scanner owner."},"platform":{"type":"string","description":"The platform of the scanner."},"pool":{"type":"boolean","description":"Indicates whether the scanner is part of a scanner group."},"report_frequency":{"type":"integer","description":"The frequency (in seconds) at which the scanner polls the Tenable.io instance."},"settings":{"type":"object","description":""},"scan_count":{"type":"integer","description":"The current number of scans currently running on the scanner."},"source":{"type":"string","description":"Historical attribute. Always `service`."},"status":{"type":"string","description":"The scanner's current status. Possible values are:\n - on—The scanner has connected in the last five minutes.\n - off—The scanner has not connected in the last five minutes."},"timestamp":{"type":"integer","description":"Equivalent to the last_modification_date."},"type":{"type":"string","description":"The type of scanner (local or remote)."},"uuid":{"type":"string","description":"The UUID of the scanner."},"remote_uuid":{"type":"string","description":"The UUID of the Nessus installation on the scanner."},"supports_remote_logs":{"type":"boolean","description":"Indicates whether the scanner supports remote logging."}}}}}},"examples":{"response":{"value":{"scanners":[{"creation_date":1521065518,"distro":"2.6.32-504.8.1.el6.x86_64","engine_build":"201710101","engine_version":"NNM 5.4.0","group":false,"id":215898,"key":"bd98a384ff0e91c8f94fa7f786f8827c1eb7b28dffcfb9895f9d85bd8f0a7d53","last_connect":1524524576,"last_modification_date":1524523493,"linked":1,"loaded_plugin_set":"201803271415","name":"NNM-540","num_hosts":0,"num_scans":0,"num_sessions":0,"num_tcp_sessions":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"c31d1cd4-6e77-4a15-a10d-54e854e3cfa9","platform":"LINUX","pool":false,"report_frequency":3600,"settings":{},"scan_count":0,"source":"service","status":"off","timestamp":1524523493,"type":"managed_pvs","uuid":"34f9ddc5-eed0-4b87-80b2-1b2b6ccec8f8","remote_uuid":"131658d2-9a1a-3daa-5ca5-196f200a3e3f9b9a533780bda648","supports_remote_logs":false}]}}}}}},"401":{"description":"Returned if Tenable.io cannot authenticate the user account that submitted the request."},"403":{"description":"Returned if you do not have sufficient permissions to list scanners and scanner groups for the default network object."},"404":{"description":"Returned if Tenable.io could not find the network object you specified."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/permissions/{object_type}/{object_id}":{"get":{"summary":"Get object permissions","description":"Returns the object's permissions.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"permissions-list","tags":["Permissions"],"parameters":[{"description":"The type of object.","required":true,"name":"object_type","in":"path","schema":{"type":"string","enum":["scanner"],"default":"scanner"}},{"description":"The unique ID of the object.","required":true,"name":"object_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the object permissions.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"owner":{"type":"integer","description":"The unique ID of the owner of the object."},"type":{"type":"string","description":"The type of permission (default, user, group).","enum":["default","user","group"]},"permissions":{"type":"integer","description":"The permission value to grant access as described in <a href=\"/docs/permissions\">Permissions</a>.","format":"int32"},"id":{"type":"integer","description":"The unique ID of the user if type is user."},"name":{"type":"string","description":"The name of the user or group."},"display_name":{"type":"string","description":"The display-friendly name of the user or group."}}}},"examples":{"response":{"value":{"acls":[{"type":"user","id":1,"uuid":"47e6b2ea-4e3c-4c09-b137-72e9f53b97f6","name":"system","display_name":"system","permissions":128,"owner":1},{"type":"default","permissions":16}]}}}}}},"403":{"description":"Returned if you do not have permission to view the object."},"404":{"description":"Returned if Tenable.io cannot find the specified object."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update object permissions","description":"Updates the permissions for a Tenable.io object.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"permissions-change","tags":["Permissions"],"parameters":[{"description":"The type of object.","required":true,"name":"object_type","in":"path","schema":{"type":"string","enum":["scanner"],"default":"scanner"}},{"description":"The unique ID of the object (for example, scanner).","required":true,"name":"object_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"acls":{"type":"array","items":{"type":"object","properties":{"owner":{"type":"integer","description":"The unique ID of the owner of the object."},"type":{"type":"string","description":"The type of permission (default, user, group).","enum":["default","user","group"]},"permissions":{"type":"integer","description":"The permission value to grant access as described in <a href=\"/docs/permissions\">Permissions</a>.","format":"int32"},"id":{"type":"integer","description":"The unique ID of the user if type is user."},"name":{"type":"string","description":"The name of the user or group."},"display_name":{"type":"string","description":"The display-friendly name of the user or group."}}}}}}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully updates the object permissions.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you do not have permission to edit the object."},"404":{"description":"Returned if Tenable.io cannot find the specified object."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/plugins/families":{"get":{"summary":"List plugin families","description":"Returns the list of plugin families.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"plugins-families","tags":["Plugins"],"parameters":[{"description":"Specifies whether to return all plugin families. If `true`, the plugin families hidden in Tenable.io UI, for example, Port Scanners, are included in the list.","required":false,"name":"all","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns the list of plugin families.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the family."},"name":{"type":"string","description":"The name of the family."},"count":{"type":"integer","description":"The number of plugins in the family."}}}},"examples":{"response":{"value":{"families":[{"count":11342,"name":"AIX Local Security Checks","id":1},{"count":1164,"name":"Amazon Linux Local Security Checks","id":35},{"count":114,"name":"Backdoors","id":17}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/plugins/families/{id}":{"get":{"summary":"List plugins in family","description":"Returns the list of plugins in a family.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"plugins-family-details","tags":["Plugins"],"parameters":[{"description":"The ID of the family to lookup.","required":true,"name":"id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the list of plugins in a family.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the family."},"id":{"type":"integer","description":"The unique ID of the family."},"plugins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the plugin."},"name":{"type":"string","description":"The name of the plugin."}}}}}},"examples":{"response":{"value":{"plugins":[{"id":22372,"name":"AIX 5.1 : IY19744"},{"id":22373,"name":"AIX 5.1 : IY20486"},{"id":22374,"name":"AIX 5.1 : IY21309"}],"name":"AIX Local Security Checks","id":1}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/plugins/plugin/{id}":{"get":{"summary":"Get plugin details","description":"Returns details for a specified plugin.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"plugins-plugin-details","tags":["Plugins"],"parameters":[{"description":"The ID of the plugin.","required":true,"name":"id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the plugin details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the plugin."},"name":{"type":"string","description":"The name of the plugin."},"family_name":{"type":"string","description":"The name of the plugin family."},"attributes":{"type":"array","description":"The plugin attributes.","items":{"type":"object","properties":{"attribute_name":{"type":"string","description":"The name of the attribute."},"attribute_value":{"type":"string","description":"The value of the attribute."}}}}}},"examples":{"response":{"value":{"attributes":[{"attribute_value":"aix_IY19744.nasl","attribute_name":"fname"},{"attribute_value":"AIX 5.1 : IY19744","attribute_name":"plugin_name"},{"attribute_value":"$Revision: 1.5 $","attribute_name":"script_version"},{"attribute_value":"http://www-912.ibm.com/eserver/support/fixes/","attribute_name":"solution"},{"attribute_value":"High","attribute_name":"risk_factor"},{"attribute_value":"The remote host is missing AIX Critical Security Patch number IY19744\n(SECURITY: Buffer Overflow in xntpd).\n\nYou should install this patch for your system to be up-to-date.","attribute_name":"description"},{"attribute_value":"2006/09/16","attribute_name":"plugin_publication_date"},{"attribute_value":"The remote host is missing a vendor-supplied security patch","attribute_name":"synopsis"}],"family_name":"AIX Local Security Checks","name":"AIX 5.1 : IY19744","id":22372}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/policies":{"post":{"summary":"Create policy","description":"Creates a policy.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"policies-create","tags":["Policies"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The uuid for the editor template to use.","example":"ab4bacd2-05f6-425c-9d79-3ba3940ad1c24e51e1f403febe40"},"settings":{"type":"object","properties":{}}},"required":["uuid"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully saves the policy.","content":{"application/json":{"schema":{"type":"object","properties":{"policy_id":{"type":"integer"},"policy_name":{"type":"string"}}},"examples":{"response":{"value":{"policy_id":"integer","policy_name":"string"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encounters an error while attempting to save the policy.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List policies","description":"Returns a list of policies.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"policies-list","tags":["Policies"],"responses":{"200":{"description":"Returns the policy list.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the policy."},"template_uuid":{"type":"string","description":"The UUID for the template the policy uses."},"name":{"type":"string","description":"The name of the policy."},"description":{"type":"string","description":"The description of the policy."},"owner_id":{"type":"string","description":"The unique ID of the owner of the policy."},"owner":{"type":"string","description":"The username for the owner of the policy."},"shared":{"type":"integer","description":"The shared status of the policy."},"user_permissions":{"type":"integer","description":"The sharing permissions for the policy."},"creation_date":{"type":"integer","description":"The creation date of the policy in unixtime."},"last_modification_date":{"type":"integer","description":"The last modification date for the policy in unixtime."},"visibility":{"type":"integer","description":"The visibility of the target (private or shared)."},"no_target":{"type":"boolean","description":"If true, the policy does not use targets."}}}},"examples":{"response":{"value":{"policies":[{"no_target":"false","template_uuid":"ad629e16-03b6-8c1d-cef6-ef8c9dd3c658d24bd260ef5f9e66","description":"An example policy.","name":"Test Policy 1","owner":"api@api.demo","visibility":"shared","shared":1,"user_permissions":128,"last_modification_date":1545938690,"creation_date":1545938690,"owner_id":3,"id":43},{"no_target":"false","template_uuid":"65d5b7ce-8d3b-d0df-f473-40633bb6122108a510a44374a167","description":"An example policy using the Shellshock template.","name":"Test Policy 2","owner":"api@api.demo","visibility":"shared","shared":1,"user_permissions":128,"last_modification_date":1545938735,"creation_date":1545938735,"owner_id":3,"id":44}]}}}}}},"403":{"description":"Returned if you do not have permission to view the policy list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/policies/{policy_id}/copy":{"post":{"summary":"Copy policy","description":"Copies a policy.<p>Requires STANDARD [32] user permissions and CAN EDIT [32] policy permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"policies-copy","tags":["Policies"],"parameters":[{"description":"The id of the policy to copy.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the policy object.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"name":"Copy of Test Policy 1","id":45}}}}}},"403":{"description":"Returned if you do not have permission to copy the policy."},"404":{"description":"Returned if Tenable.io cannot find the specified policy."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to copy the policy.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/policies/import":{"post":{"summary":"Import policy","description":"Imports an existing policy uploaded using POST /file/upload (.nessus format only).<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"policies-import","tags":["Policies"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"The name of the file to import as provided by the response from file-upload."}},"required":["file"]}}}},"responses":{"200":{"description":"Returns the policy object.","content":{"application/json":{"schema":{"type":"object","properties":{"private":{"type":"integer"},"no_target":{"type":"string"},"template_uuid":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"owner":{"type":"string"},"shared":{"type":"integer"},"user_permissions":{"type":"integer"},"last_modification_date":{"type":"integer"},"creation_date":{"type":"integer"},"owner_id":{"type":"integer"},"id":{"type":"integer"}}},"examples":{"response":{"value":{"private":"integer","no_target":"string","template_uuid":"string","description":"string","name":"string","owner":"string","shared":"integer","user_permissions":"integer","last_modification_date":"integer","creation_date":"integer","owner_id":"integer","id":"integer"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to import the policy.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/policies/{policy_id}/export":{"get":{"summary":"Export policy","description":"Exports the specified policy.<p>Requires STANDARD [32] user permissions and CAN EDIT [32] policy permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"policies-export","tags":["Policies"],"parameters":[{"description":"The ID of the policy to export.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the policy in nessus (XML) format.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"To do":"Add response sample here"}}}}}},"403":{"description":"Returned if you do not have permission to export the policy."},"404":{"description":"Returned if Tenable.io cannot find the specified policy."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/policies/{policy_id}":{"get":{"summary":"List policy details","description":"Returns the details for the specified policy.<p>Requires STANDARD [32] user permissions and CAN USE [32] policy permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"policies-details","tags":["Policies"],"parameters":[{"description":"The ID of the policy to retrieve.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the policy details. This response can be edited and passed directly to the [PUT /policies/{policy_id}](/reference#was-policies-configure) endpoint.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string"},"audits":{"type":"object"},"credentials":{"type":"object"},"plugins":{"type":"object"},"scap":{"type":"object"},"settings":{"type":"object"}}},"examples":{"response":{"value":{"plugins":{"SMTP problems":{"status":"enabled"},"Backdoors":{"status":"enabled"},"Ubuntu Local Security Checks":{"status":"enabled"},"Gentoo Local Security Checks":{"status":"enabled"},"Oracle Linux Local Security Checks":{"status":"enabled"},"RPC":{"status":"enabled"},"Brute force attacks":{"status":"enabled"},"Gain a shell remotely":{"status":"enabled"},"Service detection":{"status":"enabled"},"DNS":{"status":"enabled"},"Mandriva Local Security Checks":{"status":"enabled"},"Junos Local Security Checks":{"status":"enabled"},"Misc.":{"status":"enabled"},"FTP":{"status":"enabled"},"Slackware Local Security Checks":{"status":"enabled"},"Default Unix Accounts":{"status":"enabled"},"AIX Local Security Checks":{"status":"enabled"},"SNMP":{"status":"enabled"},"OracleVM Local Security Checks":{"status":"enabled"},"CGI abuses":{"status":"enabled"},"Settings":{"status":"enabled"},"CISCO":{"status":"enabled"},"Firewalls":{"status":"enabled"},"Databases":{"status":"enabled"},"Debian Local Security Checks":{"status":"enabled"},"Fedora Local Security Checks":{"status":"enabled"},"Netware":{"status":"enabled"},"Huawei Local Security Checks":{"status":"enabled"},"Windows : User management":{"status":"enabled"},"VMware ESX Local Security Checks":{"status":"enabled"},"Virtuozzo Local Security Checks":{"status":"enabled"},"CentOS Local Security Checks":{"status":"enabled"},"Peer-To-Peer File Sharing":{"status":"enabled"},"General":{"status":"enabled"},"Policy Compliance":{"status":"enabled"},"Amazon Linux Local Security Checks":{"status":"enabled"},"Solaris Local Security Checks":{"status":"enabled"},"F5 Networks Local Security Checks":{"status":"enabled"},"Denial of Service":{"status":"enabled"},"Windows : Microsoft Bulletins":{"status":"enabled"},"SuSE Local Security Checks":{"status":"enabled"},"Palo Alto Local Security Checks":{"status":"enabled"},"Red Hat Local Security Checks":{"status":"enabled"},"PhotonOS Local Security Checks":{"status":"enabled"},"HP-UX Local Security Checks":{"status":"enabled"},"Mobile Devices":{"status":"enabled"},"CGI abuses : XSS":{"status":"enabled"},"FreeBSD Local Security Checks":{"status":"enabled"},"Windows":{"status":"enabled"},"MacOS X Local Security Checks":{"status":"enabled"},"Scientific Linux Local Security Checks":{"status":"enabled"},"Web Servers":{"status":"enabled"},"SCADA":{"status":"enabled"}},"settings":{"cisco_offline_configs":"","apm_force_updates":"yes","region_hkg_pref_name":"yes","http_login_max_redir":"0","portscan_range":"default","icmp_unreach_means_host_down":"no","start_cotp_tsap":"8","ssh_port":"22","av_grace_period":"0","http_login_auth_regex_nocase":"no","snmp_port":"161","enable_admin_shares":"no","arista_offline_configs":"","icmp_ping_retries":"2","syn_firewall_detection":"Automatic (normal)","snmp_scanner":"yes","sonicos_offline_configs":"","slice_network_addresses":"no","patch_audit_over_rsh":"no","aws_verify_ssl":"yes","was_http_request_timeout":"5","tcp_ping":"yes","additional_snmp_port3":"161","dell_f10_offline_configs":"","test_default_oracle_accounts":"no","only_portscan_if_enum_failed":"yes","apm_update_timeout":"5","ssl_prob_ports":"Known SSL ports","ping_the_remote_host":"yes","office365filecontents_max_cumulative_size":"","attempt_least_privilege":"no","region_dfw_pref_name":"yes","modbus_start_reg":"0","max_simult_tcp_sessions_per_scan":"","scan_network_printers":"no","stop_scan_on_disconnect":"no","report_verbosity":"Normal","was_plugins_rate_limiter_requests_per_second":"25","fast_network_discovery":"no","udp_ping":"no","scan_malware":"no","never_send_win_creds_in_the_clear":"yes","log_live_hosts":"no","enum_domain_users_start_uid":"1000","name":"Test Policy 1","description":"An example policy.","tcp_scanner":"no","watchguard_offline_configs":"","office365filecontents_modified_within_x_days":"","http_login_invert_auth_regex":"no","smtp_from":"nobody@example.com","smtp_domain":"example.com","thorough_tests":"no","office365filecontents_exclude_paths":"","scan_webapps":"no","dont_use_ntlmv1":"yes","reverse_lookup":"no","smtp_to":"postmaster@[AUTO_REPLACED_IP]","adtran_aos_offline_configs":"","procurve_config_to_audit":"Saved/(show config)","microsoft_azure_subscriptions_ids":"","max_hosts_per_scan":"80","region_syd_pref_name":"yes","start_remote_registry":"no","patch_audit_over_telnet":"no","aws_use_https":"yes","stop_cotp_tsap":"8","unscanned_closed":"no","scan_netware_hosts":"no","ssh_client_banner":"OpenSSH_5.0","enumerate_all_ciphers":"yes","netapp_offline_configs":"","office365filecontents_file_extensions":"","use_kernel_congestion_detection":"no","was_http_request_concurrency":"10","wol_wait_time":"5","huawei_offline_configs":"","report_paranoia":"Normal","http_login_auth_regex_on_headers":"no","wmi_netstat_scanner":"yes","provided_creds_only":"yes","wol_mac_addresses":"","region_lon_pref_name":"yes","cert_expiry_warning_days":"60","bluecoat_proxysg_offline_configs":"","display_unreachable_hosts":"no","verify_open_ports":"no","enum_local_users_end_uid":"1200","udp_scanner":"no","was_plugins_autothrottle":"yes","ssh_known_hosts":"","safe_checks":"yes","patch_audit_over_rexec":"no","fortios_offline_configs":"","brocade_offline_configs":"","allow_post_scan_editing":"yes","report_superseded_patches":"yes","max_simult_tcp_sessions_per_host":"","region_iad_pref_name":"yes","tcp_ping_dest_ports":"built-in","enum_domain_users_end_uid":"1200","max_checks_per_host":"5","junos_offline_configs":"","check_crl":"no","svc_detection_on_all_ports":"yes","scan_ot_devices":"no","syn_scanner":"yes","cisco_config_to_audit":"Saved/(show config)","detect_ssl":"yes","request_windows_domain_info":"yes","network_receive_timeout":"5","aws_ui_region_type":"Rest of the World","additional_snmp_port1":"161","additional_snmp_port2":"161","reduce_connections_on_congestion":"no","icmp_ping":"yes","network_type":"Mixed (use RFC 1918)","checkpoint_gaia_offline_configs":"","office365filecontents_max_size":"","procurve_offline_configs":"","was_browser_cluster_job_timeout":"10","arp_ping":"yes","region_ord_pref_name":"yes","enum_local_users_start_uid":"1000","fireeye_offline_configs":"","extremeos_offline_configs":"","http_login_method":"POST","ssh_netstat_scanner":"yes","silent_dependencies":"yes","enable_plugin_debugging":"no","http_reauth_delay":0,"timeout_abort_threshold":"100","office365filecontents_include_paths":"","modbus_end_reg":"16","host_tagging":"yes"},"uuid":"ad629e16-03b6-8c1d-cef6-ef8c9dd3c658d24bd260ef5f9e66"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update policy","description":"Updates the parameters of a policy.<p>Requires STANDARD [32] user permissions and CAN EDIT [32] policy permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"policies-configure","tags":["Policies"],"parameters":[{"description":"The ID of the policy to change.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io updated the configuration of the specified policy.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"To do":"Add response sample here"}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified policy."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encounters an error while attempting to save the configuration.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete policy","description":"Deletes a policy.<p>Requires STANDARD [32] user permissions and CAN EDIT [32] policy permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"policies-delete","tags":["Policies"],"parameters":[{"description":"The ID of the policy to delete.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deletes the policy.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you do not have permission to delete the policy."},"404":{"description":"Returned if Tenable.io cannot find the specified policy."},"405":{"description":"Returned if the policy is in use by a scan."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanner-groups":{"post":{"summary":"Create scanner group","description":"Creates a new scanner group. \n\nYou cannot use this endpoint to assign the new scanner group to a network object. Tenable.io automatically assigns new scanner groups to the default network object. To assign a scanner group to a network object, use the [POST /networks/{network_id}/scanners/{scanner_uuid}](/reference#networks-assign-scanner) endpoint. <p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanner-groups-create","tags":["Scanner Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name for the new scanner group."},"type":{"type":"string","description":"The type of scanner group. If you omit this parameter, Tenable.io automatically uses the default (`load_balancing`).","enum":["load_balancing"]}},"required":["name"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully creates the scanner group.","content":{"application/json":{"schema":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The creation date for the scanner group in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scanner group in Unix time."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scanner group."},"owner":{"type":"string","description":"The username of the owner of the scanner group."},"default_permissions":{"type":"integer","description":"The access permissions for the Default group."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scanner group."},"shared":{"type":"integer","description":"The shared status of the scanner-group."},"scan_count":{"type":"integer","description":"The number of scans currently tasked to the scanner group."},"scanner_count":{"type":"string","description":"The number of scanners associated with this scanner group."},"uuid":{"type":"string","description":"The UUID of the scanner group."},"token":{"type":"string","description":"The unique token for a scanner group."},"flag":{"type":"string","description":"The flag indicating what type of scanner group."},"type":{"type":"string","description":"The type of scanner group. This is set to \"load_balancing\" by default."},"name":{"type":"string","description":"The name of the scanner group."},"network_name":{"type":"string","description":"The name of the network object associated with the scanner group. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"id":{"type":"integer","description":"The unique ID of the scanner group."},"scanner_id":{"type":"integer","description":"The unique scanner ID of the scanner group."}}},"examples":{"response":{"value":{"creation_date":1545331392,"last_modification_date":1545331392,"owner_id":1,"owner":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","default_permissions":16,"scan_count":0,"uuid":"5bf560f7-1730-4006-bb38-c1ec69e73797","type":"load_balancing","name":"Example Group","id":102826,"owner_name":"system"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to create the scanner group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List scanner groups","description":"Lists scanner groups for your Tenable.io instance.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanner-groups-list","tags":["Scanner Groups"],"responses":{"200":{"description":"Returns the scanner group list.","content":{"application/json":{"schema":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The creation date for the scanner group in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scanner group in Unix time."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scanner group."},"owner":{"type":"string","description":"The username of the owner of the scanner group."},"default_permissions":{"type":"integer","description":"The access permissions for the Default group."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scanner group."},"shared":{"type":"integer","description":"The shared status of the scanner-group."},"scan_count":{"type":"integer","description":"The number of scans currently tasked to the scanner group."},"scanner_count":{"type":"string","description":"The number of scanners associated with this scanner group."},"uuid":{"type":"string","description":"The UUID of the scanner group."},"token":{"type":"string","description":"The unique token for a scanner group."},"flag":{"type":"string","description":"The flag indicating what type of scanner group."},"type":{"type":"string","description":"The type of scanner group. This is set to \"load_balancing\" by default."},"name":{"type":"string","description":"The name of the scanner group."},"network_name":{"type":"string","description":"The name of the network object associated with the scanner group. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"id":{"type":"integer","description":"The unique ID of the scanner group."},"scanner_id":{"type":"integer","description":"The unique scanner ID of the scanner group."}}},"examples":{"response":{"value":{"scanner_pools":[{"creation_date":1545326169,"last_modification_date":1545345793,"owner_id":1,"owner":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","default_permissions":16,"user_permissions":128,"shared":1,"scan_count":0,"scanner_count":1,"uuid":"9b7b3d08-cc43-4e67-adc6-41b706c0b680","type":"load_balancing","name":"New Group Name","network_name":"Default","id":102823,"scanner_id":144057,"scanner_uuid":"9b7b3d08-cc43-4e67-adc6-41b706c0b680","owner_name":"system"},{"creation_date":1545326198,"last_modification_date":1545345902,"owner_id":1,"owner":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","default_permissions":16,"user_permissions":128,"shared":1,"scan_count":0,"scanner_count":1,"uuid":"80ac7fcd-429b-4858-9d85-207577f6a35c","type":"load_balancing","name":"Group New Name","network_name":"Columbia","id":102824,"scanner_id":144058,"scanner_uuid":"80ac7fcd-429b-4858-9d85-207577f6a35c","owner_name":"system"},{"creation_date":1545331154,"last_modification_date":1545331154,"owner_id":1,"owner":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","default_permissions":16,"user_permissions":128,"shared":1,"scan_count":0,"scanner_count":2,"uuid":"f00b532a-cbcd-4f9e-9292-9174083332df","type":"load_balancing","name":"test1","network_name":"San Francisco","id":102825,"scanner_id":144059,"scanner_uuid":"f00b532a-cbcd-4f9e-9292-9174083332df","owner_name":"system"}]}}}}}},"403":{"description":"Returned if you do not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanner-groups/{group_id}":{"get":{"summary":"List scanner group details","description":"Returns details for the specified scanner group.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanner-groups-details","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the scanner group details.","content":{"application/json":{"schema":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The creation date for the scanner group in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scanner group in Unix time."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scanner group."},"owner":{"type":"string","description":"The username of the owner of the scanner group."},"default_permissions":{"type":"integer","description":"The access permissions for the Default group."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scanner group."},"shared":{"type":"integer","description":"The shared status of the scanner-group."},"scan_count":{"type":"integer","description":"The number of scans currently tasked to the scanner group."},"scanner_count":{"type":"string","description":"The number of scanners associated with this scanner group."},"uuid":{"type":"string","description":"The UUID of the scanner group."},"token":{"type":"string","description":"The unique token for a scanner group."},"flag":{"type":"string","description":"The flag indicating what type of scanner group."},"type":{"type":"string","description":"The type of scanner group. This is set to \"load_balancing\" by default."},"name":{"type":"string","description":"The name of the scanner group."},"network_name":{"type":"string","description":"The name of the network object associated with the scanner group. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"id":{"type":"integer","description":"The unique ID of the scanner group."},"scanner_id":{"type":"integer","description":"The unique scanner ID of the scanner group."}}},"examples":{"response":{"value":{"creation_date":1545326169,"last_modification_date":1545326169,"owner_id":1,"owner":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","default_permissions":16,"user_permissions":128,"shared":1,"scan_count":0,"uuid":"9b7b3d08-cc43-4e67-adc6-41b706c0b680","type":"load_balancing","name":"New Scanner Group","network_name":"Default","id":102823,"scanner_id":144057,"scanner_uuid":"9b7b3d08-cc43-4e67-adc6-41b706c0b680","owner_name":"system"}}}}}},"403":{"description":"Returned if you do not have permission to view the scanner group."},"404":{"description":"Returned if Tenable.io cannot find the specified scanner group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update scanner group","description":"Updates a scanner group. \n\nYou cannot use this endpoint to assign a scanner group to a network object. Instead, use the [POST /networks/{network_id}/scanners/{scanner_uuid}](/reference#networks-assign-scanner) endpoint.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanner-groups-edit","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The new name for the scanner group."}},"required":["name"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully updates the scanner group.","content":{"application/json":{"schema":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The creation date for the scanner group in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scanner group in Unix time."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scanner group."},"owner":{"type":"string","description":"The username of the owner of the scanner group."},"default_permissions":{"type":"integer","description":"The access permissions for the Default group."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scanner group."},"shared":{"type":"integer","description":"The shared status of the scanner-group."},"scan_count":{"type":"integer","description":"The number of scans currently tasked to the scanner group."},"scanner_count":{"type":"string","description":"The number of scanners associated with this scanner group."},"uuid":{"type":"string","description":"The UUID of the scanner group."},"token":{"type":"string","description":"The unique token for a scanner group."},"flag":{"type":"string","description":"The flag indicating what type of scanner group."},"type":{"type":"string","description":"The type of scanner group. This is set to \"load_balancing\" by default."},"name":{"type":"string","description":"The name of the scanner group."},"network_name":{"type":"string","description":"The name of the network object associated with the scanner group. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"id":{"type":"integer","description":"The unique ID of the scanner group."},"scanner_id":{"type":"integer","description":"The unique scanner ID of the scanner group."}}},"examples":{"response":{"value":{"owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","created":1545326169245,"modified":1545345793683,"container_uuid":"36f234c4-4ae3-4353-9324-8ad3dcc7fcc5","uuid":"9b7b3d08-cc43-4e67-adc6-41b706c0b680","id":102823,"name":"New Group Name","type":"load_balancing","distributed":false,"default_permissions":16,"network_name":"Default","shared":1,"user_permissions":128,"created_in_seconds":1545326169,"modified_in_seconds":1545345793}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified scanner group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to update the scanner group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete a scanner group","description":"Deletes a scanner group.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanner-groups-delete","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deletes the specified scanner group.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified scanner group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to delete the scanner group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanner-groups/{group_id}/scanners":{"get":{"summary":"List scanners within scanner group","description":"Lists scanners associated with the scanner group.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanner-groups-list-scanners","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the list of scanners in the group.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the scanner."},"uuid":{"type":"string","description":"The UUID of the scanner."},"name":{"type":"string","description":"The user-defined name of the scanner."},"network_name":{"type":"string","description":"The name of the network object associated with the scanner. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"type":{"type":"string","description":"The type of scanner (local or remote)."},"status":{"type":"string","description":"The status of the scanner (on or off)."},"scan_count":{"type":"integer","description":"The current number of running scans on the scanner."},"engine_version":{"type":"string","description":"The version of the scanner."},"platform":{"type":"string","description":"The platform of the scanner."},"loaded_plugin_set":{"type":"string","description":"The current plugin set on the scanner."},"registration_code":{"type":"string","description":"The registration code of the scanner."},"owner":{"type":"string","description":"The owner of the scanner."},"key":{"type":"string","description":"An alpha-numeric sequence of characters used when linking a scanner to Tenable.io."},"license":{"type":"object","properties":{"type":{"type":"string","description":"The license type."},"ips":{"type":"integer","description":"The number of hosts the scanner is licensed to use."},"agents":{"type":"integer","description":"The number of hosts agents scanner is licensed to use."},"scanners":{"type":"integer","description":"The number of scanners the scanner is licensed to use."}}}}}},"examples":{"response":{"value":{"scanners":[{"creation_date":1543416914,"group":true,"id":141483,"key":"e3eeefeacca0d998c466af126549d68ef0f4e0d0ba3ab04a6e59a1d8a8a57079","last_connect":null,"last_modification_date":1543416914,"license":null,"linked":1,"name":"EU Frankfurt Cloud Scanners","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"source":"service","status":"on","timestamp":1543416914,"type":"local","uuid":"06ab826a-301d-7829-d2c4-37f400c0f949ea8cce60f523eeef"},{"creation_date":1543416914,"group":true,"id":141482,"key":"83520d0f4da8265cb52f7b558a3319ecb36d4b0ea490d4f9ec4ca9f2e1eee8b9","last_connect":null,"last_modification_date":1543416914,"license":null,"linked":1,"name":"AP Singapore Cloud Scanners","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"source":"service","status":"on","timestamp":1543416914,"type":"local","uuid":"1b895828-62a9-5084-8bc5-d4864a927fb10523d1e84e3fef44"},{"creation_date":1545331392,"group":true,"id":144060,"key":"7ceeb2b90a14d640093e5c6b6a163d0e625e575f71ee7dec9b4d97b90a874d98","last_connect":null,"last_modification_date":1545331392,"linked":1,"name":"Example Group","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"source":"service","status":"on","timestamp":1545331392,"type":"pool","uuid":"5bf560f7-1730-4006-bb38-c1ec69e73797"}]}}}}}},"403":{"description":"Returned if you do not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanner-groups/{group_id}/scanners/{scanner_id}":{"post":{"summary":"Add scanner to scanner group","description":"Adds a scanner to the scanner group.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanner-groups-add-scanner","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the scanner to add to the scanner group.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully adds the scanner to the scanner group.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"To do":"Add response sample here"}}}}}},"400":{"description":"Returned if you attempt to add a scanner group to another scanner group."},"409":{"description":"Returned if you attempt to add a scanner to a scanner group that the scanner is already a member of.","content":{"text/html":{"examples":{"response":{"value":{"error":"Scanner 00000000-0000-0000-0000-00000000000000000000000000001 already exists in group 9b7b3d08-cc43-4e67-adc6-41b706c0b680"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to add the scanner to the scanner group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Remove scanner from scanner group","description":"Remove a scanner from the scanner group.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanner-groups-delete-scanner","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the scanner to remove from the scanner group.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully removes the scanner from the scanner group.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to remove the scanner from the scanner group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanners":{"get":{"summary":"List scanners","description":"Returns the scanner list.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanners-list","tags":["Scanners"],"responses":{"200":{"description":"Returns the scanner list.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the scanner."},"uuid":{"type":"string","description":"The UUID of the scanner."},"name":{"type":"string","description":"The user-defined name of the scanner."},"network_name":{"type":"string","description":"The name of the network object associated with the scanner. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"type":{"type":"string","description":"The type of scanner (local or remote)."},"status":{"type":"string","description":"The status of the scanner (on or off)."},"scan_count":{"type":"integer","description":"The current number of running scans on the scanner."},"engine_version":{"type":"string","description":"The version of the scanner."},"platform":{"type":"string","description":"The platform of the scanner."},"loaded_plugin_set":{"type":"string","description":"The current plugin set on the scanner."},"registration_code":{"type":"string","description":"The registration code of the scanner."},"owner":{"type":"string","description":"The owner of the scanner."},"key":{"type":"string","description":"An alpha-numeric sequence of characters used when linking a scanner to Tenable.io."},"license":{"type":"object","properties":{"type":{"type":"string","description":"The license type."},"ips":{"type":"integer","description":"The number of hosts the scanner is licensed to use."},"agents":{"type":"integer","description":"The number of hosts agents scanner is licensed to use."},"scanners":{"type":"integer","description":"The number of scanners the scanner is licensed to use."}}}}}},"examples":{"response":{"value":{"scanners":[{"creation_date":1543416914,"group":true,"id":141483,"key":"e3eeefeacca0d998c466af126549d68ef0f4e0d0ba3ab04a6e59a1d8a8a57079","last_connect":null,"last_modification_date":1543416914,"license":{"agents":512,"ips":1024,"scanners":2,"users":10,"enterprise_pause":false,"expiration_date":1551160800,"evaluation":false,"apps":{"was":{"mode":"eval","expiration_date":1549299101}},"scanners_used":0,"agents_used":0},"linked":1,"name":"EU Frankfurt Cloud Scanners","network_name":"Default","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"shared":1,"source":"service","status":"on","timestamp":1543416914,"type":"local","user_permissions":64,"uuid":"06ab826a-301d-7829-d2c4-37f400c0f949ea8cce60f523eeef"},{"creation_date":1543416914,"group":true,"id":141484,"key":"70d1969c3a1a14697ad51f27f1ee4afe48ef535051d90f5481e32fd78005f05a","last_connect":null,"last_modification_date":1543416914,"license":{"agents":512,"ips":1024,"scanners":2,"users":10,"enterprise_pause":false,"expiration_date":1551160800,"evaluation":false,"apps":{"was":{"mode":"eval","expiration_date":1549299101}},"scanners_used":0,"agents_used":0},"linked":1,"name":"US Cloud Scanner","network_name":"Default","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"shared":1,"source":"service","status":"on","timestamp":1543416914,"type":"local","user_permissions":64,"uuid":"00000000-0000-0000-0000-00000000000000000000000000001"},{"creation_date":1543416914,"group":true,"id":141486,"key":"288b2c20c88c1c5d4dbd9a561713cfc91bacccb65d1d4f6e2edee244afc43c87","last_connect":null,"last_modification_date":1543416914,"license":{"agents":512,"ips":1024,"scanners":2,"users":10,"enterprise_pause":false,"expiration_date":1551160800,"evaluation":false,"apps":{"was":{"mode":"eval","expiration_date":1549299101}},"scanners_used":0,"agents_used":0},"linked":1,"name":"US West Cloud Scanners","network_name":"Default","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"shared":1,"source":"service","status":"on","timestamp":1543416914,"type":"local","user_permissions":64,"uuid":"37b315c1-f31f-cc8e-7e78-585c609fc1d7eba88f8d1e7d24b3"}]}}}}}},"403":{"description":"Returned if you do not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}":{"get":{"summary":"Get scanner details","description":"Returns details for the specified scanner.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanners-details","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the scanner details.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the scanner."},"uuid":{"type":"string","description":"The UUID of the scanner."},"name":{"type":"string","description":"The user-defined name of the scanner."},"network_name":{"type":"string","description":"The name of the network object associated with the scanner. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"type":{"type":"string","description":"The type of scanner (local or remote)."},"status":{"type":"string","description":"The status of the scanner (on or off)."},"scan_count":{"type":"integer","description":"The current number of running scans on the scanner."},"engine_version":{"type":"string","description":"The version of the scanner."},"platform":{"type":"string","description":"The platform of the scanner."},"loaded_plugin_set":{"type":"string","description":"The current plugin set on the scanner."},"registration_code":{"type":"string","description":"The registration code of the scanner."},"owner":{"type":"string","description":"The owner of the scanner."},"key":{"type":"string","description":"An alpha-numeric sequence of characters used when linking a scanner to Tenable.io."},"license":{"type":"object","properties":{"type":{"type":"string","description":"The license type."},"ips":{"type":"integer","description":"The number of hosts the scanner is licensed to use."},"agents":{"type":"integer","description":"The number of hosts agents scanner is licensed to use."},"scanners":{"type":"integer","description":"The number of scanners the scanner is licensed to use."}}}}},"examples":{"response":{"value":{"creation_date":1543416914,"group":true,"id":141482,"key":"83520d0f4da8265cb52f7b558a3319ecb36d4b0ea490d4f9ec4ca9f2e1eee8b9","last_connect":null,"last_modification_date":1543416914,"license":null,"linked":1,"name":"AP Singapore Cloud Scanners","network_name":"Default","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"shared":1,"source":"service","status":"on","timestamp":1543416914,"type":"local","user_permissions":64,"uuid":"1b895828-62a9-5084-8bc5-d4864a927fb10523d1e84e3fef44"}}}}}},"403":{"description":"Returned if you do not have permission to view the specified scanner."},"404":{"description":"Returned if Tenable.io cannot find the specified scanner."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update scanner","description":"Updates the specified scanner. \n\nYou cannot use this endpoint to assign the scanner to a network object. Instead, use the [POST /networks/{network_id}/scanners/{scanner_uuid}](/reference#networks-assign-scanner) endpoint.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanners-edit","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"force_plugin_update":{"type":"integer","description":"Pass 1 to force a plugin update.","format":"int32"},"force_ui_update":{"type":"integer","description":"Pass 1 to force a UI update.","format":"int32"},"finish_update":{"type":"integer","description":"Pass 1 to reboot the scanner and run the latest software update (only valid if automatic updates are disabled).","format":"int32"},"registration_code":{"type":"string","description":"Sets the registration code for the scanner."},"aws_update_interval":{"type":"integer","description":"For Amazon Web Services scanners this will tell the scanner how often to check in Tenable.io.","format":"int32"}}}}}},"responses":{"200":{"description":"Returned if Tenable.io succesfully updates the specified scanner.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the scanner."},"uuid":{"type":"string","description":"The UUID of the scanner."},"name":{"type":"string","description":"The user-defined name of the scanner."},"network_name":{"type":"string","description":"The name of the network object associated with the scanner. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."},"type":{"type":"string","description":"The type of scanner (local or remote)."},"status":{"type":"string","description":"The status of the scanner (on or off)."},"scan_count":{"type":"integer","description":"The current number of running scans on the scanner."},"engine_version":{"type":"string","description":"The version of the scanner."},"platform":{"type":"string","description":"The platform of the scanner."},"loaded_plugin_set":{"type":"string","description":"The current plugin set on the scanner."},"registration_code":{"type":"string","description":"The registration code of the scanner."},"owner":{"type":"string","description":"The owner of the scanner."},"key":{"type":"string","description":"An alpha-numeric sequence of characters used when linking a scanner to Tenable.io."},"license":{"type":"object","properties":{"type":{"type":"string","description":"The license type."},"ips":{"type":"integer","description":"The number of hosts the scanner is licensed to use."},"agents":{"type":"integer","description":"The number of hosts agents scanner is licensed to use."},"scanners":{"type":"integer","description":"The number of scanners the scanner is licensed to use."}}}}},"examples":{"response":{"value":{"owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","created":1543416914744,"modified":1545944374309,"container_uuid":"36f234c4-4ae3-4353-9324-8ad3dcc7fcc5","uuid":"06ab826a-301d-7829-d2c4-37f400c0f949ea8cce60f523eeef","id":141483,"network_id":"00000000-0000-0000-0000-000000000000","key":"e3eeefeacca0d998c466af126549d68ef0f4e0d0ba3ab04a6e59a1d8a8a57079","name":"EU Frankfurt Cloud Scanners","type":"local","system":true,"linked":1,"settings":{},"network_name":"Default","default_permissions":16,"shared":1,"user_permissions":64,"status":"on","lce":false,"pvs":false,"aws":false,"industrial_security":false,"webapp":false,"group":true,"can_factory_reset":false,"scanner_scanner":false,"system_group_scanner":true,"system_scanner_scanner":false,"system_webapp_scanner":false,"created_in_seconds":1543416914,"modified_in_seconds":1545944374}}}}}},"403":{"description":"Returned if you attempt to update a cloud scanner where you don't have edit permissions, or if you attempt to set a registration code for an Amazon Web Services scanner."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encounters an internal error while attempting to update the scanner.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete scanner","description":"Deletes and unlinks a scanner from Tenable.io.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanners-delete","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deletes/unlinks the scanner.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you attempt to delete the local scanner."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to delete the scanner.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/key":{"get":{"summary":"Get scanner key","description":"Gets the key of the requested scanner.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanners-get-scanner-key","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the scanner key.","content":{"application/json":{"schema":{"type":"object","properties":{"scanner_id":{"type":"string","description":"The key of the scanner."}}},"examples":{"response":{"value":{"key":"615f4cbeda288998dffe534d36385a422cd4e27be34dcdd7738dc0a01b787f5f"}}}}}},"403":{"description":"Returned if you do not have permission to view scanner data."},"404":{"description":"Returned if Tenable.io cannot find the specified scanner."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/aws-targets":{"get":{"summary":"List AWS scan targets","description":"Lists AWS scan targets if the requested scanner is an Amazon Web Services scanner.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanners-get-aws-targets","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the AWS target list for the specified scanner.","content":{"application/json":{"schema":{"type":"object","properties":{"scanner_id":{"type":"integer","description":"The ID of the scanner."},"instance_id":{"type":"string","description":"Unique instance identifier from Amazon."},"private_ip":{"type":"string","description":"Private IP address of the AWS instance."},"public_ip":{"type":"string","description":"Public IP address of the AWS instance."},"state":{"type":"string","description":"The state of the instance. Can be one of the following values: `running`, `stopped`, or `terminated`."},"zone":{"type":"string","description":"The availability zone for the instance. Example: `us-east-1a`, `us-east-1b`, etc..."},"type":{"type":"string","description":"The size of the instance. Example: `t2.small`, `t2.medium`, etc..."},"name":{"type":"string","description":"The user-defined name of the instance."}}},"examples":{"response":{"value":{"object":"aws-target"}}}}}},"403":{"description":"Returned if you do not have permission to view scanner data."},"404":{"description":"Returned if Tenable.io cannot find the specified scanner, or if the scanner is not an AWS scanner."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/scans":{"get":{"summary":"List running scans","description":"Lists scans running on the requested scanner.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanners-get-scans","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the list of scans running on the specified scanner.","content":{"application/json":{"schema":{"type":"object","properties":{"scanner_uuid":{"type":"string","description":"The UUID of the scanner the scan belongs to."},"name":{"type":"string","description":"The name of the scan."},"status":{"type":"string","description":"Scan status. One of pending, processing, stopping, pausing, paused, resuming, or running."},"id":{"type":"string","description":"The scan UUID."},"scan_id":{"type":"integer","description":"The ID of the scan."},"user":{"type":"string","description":"The username of the owner of the scan."},"last_modification_date":{"type":"integer","description":"The last time the scan was modified."},"start_time":{"type":"integer","description":"When the scan was started."},"remote":{"type":"boolean","description":"true if the scan is running remotely; false otherwise."},"network_id":{"type":"string","description":"The ID of the network object associated with the scanner currently running the scan. The default network ID is `00000000-0000-0000-0000-000000000000`. To determine the ID of a custom network, use the [GET /networks](/reference#networks-list) endpoint. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio)."}}},"examples":{"response":{"value":{"scans":[{"scan_id":36,"scanner_uuid":"00000000-0000-0000-0000-00000000000000000000000000001","name":"Basic Scan","status":"pending","id":"cd5c32e9-0b66-4c31-b61a-8d1bdd8a67ad","user":"API Demo User","user_uuid":"394a4be9-782d-406a-9d0a-695188260f0b","last_modification_date":1545945321,"start_time":1545945321,"network_id":"df4656fc-9ba8-4efb-bd1f-ff83991ec107"}]}}}}}},"403":{"description":"Returned if you do not have permission to view scanner data."},"404":{"description":"Returned if Tenable.io cannot find the specified scanner."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/scans/{scan_uuid}/control":{"post":{"summary":"Allow control of running scans","description":"Allows control of scans that are currently running on a scanner.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanners-control-scans","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The UUID of the scan.","required":true,"name":"scan_uuid","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","description":"An action to perform on a scan. Valid values are `stop`, `pause`, and `resume`."}},"required":["action"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully completes the specified action.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you do not have permission to perform the specified action."},"404":{"description":"Returned if Tenable.io cannot find the specified scan or scanner."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/link":{"put":{"summary":"Toggle scanner link state","description":"Enables or disables the link state of the scanner identified by `scanner_id`.<p>Requires SCAN MANAGER [40] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scanners-toggle-link-state","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"integer","description":"Pass `1` enable the link. Pass `0` to disable.","format":"int32"}},"required":["link"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully updates the link state of the scanner.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you attempt to edit a cloud scanner where you do not have edit permissions."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans":{"post":{"summary":"Create scan","description":"Creates a scan configuration.<p>Requires SCAN OPERATOR [24] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-create","tags":["Scans"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID for the editor template to use. Use the [GET /editor/scan/templates] (#editor-list-templates) endpoint to find the template UUID.","example":"ab4bacd2-05f6-425c-9d79-3ba3940ad1c24e51e1f403febe40"},"settings":{"type":"object","properties":{"name":{"type":"string","description":"The name of the scan."},"description":{"type":"string","description":"The description of the scan."},"policy_id":{"type":"integer","description":"The unique ID of the policy to use. If your user permissions are set to SCAN OPERATOR [24], this parameter is required. Use the [GET /policies] (#policies-list) endpoint to find the policy ID.","format":"int32"},"folder_id":{"type":"integer","description":"The unique ID of the destination folder for the scan. Use the [GET /folders] (#folders-list) endpoint to find the folder ID.","format":"int32"},"scanner_id":{"type":"integer","description":"The unique ID of the scanner to use. Use the [GET /scanners] (#scanners-list) endpoint to find the scanner ID.","example":"1","format":"int32"},"scanner_uuid":{"type":"string","description":"The UUID of the scanner to use. Use the [GET /scanners] (#scanners-list) endpoint to find the scanner UUID."},"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"launch":{"type":"string","description":"When to launch the scan. (i.e. ON\\_DEMAND, DAILY, WEEKLY, MONTHLY, YEARLY)","enum":["ON_DEMAND","DAILY","WEEKLY","MONTHLY","YEARLY"]},"starttime":{"type":"string","description":"The starting time and date for the scan (i.e. YYYYMMDDTHHMMSS).","example":"20140826T133000"},"rrules":{"type":"string","description":"The interval at which the scan repeats. The interval is formatted as a string of three values delimited by semi-colons. These values are: the frequency (FREQ=ONETIME or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). For a scan that runs every three weeks on Monday Wednesday and Friday, the string would be `FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR`.","example":"FREQ=DAILY;INTERVAL=1"},"timezone":{"type":"string","description":"The timezone for the scan schedule. Use the [GET /scans/timezones] (#scans-timezones) endpoint to find the scanner ID.","example":"America/New_York"},"text_targets":{"type":"string","description":"The list of targets to scan.","example":"localhost"},"file_targets":{"type":"string","description":"The name of a file containing the list of targets to scan. Use the [POST /files/upload] (#file-upload) endpoint to upload the file to Tenable.io.","example":"scan_targets.txt"},"tag_targets":{"type":"array","description":"The list of asset tag identifiers the scan uses to determine which assets it evaluates. For more information about tag-based scans, see [Manage Tag-Based Scans](/docs/manage-tag-based-scans-tio).","items":{"type":"string","description":"The UUID for an asset tag value. For more information about asset tags, see [Manage Asset Tags](/docs/manage-asset-tags-tio)."}},"agent_group_id":{"items":{"type":"string"},"description":"An array of agent group UUIDs to scan. Required if the scan is an agent scan.","type":"array"},"emails":{"type":"string","description":"A comma-separated list of accounts that receive the email summary report.","example":"test1@test.com, test2@test.com"},"acls":{"items":{"type":"object","properties":{"permissions":{"type":"integer","description":"The scan permission. For more information, see [Permissions](/docs/permissions)."},"owner":{"type":"integer","description":"A value that indicates whether the user or user group specified in the object owns the scan. Possible values include: `null` (system-owned permissions), `0` (the user is not the owner of the scan), `1` (the user is the owner of the scan)."},"display_name":{"type":"string","description":"The name of the user or group granted the specified permissions, as it appears in the Tenable.io user interface."},"name":{"type":"string","description":"The name of the user or group granted the specified permissions."},"id":{"type":"integer","description":"A number representing the order in which the user or user groups display in the Permissions tab in the Tenable.io user interface."},"type":{"type":"string","description":"The type of scan permissions: `default` (default permissions for the scan), `user` (permissions for an individual user), or `group` (permissions for a user group)."}}},"description":"An array containing permissions to apply to the scan.","type":"array","example":"[{\"type\": \"default\", \"permissions\": 16}, {\"type\": \"user\", \"permissions\": 64, \"name\": \"admin\", \"id\": 1, \"owner\": 1}]"}},"required":["name","enabled","text_targets"]}},"required":["uuid"]}}}},"responses":{"200":{"description":"Returned if Tenable.io creates the scan configuration successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"container_id":{"type":"string","description":"The unique ID of your Tenable.io instance."},"owner_uuid":{"type":"string","description":"The unique ID of the scan owner."},"uuid":{"type":"string","description":"The UUID of the schedule for the scan."},"name":{"type":"string","description":"The user-defined scan name."},"description":{"type":"string","description":"A brief user-defined description of the scan."},"policy_id":{"type":"integer","description":"The unique ID of the policy associated with the scan."},"scanner_id":{"type":"integer","description":"The unique ID of the scanner that the scan is configured to use.","example":"1","format":"int32"},"scanner_uuid":{"type":"string","description":"The UUID of the scanner that the scan is configured to use."},"emails":{"type":"string","description":"A comma-separated list of accounts that receive the email summary report.","example":"test1@test.com, test2@test.com"},"sms":{"type":"string","description":"A comma-separated list of mobile phone numbers that receive notification of the scan."},"enabled":{"type":"boolean","description":"A value indicating whether the scan schedule is active (`true`) or inactive (`false`)."},"dashboard_file":{"type":"string","description":"The name of the dashboard file associated with the scan."},"include_aggregate":{"type":"boolean","description":"A value indicating whether the scan results appear in dashboards."},"scan_time_window":{"type":"string","description":"The time frame during which agents must report in order to be included and visible in vulnerability reports. For non-agent scans, this attribute is `null`."},"custom_targets":{"type":"string","description":"Targets you specify in the text_targets parameter of the request message that creates or modifies the scan configuration."},"starttime":{"type":"string","description":"The scheduled start time for the scan."},"rrules":{"type":"string","description":"The interval at which the scan repeats. The interval is formatted as a string of three values delimited by semi-colons. These values are: the frequency (FREQ=ONETIME or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). For a scan that runs every three weeks on Monday Wednesday and Friday, the string would be `FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR`. If the scan is not scheduled to recur, this attribute is `null`. "},"timezone":{"type":"string","description":"The timezone for the scan."},"notification_filters":{"type":"array","description":"A list of filters that Tenable.io applies to determine whether it sends a notification email on scan completion to the recipients specified in the `emails` attribute.","items":{"type":"object","properties":{"value":{"type":"string","description":"The attribute value Tenable.io filters on. For example, when filtering on severity, this attribute might specify `Critical`."},"quality":{"type":"string","description":"The operator Tenable.io applies to the filter value, for example, `eq`."},"filter":{"type":"string","description":"The attribute name. For example, use the `risk_factor` attribute if you want to filter on vulnerability severity."}}}},"tag_targets":{"type":"array","description":"The list of asset tag identifiers the scan uses to determine which assets it evaluates. For more information about tag-based scans, see [Manage Tag-Based Scans](/docs/manage-tag-based-scans-tio).","items":{"type":"string","description":"The UUID for an asset tag value. For more information about asset tags, see [Manage Asset Tags](/docs/manage-asset-tags-tio)."}},"shared":{"type":"boolean","description":"If `1`, the scan is shared with users other than the scan owner. The level of sharing is specified in the `acls` attribute of the scan details."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scan.","format":"int32"},"default_permissions":{"type":"integer","description":"The default permissions for the scan.","format":"int32"},"owner":{"type":"string","description":"The owner of the scan."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scan."},"last_modification_date":{"type":"integer","description":"For newly-created scans, the date on which the scan configuration was created. For scans that have been launched at least once, this attribute does not represent the date on which the scan configuration was last modified. Instead, it represents the date on which the scan was last launched, in Unix time format. Tenable.io updates this attribute each time the scan launches.","format":"int32"},"creation_date":{"type":"integer","description":"For newly-created scans, the date on which the scan configuration was originally created. For scans that have been launched at least once, this attribute does not represent the date on which the scan configuration was originally created. Instead, it represents the date on which the scan was first launched, in Unix time format.","format":"int32"},"type":{"type":"string","description":"The type of scan."},"id":{"type":"integer","description":"The unique ID of the scan.","format":"int32"}}},"examples":{"response":{"value":{"scan":{"container_id":"40ac4662-6af3-4a0b-b422-93387ec0f298","owner_uuid":"50f84b7f-d1d3-4182-bb46-79cf5c51806e","uuid":"template-c311aa94-82d0-7827-6c71-72978df15544f4f660ba792e0b0f","name":"Full Network Scan","description":"Scan all hosts daily","policy_id":16,"scanner_id":null,"scanner_uuid":"00000000-0000-0000-0000-00000000000000000000000000001","emails":null,"sms":"","enabled":true,"dashboard_file":null,"include_aggregate":true,"scan_time_window":null,"custom_targets":"host1.example.com\r\nhost2.example.com\r\nhost3.example.com\r\nhost4.example.com\r\nhost5.example.com\r\n","starttime":null,"rrules":null,"timezone":"US-Central","notification_filters":null,"tag_targets":["6fb39d03-fc3d-470d-96f1-6dbb7bef1f51","715f11cc-c503-4a73-9dc2-cbfb1089616d"],"shared":0,"user_permissions":128,"default_permissions":0,"owner":"user2@example.com","owner_id":2,"last_modification_date":1544145190,"creation_date":1544145190,"type":"public","id":26}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encounters an error while attempting to save the scan.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List scans","description":"Returns a list of scans where you have at least CAN VIEW [16] permissions.<p>Requires BASIC [16] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-list","tags":["Scans"],"parameters":[{"description":"The ID of the folder where the scans you want to list are stored.","required":false,"name":"folder_id","in":"query","schema":{"type":"integer"}},{"description":"Limit the results to those scans that have only changed since the specified time.","required":false,"name":"last_modification_date","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the scan list.","content":{"application/json":{"schema":{"type":"object","properties":{"folders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the folder."},"name":{"type":"string","description":"The name of the folder."},"type":{"type":"string","description":"The type of the folder (main, trash, custom)."},"default_tag":{"type":"integer","description":"Whether or not the folder is the default (1 or 0)."},"custom":{"type":"integer","description":"The custom status of the folder (1 or 0)."},"unread_count":{"type":"integer","description":"The number of unread scans in the folder."}}}},"scans":{"type":"array","items":{"type":"object","properties":{"legacy":{"type":"boolean","description":"A value indicating whether the scan results were created before a change in storage method. If `true`, Tenable.io stores the results in the old storage method. If `false`, Tenable.io stores the results in the new storage method."},"permissions":{"type":"integer","description":"The requesting user's permissions for the scan.","format":"int32"},"type":{"type":"string","description":"The type of scan."},"read":{"type":"boolean","description":"A value indicating whether the user account associated with the request message has viewed the scan in the Tenable.io user interface. If `1`, the user account has viewed the scan results."},"last_modification_date":{"type":"integer","description":"For newly-created scans, the date on which the scan configuration was created. For scans that have been launched at least once, this attribute does not represent the date on which the scan configuration was last modified. Instead, it represents the date on which the scan was last launched, in Unix time format. Tenable.io updates this attribute each time the scan launches.","format":"int32"},"creation_date":{"type":"integer","description":"For newly-created scans, the date on which the scan configuration was originally created. For scans that have been launched at least once, this attribute does not represent the date on which the scan configuration was originally created. Instead, it represents the date on which the scan was first launched, in Unix time format.","format":"int32"},"status":{"type":"string","description":"The status of the scan (completed, aborted, imported, pending, running, resuming, canceling, canceled, pausing, paused, stopping, stopped)."},"uuid":{"type":"string","description":"The UUID of the scan."},"shared":{"type":"boolean","description":"If `true`, the scan is shared with users other than the scan owner. The level of sharing is specified in the `acls` attribute of the scan details."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scan.","format":"int32"},"owner":{"type":"string","description":"The owner of the scan."},"schedule_uuid":{"type":"string","description":"The UUID for a specific instance in the scan schedule."},"timezone":{"type":"string","description":"The timezone for the scan."},"rrules":{"type":"string","description":"The interval at which the scan repeats. The interval is formatted as a string of three values delimited by semi-colons. These values are: the frequency (FREQ=ONETIME or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). For a scan that runs every three weeks on Monday Wednesday and Friday, the string would be `FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR`. If the scan is not scheduled to recur, this attribute is `null`. "},"starttime":{"type":"string","description":"The scheduled start time for the scan."},"enabled":{"type":"boolean","description":"A value indicating whether the scan schedule is active (`true`) or inactive (`false`)."},"control":{"type":"boolean","description":"If `true`, the scan has a schedule and can be launched."},"name":{"type":"string","description":"The name of the scan."},"id":{"type":"integer","description":"The unique ID of the scan.","format":"int32"}}}},"timestamp":{"type":"integer","description":"The Unix timestamp when Tenable.io received the list request.","format":"int32"}}},"examples":{"response":{"value":{"folders":[{"unread_count":0,"custom":0,"default_tag":0,"type":"trash","name":"Trash","id":8},{"unread_count":0,"custom":0,"default_tag":1,"type":"main","name":"My Scans","id":9}],"scans":[{"legacy":false,"permissions":128,"type":null,"read":true,"last_modification_date":1430934526,"creation_date":1430933086,"status":"imported","uuid":"2776e999-1f5b-45b9-2e15-65a7be35b2e3ab8f7ecb158c480e","shared":false,"user_permissions":128,"owner":"user2@example.com","schedule_uuid":"0fafc7a8-c5f6-fe9d-68b9-4d60ab0d9d2cf60557ee0e264228","timezone":null,"rrules":null,"starttime":null,"enabled":false,"control":false,"name":"KitchenSinkScan","id":11},{"permissions":128,"type":null,"read":true,"last_modification_date":0,"creation_date":0,"status":"empty","uuid":null,"shared":false,"user_permissions":128,"owner":"user2@example.com","schedule_uuid":"template-c311aa94-82d0-7827-6c71-72978df15544f4f660ba792e0b0f","timezone":"US-Central","rrules":null,"starttime":null,"enabled":true,"control":true,"name":"Full Network Scan","id":26},{"permissions":128,"type":null,"read":true,"last_modification_date":0,"creation_date":0,"status":"empty","uuid":null,"shared":false,"user_permissions":128,"owner":"user2@example.com","schedule_uuid":"template-5f050b0a-6be6-1eb8-68dc-5a2f459ec7f710499ad7667391df","timezone":null,"rrules":null,"starttime":null,"enabled":false,"control":true,"name":"test-scan-2","id":25},{"permissions":128,"type":null,"read":true,"last_modification_date":0,"creation_date":0,"status":"empty","uuid":null,"shared":false,"user_permissions":128,"owner":"user2@example.com","schedule_uuid":"template-95626145-6b38-96bc-238f-148b1353910d0c27f2a930c2c843","timezone":null,"rrules":null,"starttime":null,"enabled":false,"control":true,"name":"test-scan","id":23},{"permissions":128,"type":null,"read":true,"last_modification_date":0,"creation_date":0,"status":"empty","uuid":null,"shared":false,"user_permissions":128,"owner":"user2@example.com","schedule_uuid":"template-ac665a85-2fca-f34c-9294-9bdc5bc925aee1c068e70183409e","timezone":null,"rrules":null,"starttime":null,"enabled":false,"control":true,"name":"basic Scan","id":21}],"timestamp":1544146142}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}":{"get":{"summary":"Get scan details","description":"Returns details for the specified scan.<p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-details","tags":["Scans"],"parameters":[{"description":"The identifier for the scan you want to retrieve. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string","format":"uuid"}},{"description":"The history\\_id of the historical data that should be returned.","name":"history_id","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The history\\_uuid of the historical data that should be returned.","name":"history_uuid","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the scan details.","content":{"application/json":{"schema":{"type":"object","properties":{"info":{"type":"object","properties":{"owner":{"type":"string","description":"The owner of the scan."},"name":{"type":"string","description":"The name of the scan."},"no_target":{"type":"boolean","description":"Indicates whether the scan based on this policy can specify targets."},"folder_id":{"type":"integer","description":"The unique ID of the destination folder for the scan.","format":"int32"},"control":{"type":"boolean","description":"If `true`, the scan has a schedule and can be launched."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scan.","format":"int32"},"schedule_uuid":{"type":"string","description":"The UUID for a specific instance in the scan schedule."},"edit_allowed":{"type":"boolean","description":"If `true`, the requesting user can edit this scan configuration."},"scanner_name":{"type":"string","description":"The name of the scanner configured to run the scan."},"policy":{"type":"string","description":"The name of the scan template associated with the scan."},"shared":{"type":"boolean","description":"If `true`, the scan is shared with users other than the owner. The level of sharing is specified in the `acls` attribute of the scan details."},"object_id":{"type":"integer","description":"","format":"int32"},"tag_targets":{"type":"array","description":"The list of asset tag identifiers the scan uses to determine which assets it evaluates. For more information about tag-based scans, see [Manage Tag-Based Scans](/docs/manage-tag-based-scans-tio).","items":{"type":"string","description":"The UUID for an asset tag value. For more information about asset tags, see [Manage Asset Tags](/docs/manage-asset-tags-tio)."}},"acls":{"type":"array","description":"An array of objects that control sharing permissions for the scan.","items":{"type":"object","properties":{"permissions":{"type":"integer","description":"The scan permission. For more information, see [Permissions](/docs/permissions)."},"owner":{"type":"integer","description":"A value that indicates whether the user or user group specified in the object owns the scan. Possible values include: `null` (system-owned permissions), `0` (the user is not the owner of the scan), `1` (the user is the owner of the scan)."},"display_name":{"type":"string","description":"The name of the user or group granted the specified permissions, as it appears in the Tenable.io user interface."},"name":{"type":"string","description":"The name of the user or group granted the specified permissions."},"id":{"type":"integer","description":"A number representing the order in which the user or user groups display in the Permissions tab in the Tenable.io user interface."},"type":{"type":"string","description":"The type of scan permissions: `default` (default permissions for the scan), `user` (permissions for an individual user), or `group` (permissions for a user group)."}}}},"hostcount":{"type":"integer","description":"The total number of assets scanned for vulnerabilities.","format":"int32"},"uuid":{"type":"string","description":"The UUID of the scan."},"status":{"type":"string","description":"The status of the scan (completed, aborted, imported, pending, running, resuming, canceling, canceled, pausing, paused, stopping, stopped)."},"scan_type":{"type":"string","description":"The type of scan: `local` (a credentialed scan performed over the network), `remote` (an uncredentialed scan performed over the network, `agent` (a scan on a local host that a Nessus agent performs directly), or `null` (the scan has never been launched, or the scan is imported)."},"targets":{"type":"string","description":"A comma-delimited list of IPv4 addresses that are configured as targets for the scan."},"alt_targets_used":{"type":"boolean","description":"If `true`, Tenable.io did not not launched with a target list. This parameter is `true` for agent scans."},"pci-can-upload":{"type":"boolean","description":"If `true`, you can submit the results of the scan for PCI ASV review. For more information, see [PCI ASV](https://docs.tenable.com/cloud/Content/PCI_ASV/Welcome.htm) in the Tenable.io Vulnerability Management User Guide."},"scan_start":{"type":"integer","description":"The Unix timestamp when the scan instance started.","format":"int32"},"timestamp":{"type":"integer","description":"The Unix timestamp when the scan instance finished."},"scan_end":{"type":"integer","description":"The Unix timestamp when the scan instance finished."},"haskb":{"type":"boolean","description":"Indicates whether a scan has a Knowledge Base (KB) associated with it. A KB is an ASCII text file containing a log of information relevant to the scan performed and results found."},"hasaudittrail":{"type":"boolean","description":"Indicates whether the scan is configured to create an audit trail."},"scanner_start":{"type":"string","description":"The scan's start time, if the scan is imported."},"scanner_end":{"type":"string","description":"The scan's end time, if the scan is imported."}}},"comphosts":{"type":"array","items":{"type":"object","properties":{"totalchecksconsidered":{"type":"integer","description":"The total number of checks considered on the host."},"numchecksconsidered":{"type":"integer","description":"The number of checks considered on the host."},"scanprogresstotal":{"type":"integer","description":"The total scan progress for the host."},"scanprogresscurrent":{"type":"integer","description":"The current scan progress for the host."},"host_index":{"type":"string","description":"The index for the host."},"score":{"type":"integer","description":"The overall score for the host."},"severitycount":{"type":"object","properties":{}},"progress":{"type":"string","description":"The scan progress of the host."},"critical":{"type":"integer","description":"The percentage of critical findings on the host."},"high":{"type":"integer","description":"The percentage of high findings on the host."},"medium":{"type":"integer","description":"The percentage of medium findings on the host."},"low":{"type":"integer","description":"The percentage of low findings on the host."},"info":{"type":"integer","description":"The percentage of info findings on the host."},"host_id":{"type":"integer","description":"The unique ID of the host."},"hostname":{"type":"string","description":"The name of the host."}}}},"hosts":{"type":"array","items":{"type":"object","properties":{"totalchecksconsidered":{"type":"integer","description":"The total number of checks considered on the host."},"numchecksconsidered":{"type":"integer","description":"The number of checks considered on the host."},"scanprogresstotal":{"type":"integer","description":"The total scan progress for the host."},"scanprogresscurrent":{"type":"integer","description":"The current scan progress for the host."},"host_index":{"type":"string","description":"The index for the host."},"score":{"type":"integer","description":"The overall score for the host."},"severitycount":{"type":"object","properties":{}},"progress":{"type":"string","description":"The scan progress of the host."},"critical":{"type":"integer","description":"The percentage of critical findings on the host."},"high":{"type":"integer","description":"The percentage of high findings on the host."},"medium":{"type":"integer","description":"The percentage of medium findings on the host."},"low":{"type":"integer","description":"The percentage of low findings on the host."},"info":{"type":"integer","description":"The percentage of info findings on the host."},"host_id":{"type":"integer","description":"The unique ID of the host."},"hostname":{"type":"string","description":"The name of the host."}}}},"notes":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the note."},"message":{"type":"string","description":"The specific message of the note."},"severity":{"type":"integer","description":"The severity of the note."}}}},"remediations":{"type":"object"},"vulnerabilities":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","description":"The number of vulnerabilities found."},"plugin_name":{"type":"string","description":"The name of the vulnerability plugin."},"vuln_index":{"type":"integer","description":"The index of the vulnerability plugin."},"severity":{"type":"integer","description":"The severity rating of the plugin."},"plugin_id":{"type":"integer","description":"The unique ID of the vulnerability plugin."},"severity_index":{"type":"integer","description":"The severity index order of the plugin."},"plugin_family":{"type":"string","description":"The parent family of the vulnerability plugin."}}}},"filters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The short name of the filter."},"readable_name":{"type":"string","description":"The long name of the filter."},"operators":{"description":"The comparison options for the filter.","type":"array","items":{"type":"string"}},"control":{"type":"object","properties":{"type":{"type":"string","description":"The input type (entry or dropdown)."},"readable_regest":{"type":"string","description":"The placeholder for the input."},"regex":{"type":"string","description":"A regex for checking the value of the input."},"options":{"description":"A list of options if the input is a dropdown.","type":"array","items":{"type":"string"}}}}}}},"history":{"type":"array","items":{"type":"object","properties":{"alt_targets_used":{"type":"boolean","description":"If `true`, Tenable.io did not not launched with a target list. This parameter is `true` for agent scans."},"scheduler":{"type":"integer","description":"If `true`, Tenable.io launched the scan automatically from a schedule."},"status":{"type":"string","description":"The status of the historical data."},"type":{"type":"string","description":"The type of scan: local, remote, or agent."},"uuid":{"type":"string","description":"The UUID of the historical data."},"last_modification_date":{"type":"integer","description":"The last modification date for the historical data in Unix time."},"creation_date":{"type":"integer","description":"The creation date for the historical data in Unix time."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scan."},"history_id":{"type":"integer","description":"The unique ID of the historical data."}}}},"compliance":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","description":"The number of vulnerabilities found."},"plugin_name":{"type":"string","description":"The name of the vulnerability plugin."},"vuln_index":{"type":"integer","description":"The index of the vulnerability plugin."},"severity":{"type":"integer","description":"The severity rating of the plugin."},"plugin_id":{"type":"integer","description":"The unique ID of the vulnerability plugin."},"severity_index":{"type":"integer","description":"The severity index order of the plugin."},"plugin_family":{"type":"string","description":"The parent family of the vulnerability plugin."}}}}}},"examples":{"response":{"value":{"info":{"owner":"user2@example.com","name":"KitchenSinkScan","no_target":false,"folder_id":9,"control":false,"user_permissions":128,"schedule_uuid":"0fafc7a8-c5f6-fe9d-68b9-4d60ab0d9d2cf60557ee0e264228","edit_allowed":false,"scanner_name":null,"policy":null,"shared":false,"object_id":11,"tag_targets":["6fb39d03-fc3d-470d-96f1-6dbb7bef1f51","715f11cc-c503-4a73-9dc2-cbfb1089616d"],"acls":[{"permissions":0,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"user2@example.com","name":"user2@example.com","id":2,"type":"user"}],"hostcount":10,"uuid":"2776e999-1f5b-45b9-2e15-65a7be35b2e3ab8f7ecb158c480e","status":"imported","scan_type":null,"targets":null,"alt_targets_used":null,"pci-can-upload":null,"scan_start":1430933086,"timestamp":1430934526,"scan_end":1430934526,"haskb":true,"hasaudittrail":true,"scanner_start":null,"scanner_end":null},"history":[{"history_id":10328682,"owner_id":2,"creation_date":1430933086,"last_modification_date":1430934526,"uuid":"2776e999-1f5b-45b9-2e15-65a7be35b2e3ab8f7ecb158c480e","type":null,"status":"imported","scheduler":0,"alt_targets_used":false}],"hosts":[{"asset_id":5,"host_id":5,"hostname":"172.204.81.57","progress":"100-100/200-200","scanprogresscurrent":100,"scanprogresstotal":100,"numchecksconsidered":100,"totalchecksconsidered":100,"severitycount":{"item":[{"count":156,"severitylevel":0},{"count":1,"severitylevel":1},{"count":6,"severitylevel":2},{"count":3,"severitylevel":3},{"count":0,"severitylevel":4}]},"severity":166,"score":3766,"info":156,"low":1,"medium":6,"high":3,"critical":0,"host_index":0},{"asset_id":3,"host_id":3,"hostname":"172.204.81.57","progress":"100-100/200-200","scanprogresscurrent":100,"scanprogresstotal":100,"numchecksconsidered":100,"totalchecksconsidered":100,"severitycount":{"item":[{"count":52,"severitylevel":0},{"count":11,"severitylevel":1},{"count":100,"severitylevel":2},{"count":58,"severitylevel":3},{"count":32,"severitylevel":4}]},"severity":253,"score":388162,"info":52,"low":11,"medium":100,"high":58,"critical":32,"host_index":1},{"asset_id":9,"host_id":9,"hostname":"172.204.81.57","progress":"100-100/200-200","scanprogresscurrent":100,"scanprogresstotal":100,"numchecksconsidered":100,"totalchecksconsidered":100,"severitycount":{"item":[{"count":115,"severitylevel":0},{"count":5,"severitylevel":1},{"count":21,"severitylevel":2},{"count":45,"severitylevel":3},{"count":16,"severitylevel":4}]},"severity":202,"score":207265,"info":115,"low":5,"medium":21,"high":45,"critical":16,"host_index":2}],"vulnerabilities":[{"count":68,"plugin_id":34220,"plugin_name":"Netstat Portscanner (WMI)","severity":0,"plugin_family":"Port scanners","vuln_index":1},{"count":65,"plugin_id":34252,"plugin_name":"Microsoft Windows Remote Listeners Enumeration (WMI)","severity":0,"plugin_family":"Windows","vuln_index":2},{"count":41,"plugin_id":14272,"plugin_name":"netstat portscanner (SSH)","severity":0,"plugin_family":"Port scanners","vuln_index":3}],"comphosts":[{"asset_id":5,"host_id":5,"hostname":"172.204.81.57","progress":"100-100/200-200","scanprogresscurrent":100,"scanprogresstotal":100,"numchecksconsidered":100,"totalchecksconsidered":100,"severitycount":{"item":[{"count":0,"severitylevel":0},{"count":145,"severitylevel":1},{"count":62,"severitylevel":2},{"count":0,"severitylevel":3},{"count":86,"severitylevel":4}]},"score":867650,"info":0,"low":145,"medium":62,"high":0,"critical":86,"host_index":0,"severity":293},{"asset_id":3,"host_id":3,"hostname":"172.204.81.57","progress":"100-100/200-200","scanprogresscurrent":100,"scanprogresstotal":100,"numchecksconsidered":100,"totalchecksconsidered":100,"severitycount":{"item":[{"count":0,"severitylevel":0},{"count":52,"severitylevel":1},{"count":1,"severitylevel":2},{"count":0,"severitylevel":3},{"count":45,"severitylevel":4}]},"score":450620,"info":0,"low":52,"medium":1,"high":0,"critical":45,"host_index":1,"severity":98},{"asset_id":9,"host_id":9,"hostname":"172.204.81.57","progress":"100-100/200-200","scanprogresscurrent":100,"scanprogresstotal":100,"numchecksconsidered":100,"totalchecksconsidered":100,"severitycount":{"item":[{"count":0,"severitylevel":0},{"count":61,"severitylevel":1},{"count":23,"severitylevel":2},{"count":0,"severitylevel":3},{"count":64,"severitylevel":4}]},"score":642910,"info":0,"low":61,"medium":23,"high":0,"critical":64,"host_index":2,"severity":148}],"compliance":[{"count":5,"host_id":0,"hostname":null,"plugin_family":"Unix Compliance Checks","plugin_id":"143e17d31e1a30830fcc2c3539d803d0","plugin_name":"BSI-100-2: S 4.13: /etc/group consistency - Careful allocation of identifiers","severity":1,"severity_index":0},{"count":5,"host_id":0,"hostname":null,"plugin_family":"Unix Compliance Checks","plugin_id":"21361aed1df4e64051bc939431ca3096","plugin_name":"BSI-100-2: S 4.105: No world writeable files - Preventing unauthorised acquisition of administrator rights","severity":3,"severity_index":1},{"count":5,"host_id":0,"hostname":null,"plugin_family":"Unix Compliance Checks","plugin_id":"5784176f032f448cb73b6cd4d4cff8be","plugin_name":"BSI-100-2: S 4.105: Rlogind must be deactivated","severity":3,"severity_index":2}],"filters":[{"name":"host.id","readable_name":"Asset ID","control":{"type":"entry","regex":"[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}(,[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})*","readable_regex":"01234567-abcd-ef01-2345-6789abcdef01"},"operators":["eq","neq","match","nmatch"],"group_name":"vulnerability"},{"name":"plugin.attributes.bid","readable_name":"Bugtraq ID","control":{"type":"entry","regex":"^[0-9]+(,[0-9]+)*","readable_regex":"NUMBER","maxlength":18},"operators":["eq","neq","match","nmatch"],"group_name":"vulnerability"},{"name":"plugin.attributes.exploit_framework_canvas","readable_name":"CANVAS Exploit Framework","control":{"type":"dropdown","list":["true","false"]},"operators":["eq","neq"],"group_name":"vulnerability"}],"notes":[{"message":"One or more AirWatch API settings are not set","title":"MDM501 AirWatch API settings misconfiguration"},{"message":"Unable to connect to the ActiveSync server.","title":"MDM501 ActiveSync connection error"},{"message":"ADSI server (matrix.tenablesecurity.com) could not connect to server.","title":"adsi_enum_directory_trusts.nbin: ADSI error"}],"remediations":{"num_cves":2536,"num_hosts":10,"num_remediated_cves":2283,"num_impacted_hosts":8,"remediations":[{"vulns":1,"value":"96a449d372af3d23ca9a4f9f9a2ea73e","hosts":1,"remediation":"FreeBSD : gpgme -- heap-based buffer overflow in gpgsm status handler (90ca3ba5-19e6-11e4-8616-001b3856973b): Update the affected package."},{"vulns":296,"value":"319a8ba9e264c876028b2a5abf5a1b0e","hosts":1,"remediation":"FreeBSD : mozilla -- multiple vulnerabilities (d0c97697-df2c-4b8b-bff2-cec24dc35af8): Update the affected packages."},{"vulns":0,"value":"c22105fdc2756d11c39d1380e58c8fbc","hosts":1,"remediation":"RHEL 6 / 7 : postgresql (RHSA-2015:0750): Update the affected packages."}]}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update scan","description":"Updates the scan configuration. For example, you can enable or disable a scan, change the scan name, description, folder, scanner, targets, and schedule parameters. <p>Requires SCAN MANAGER [40] user permissions and CAN CONFIGURE [64] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>\n<b>Note: </b>You can specify scan targets as text, input file, or target groups.","operationId":"scans-configure","tags":["Scans"],"parameters":[{"description":"The identifier for the scan you want to update. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","properties":{"name":{"type":"string","description":"The name of the scan."},"description":{"type":"string","description":"The description of the scan."},"folder_id":{"type":"integer","description":"The unique ID of the destination folder for the scan.","format":"int32"},"scanner_id":{"type":"integer","description":"The unique ID of the scanner to use.","example":"1","format":"int32"},"scanner_uuid":{"type":"string","description":"The UUID of the scanner to use. Use the [GET /scanners] (#scanners-list) endpoint to find the scanner UUID."},"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"launch":{"type":"string","description":"When to launch the scan. (i.e. DAILY, WEEKLY, MONTHLY, YEARLY)","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"]},"starttime":{"type":"string","description":"The starting time and date for the scan (i.e. YYYYMMDDTHHMMSS).","example":"20140826T133000"},"rrules":{"type":"string","description":"Expects a semi-colon delimited string comprised of three values. The frequency (FREQ=ONETIME or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). To create a scan that runs every three weeks on Monday Wednesday and Friday the string would be `FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR`","example":"FREQ=DAILY;INTERVAL=1"},"timezone":{"type":"string","description":"The timezone for the scan schedule.","example":"America/New_York"},"target_groups":{"items":{"type":"string"},"description":"An array of target group IDs to scan.","type":"array","example":"[2, 8, 12]"},"agent_group_id":{"items":{"type":"string"},"description":"An array of agent group UUIDs to scan. Required if the scan is an agent scan.","type":"array"},"text_targets":{"type":"string","description":"Comma separated list of targets to scan. Required for non-agent scans if no target groups are provided.","example":"localhost"},"file_targets":{"type":"string","description":"The name of a file containing the list of targets to scan.","example":"targets.txt"},"tag_targets":{"type":"array","description":"The list of asset tag identifiers the scan uses to determine which assets it evaluates. For more information about tag-based scans, see [Manage Tag-Based Scans](/docs/manage-tag-based-scans-tio).","items":{"type":"string","description":"The UUID for an asset tag value. For more information about asset tags, see [Manage Asset Tags](/docs/manage-asset-tags-tio)."}},"emails":{"type":"string","description":"A comma-separated list of accounts that receive the email summary report.","example":"test1@test.com, test2@test.com"},"acls":{"items":{"type":"object","properties":{"permissions":{"type":"integer","description":"The scan permission. For more information, see [Permissions](/docs/permissions)."},"owner":{"type":"integer","description":"A value that indicates whether the user or user group specified in the object owns the scan. Possible values include: `null` (system-owned permissions), `0` (the user is not the owner of the scan), `1` (the user is the owner of the scan)."},"display_name":{"type":"string","description":"The name of the user or group granted the specified permissions, as it appears in the Tenable.io user interface."},"name":{"type":"string","description":"The name of the user or group granted the specified permissions."},"id":{"type":"integer","description":"A number representing the order in which the user or user groups display in the Permissions tab in the Tenable.io user interface."},"type":{"type":"string","description":"The type of scan permissions: `default` (default permissions for the scan), `user` (permissions for an individual user), or `group` (permissions for a user group)."}}},"description":"An array containing sharing permissions to apply to the scan.","type":"array","example":"[{\"type\": \"default\", \"permissions\": 16}, {\"type\": \"user\", \"permissions\": 64, \"name\": \"admin\", \"id\": 1, \"owner\": 1}]"}},"required":["text_targets","file_targets","target_groups"]}}}}}},"responses":{"200":{"description":"Returned if Tenable.io updates the scan configuration as specified.","content":{"application/json":{"schema":{"type":"object","properties":{"container_id":{"type":"string","description":"The unique ID of your Tenable.io instance."},"owner_uuid":{"type":"string","description":"The unique ID of the scan owner."},"uuid":{"type":"string","description":"The UUID of the schedule for the scan."},"name":{"type":"string","description":"The user-defined scan name."},"description":{"type":"string","description":"A brief user-defined description of the scan."},"policy_id":{"type":"integer","description":"The unique ID of the policy associated with the scan."},"scanner_id":{"type":"integer","description":"The unique ID of the scanner that the scan is configured to use.","example":"1","format":"int32"},"scanner_uuid":{"type":"string","description":"The UUID of the scanner that the scan is configured to use."},"emails":{"type":"string","description":"A comma-separated list of accounts that receive the email summary report.","example":"test1@test.com, test2@test.com"},"sms":{"type":"string","description":"A comma-separated list of mobile phone numbers that receive notification of the scan."},"enabled":{"type":"boolean","description":"A value indicating whether the scan schedule is active (`true`) or inactive (`false`)."},"dashboard_file":{"type":"string","description":"The name of the dashboard file associated with the scan."},"include_aggregate":{"type":"boolean","description":"A value indicating whether the scan results appear in dashboards."},"scan_time_window":{"type":"string","description":"The time frame during which agents must report in order to be included and visible in vulnerability reports. For non-agent scans, this attribute is `null`."},"custom_targets":{"type":"string","description":"Targets you specify in the text_targets parameter of the request message that creates or modifies the scan configuration."},"starttime":{"type":"string","description":"The scheduled start time for the scan."},"rrules":{"type":"string","description":"The interval at which the scan repeats. The interval is formatted as a string of three values delimited by semi-colons. These values are: the frequency (FREQ=ONETIME or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). For a scan that runs every three weeks on Monday Wednesday and Friday, the string would be `FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR`. If the scan is not scheduled to recur, this attribute is `null`. "},"timezone":{"type":"string","description":"The timezone for the scan."},"notification_filters":{"type":"array","description":"A list of filters that Tenable.io applies to determine whether it sends a notification email on scan completion to the recipients specified in the `emails` attribute.","items":{"type":"object","properties":{"value":{"type":"string","description":"The attribute value Tenable.io filters on. For example, when filtering on severity, this attribute might specify `Critical`."},"quality":{"type":"string","description":"The operator Tenable.io applies to the filter value, for example, `eq`."},"filter":{"type":"string","description":"The attribute name. For example, use the `risk_factor` attribute if you want to filter on vulnerability severity."}}}},"tag_targets":{"type":"array","description":"The list of asset tag identifiers the scan uses to determine which assets it evaluates. For more information about tag-based scans, see [Manage Tag-Based Scans](/docs/manage-tag-based-scans-tio).","items":{"type":"string","description":"The UUID for an asset tag value. For more information about asset tags, see [Manage Asset Tags](/docs/manage-asset-tags-tio)."}},"shared":{"type":"boolean","description":"If `1`, the scan is shared with users other than the scan owner. The level of sharing is specified in the `acls` attribute of the scan details."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scan.","format":"int32"},"default_permissions":{"type":"integer","description":"The default permissions for the scan.","format":"int32"},"owner":{"type":"string","description":"The owner of the scan."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scan."},"last_modification_date":{"type":"integer","description":"For newly-created scans, the date on which the scan configuration was created. For scans that have been launched at least once, this attribute does not represent the date on which the scan configuration was last modified. Instead, it represents the date on which the scan was last launched, in Unix time format. Tenable.io updates this attribute each time the scan launches.","format":"int32"},"creation_date":{"type":"integer","description":"For newly-created scans, the date on which the scan configuration was originally created. For scans that have been launched at least once, this attribute does not represent the date on which the scan configuration was originally created. Instead, it represents the date on which the scan was first launched, in Unix time format.","format":"int32"},"type":{"type":"string","description":"The type of scan."},"id":{"type":"integer","description":"The unique ID of the scan.","format":"int32"}}},"examples":{"response":{"value":{"container_id":"40ac4662-6af3-4a0b-b422-93387ec0f298","owner_uuid":"50f84b7f-d1d3-4182-bb46-79cf5c51806e","uuid":"template-c311aa94-82d0-7827-6c71-72978df15544f4f660ba792e0b0f","name":"Basic Daily Network Scan","description":"Scan all hosts daily","policy_id":16,"scanner_id":null,"scanner_uuid":"00000000-0000-0000-0000-00000000000000000000000000001","emails":"","sms":"","enabled":false,"dashboard_file":null,"include_aggregate":true,"scan_time_window":null,"custom_targets":"host1.example.com\r\nhost2.example.com\r\nhost3.example.com\r\nhost4.example.com\r\nhost5.example.com\r\n","starttime":null,"rrules":null,"timezone":"US-Central","notification_filters":[{"value":"Critical","quality":"eq","filter":"risk_factor"}],"tag_targets":["6fb39d03-fc3d-470d-96f1-6dbb7bef1f51","715f11cc-c503-4a73-9dc2-cbfb1089616d"],"shared":0,"user_permissions":128,"default_permissions":0,"owner":"user2@example.com","owner_id":2,"last_modification_date":1544207231,"creation_date":1544145190,"type":"public","id":26}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified scan."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encounters an error while attempting to save the configuration.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete scan","description":"Deletes a scan.\n**Note:** You cannot delete scans in running, paused, or stopping states.<p>Requires SCAN MANAGER [40] user permissions and CAN CONFIGURE [64] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-delete","tags":["Scans"],"parameters":[{"description":"The identifier for the scan you want to delete. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deletes the specified scan configuration.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to delete the scan.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/launch":{"post":{"summary":"Launch scan","description":"Launches a scan.<p>Requires SCAN OPERATOR [24] user permissions and CAN CONTROL [32] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-launch","tags":["Scans"],"parameters":[{"description":"The identifier for the scan you want to launch. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"alt_targets":{"items":{"type":"string"},"description":"If you include this parameter, Tenable.io scans these targets instead of the default. Value can be an array where each index is a target, or an array with a single index of comma-separated targets.","type":"array"}}}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully launches the scan.","content":{"application/json":{"schema":{"type":"object","properties":{"scan_uuid":{"type":"string"}}},"examples":{"response":{"value":{"scan_uuid":"e7f6c3f2-1718-4451-b459-1e8aa2ec6cdf"}}}}}},"403":{"description":"Returned if Tenable.io cannot launch the scan because the scan is disabled."},"404":{"description":"Returned if Tenable.io cannot find the specified scan."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/pause":{"post":{"summary":"Pause scan","description":"Pauses a scan.<p>Requires SCAN OPERATOR [24] user permissions and CAN CONTROL [32] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-pause","tags":["Scans"],"parameters":[{"description":"The identifier for the scan you want to pause. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully queues the scan to pause.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified scan."},"409":{"description":"Returned if the scan is not currently active."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/resume":{"post":{"summary":"Resume scan","description":"Resumes a scan.<p>Requires SCAN OPERATOR [24] user permissions and CAN CONTROL [32] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-resume","tags":["Scans"],"parameters":[{"description":"The identifier for the scan you want to resume. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully queues the scan to resume.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified scan."},"409":{"description":"Returned if the scan is not currently active."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/stop":{"post":{"summary":"Stop scan","description":"Stops a scan.<p>Requires SCAN OPERATOR [24] user permissions and CAN CONTROL [32] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-stop","tags":["Scans"],"parameters":[{"description":"The identifier for the scan you want to stop. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully queues the scan to stop.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified scan."},"409":{"description":"Returned if the scan is not currently active."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/schedule":{"put":{"summary":"Enable schedule","description":"Enables or disables a scan schedule.<p>Requires SCAN OPERATOR [24] user permisisons and CAN CONTROL [32] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-schedule","tags":["Scans"],"parameters":[{"description":"The identifier for the scan you want to schedule. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enables or disables the scan schedule."}},"required":["enabled"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully enabled or disabled the scan schedule.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"control":{"type":"boolean","description":"If `true`, the scan has a schedule and can be launched."},"rrules":{"type":"string","description":"Indicates whether the schedule is enabled."},"starttime":{"type":"string","description":"Indicates whether the schedule is enabled."},"timezone":{"type":"string","description":"Indicates whether the schedule is enabled."}}},"examples":{"response":{"value":{"control":true,"enabled":false,"rrules":"FREQ=DAILY;INTERVAL=1","timezone":"US/Central","starttime":"20181206T230000"}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified scan."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the scan does not have a schedule to enable.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/latest-status":{"get":{"summary":"Get latest scan status","description":"Returns the latest status for a scan. Status values can include:<ul><li>aborted—Tenable.io or the scanner encountered problems during the latest run and aborted the scan. The scan results associated with the run reflect only the completed tasks.</li><li>canceled—At user request, Tenable.io successfully stopped the latest scan run.</li><li>completed—The latest run of the scan completed.</li><li>empty—The scan configuration is new or has yet to run.</li><li>imported—A user imported the scan. You cannot run imported scans. Scan history is unavailable for imported scans.</li><li>pausing—A user paused a running scan, and Tenable.io is in the process of terminating tasks for the scan.</li><li>paused—At user request, Tenable.io successfully paused active tasks related to the scan. The paused tasks continue to fill the task capacity of the scanner that the tasks were assigned to. Tenable.io does not dispatch new tasks from a paused scan job. If the scan remains in a paused state for more than 14 days, the scan times out. Tenable.io then aborts the related tasks on the scanner and categorizes the scan as aborted.</li><li>processing—Tenable.io is processing tasks for the scan. For example, Tenable.io may be importing scan results from the scanner that performed the latest run of the scan.</li><li>resuming—Tenable.io is restarting tasks for a paused scan. When you resume a scan, Tenable.io instructs the scanner to start the tasks from the point at which the scan was paused. If Tenable.io or the scanner encounters problems when resuming the scan, the scan fails, and Tenable.io updates the scan status to aborted.</li><li>running—The scan is currently running.</li><li>stopping—A user stopped a pending, running, or paused scan, and Tenable.io is in the process of terminating tasks for the scan.</ul><br><p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-get-latest-status","tags":["Scans"],"parameters":[{"description":"The identifier for the scan. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully retrieves the scan status.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The latest status of the scan."}}},"examples":{"response":{"value":{"status":"imported"}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified scan."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n  <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encounters an error while attempting to retrieve the status.","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n      <h1>429 Too Many Requests</h1>\n    </center>\n <hr>\n  <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/status":{"put":{"summary":"Update scan status","description":"Changes the status of a scan.<p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-read-status","tags":["Scans"],"parameters":[{"description":"The identifier for the scan. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"read":{"type":"boolean","description":"If `true`, the scan has been read."}},"required":["read"]}}}},"responses":{"200":{"description":"Returned if Tenable.io updates the scan status.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified scan."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/copy":{"post":{"summary":"Copy scan","description":"Copies the specified scan.<p>Requires SCAN OPERATOR [24] user permissions and CAN CONFIGURE [64] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-copy","tags":["Scans"],"parameters":[{"description":"The identifier for the scan you want to copy. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"folder_id":{"type":"integer","description":"The ID of the destination folder. If you don't specify a folder ID, Tenable.io creates the copy in the same folder as the original.","format":"int32"},"name":{"type":"string","description":"The name of the copied scan. If you don't specify a name, Tenable.io uses the same name as the original with \"Copy of\" prefix."}}}}}},"responses":{"200":{"description":"Returns the copied scan object.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the scan."},"status":{"type":"string","description":"The status of the scan (completed, aborted, imported, pending, running, resuming, canceling, canceled, pausing, paused, stopping, stopped)."},"id":{"type":"integer","description":"The unique ID of the scan."},"last_modification_date":{"type":"integer","description":"For newly-created scans, the date on which the scan configuration was created. For scans that have been launched at least once, this attribute does not represent the date on which the scan configuration was last modified. Instead, it represents the date on which the scan was last launched, in Unix time format. Tenable.io updates this attribute each time the scan launches.","format":"int32"},"uuid":{"type":"string","description":"The UUID of the scan."},"type":{"type":"string","description":"The type of scan (local, remote, or agent)."},"owner":{"type":"string","description":"The owner of the scan."},"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"read":{"type":"boolean","description":"If `true`, the scan has been read."},"shared":{"type":"boolean","description":"If `1`, the scan is shared with users other than the scan owner. The level of sharing is specified in the `acls` attribute of the scan details."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scan."},"creation_date":{"type":"integer","description":"The creation date for the scan in Unix time."},"control":{"type":"boolean","description":"If `true`, the scan has a schedule and can be launched."},"starttime":{"type":"string","description":"The scheduled start time for the scan."},"timezone":{"type":"string","description":"The timezone for the scan."},"rrules":{"type":"string","description":"The interval at which the scan repeats. The interval is formatted as a string of three values delimited by semi-colons. These values are: the frequency (FREQ=ONETIME or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). For a scan that runs every three weeks on Monday Wednesday and Friday, the string would be `FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR`. If the scan is not scheduled to recur, this attribute is `null`. "},"schedule_uuid":{"type":"string","description":"The UUID for a specific instance in the scan schedule."}}},"examples":{"response":{"value":{"timezone":"US-Central","enabled":false,"last_modification_date":1544207231,"id":28,"status":"empty","user_permissions":128,"owner":"user@example.com","starttime":null,"control":true,"uuid":"6240fb62-e950-5a07-90fa-9a82634a851615c4912d35e1c64c","rrules":null,"creation_date":1544145190,"read":false,"shared":false,"name":"Copy of Basic Network Scan - Daily"}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified scan."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encounters an error while attempting to copy.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scans/import":{"post":{"summary":"Import uploaded scan","description":"Import an existing scan uploaded using [Upload File] (#file-upload) endpoint.\n**Note:** You cannot import results from scans run more than 15 months ago.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-import","tags":["Scans"],"parameters":[{"description":"Specifies whether to include the imported scan data in the vulnerabilities dashboard views. To include, use `1`. To exclude, use `0`. If you don't specify the include_aggregate parameter, the data does not appear in the dashboard.","required":false,"name":"include_aggregate","in":"query","schema":{"type":"integer","enum":[0,1]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"The name of the file to import as provided by the response from [Upload File] (#file-upload) endpoint."},"folder_id":{"type":"integer","description":"The ID of the destination folder. If you omit this parameter, Tenable.io stores the imported scan in the default folder.","format":"int32"},"password":{"type":"string","description":"The password for the file to import (required for nessus.db).","format":"password"}},"required":["file"]}}}},"responses":{"200":{"description":"Returns the scan object.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the scan."},"status":{"type":"string","description":"The status of the scan (completed, aborted, imported, pending, running, resuming, canceling, canceled, pausing, paused, stopping, stopped)."},"id":{"type":"integer","description":"The unique ID of the scan."},"last_modification_date":{"type":"integer","description":"For newly-created scans, the date on which the scan configuration was created. For scans that have been launched at least once, this attribute does not represent the date on which the scan configuration was last modified. Instead, it represents the date on which the scan was last launched, in Unix time format. Tenable.io updates this attribute each time the scan launches.","format":"int32"},"uuid":{"type":"string","description":"The UUID of the scan."},"type":{"type":"string","description":"The type of scan (local, remote, or agent)."},"owner":{"type":"string","description":"The owner of the scan."},"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"read":{"type":"boolean","description":"If `true`, the scan has been read."},"shared":{"type":"boolean","description":"If `1`, the scan is shared with users other than the scan owner. The level of sharing is specified in the `acls` attribute of the scan details."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scan."},"creation_date":{"type":"integer","description":"The creation date for the scan in Unix time."},"control":{"type":"boolean","description":"If `true`, the scan has a schedule and can be launched."},"starttime":{"type":"string","description":"The scheduled start time for the scan."},"timezone":{"type":"string","description":"The timezone for the scan."},"rrules":{"type":"string","description":"The interval at which the scan repeats. The interval is formatted as a string of three values delimited by semi-colons. These values are: the frequency (FREQ=ONETIME or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). For a scan that runs every three weeks on Monday Wednesday and Friday, the string would be `FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR`. If the scan is not scheduled to recur, this attribute is `null`. "},"schedule_uuid":{"type":"string","description":"The UUID for a specific instance in the scan schedule."}}},"examples":{"response":{"value":{"scan":{"timezone":null,"id":38,"last_modification_date":1544219402,"status":"imported","user_permissions":128,"folder_id":null,"owner":"user2@example.com","control":null,"starttime":null,"uuid":"25f3b839-3e4b-aa38-252f-f4614dbe5b170e3fa8eea4c7cb27","rrules":null,"creation_date":1544219402,"read":false,"name":"KitchenSinkScan","shared":false}}}}}}},"409":{"description":"Returned if you attempt to import results from scans run more than 15 months ago.","content":{"text/html":{"examples":{"response":{"value":{"error":"{\"error\":\"Scans older than 06/01/2018 cannot be imported.\"}"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to import the scan.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/export":{"post":{"summary":"Export scan","description":"Export the specified scan. To see the status of the requested export, submit an <a href=\"#scans-export-status\">export status</a> request. On receiving a \"ready\" status from the export-status request, download the export file using the <a href=\"#scans-export-download\">export download</a> method.\n\n**Note:** If you request a scan export in the `nessus` file format, but do not specify filters for the export, Tenable.io truncates the plugins output data in the export file at 5 MB or 5,000,000 characters, and appends `TRUNCATED` (bracketed by three asterisks) at the end of the output in the export file. You can obtain the full plugins output by exporting the scan in any other file format than `nessus`.<p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-export-request","tags":["Scans"],"parameters":[{"description":"The identifier for the scan you want to export. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}},{"description":"The ID of the historical data that should be exported.","required":false,"name":"history_id","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The UUID of the historical data that should be returned.","required":false,"name":"history_uuid","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string","description":"The file format to use (Nessus, HTML, PDF, CSV, or DB).","enum":["nessus","html","pdf","csv","db"]},"password":{"type":"string","description":"The password used to encrypt database exports (\\*Required when exporting as DB).","format":"password"},"chapters":{"type":"string","description":"The chapters to include in the export (expecting a semi-colon delimited string comprised of some combination of the following options: vuln\\_hosts\\_summary, vuln\\_by\\_host, compliance\\_exec, remediations, vuln\\_by\\_plugin, compliance)"},"filter.0.filter":{"type":"string","description":"The name of the filter to apply to the exported scan report. You can find available filters by using the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. If you specify the name of the filter, you must specify the operator as the `filter.0.quality` parameter and the value as the `filter.0.value` parameter. To use multiple filters, increment the `<INDEX>` portion of `filter.<INDEX>.filter`, for example, `filter.1.filter`. For more information about using this parameter, see [Scan Export Filters](/docs/scan-export-filters-tio)."},"filter.0.quality":{"type":"string","description":"The operator of the filter to apply to the exported scan report. You can find the operators for the filter using the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. To use multiple filters, increment the `<INDEX>` portion of `filter.<INDEX>.quality`, for example, `filter.1.quality`. For more information about using this parameter, see [Scan Export Filters](/docs/scan-export-filters-tio)."},"filter.0.value":{"type":"string","description":"The value of the filter to apply to the exported scan report. You can find valid values for the filter in the `control` attribute of the objects returned by the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. To use multiple filters, increment the `<INDEX>` portion of `filter.<INDEX>.value`, for example, `filter.1.value`. For more information about using this parameter, see [Scan Export Filters](/docs/scan-export-filters-tio)."},"filter.search_type":{"type":"string","description":"For multiple filters, specifies whether to use the AND or the OR logical operator. The default is AND. For more information about using this parameter, see [Scan Export Filters](/docs/scan-export-filters-tio).","enum":["and","or"]},"asset_id":{"type":"integer","description":"The ID of the asset scanned.","format":"int32"}},"required":["format","chapters","asset_id"]}}}},"responses":{"200":{"description":"Returned if Tenable.io queues the export successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string"},"temp_token":{"type":"string"}}},"examples":{"response":{"value":{"file":778874546,"temp_token":"995bdb656fc6dc5d76e18ccafe7fbd390618fcd0257e0e1aa121f4412a6f7ecc"}}}}}},"400":{"description":"Returned if your request message is missing a required parameter."},"404":{"description":"Returned if Tenable.io cannot find the specified scan."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/export/{file_id}/status":{"get":{"summary":"Check scan export status","description":"Check the file status of an exported scan. When an export has been requested, it is necessary to poll this endpoint until a \"ready\" status is returned, at which point the file is complete and can be downloaded using the <a href=\"#scans-export-download\">export download</a> endpoint.<p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-export-status","tags":["Scans"],"parameters":[{"description":"The identifier for the scan. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}},{"description":"The ID of the file to poll (Included in response from /scans/{scan\\_id}/export).","required":true,"name":"file_id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the status of the file. A status of `ready` indicates the file can be downloaded.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The export status."}}},"examples":{"response":{"value":{"status":"ready"}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified file."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/export/{file_id}/download":{"get":{"summary":"Download exported scan","description":"Download an exported scan.<p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-export-download","tags":["Scans"],"parameters":[{"description":"The identifier for the exported scan you want to download. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}},{"description":"The ID of the file to download (Included in response from /scans/{scan\\_id}/export).","required":true,"name":"file_id","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the content of the file as an attachment.","content":{"application/octet-stream":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified file."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/history":{"get":{"summary":"Get scan history","description":"Returns a scan's history records.<p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-history","tags":["Scans"],"parameters":[{"description":"The identifier for the scan. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}},{"description":"Maximum number of objects requested (or service imposed limit if not in request). The max limit value allowed is 50. Must be in the int32 format.","required":false,"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"Offset from request (or zero). Must be in the int32 format.","required":false,"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a scan's history records.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of objects matching your search criteria. Must be in the int32 format."},"limit":{"type":"integer","description":"Maximum number of objects requested (or service imposed limit if not in request). Must be in the int32 format."},"offset":{"type":"integer","description":"Offset from request (or zero). Must be in the int32 format."},"sort":{"description":"An array of objects representing the fields you specified as sort fields in the request message, which Tenable.io uses to sort the returned data.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The field on which Tenable.io sorts the results."},"order":{"type":"string","description":"The direction of the sort order. Supported values are `asc` (ascending) and `desc` (descending)."}}}}}},"history":{"type":"array","items":{"type":"object","properties":{"time_end":{"type":"integer","description":"The date the scan completed in Unix time."},"scan_uuid":{"type":"string","description":"The scan history's UUID."},"time_start":{"type":"integer","description":"The date the scan started in Unix time."},"visibility":{"type":"string","description":"The visibility of the scan in workbenches (public or private)."},"targets":{"type":"object","description":"The target parameters used to launch the scan.","properties":{"custom":{"type":"boolean","description":"If `true`, custom parameters were used to launch the scan."},"default":{"type":"boolean","description":"If `true`, default parameters were used to launch the scan.."}}},"status":{"type":"string","description":"The status of the scan (completed, aborted, imported, pending, running, resuming, canceling, canceled, pausing, paused, stopping, stopped)."}}}}}},"examples":{"response":{"value":{"pagination":{"offset":0,"total":8,"sort":[{"order":"DESC","name":"start_date"}],"limit":50},"history":[{"time_end":1545945607,"scan_uuid":"1732621d-a7c3-4295-bbc9-37035112ff0a","id":10535512,"time_start":1545945482,"visibility":"public","targets":{"custom":false,"default":null},"status":"canceled"},{"time_end":1545945457,"scan_uuid":"cd5c32e9-0b66-4c31-b61a-8d1bdd8a67ad","id":10535505,"time_start":1545945321,"visibility":"public","targets":{"custom":false,"default":null},"status":"completed"},{"time_end":1545944767,"scan_uuid":"34e04696-2abf-4767-86cb-c51eb26a3511","id":10535496,"time_start":1545944637,"visibility":"public","targets":{"custom":false,"default":null},"status":"completed"},{"time_end":1545877987,"scan_uuid":"47ee2c49-9422-4082-9b5b-48d0883bc76e","id":10534608,"time_start":1545877843,"visibility":"public","targets":{"custom":false,"default":null},"status":"aborted"},{"time_end":1545877717,"scan_uuid":"0a20f6f1-cb6e-4947-ab71-8121dddff8e9","id":10534601,"time_start":1545877590,"visibility":"public","targets":{"custom":false,"default":null},"status":"aborted"},{"time_end":1545877057,"scan_uuid":"2b346502-d769-452e-9c2e-0c50033852d2","id":10534598,"time_start":1545876907,"visibility":"public","targets":{"custom":false,"default":null},"status":"aborted"},{"time_end":1545871897,"scan_uuid":"e80fa271-8a6e-44e8-bdcf-dc75274d4b25","id":10534540,"time_start":1545871758,"visibility":"public","targets":{"custom":false,"default":null},"status":"aborted"},{"time_end":1545871177,"scan_uuid":"36984557-946d-4858-8af7-ded422fee78b","id":10534536,"time_start":1545871035,"visibility":"public","targets":{"custom":false,"default":null},"status":"aborted"}]}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified `scan_id`."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/history/{history_uuid}":{"get":{"summary":"Get scan history details","description":"Returns the details of a previous result of a scan.<p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-history-details","tags":["Scans"],"parameters":[{"description":"The identifier for the scan. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}},{"description":"The UUID of the historical scan result to return details about. You can use either the `history_uuid` or the numeric `history_id` attribute. You can find the ID values by examining the scan details object returned by the [GET /scans/{scan_id}](#scans-details) endpoint.","required":true,"name":"history_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns details of the historical scan result.","content":{"application/json":{"schema":{"type":"object","properties":{"alt_targets_used":{"type":"boolean","description":"If `true`, Tenable.io did not not launched with a target list. This parameter is `true` for agent scans."},"scheduler":{"type":"integer","description":"If `true`, Tenable.io launched the scan automatically from a schedule."},"status":{"type":"string","description":"The status of the historical data."},"type":{"type":"string","description":"The type of scan: local, remote, or agent."},"uuid":{"type":"string","description":"The UUID of the historical data."},"last_modification_date":{"type":"integer","description":"The last modification date for the historical data in Unix time."},"creation_date":{"type":"integer","description":"The creation date for the historical data in Unix time."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scan."},"history_id":{"type":"integer","description":"The unique ID of the historical data."}}},"examples":{"response":{"value":{"owner_id":2,"schedule_uuid":"template-c47a2aec-516d-20fc-6128-e8cbbb9864d1c98ab9a2d2e18e78","status":"aborted","scan_start":1543870842,"owner_uuid":"6ee44fda-eced-400b-a574-503884bdafa5","owner":"user2@example.com","targets":"","object_id":10509951,"uuid":"7cf03b42-ee6b-4d89-aa83-6c726509b369","scan_end":null,"scan_type":"remote","name":"Advanced Windows Servers Scan"}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified `scan_id` or `history_uuid`."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/history/{history_id}":{"delete":{"summary":"Delete scan history","description":"Deletes historical results from a scan.<p>Requires SCAN OPERATOR [24] user permissions and CAN CONFIGURE [64] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-delete-history","tags":["Scans"],"parameters":[{"description":"The identifier for the scan. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}},{"description":"The ID of the results to delete.","required":true,"name":"history_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deleted the specified scan results.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified scan results."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to delete the scan results.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"501":{"description":"Returned if Tenable.io does not support deleting historical scan results.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":501,"error":"Not Implemented","message":"This feature is not yet implemented."}}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_uuid}/hosts/{host_id}":{"get":{"summary":"Get host details","description":"Returns details for the specified host.<p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-host-details","tags":["Scans"],"parameters":[{"description":"The identifier for the scan. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_uuid","in":"path","schema":{"type":"string"}},{"description":"The ID of the host to retrieve.","required":true,"name":"host_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the historical data that should be returned.","name":"history_id","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the historical data that should be returned.","name":"history_uuid","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the host details.","content":{"application/json":{"schema":{"type":"object","properties":{"info":{"type":"object"},"compliance":{"type":"array","items":{"type":"object","properties":{"host_id":{"type":"integer","description":"The unique ID of the host."},"hostname":{"type":"string","description":"The name of the host."},"plugin_id":{"type":"integer","description":"The unique ID of the vulnerability plugin."},"plugin_name":{"type":"string","description":"The name of the vulnerability plugin."},"plugin_family":{"type":"string","description":"The parent family of the vulnerability plugin."},"count":{"type":"integer","description":"The number of vulnerabilities found."},"severity_index":{"type":"integer","description":"The severity index order of the plugin."},"severity":{"type":"integer","description":"The severity of plugin."}}}},"vulnerabilities":{"type":"array","items":{"type":"object","properties":{"host_id":{"type":"integer","description":"The unique ID of the host."},"hostname":{"type":"string","description":"The name of the host."},"plugin_id":{"type":"integer","description":"The unique ID of the vulnerability plugin."},"plugin_name":{"type":"string","description":"The name of the vulnerability plugin."},"plugin_family":{"type":"string","description":"The parent family of the vulnerability plugin."},"count":{"type":"integer","description":"The number of vulnerabilities found."},"vuln_index":{"type":"integer","description":"The index of the vulnerability plugin."},"severity_index":{"type":"integer","description":"The severity index order of the plugin."},"severity":{"type":"integer","description":"The severity of plugin."}}}}}},"examples":{"response":{"value":{"info":{"mac-address":null,"host-fqdn":"matrixcentos5_matrix","host-ip":"172.204.81.57","operating-system":["Linux Kernel 2.6.18-274.el5PAE on CentOS release 5.7 (Final)"],"host_end":"Fri Dec 7 21:46:59 2018","host_start":"Fri Dec 7 21:46:59 2018"},"vulnerabilities":[{"count":7,"host_id":9,"hostname":"172.204.81.57","plugin_family":"Port scanners","plugin_id":14272,"plugin_name":"Netstat Portscanner (SSH)","severity":0,"severity_index":0,"vuln_index":0},{"count":7,"host_id":9,"hostname":"172.204.81.57","plugin_family":"Service detection","plugin_id":25221,"plugin_name":"Remote listeners enumeration (Linux / AIX)","severity":0,"severity_index":0,"vuln_index":0},{"count":4,"host_id":9,"hostname":"172.204.81.57","plugin_family":"Service detection","plugin_id":11111,"plugin_name":"RPC Services Enumeration","severity":0,"severity_index":0,"vuln_index":0}],"compliance":[{"count":1,"host_id":9,"hostname":"172.204.81.57","plugin_family":"Unix Compliance Checks","plugin_id":"0042cf05a8358f531c68c8bd249a4874","plugin_name":"BSI-100-2: S 4.105: Telnet should be replaced by SSH.","severity":1,"severity_index":0},{"count":1,"host_id":9,"hostname":"172.204.81.57","plugin_family":"Unix Compliance Checks","plugin_id":"0483f10c66f3ecf1f2ec55cf47365416","plugin_name":"BSI-100-2: S 4.105: /usr/X11R6/bin/startx - `xhost +` should never be used.","severity":3,"severity_index":1},{"count":1,"host_id":9,"hostname":"172.204.81.57","plugin_family":"Unix Compliance Checks","plugin_id":"04a999b7e2dbe28fc1c76b15237a39a2","plugin_name":"Red Hat 6 is not installed on target","severity":2,"severity_index":2}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_uuid}/hosts/{host_id}/plugins/{plugin_id}":{"get":{"summary":"Get plugin output","description":"Returns the output for a specified plugin.<p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-plugin-output","tags":["Scans"],"parameters":[{"description":"The identifier for the scan. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_uuid","in":"path","schema":{"type":"string"}},{"description":"The ID of the host to retrieve.","required":true,"name":"host_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the plugin to retrieve.","required":true,"name":"plugin_id","in":"path","schema":{"type":"string"}},{"description":"The ID of the historical data that should be returned.","name":"history_id","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The UUID of the historical data that should be returned.","name":"history_uuid","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the plugin output.","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"array","items":{"type":"object","properties":{"ports":{"type":"object","properties":{}},"has_attachment":{"type":"integer","description":"If the value is 1, the plugin output contains files that may be exported."},"custom_description":{"type":"string","description":"A custom description of the plugin."},"plugin_output":{"type":"string","description":"The text of the plugin output."},"hosts":{"type":"string","description":"Other hosts with the same output."},"severity":{"type":"integer","description":"The severity the output."}}}},"info":{"type":"object","properties":{"host-fqdn":{"type":"string","description":"The host's fully qualified domain name; optional."},"host_fqdn":{"type":"string","description":"The FQDN of the host. Normally, this is populated with the value used to scan the host in the target list of the last scan that was ran where it was seen; always present."},"host-ip":{"type":"string","description":"The host's IPv4 address; optional."},"host-uuid":{"type":"string","description":"The host's UUID generated by Tenable.io for identification purposes; always present."},"host_start":{"type":"string","description":"The last time a scan was started for this host as an ISO 8601 timestamp; always present."},"host_end":{"type":"string","description":"The last time a scan was completed for this host as an ISO 8601 timestamp; always present."},"mac-address":{"type":"string","description":"The hosts's mac addresses in a newline-separated list; optional."}}}}},"examples":{"response":{"value":{"outputs":[{"ports":{"445 / tcp / cifs":[{"hostname":"172.204.81.57"}]},"has_attachment":0,"severity":0,"plugin_output":"\nThe following DCERPC services are available remotely :\n\nObject UUID : 765294ba-60bc-48b8-92e9-89fd77769d91\nUUID : d95afe70-a6d5-4259-822e-2c84da1ddb0d, version 1.0\nDescription : Unknown RPC service\nType : Remote RPC service\nNamed pipe : \\PIPE\\InitShutdown\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : b08669ee-8cb5-43a5-a017-84fe00000000\nUUID : 76f226c3-ec14-4325-8a99-6a46348418af, version 1.0\nDescription : Unknown RPC service\nType : Remote RPC service\nNamed pipe : \\PIPE\\InitShutdown\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 0767a036-0d22-48aa-ba69-b619480f38cb, version 1.0\nDescription : Unknown RPC service\nAnnotation : PcaSvc\nType : Remote RPC service\nNamed pipe : \\pipe\\trkwks\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345778-1234-abcd-ef00-0123456789ac, version 1.0\nDescription : Security Account Manager\nWindows process : lsass.exe\nType : Remote RPC service\nNamed pipe : \\pipe\\lsass\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345778-1234-abcd-ef00-0123456789ac, version 1.0\nDescription : Security Account Manager\nWindows process : lsass.exe\nType : Remote RPC service\nNamed pipe : \\PIPE\\protected_storage\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3473dd4d-2e88-4006-9cba-22570909dd10, version 5.0\nDescription : Unknown RPC service\nAnnotation : WinHttp Auto-Proxy Service\nType : Remote RPC service\nNamed pipe : \\PIPE\\W32TIME_ALT\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 1ff70682-0a51-30e8-076d-740be8cee98b, version 1.0\nDescription : Scheduler Service\nWindows process : svchost.exe\nType : Remote RPC service\nNamed pipe : \\PIPE\\atsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 378e52b0-c0a9-11cf-822d-00aa0051e40f, version 1.0\nDescription : Scheduler Service\nWindows process : svchost.exe\nType : Remote RPC service\nNamed pipe : \\PIPE\\atsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 86d35949-83c9-4044-b424-db363231fd0c, version 1.0\nDescription : Unknown RPC service\nType : Remote RPC service\nNamed pipe : \\PIPE\\atsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : a398e520-d59a-4bdd-aa7a-3c1e0303a511, version 1.0\nDescription : Unknown RPC service\nAnnotation : IKE/Authip API\nType : Remote RPC service\nNamed pipe : \\PIPE\\atsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 552d076a-cb29-4e44-8b6a-d15e59e2c0af, version 1.0\nDescription : Unknown RPC service\nAnnotation : IP Transition Configuration endpoint\nType : Remote RPC service\nNamed pipe : \\PIPE\\atsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 98716d03-89ac-44c7-bb8c-285824e51c4a, version 1.0\nDescription : Unknown RPC service\nAnnotation : XactSrv service\nType : Remote RPC service\nNamed pipe : \\PIPE\\atsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 201ef99a-7fa0-444c-9399-19ba84f12a1a, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\atsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 201ef99a-7fa0-444c-9399-19ba84f12a1a, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\srvsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 201ef99a-7fa0-444c-9399-19ba84f12a1a, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\browser\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 5f54ce7d-5b79-4175-8584-cb65313a0e98, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\atsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 5f54ce7d-5b79-4175-8584-cb65313a0e98, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\srvsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 5f54ce7d-5b79-4175-8584-cb65313a0e98, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\browser\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : fd7a0523-dc70-43dd-9b2e-9c5ed48225b1, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\atsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : fd7a0523-dc70-43dd-9b2e-9c5ed48225b1, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\srvsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : fd7a0523-dc70-43dd-9b2e-9c5ed48225b1, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\browser\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 58e604e8-9adb-4d2e-a464-3b0683fb1480, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\atsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 58e604e8-9adb-4d2e-a464-3b0683fb1480, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\srvsvc\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 58e604e8-9adb-4d2e-a464-3b0683fb1480, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nNamed pipe : \\PIPE\\browser\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : f6beaff7-1e19-4fbb-9f8f-b89e2018337c, version 1.0\nDescription : Unknown RPC service\nAnnotation : Event log TCPIP\nType : Remote RPC service\nNamed pipe : \\pipe\\eventlog\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 30adc50c-5cbc-46ce-9a0e-91914789e23c, version 1.0\nDescription : Unknown RPC service\nAnnotation : NRP server endpoint\nType : Remote RPC service\nNamed pipe : \\pipe\\eventlog\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d5, version 1.0\nDescription : DHCP Client Service\nWindows process : svchost.exe\nAnnotation : DHCP Client LRPC Endpoint\nType : Remote RPC service\nNamed pipe : \\pipe\\eventlog\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d6, version 1.0\nDescription : Unknown RPC service\nAnnotation : DHCPv6 Client LRPC Endpoint\nType : Remote RPC service\nNamed pipe : \\pipe\\eventlog\nNetbios name : \\\\WIN764-UTIL\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 06bba54a-be05-49f9-b0a0-30f790261023, version 1.0\nDescription : Unknown RPC service\nAnnotation : Security Center\nType : Remote RPC service\nNamed pipe : \\pipe\\eventlog\nNetbios name : \\\\WIN764-UTIL\n\n","hosts":null,"custom_description":null},{"ports":{"135 / tcp / epmap":[{"hostname":"172.204.81.57"}]},"has_attachment":0,"severity":0,"plugin_output":"\nThe following DCERPC services are available locally :\n\nObject UUID : 765294ba-60bc-48b8-92e9-89fd77769d91\nUUID : d95afe70-a6d5-4259-822e-2c84da1ddb0d, version 1.0\nDescription : Unknown RPC service\nType : Local RPC service\nNamed pipe : WindowsShutdown\n\nObject UUID : 765294ba-60bc-48b8-92e9-89fd77769d91\nUUID : d95afe70-a6d5-4259-822e-2c84da1ddb0d, version 1.0\nDescription : Unknown RPC service\nType : Local RPC service\nNamed pipe : WMsgKRpc080D30\n\nObject UUID : b08669ee-8cb5-43a5-a017-84fe00000000\nUUID : 76f226c3-ec14-4325-8a99-6a46348418af, version 1.0\nDescription : Unknown RPC service\nType : Local RPC service\nNamed pipe : WindowsShutdown\n\nObject UUID : b08669ee-8cb5-43a5-a017-84fe00000000\nUUID : 76f226c3-ec14-4325-8a99-6a46348418af, version 1.0\nDescription : Unknown RPC service\nType : Local RPC service\nNamed pipe : WMsgKRpc080D30\n\nObject UUID : 6d726574-7273-0076-0000-000000000000\nUUID : c9ac6db5-82b7-4e55-ae8a-e464ed7b4277, version 1.0\nDescription : Unknown RPC service\nAnnotation : Impl friendly name\nType : Local RPC service\nNamed pipe : LRPC-1c3977acb41cea1124\n\nObject UUID : 52ef130c-08fd-4388-86b3-6edf00000001\nUUID : 12e65dd8-887f-41ef-91bf-8d816c42c2e7, version 1.0\nDescription : Unknown RPC service\nAnnotation : Secure Desktop LRPC interface\nType : Local RPC service\nNamed pipe : WMsgKRpc080F61\n\nObject UUID : b08669ee-8cb5-43a5-a017-84fe00000001\nUUID : 76f226c3-ec14-4325-8a99-6a46348418af, version 1.0\nDescription : Unknown RPC service\nType : Local RPC service\nNamed pipe : WMsgKRpc080F61\n\nObject UUID : 8d6696ea-1fe0-42cf-89e9-788c0c0bed65\nUUID : 906b0ce0-c70b-1067-b317-00dd010662da, version 1.0\nDescription : Distributed Transaction Coordinator\nWindows process : msdtc.exe\nType : Local RPC service\nNamed pipe : LRPC-1f8c246f740d47d8e2\n\nObject UUID : 36833313-dcb3-4e11-901d-4d9bbd1c431e\nUUID : 906b0ce0-c70b-1067-b317-00dd010662da, version 1.0\nDescription : Distributed Transaction Coordinator\nWindows process : msdtc.exe\nType : Local RPC service\nNamed pipe : LRPC-1f8c246f740d47d8e2\n\nObject UUID : 3e594dc9-6140-44a0-96f3-c5fe867c50d0\nUUID : 906b0ce0-c70b-1067-b317-00dd010662da, version 1.0\nDescription : Distributed Transaction Coordinator\nWindows process : msdtc.exe\nType : Local RPC service\nNamed pipe : LRPC-1f8c246f740d47d8e2\n\nObject UUID : 5ee96290-1a81-45db-b4e6-8f26c5b72870\nUUID : 906b0ce0-c70b-1067-b317-00dd010662da, version 1.0\nDescription : Distributed Transaction Coordinator\nWindows process : msdtc.exe\nType : Local RPC service\nNamed pipe : LRPC-1f8c246f740d47d8e2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345678-1234-abcd-ef00-0123456789ab, version 1.0\nDescription : IPsec Services (Windows XP & 2003)\nWindows process : lsass.exe\nAnnotation : IPSec Policy agent endpoint\nType : Local RPC service\nNamed pipe : LRPC-b5787f2c3745e80e78\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 0767a036-0d22-48aa-ba69-b619480f38cb, version 1.0\nDescription : Unknown RPC service\nAnnotation : PcaSvc\nType : Local RPC service\nNamed pipe : OLE9B946BCEF2704168BDBCB83E70EF\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 0767a036-0d22-48aa-ba69-b619480f38cb, version 1.0\nDescription : Unknown RPC service\nAnnotation : PcaSvc\nType : Local RPC service\nNamed pipe : trkwks\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345778-1234-abcd-ef00-0123456789ac, version 1.0\nDescription : Security Account Manager\nWindows process : lsass.exe\nType : Local RPC service\nNamed pipe : LRPC-055bf0579030efacc0\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345778-1234-abcd-ef00-0123456789ac, version 1.0\nDescription : Security Account Manager\nWindows process : lsass.exe\nType : Local RPC service\nNamed pipe : audit\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345778-1234-abcd-ef00-0123456789ac, version 1.0\nDescription : Security Account Manager\nWindows process : lsass.exe\nType : Local RPC service\nNamed pipe : securityevent\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345778-1234-abcd-ef00-0123456789ac, version 1.0\nDescription : Security Account Manager\nWindows process : lsass.exe\nType : Local RPC service\nNamed pipe : LSARPC_ENDPOINT\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345778-1234-abcd-ef00-0123456789ac, version 1.0\nDescription : Security Account Manager\nWindows process : lsass.exe\nType : Local RPC service\nNamed pipe : lsapolicylookup\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345778-1234-abcd-ef00-0123456789ac, version 1.0\nDescription : Security Account Manager\nWindows process : lsass.exe\nType : Local RPC service\nNamed pipe : lsasspirpc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345778-1234-abcd-ef00-0123456789ac, version 1.0\nDescription : Security Account Manager\nWindows process : lsass.exe\nType : Local RPC service\nNamed pipe : protected_storage\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345778-1234-abcd-ef00-0123456789ac, version 1.0\nDescription : Security Account Manager\nWindows process : lsass.exe\nType : Local RPC service\nNamed pipe : samss lpc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : dd490425-5325-4565-b774-7e27d6c09c24, version 1.0\nDescription : Unknown RPC service\nAnnotation : Base Firewall Engine API\nType : Local RPC service\nNamed pipe : LRPC-1bee010807d4fce7f5\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 7f9d11bf-7fb9-436b-a812-b2d50c5d4c03, version 1.0\nDescription : Unknown RPC service\nAnnotation : Fw APIs\nType : Local RPC service\nNamed pipe : LRPC-1bee010807d4fce7f5\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 2fb92682-6599-42dc-ae13-bd2ca89bd11c, version 1.0\nDescription : Unknown RPC service\nAnnotation : Fw APIs\nType : Local RPC service\nNamed pipe : LRPC-1bee010807d4fce7f5\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 0b6edbfa-4a24-4fc6-8a23-942b1eca65d1, version 1.0\nDescription : Unknown RPC service\nAnnotation : Spooler function endpoint\nType : Local RPC service\nNamed pipe : spoolss\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : ae33069b-a2a8-46ee-a235-ddfd339be281, version 1.0\nDescription : Unknown RPC service\nAnnotation : Spooler base remote object endpoint\nType : Local RPC service\nNamed pipe : spoolss\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 4a452661-8290-4b36-8fbe-7f4093a94978, version 1.0\nDescription : Unknown RPC service\nAnnotation : Spooler function endpoint\nType : Local RPC service\nNamed pipe : spoolss\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 7ea70bcf-48af-4f6a-8968-6a440754d5fa, version 1.0\nDescription : Unknown RPC service\nAnnotation : NSI server endpoint\nType : Local RPC service\nNamed pipe : OLE1555EBBE48654F7BBACABDD0A0E0\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 7ea70bcf-48af-4f6a-8968-6a440754d5fa, version 1.0\nDescription : Unknown RPC service\nAnnotation : NSI server endpoint\nType : Local RPC service\nNamed pipe : LRPC-1195853e231b3360c7\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3473dd4d-2e88-4006-9cba-22570909dd10, version 5.0\nDescription : Unknown RPC service\nAnnotation : WinHttp Auto-Proxy Service\nType : Local RPC service\nNamed pipe : OLE1555EBBE48654F7BBACABDD0A0E0\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3473dd4d-2e88-4006-9cba-22570909dd10, version 5.0\nDescription : Unknown RPC service\nAnnotation : WinHttp Auto-Proxy Service\nType : Local RPC service\nNamed pipe : LRPC-1195853e231b3360c7\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3473dd4d-2e88-4006-9cba-22570909dd10, version 5.0\nDescription : Unknown RPC service\nAnnotation : WinHttp Auto-Proxy Service\nType : Local RPC service\nNamed pipe : W32TIME_ALT\n\nObject UUID : 666f7270-6c69-7365-0000-000000000000\nUUID : c9ac6db5-82b7-4e55-ae8a-e464ed7b4277, version 1.0\nDescription : Unknown RPC service\nAnnotation : Impl friendly name\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 6c637067-6569-746e-0000-000000000000\nUUID : c9ac6db5-82b7-4e55-ae8a-e464ed7b4277, version 1.0\nDescription : Unknown RPC service\nAnnotation : Impl friendly name\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 24d1f7c7-76af-4f28-9ccd-7f6cb6468601\nUUID : 2eb08e3e-639f-4fba-97b1-14f878961076, version 1.0\nDescription : Unknown RPC service\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 736e6573-0000-0000-0000-000000000000\nUUID : c9ac6db5-82b7-4e55-ae8a-e464ed7b4277, version 1.0\nDescription : Unknown RPC service\nAnnotation : Impl friendly name\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 736e6573-0000-0000-0000-000000000000\nUUID : c9ac6db5-82b7-4e55-ae8a-e464ed7b4277, version 1.0\nDescription : Unknown RPC service\nAnnotation : Impl friendly name\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 736e6573-0000-0000-0000-000000000000\nUUID : c9ac6db5-82b7-4e55-ae8a-e464ed7b4277, version 1.0\nDescription : Unknown RPC service\nAnnotation : Impl friendly name\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 0a74ef1c-41a4-4e06-83ae-dc74fb1cdd53, version 1.0\nDescription : Scheduler Service\nWindows process : svchost.exe\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 0a74ef1c-41a4-4e06-83ae-dc74fb1cdd53, version 1.0\nDescription : Scheduler Service\nWindows process : svchost.exe\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 0a74ef1c-41a4-4e06-83ae-dc74fb1cdd53, version 1.0\nDescription : Scheduler Service\nWindows process : svchost.exe\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 1ff70682-0a51-30e8-076d-740be8cee98b, version 1.0\nDescription : Scheduler Service\nWindows process : svchost.exe\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 1ff70682-0a51-30e8-076d-740be8cee98b, version 1.0\nDescription : Scheduler Service\nWindows process : svchost.exe\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 1ff70682-0a51-30e8-076d-740be8cee98b, version 1.0\nDescription : Scheduler Service\nWindows process : svchost.exe\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 378e52b0-c0a9-11cf-822d-00aa0051e40f, version 1.0\nDescription : Scheduler Service\nWindows process : svchost.exe\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 378e52b0-c0a9-11cf-822d-00aa0051e40f, version 1.0\nDescription : Scheduler Service\nWindows process : svchost.exe\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 378e52b0-c0a9-11cf-822d-00aa0051e40f, version 1.0\nDescription : Scheduler Service\nWindows process : svchost.exe\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 86d35949-83c9-4044-b424-db363231fd0c, version 1.0\nDescription : Unknown RPC service\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 86d35949-83c9-4044-b424-db363231fd0c, version 1.0\nDescription : Unknown RPC service\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 86d35949-83c9-4044-b424-db363231fd0c, version 1.0\nDescription : Unknown RPC service\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : a398e520-d59a-4bdd-aa7a-3c1e0303a511, version 1.0\nDescription : Unknown RPC service\nAnnotation : IKE/Authip API\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : a398e520-d59a-4bdd-aa7a-3c1e0303a511, version 1.0\nDescription : Unknown RPC service\nAnnotation : IKE/Authip API\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : a398e520-d59a-4bdd-aa7a-3c1e0303a511, version 1.0\nDescription : Unknown RPC service\nAnnotation : IKE/Authip API\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 552d076a-cb29-4e44-8b6a-d15e59e2c0af, version 1.0\nDescription : Unknown RPC service\nAnnotation : IP Transition Configuration endpoint\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 552d076a-cb29-4e44-8b6a-d15e59e2c0af, version 1.0\nDescription : Unknown RPC service\nAnnotation : IP Transition Configuration endpoint\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 552d076a-cb29-4e44-8b6a-d15e59e2c0af, version 1.0\nDescription : Unknown RPC service\nAnnotation : IP Transition Configuration endpoint\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 98716d03-89ac-44c7-bb8c-285824e51c4a, version 1.0\nDescription : Unknown RPC service\nAnnotation : XactSrv service\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 98716d03-89ac-44c7-bb8c-285824e51c4a, version 1.0\nDescription : Unknown RPC service\nAnnotation : XactSrv service\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 98716d03-89ac-44c7-bb8c-285824e51c4a, version 1.0\nDescription : Unknown RPC service\nAnnotation : XactSrv service\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 201ef99a-7fa0-444c-9399-19ba84f12a1a, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 201ef99a-7fa0-444c-9399-19ba84f12a1a, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 201ef99a-7fa0-444c-9399-19ba84f12a1a, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 5f54ce7d-5b79-4175-8584-cb65313a0e98, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 5f54ce7d-5b79-4175-8584-cb65313a0e98, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 5f54ce7d-5b79-4175-8584-cb65313a0e98, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : fd7a0523-dc70-43dd-9b2e-9c5ed48225b1, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : fd7a0523-dc70-43dd-9b2e-9c5ed48225b1, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : fd7a0523-dc70-43dd-9b2e-9c5ed48225b1, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 58e604e8-9adb-4d2e-a464-3b0683fb1480, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : IUserProfile2\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 58e604e8-9adb-4d2e-a464-3b0683fb1480, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : OLEE4DBCACEC38F463A8D7319C3ED20\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 58e604e8-9adb-4d2e-a464-3b0683fb1480, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Local RPC service\nNamed pipe : senssvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : f6beaff7-1e19-4fbb-9f8f-b89e2018337c, version 1.0\nDescription : Unknown RPC service\nAnnotation : Event log TCPIP\nType : Local RPC service\nNamed pipe : eventlog\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 30adc50c-5cbc-46ce-9a0e-91914789e23c, version 1.0\nDescription : Unknown RPC service\nAnnotation : NRP server endpoint\nType : Local RPC service\nNamed pipe : eventlog\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 30adc50c-5cbc-46ce-9a0e-91914789e23c, version 1.0\nDescription : Unknown RPC service\nAnnotation : NRP server endpoint\nType : Local RPC service\nNamed pipe : AudioClientRpc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 30adc50c-5cbc-46ce-9a0e-91914789e23c, version 1.0\nDescription : Unknown RPC service\nAnnotation : NRP server endpoint\nType : Local RPC service\nNamed pipe : Audiosrv\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d5, version 1.0\nDescription : DHCP Client Service\nWindows process : svchost.exe\nAnnotation : DHCP Client LRPC Endpoint\nType : Local RPC service\nNamed pipe : eventlog\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d5, version 1.0\nDescription : DHCP Client Service\nWindows process : svchost.exe\nAnnotation : DHCP Client LRPC Endpoint\nType : Local RPC service\nNamed pipe : AudioClientRpc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d5, version 1.0\nDescription : DHCP Client Service\nWindows process : svchost.exe\nAnnotation : DHCP Client LRPC Endpoint\nType : Local RPC service\nNamed pipe : Audiosrv\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d5, version 1.0\nDescription : DHCP Client Service\nWindows process : svchost.exe\nAnnotation : DHCP Client LRPC Endpoint\nType : Local RPC service\nNamed pipe : dhcpcsvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d6, version 1.0\nDescription : Unknown RPC service\nAnnotation : DHCPv6 Client LRPC Endpoint\nType : Local RPC service\nNamed pipe : eventlog\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d6, version 1.0\nDescription : Unknown RPC service\nAnnotation : DHCPv6 Client LRPC Endpoint\nType : Local RPC service\nNamed pipe : AudioClientRpc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d6, version 1.0\nDescription : Unknown RPC service\nAnnotation : DHCPv6 Client LRPC Endpoint\nType : Local RPC service\nNamed pipe : Audiosrv\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d6, version 1.0\nDescription : Unknown RPC service\nAnnotation : DHCPv6 Client LRPC Endpoint\nType : Local RPC service\nNamed pipe : dhcpcsvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d6, version 1.0\nDescription : Unknown RPC service\nAnnotation : DHCPv6 Client LRPC Endpoint\nType : Local RPC service\nNamed pipe : dhcpcsvc6\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 06bba54a-be05-49f9-b0a0-30f790261023, version 1.0\nDescription : Unknown RPC service\nAnnotation : Security Center\nType : Local RPC service\nNamed pipe : eventlog\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 06bba54a-be05-49f9-b0a0-30f790261023, version 1.0\nDescription : Unknown RPC service\nAnnotation : Security Center\nType : Local RPC service\nNamed pipe : AudioClientRpc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 06bba54a-be05-49f9-b0a0-30f790261023, version 1.0\nDescription : Unknown RPC service\nAnnotation : Security Center\nType : Local RPC service\nNamed pipe : Audiosrv\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 06bba54a-be05-49f9-b0a0-30f790261023, version 1.0\nDescription : Unknown RPC service\nAnnotation : Security Center\nType : Local RPC service\nNamed pipe : dhcpcsvc\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 06bba54a-be05-49f9-b0a0-30f790261023, version 1.0\nDescription : Unknown RPC service\nAnnotation : Security Center\nType : Local RPC service\nNamed pipe : dhcpcsvc6\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 06bba54a-be05-49f9-b0a0-30f790261023, version 1.0\nDescription : Unknown RPC service\nAnnotation : Security Center\nType : Local RPC service\nNamed pipe : OLE4F91526C693C4FC7944E94E9DEC2\n\n","hosts":null,"custom_description":null},{"ports":{"49155 / tcp / dce-rpc":[{"hostname":"172.204.81.57"}]},"has_attachment":0,"severity":0,"plugin_output":"\nThe following DCERPC services are available on TCP port 49155 :\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345778-1234-abcd-ef00-0123456789ac, version 1.0\nDescription : Security Account Manager\nWindows process : lsass.exe\nType : Remote RPC service\nTCP Port : 49155\nIP : 172.204.81.57\n\n","hosts":null,"custom_description":null},{"ports":{"49152 / tcp / dce-rpc":[{"hostname":"172.204.81.57"}]},"has_attachment":0,"severity":0,"plugin_output":"\nThe following DCERPC services are available on TCP port 49152 :\n\nObject UUID : 765294ba-60bc-48b8-92e9-89fd77769d91\nUUID : d95afe70-a6d5-4259-822e-2c84da1ddb0d, version 1.0\nDescription : Unknown RPC service\nType : Remote RPC service\nTCP Port : 49152\nIP : 172.204.81.57\n\n","hosts":null,"custom_description":null},{"ports":{"49157 / tcp / dce-rpc":[{"hostname":"172.204.81.57"}]},"has_attachment":0,"severity":0,"plugin_output":"\nThe following DCERPC services are available on TCP port 49157 :\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 6b5bdd1e-528c-422c-af8c-a4079be4fe48, version 1.0\nDescription : Unknown RPC service\nAnnotation : Remote Fw APIs\nType : Remote RPC service\nTCP Port : 49157\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 12345678-1234-abcd-ef00-0123456789ab, version 1.0\nDescription : IPsec Services (Windows XP & 2003)\nWindows process : lsass.exe\nAnnotation : IPSec Policy agent endpoint\nType : Remote RPC service\nTCP Port : 49157\nIP : 172.204.81.57\n\n","hosts":null,"custom_description":null},{"ports":{"49156 / tcp / dce-rpc":[{"hostname":"172.204.81.57"}]},"has_attachment":0,"severity":0,"plugin_output":"\nThe following DCERPC services are available on TCP port 49156 :\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 367abb81-9844-35f1-ad32-98f038001003, version 2.0\nDescription : Service Control Manager\nWindows process : svchost.exe\nType : Remote RPC service\nTCP Port : 49156\nIP : 172.204.81.57\n\n","hosts":null,"custom_description":null},{"ports":{"49154 / tcp / dce-rpc":[{"hostname":"172.204.81.57"}]},"has_attachment":0,"severity":0,"plugin_output":"\nThe following DCERPC services are available on TCP port 49154 :\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 86d35949-83c9-4044-b424-db363231fd0c, version 1.0\nDescription : Unknown RPC service\nType : Remote RPC service\nTCP Port : 49154\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : a398e520-d59a-4bdd-aa7a-3c1e0303a511, version 1.0\nDescription : Unknown RPC service\nAnnotation : IKE/Authip API\nType : Remote RPC service\nTCP Port : 49154\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 552d076a-cb29-4e44-8b6a-d15e59e2c0af, version 1.0\nDescription : Unknown RPC service\nAnnotation : IP Transition Configuration endpoint\nType : Remote RPC service\nTCP Port : 49154\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 98716d03-89ac-44c7-bb8c-285824e51c4a, version 1.0\nDescription : Unknown RPC service\nAnnotation : XactSrv service\nType : Remote RPC service\nTCP Port : 49154\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 201ef99a-7fa0-444c-9399-19ba84f12a1a, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nTCP Port : 49154\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 5f54ce7d-5b79-4175-8584-cb65313a0e98, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nTCP Port : 49154\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : fd7a0523-dc70-43dd-9b2e-9c5ed48225b1, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nTCP Port : 49154\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 58e604e8-9adb-4d2e-a464-3b0683fb1480, version 1.0\nDescription : Unknown RPC service\nAnnotation : AppInfo\nType : Remote RPC service\nTCP Port : 49154\nIP : 172.204.81.57\n\n","hosts":null,"custom_description":null},{"ports":{"49153 / tcp / dce-rpc":[{"hostname":"172.204.81.57"}]},"has_attachment":0,"severity":0,"plugin_output":"\nThe following DCERPC services are available on TCP port 49153 :\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : f6beaff7-1e19-4fbb-9f8f-b89e2018337c, version 1.0\nDescription : Unknown RPC service\nAnnotation : Event log TCPIP\nType : Remote RPC service\nTCP Port : 49153\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 30adc50c-5cbc-46ce-9a0e-91914789e23c, version 1.0\nDescription : Unknown RPC service\nAnnotation : NRP server endpoint\nType : Remote RPC service\nTCP Port : 49153\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d5, version 1.0\nDescription : DHCP Client Service\nWindows process : svchost.exe\nAnnotation : DHCP Client LRPC Endpoint\nType : Remote RPC service\nTCP Port : 49153\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 3c4728c5-f0ab-448b-bda1-6ce01eb0a6d6, version 1.0\nDescription : Unknown RPC service\nAnnotation : DHCPv6 Client LRPC Endpoint\nType : Remote RPC service\nTCP Port : 49153\nIP : 172.204.81.57\n\nObject UUID : 00000000-0000-0000-0000-000000000000\nUUID : 06bba54a-be05-49f9-b0a0-30f790261023, version 1.0\nDescription : Unknown RPC service\nAnnotation : Security Center\nType : Remote RPC service\nTCP Port : 49153\nIP : 172.204.81.57\n\n","hosts":null,"custom_description":null}],"info":{"plugindescription":{"severity":0,"pluginname":"DCE Services Enumeration","pluginattributes":{"risk_information":{"risk_factor":"None"},"plugin_information":{"plugin_version":"$Revision: 1.51 $","plugin_id":10736,"plugin_type":"local","plugin_publication_date":"2001-08-26T00:00:00Z","plugin_family":"Windows","plugin_modification_date":"2014-05-12T00:00:00Z"},"solution":null,"has_patch":false,"description":"By sending a Lookup request to the portmapper (TCP 135 or epmapper PIPE) it was possible to enumerate the Distributed Computing Environment (DCE) services running on the remote port. Using this information it is possible to connect and bind to each service by sending an RPC request to the remote port/pipe.","synopsis":"A DCE/RPC service is running on the remote host."},"pluginfamily":"Windows","pluginid":"10736"}}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/attachments/{attachment_id}":{"get":{"summary":"Get scan attachment file","description":"Gets the requested scan attachment file.<p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-attachments","tags":["Scans"],"parameters":[{"description":"The identifier for the scan containing the attachment. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}},{"description":"The ID of the scan attachment.","required":true,"name":"attachment_id","in":"path","schema":{"type":"string"}},{"description":"The attachment access token.","required":true,"name":"key","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the attachment file.","content":{"application/octet-stream":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified attachment file."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/timezones":{"get":{"summary":"Get timezones","description":"Returns the timezones list for creating a scan.<p>Requires SCAN OPERATOR [24] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"scans-timezones","tags":["Scans"],"responses":{"200":{"description":"Returns the timezone list.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The readable name of the timezone."},"value":{"type":"string","description":"The system value for the timezone."}}}},"examples":{"response":{"value":{"timezones":[{"name":"Africa/Abidjan","value":"Africa/Abidjan"},{"name":"Europe/Tiraspol","value":"Europe/Tiraspol"},{"name":"UCT","value":"UCT"},{"name":"US/Alaska","value":"US/Alaska"},{"name":"US/Aleutian","value":"US/Aleutian"},{"name":"US/Arizona","value":"US/Arizona"},{"name":"US/Central","value":"US/Central"},{"name":"US/East-Indiana","value":"US/East-Indiana"},{"name":"US/Eastern","value":"US/Eastern"},{"name":"US/Hawaii","value":"US/Hawaii"},{"name":"US/Indiana-Starke","value":"US/Indiana-Starke"},{"name":"US/Michigan","value":"US/Michigan"},{"name":"US/Mountain","value":"US/Mountain"},{"name":"US/Pacific","value":"US/Pacific"},{"name":"US/Pacific-New","value":"US/Pacific-New"},{"name":"US/Samoa","value":"US/Samoa"},{"name":"UTC","value":"UTC"},{"name":"Universal","value":"Universal"},{"name":"W-SU","value":"W-SU"},{"name":"WET","value":"WET"},{"current":true,"name":"Zulu","value":"Zulu"}]}}}}}},"403":{"description":"Returned if you do not have permission to view timezones."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/server/status":{"get":{"summary":"Get server status","description":"Gets the server status.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"server-status","tags":["Server"],"responses":{"200":{"description":"Returns the server status. Status values can include:\n - loading\n - ready\n - corrupt-db\n - feed-expired\n - eval-expired\n - locked\n - register\n - register-locked\n - download-failed\n - feed-error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"}}},"examples":{"response":{"value":{"code":200,"status":"ready"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"503":{"description":"Returns the server status. Indicates a session destroy is required.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":503,"error":"Service Unavailable","message":"Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/server/properties":{"get":{"summary":"List server properties","description":"Lists the server version and other properties.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"server-properties","tags":["Server"],"responses":{"200":{"description":"Returns the server properties.","content":{"application/json":{"schema":{"type":"object","properties":{"capabilities":{"type":"object"},"enterprise":{"type":"boolean"},"expiration":{"type":"integer"},"expiration_time":{"type":"integer"},"idle_timeout":{"type":"integer"},"license":{"type":"object"},"loaded_plugin_set":{"type":"string"},"login_banner":{"type":"boolean"},"nessus_type":{"type":"string"},"nessus_ui_version":{"type":"string"},"notifications":{"type":"array","items":{"type":"string"}},"plugin_set":{"type":"string"},"scanner_boottime":{"type":"integer"},"server_version":{"type":"string"},"server_uuid":{"type":"string"},"update":{"type":"object","properties":{"href":{"type":"string"},"new_version":{"type":"integer"},"restart":{"type":"integer"}}},"analytics":{"type":"object"},"limitEnabled":{"type":"boolean"},"msp":{"type":"boolean"},"server_build":{"type":"string"},"force_ui_reload":{"type":"boolean"},"nessus_ui_build":{"type":"string"},"container_db_version":{"type":"string"}}},"examples":{"response":{"value":{"limitEnabled":false,"region":"US East","loaded_plugin_set":"201812271241","server_uuid":"417457f6-cd2b-727c-d94f-06bce34d74cf27789b39c292efc6","update":{"href":null,"new_version":0,"restart":0},"expiration":1551160800,"nessus_ui_version":"11.0.52","nessus_type":"Nessus Cloud","notifications":[],"expiration_time":60,"license":{"enterprise_pause":false,"expiration_date":1551160800,"ips":1024,"agents":512,"users":10,"scanners":2,"evaluation":false,"scanners_used":0,"agents_used":0,"apps":{"was":{"mode":"eval","expiration_date":1549299101}}},"enterprise":true,"analytics":{"key":"ddf4b2ef-ac5e-4ee7-701d-7fd1a95bc458","enabled":true,"site_id":"us-2b"},"msp":true,"server_build":"C20023","force_ui_reload":true,"capabilities":{"multi_user":"full","multi_scanner":true,"report_email_config":true,"two_factor":{"twilio":true,"smtp":false}},"plugin_set":"201812271241","idle_timeout":"30","nessus_ui_build":"161","scanner_boottime":1545191736,"evaluation":{"limitEnabled":true,"targets":25},"container_db_version":"10.43.0","login_banner":null,"server_version":"6.9.1"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/tags/categories":{"post":{"summary":"Create tag category","description":"Creates a new tag category.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-create-tag-category","tags":["Tags"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the tag category."},"description":{"type":"string","description":"The description of the tag category."}},"required":["name"]},"example":{"name":"Location","description":"The geographic location of the asset."}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully creates a category.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the category."},"name":{"type":"string","description":"The name of the category. The name must be unique within a Tenable.io instance."},"description":{"type":"string","description":"The description of the category."},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the category was created, for example, `2018-08-09T13:51:17.243Z`."},"created_by":{"type":"string","description":"The name of the user who created the category."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the category was last updated, for example, `2018-08-09T13:51:17.243Z`."},"updated_by":{"type":"string","description":"The name of the user who last updated the category."},"reserved":{"type":"boolean","description":"Indicates whether the tags in this category are reserved (cannot be updated). This is a read-only field set by the system."}}},"examples":{"response":{"value":{"uuid":"ce8e96b5-4e4a-4469-99a6-425479153dea","created_at":"2018-10-30T20:43:36.496Z","created_by":"user3@example.com","updated_at":"2018-10-30T20:43:36.496Z","updated_by":"user3@example.com","name":"Location","description":"The geographic location of the asset.","reserved":false}}}}}},"400":{"description":"Returned if Tenable.io encounters any of the following error conditions:\n - max_entries—your request exceeds the maximum number of categories (100 per container).\n - duplicate—a category with the name you specified already exists."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List tag categories","description":"Returns a list of tag categories.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-list-tag-categories","tags":["Tags"],"parameters":[{"description":"A filter condition in the `field:operator:value` format, for example, `f=name:match:location`. Filter conditions can include:  \n* name:eq:&lt;name>  \n* name:match:<partial\\_name>  \n* description:eq:&lt;description>  \n* description:match:<partial\\_description>  \n* updated\\_at:date-eq:<timestamp\\_as\\_int>  \n* updated\\_at:date-gt:<timestamp\\_as\\_int>  \n* updated\\_at:date-lt:<timestamp\\_as\\_int>  \n* created\\_at:date-eq:<timestamp\\_as\\_int>  \n* created\\_at:date-gt:<timestamp\\_as\\_int>  \n* created\\_at:date-lt:<timestamp\\_as\\_int>  \n* updated\\_by:eq:<user\\_uuid>","required":false,"name":"f","in":"query","schema":{"type":"string"}},{"description":"If multiple `f` parameters are present, specifies whether Tenable.io applies `AND` or `OR` to conditions. Supported values are `and` and `or`. If you omit this parameter when using multiple `f` parameters, Tenable.io applies `AND` by default.","required":false,"name":"ft","in":"query","schema":{"type":"string"}},{"description":"Maximum number of records requested (or service imposed limit if not in request). Must be in the int32 format.","required":false,"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The number of records to skip in the returned result set. Must be in the int32 format.","required":false,"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The fields to sort on and the sort order, for example, `sort=updated_at:desc,name`. Default sort order is `asc`. If you specify multiple fields, fields must be separated by commas.","required":false,"name":"sort","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of tag categories with pagination information.","content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"description":"A collection of category objects.","type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the category."},"name":{"type":"string","description":"The name of the category. The name must be unique within a Tenable.io instance."},"description":{"type":"string","description":"The description of the category."},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the category was created, for example, `2018-08-09T13:51:17.243Z`."},"created_by":{"type":"string","description":"The name of the user who created the category."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the category was last updated, for example, `2018-08-09T13:51:17.243Z`."},"updated_by":{"type":"string","description":"The name of the user who last updated the category."},"reserved":{"type":"boolean","description":"Indicates whether the tags in this category are reserved (cannot be updated). This is a read-only field set by the system."}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of records matching your search criteria. Must be in the int32 format."},"limit":{"type":"integer","description":"Maximum number of records requested (or service imposed limit if not in request). Must be in the int32 format."},"offset":{"type":"integer","description":"The number of skipped records in the returned result set. Must be in the int32 format."},"sort":{"description":"An array of objects representing the fields you specified as sort parameters in the request. This attribute is only present if your request message specifies sort parameters.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the sort field."},"order":{"type":"string","description":"The direction in which Tenable.io sorts on the field, `asc` for ascending or `desc` for descending.","enum":["asc","desc"]}}}}}}}},"examples":{"response":{"value":{"categories":[{"uuid":"4ae732b5-f34b-4ef4-b4c7-c2da6d01f49b","created_at":"2018-10-29T16:37:51.097Z","created_by":"user3@example.com","updated_at":"2018-10-29T16:37:51.097Z","updated_by":"user3@example.com","name":"asset_class","description":"Asset class","reserved":false},{"uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","created_at":"2018-09-20T16:10:21.412Z","created_by":"user3@example.com","updated_at":"2018-10-30T15:39:16.540Z","updated_by":"user3@example.com","name":"location","description":"Asset location","reserved":false}],"pagination":{"offset":0,"limit":5000,"total":4,"sort":[{"name":"name","order":"asc"}]}}}}}}},"400":{"description":"Returned if your request specifies invalid or malformed query parameters. Tenable.io can encounter the following error conditions:\n - `invalidvalue`—The query parameter format is incorrect, for example, uses an invalid operator as in this example: `f=name:invalid_operator:some_value`.\n- `unknownproperty`—The query parameter format is correct, but it references a field that does not exist, for example `sort=non_existing_property:desc`.","content":{"application/json":{"examples":{"response":{"value":{"errors":[{"property":"filter","rule":"invalidvalue","message":"'Filter' does not have a valid value"}],"error":"'Filter' does not have a valid value"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/tags/categories/{category_uuid}":{"get":{"summary":"Get category details","description":"Returns the details for the specified category.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-tag-category-details","tags":["Tags"],"parameters":[{"description":"The UUID of the tag category to return details for. For more information on determining this value, see [Determine Tag Identifiers](/docs/determine-tag-identifiers-tio).","required":true,"name":"category_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the category details.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the category."},"name":{"type":"string","description":"The name of the category. The name must be unique within a Tenable.io instance."},"description":{"type":"string","description":"The description of the category."},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the category was created, for example, `2018-08-09T13:51:17.243Z`."},"created_by":{"type":"string","description":"The name of the user who created the category."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the category was last updated, for example, `2018-08-09T13:51:17.243Z`."},"updated_by":{"type":"string","description":"The name of the user who last updated the category."},"reserved":{"type":"boolean","description":"Indicates whether the tags in this category are reserved (cannot be updated). This is a read-only field set by the system."}}},"examples":{"response":{"value":{"uuid":"ce8e96b5-4e4a-4469-99a6-425479153dea","created_at":"2018-10-30T20:43:36.496Z","created_by":"user3@example.com","updated_at":"2018-10-30T20:43:36.496Z","updated_by":"user3@example.com","name":"Location","description":"The geographic location of the asset.","reserved":false}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified tag category."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update tag category","description":"Updates the specified tag category.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-edit-tag-category","tags":["Tags"],"parameters":[{"description":"The UUID of the category. For more information on determining this value, see [Determine Tag Identifiers](/docs/determine-tag-identifiers-tio).","required":true,"name":"category_uuid","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the tag category."},"description":{"type":"string","description":"The description of the category."}},"required":["name"]},"example":{"name":"location","description":"The physical location of the asset."}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully updates the tag category.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the category."},"name":{"type":"string","description":"The name of the category. The name must be unique within a Tenable.io instance."},"description":{"type":"string","description":"The description of the category."},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the category was created, for example, `2018-08-09T13:51:17.243Z`."},"created_by":{"type":"string","description":"The name of the user who created the category."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the category was last updated, for example, `2018-08-09T13:51:17.243Z`."},"updated_by":{"type":"string","description":"The name of the user who last updated the category."},"reserved":{"type":"boolean","description":"Indicates whether the tags in this category are reserved (cannot be updated). This is a read-only field set by the system."}}},"examples":{"response":{"value":{"uuid":"ce8e96b5-4e4a-4469-99a6-425479153dea","created_at":"2018-10-30T20:43:36.496Z","created_by":"user3@sample.org","updated_at":"2018-10-30T23:01:42.105Z","updated_by":"user3@sample.org","name":"operating_system","description":"The operating system of the asset","reserved":false}}}}}},"400":{"description":"Returned if your request message does not specify a value for the tag category name."},"404":{"description":"Returned if Tenable.io cannot find the specified tag category."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete tag category","description":"Deletes the specified category and any associated tag values. Deleting an asset tag category automatically deletes all tag values associated with that category and removes the tags from any assets where the tags were assigned.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-delete-tag-category","tags":["Tags"],"parameters":[{"description":"The UUID of the category to delete. For more information on determining this value, see [Determine Tag Identifiers](/docs/determine-tag-identifiers-tio).","required":true,"name":"category_uuid","in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if Tenable.io successfully deletes the specified tag category.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified tag category."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/tags/values":{"get":{"summary":"List tag values","description":"Returns a list of tag values.\n**Note:** The list can also include the tag categories that do not have any associated values.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-list-tag-values","tags":["Tags"],"parameters":[{"description":"A filter condition in the `field:operator:value` format, for example, `f=value:match:rhel`. Filters should match `field:op:value` format. Filter conditions can include:  \n* value:eq:&lt;value>  \n* value:match:&lt;value>  \n* category\\_name:match:<partial\\_value>  \n* category\\_name:eq:<category\\_name>  \n* category\\_name:match:<partial\\_category\\_name>  \n* description:eq:&lt;description>  \n* description:match:<partial\\_description>  \n* updated\\_at:date-eq:<timestamp\\_as\\_int>  \n* updated\\_at:date-gt:<timestamp\\_as\\_int>  \n* updated\\_at:date-lt:<timestamp\\_as\\_int>  \n* updated\\_by:eq:<user\\_uuid>","name":"f","in":"query","schema":{"type":"string"}},{"description":"If multiple `f` parameters are present, specifies whether Tenable.io applies `AND` or `OR` to conditions. Supported values are `and` and `or`. If you omit this parameter when using multiple `f` parameters, Tenable.io applies `AND` by default.","name":"ft","in":"query","schema":{"type":"string"}},{"description":"A comma-separated list of fields to include in the wildcard search. Provides the same functionality as a `match` condition in the `f` in parameter. For example, `f=value:match:Chi` returns the same results as `wf=value&w=Chi`. Wildcard fields include:  \n* category\\_name  \n* value  \n* description  \nUse the `w` parameter to specify the search value.","name":"wf","in":"query","schema":{"type":"string"}},{"description":"A single search value for the wildcard fields specified in the `wf` parameter.","required":false,"name":"w","in":"query","schema":{"type":"string"}},{"description":"Maximum number of records requested (or service imposed limit if not in request). Must be in the int32 format.","name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The number of records to skip in the returned result set. Must be in the int32 format.","name":"offset","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The fields to sort on, for example, `sort=updated_at:desc,value`. Default sort order is `asc`. If you specify multiple fields, fields must be separated by commas.","name":"sort","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of tags with pagination information.","content":{"application/json":{"schema":{"type":"object","properties":{"values":{"description":"An array of tag value objects.","type":"array","items":{"type":"object","properties":{"uuid":{"description":"The UUID of the tag value. Use this value to assign the tag to assets.","type":"string"},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the tag value was created, for example, `2018-08-09T13:51:17.243Z`."},"created_by":{"type":"string","description":"The name of the user who created the tag value."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the tag value was last updated, for example, `2018-08-09T13:51:17.243Z`. When you create a tag value, this date matches the `created_at` date."},"updated_by":{"type":"string","description":"The name of the user who last updated the tag value. When you create a tag value, this name matches the `created_by` name."},"category_uuid":{"type":"string","description":"The UUID of the category associated with the tag value. Use this value to create future tags in the same category."},"value":{"description":"The tag value. Must be unique within the category.","type":"string"},"description":{"type":"string","description":"The description of the tag value."},"type":{"type":"string","description":"The tag type:\n - static—A user must manually apply the tag to assets.\n - dynamic—Tenable.io automatically applies the tag based on asset attribute rules."},"category_name":{"type":"string","description":"The name of the category associated with the tag value."},"category_description":{"type":"string","description":"The description of the category associated with the tag value."}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of records matching your search criteria. Must be in the int32 format."},"limit":{"type":"integer","description":"Maximum number of records requested (or service imposed limit if not in request). Must be in the int32 format."},"offset":{"type":"integer","description":"The number of skipped records in the returned result set. Must be in the int32 format."},"sort":{"description":"An array of objects representing the fields you specified as sort parameters in the request. This attribute is only present if your request message specifies sort parameters.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the sort field."},"order":{"type":"string","description":"The direction in which Tenable.io sorts on the field, `asc` for ascending or `desc` for descending.","enum":["asc","desc"]}}}}}}}},"examples":{"response":{"value":{"values":[{"uuid":"0a6c1176-4c03-4776-a60a-048021a48799","created_at":"2018-10-30T15:39:16.687Z","created_by":"user3@example.com","updated_at":"2018-10-30T15:39:16.687Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"Seattle","description":"","type":"static","category_name":"location","category_description":"Asset location"},{"uuid":"18179e00-b0e0-4fd7-be91-e9e854fe66b9","created_at":"2018-09-20T16:10:21.710Z","created_by":"user3@example.com","updated_at":"2018-10-30T16:12:11.901Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"Chicago","description":"Chicago Office New","type":"static","category_name":"location","category_description":"Asset location"},{"uuid":"4a4627e8-6334-4ec7-a44d-414d6f510936","created_at":"2018-10-30T23:27:58.579Z","created_by":"user3@example.com","updated_at":"2018-10-30T23:27:58.579Z","updated_by":"user3@example.com","category_uuid":"ce8e96b5-4e4a-4469-99a6-425479153dea","value":"mac","type":"static","category_name":"operating_system","category_description":"The operating system of the asset"},{"uuid":"8e40f9c6-7a6a-4add-b92b-14f3de7f5c5e","created_at":"2018-10-30T15:40:49.110Z","created_by":"user3@example.com","updated_at":"2018-10-30T15:40:49.110Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"New York","type":"static","category_name":"location","category_description":"Asset location"},{"uuid":"9e65d586-94d8-4b44-b3fd-2765385dfb0b","created_at":"2018-10-30T15:34:57.099Z","created_by":"user3@example.com","updated_at":"2018-10-30T15:34:57.099Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"Austin","type":"static","category_name":"location","category_description":"Asset location"},{"uuid":"a270a97d-a5d4-400f-83fd-6f9e0bd44fc1","created_at":"2018-10-30T15:54:47.830Z","created_by":"user3@example.com","updated_at":"2018-10-30T15:54:47.830Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"Rochester","type":"static","category_name":"location","category_description":"Asset location"},{"uuid":"cb12b269-862a-486d-88d2-c20e85d499b3","created_at":"2018-10-30T15:34:57.113Z","created_by":"user3@example.com","updated_at":"2018-10-30T15:34:57.113Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"Portland","type":"static","category_name":"location","category_description":"Asset location"}],"pagination":{"offset":0,"limit":5000,"total":10,"sort":[{"name":"category_name","order":"asc"}]}}}}}}},"400":{"description":"Returned if your request specifies invalid or malformed query parameters. Tenable.io can encounter the following error conditions:\n - `invalidvalue`—The query parameter format is incorrect, for example, uses an invalid operator as in this example: `f=name:invalid_operator:some_value`.\n- `unknownproperty`—The query parameter format is correct, but it references a field that does not exist, for example `sort=non_existing_property:desc`.","content":{"application/json":{"examples":{"response":{"value":{"errors":[{"property":"filter","rule":"invalidvalue","message":"'Filter' does not have a valid value"}],"error":"'Filter' does not have a valid value"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"post":{"summary":"Create tag value","description":"Creates a tag value. The tag category can be specified by UUID or name. If Tenable.io cannot find a category you specify by name, the system creates a new category with the specified name. To automatically apply the tag to assets, specify the rules using the `filters` property.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-create-tag-value","tags":["Tags"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"category_name":{"type":"string","description":"The name of the tag category to associate with the new value.\n\nSpecify the name of a new category if you want to add both a <i>new</i> category and tag value.\n\nSpecify the name of an <i>existing</i> category if you want to add the tag value to the existing category.\n\n<b>Caution:</b> This value is case-sensitive. For example, Tenable.io considers \"location\" and \"Location\" to be separate categories.\n\nThe category_name can result in the following responses:\n\n - If the category_name you specify exists, and the tag value you specify already exists for that category, Tenable.io returns a 400 response code, instead of adding the tag.\n\n - If the category_name you specify exists, but the tag value you specify does not yet exist for that category, Tenable.io adds the tag value to the existing category.\n\n - If the category_name you specify does not exist, Tenable.io creates a new tag category and adds the new tag value to that category.\n\nThis parameter is required if category_uuid is not present in the request message."},"category_uuid":{"type":"string","description":"The UUID of the tag category to associate with the new value. For more information on determining this value, see [Determine Tag Identifiers](/docs/determine-tag-identifiers-tio).\n\nUse this parameter only if you want to add the tag value to an existing category. If the UUID you specify does not exist, Tenable.io does not create a new catgory. Instead, it returns a 400 (Bad Request) response code.\n\nThis parameter is required if category_name is not present in the request message."},"category_description":{"type":"string","description":"The description for the new tag category that Tenable.io creates if the category specified by name does not exist. Otherwise, Tenable.io ignores the description."},"value":{"type":"string","description":"The new tag value.\n\n<b>Caution:</b> This value is case-sensitive. For example, Tenable.io considers \"headquarters\" and \"Headquarters\" to be separate tag values."},"description":{"type":"string","description":"The new tag value description."},"filters":{"type":"object","description":"The filters (conditional sets of rules) for automatically applying the tag to assets. For more information, see [Apply Dynamic Tags](/docs/apply-dynamic-tags).","properties":{"asset":{"type":"object","description":"The object containing conditional sets of rules for applying the tags. \n\n**Note:** Tenable.io supports a maximum of 1,000 rules per tag. This limit means that you can specify a maximum of 1,000 `and` or `or` conditions for a single tag value. However, there is no limit on the number of values you can specify in a comma-delimited string for the `value` of an individual rule.","properties":{"and":{"type":"array","description":"To apply the tag to assets that match all of the rules, specify the rules inside the `and` object.","items":{"type":"object","description":"A rule for applying the tag to assets by matching asset properties or other tags. Includes a field or tag name, an operator, and a value.","properties":{"field":{"type":"string","description":"The asset attribute name or tag to match."},"operator":{"type":"string","description":"The operator to apply to the matched value, for example, equals, does not equal, or contains. To find supported operators, use the [GET /tags/assets/filters](/reference#tags-list-asset-filters) endpoint."},"value":{"type":"string","description":"The asset attribute value or tag to match. You can specify multiple values separated by commas, for example, \"172.204.81.57,172.82.157.177,172.156.65.8,172.207.124.176,172.106.217.225\"."}}}},"or":{"type":"array","description":"To apply the tag to assets that match any of the rules, specify the rules inside the `or` object.","items":{"type":"object","description":"A rule for applying the tag to assets by matching asset properties or other tags. Includes a field or tag name, an operator, and a value.","properties":{"field":{"type":"string","description":"The asset attribute name or tag to match."},"operator":{"type":"string","description":"The operator to apply to the matched value, for example, equals, does not equal, or contains. To find supported operators, use the [GET /tags/assets/filters](/reference#tags-list-asset-filters) endpoint."},"value":{"type":"string","description":"The asset attribute value or tag to match. You can specify multiple values separated by commas, for example, \"172.204.81.57,172.82.157.177,172.156.65.8,172.207.124.176,172.106.217.225\"."}}}}}}}}},"required":["value"]},"example":{"category_name":"Location","value":"San Diego","description":"San Diego - WFH"}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully creates a value.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"description":"The UUID of the tag value. Use this value to assign the tag to assets.","type":"string"},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the tag value was created, for example, `2018-08-09T13:51:17.243Z`."},"created_by":{"type":"string","description":"The name of the user who created the tag value."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the tag value was last updated, for example, `2018-08-09T13:51:17.243Z`. When you create a tag value, this date matches the `created_at` date."},"updated_by":{"type":"string","description":"The name of the user who last updated the tag value. When you create a tag value, this name matches the `created_by` name."},"category_uuid":{"type":"string","description":"The UUID of the category associated with the tag value. Use this value to create future tags in the same category."},"value":{"description":"The tag value. Must be unique within the category.","type":"string"},"description":{"type":"string","description":"The description of the tag value."},"type":{"type":"string","description":"The tag type:\n - static—A user must manually apply the tag to assets.\n - dynamic—Tenable.io automatically applies the tag based on asset attribute rules."},"category_name":{"type":"string","description":"The name of the category associated with the tag value."},"category_description":{"type":"string","description":"The description of the category associated with the tag value."},"filters":{"type":"object","description":"For dynamic tags, asset selection rules.","properties":{"asset":{"type":"string","description":"Tag rule definitions represented as a JSON-formatted string."}}}}},"examples":{"response":{"value":{"uuid":"fb7fae7d-8acb-48e4-928c-d93103e9e73f","created_at":"2018-11-08T19:39:40.473Z","created_by":"user3@example.com","updated_at":"2018-11-08T19:39:40.473Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"San Diego","description":"San Diego - WFH","type":"static","category_name":"location","category_description":"Asset location"}}}}}},"400":{"description":"Returned if Tenable.io encounters any of the following error conditions:\n - the combination of category and value you specified already exists (`duplicate`)\n - the category you specified does not exist (`not_found`)\n - your request exceeded a tag limit for your organization, which can be either the maximum of 100 categories or the maximum 100,000 tags for each category, or as configured for your organization\n - you attempted to specify more than 1,000 rules for an individual tag (`Filter expression cannot have more than 1,000 conditions`)\n - your request specified an invalid filter for the dynamic tag rule, for example, `ipv 4` (`The following filter types are not valid: {string}`)."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/tags/values/{value_uuid}":{"get":{"summary":"Get tag value details","description":"Returns the details for specified tag value.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-tag-value-details","tags":["Tags"],"parameters":[{"description":"The UUID of the tag value. For more information on determining this value, see [Determine Tag Identifiers](/docs/determine-tag-identifiers-tio).","required":true,"name":"value_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the details for tag value.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"description":"The UUID of the tag value. Use this value to assign the tag to assets.","type":"string"},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the tag value was created, for example, `2018-08-09T13:51:17.243Z`."},"created_by":{"type":"string","description":"The name of the user who created the tag value."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the tag value was last updated, for example, `2018-08-09T13:51:17.243Z`. When you create a tag value, this date matches the `created_at` date."},"updated_by":{"type":"string","description":"The name of the user who last updated the tag value. When you create a tag value, this name matches the `created_by` name."},"category_uuid":{"type":"string","description":"The UUID of the category associated with the tag value. Use this value to create future tags in the same category."},"value":{"description":"The tag value. Must be unique within the category.","type":"string"},"description":{"type":"string","description":"The description of the tag value."},"type":{"type":"string","description":"The tag type:\n - static—A user must manually apply the tag to assets.\n - dynamic—Tenable.io automatically applies the tag based on asset attribute rules."},"category_name":{"type":"string","description":"The name of the category associated with the tag value."},"category_description":{"type":"string","description":"The description of the category associated with the tag value."},"filters":{"type":"object","description":"For dynamic tags, asset selection rules.","properties":{"asset":{"type":"string","description":"Tag rule definitions represented as a JSON-formatted string."}}}}},"examples":{"response":{"value":{"uuid":"2ffde3b7-85b4-4f01-b226-15ebc4551c4e","created_at":"2019-05-02T17:11:26.492Z","created_by":"user@example.com","updated_at":"2019-05-02T17:11:26.492Z","updated_by":"user@example.com","category_uuid":"7467cbe4-d6d3-4ffe-ae36-9f5ef4dac933","value":"freebsd","description":"FreeBSD hosts","type":"dynamic","category_name":"unix","category_description":"Unix hosts","filters":{"asset":"{\"and\":[{\"field\":\"operating_system\",\"operator\":\"match\",\"value\":\"FreeBSD\"}]}"}}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified tag value."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update tag value","description":"Updates the specified tag value.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-update-tag-value","tags":["Tags"],"parameters":[{"description":"The UUID of the value you want to update. For more information on determining this value, see [Determine Tag Identifiers](/docs/determine-tag-identifiers-tio).","required":true,"name":"value_uuid","in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","description":"The new tag value."},"description":{"type":"string","description":"The new tag value description."},"filters":{"type":"object","description":"The filters (conditional sets of rules) for automatically applying the tag to assets. For more information, see [Apply Dynamic Tags](/docs/apply-dynamic-tags).","properties":{"asset":{"type":"object","description":"The object containing conditional sets of rules for applying the tags.\n\n**Note:** Tenable.io supports a maximum of 1,000 rules per tag. This limit means that you can specify a maximum of 1,000 `and` or `or` conditions for a single tag value. However, there is no limit on the number of values you can specify in a comma-delimited string for the `value` of an individual rule.","properties":{"and":{"type":"array","description":"To apply the tag to assets that match all of the rules, specify the rules inside the `and` object.","items":{"type":"object","description":"A rule for applying the tag to assets by matching asset properties or other tags. Includes a field or tag name, an operator, and a value.","properties":{"field":{"type":"string","description":"The asset attribute name or tag to match."},"operator":{"type":"string","description":"The operator to apply to the matched value, for example, equals, does not equal, or contains. To find supported operators, use the [GET /tags/assets/filters](/reference#tags-list-asset-filters) endpoint."},"value":{"type":"string","description":"The asset attribute value or tag to match. You can specify multiple values separated by commas, for example, \"172.204.81.57,172.82.157.177,172.156.65.8,172.207.124.176,172.106.217.225\"."}}}},"or":{"type":"array","description":"To apply the tag to assets that match any of the rules, specify the rules inside the `or` object.","items":{"type":"object","description":"A rule for applying the tag to assets by matching asset properties or other tags. Includes a field or tag name, an operator, and a value.","properties":{"field":{"type":"string","description":"The asset attribute name or tag to match."},"operator":{"type":"string","description":"The operator to apply to the matched value, for example, equals, does not equal, or contains. To find supported operators, use the [GET /tags/assets/filters](/reference#tags-list-asset-filters) endpoint."},"value":{"type":"string","description":"The asset attribute value or tag to match. You can specify multiple values separated by commas, for example, \"172.204.81.57,172.82.157.177,172.156.65.8,172.207.124.176,172.106.217.225\"."}}}}}}}}}},"example":{"description":"San Diego - Home Office"}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully updates the tag value.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"description":"The UUID of the tag value. Use this value to assign the tag to assets.","type":"string"},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the tag value was created, for example, `2018-08-09T13:51:17.243Z`."},"created_by":{"type":"string","description":"The name of the user who created the tag value."},"updated_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the tag value was last updated, for example, `2018-08-09T13:51:17.243Z`. When you create a tag value, this date matches the `created_at` date."},"updated_by":{"type":"string","description":"The name of the user who last updated the tag value. When you create a tag value, this name matches the `created_by` name."},"category_uuid":{"type":"string","description":"The UUID of the category associated with the tag value. Use this value to create future tags in the same category."},"value":{"description":"The tag value. Must be unique within the category.","type":"string"},"description":{"type":"string","description":"The description of the tag value."},"type":{"type":"string","description":"The tag type:\n - static—A user must manually apply the tag to assets.\n - dynamic—Tenable.io automatically applies the tag based on asset attribute rules."},"category_name":{"type":"string","description":"The name of the category associated with the tag value."},"category_description":{"type":"string","description":"The description of the category associated with the tag value."},"filters":{"type":"object","description":"For dynamic tags, asset selection rules.","properties":{"asset":{"type":"string","description":"Tag rule definitions represented as a JSON-formatted string."}}}}},"examples":{"response":{"value":{"uuid":"fb7fae7d-8acb-48e4-928c-d93103e9e73f","created_at":"2018-11-08T19:39:40.473Z","created_by":"user3@example.com","updated_at":"2018-11-08T19:45:37.591Z","updated_by":"user3@example.com","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf","value":"San Diego","description":"San Diego - Home Office","type":"static","category_name":"location","category_description":"Asset location"}}}}}},"400":{"description":"Returned if Tenable.io encounters any of the following error conditions:\n - the combination of category and value you specified already exists (`duplicate`)\n - the category you specified does not exist (`not_found`)\n - your request exceeded a tag limit for your organization, which can be either the maximum of 100 categories or the maximum 100,000 tags for each category, or as configured for your organization\n - you attempted to specify more than 1,000 rules for an individual tag (`Filter expression cannot have more than 1,000 conditions`)\n - your request specified an invalid filter for the dynamic tag rule, for example, `ipv 4` (`The following filter types are not valid: {string}`)."},"404":{"description":"Returned if Tenable.io cannot find the specified tag value."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete tag value","description":"Deletes the specified tag value. If you delete an asset tag, Tenable.io also removes that tag from any assets where the tag was assigned.\n\n**Note:** If you delete all asset tags associated with a category, Tenable.io retains the category. You must [delete](/reference#tags-delete-tag-category) the category separately.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-delete-tag-value","tags":["Tags"],"parameters":[{"description":"The UUID of the tag value you want to delete.\n\n**Note:** A tag UUID is technically assigned to the tag value only (the second half of the category:value pair), but the API commands use this value to represent the whole `category:value` pair. For more information on determining this value, see [Determine Tag Identifiers](/docs/determine-tag-identifiers-tio).","required":true,"name":"value_uuid","in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if Tenable.io successfully deletes the specified tag value.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified tag value."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/tags/values/delete-requests":{"post":{"summary":"Bulk delete tag values","description":"Deletes tag values in bulk. If you delete an asset tag, Tenable.io also removes that tag from any assets where the tag was assigned. If you delete all asset tags associated with a category, Tenable.io retains the category. You must [delete](/reference#tags-delete-tag-category) the category separately.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-delete-tag-values-bulk","tags":["Tags"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"values":{"items":{"type":"string","format":"uuid"},"description":"The UUIDs of the tag values you want to delete.\n\n**Note:** A tag UUID is technically assigned to the tag value only (the second half of the category:value pair), but the API commands use this value to represent the whole `category:value` pair. For more information on determining this value, see [Determine Tag Identifiers](/docs/determine-tag-identifiers-tio).","type":"array"}}},"example":{"values":["18179e00-b0e0-4fd7-be91-e9e854fe66b9","f45a48b4-50e7-41c3-afb9-2e01f5423698","fb7fae7d-8acb-48e4-928c-d93103e9e73f"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully deletes the specified tag values.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"400":{"description":"Returned if you specify invalid UUIDs."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/tags/assets/{asset_uuid}/assignments":{"get":{"summary":"List tags for an asset","description":"Returns a list of assigned tags for an asset specified by UUID.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-list-asset-tags","tags":["Tags"],"parameters":[{"description":"The UUID of the asset.","required":true,"name":"asset_uuid","in":"path","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Returns a list of tags assigned to the specified asset. If no tags are assigned to the asset, Tenable.io returns an empty list. Also, the service does not validate the asset UUID.","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"description":"An array of asset assignment objects.","type":"array","items":{"type":"object","properties":{"asset_uuid":{"type":"string","description":"The UUID of the asset where the tag is assigned."},"value":{"type":"string","description":"The tag value (the second half of the category:value pair)."},"value_uuid":{"description":"The UUID of the tag value.\n\n**Note:** A tag UUID is technically assigned to the tag value only (the second half of the category:value pair), but the API commands use this value to represent the whole `category:value` pair.","type":"string"},"category_name":{"type":"string","description":"The tag category name (the first half of the category:value pair)."},"category_uuid":{"description":"The UUID of the tag category. Use this value to create future tags in the same category.","type":"string"},"created_at":{"type":"string","description":"An ISO timestamp indicating the date and time on which the was assigned to an asset, for example, `2018-08-09T13:51:17.243Z`."},"created_by":{"type":"string","description":"The name of the user who assigned the tag to the asset."},"source":{"type":"string","description":"The tag type:\n - static—A user must manually apply the tag to assets.\n - dynamic—Tenable.io automatically applies the tag based on asset attribute rules."}}}}}},"examples":{"response":{"value":{"tags":[{"value_uuid":"18179e00-b0e0-4fd7-be91-e9e854fe66b9","category_name":"location","asset_uuid":"842fa017-0141-4fdd-a53b-bcdd971ed1da","created_at":"2018-11-01T16:29:40.606Z","source":"static","value":"Chicago","created_by":"fa76f456-9a6f-4f63-8553-1cee233eb965","category_uuid":"8981f2d8-a043-4a74-ad78-e6a73b13ccaf"},{"value_uuid":"f45a48b4-50e7-41c3-afb9-2e01f5423698","category_name":"threat","asset_uuid":"842fa017-0141-4fdd-a53b-bcdd971ed1da","created_at":"2018-11-01T16:29:40.606Z","source":"static","value":"wannacry","created_by":"fa76f456-9a6f-4f63-8553-1cee233eb965","category_uuid":"a43054ec-87d7-4290-951f-2c489e848463"}]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/tags/assets/assignments":{"post":{"summary":"Add or remove asset tags","description":"Adds or removes tags to/from assets.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-assign-asset-tags","tags":["Tags"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","description":"Specifies whether to add or remove tags.","enum":["add","remove"]},"assets":{"items":{"type":"string","format":"uuid"},"description":"An array of asset UUIDs. For more information on determining values for this array, see [Determine Tag Identifiers](/docs/determine-tag-identifiers-tio).","type":"array"},"tags":{"items":{"type":"string","format":"uuid"},"description":"An array of tag value UUIDs. For more information on determining values for this array, see [Determine Tag Identifiers](/docs/determine-tag-identifiers-tio).","type":"array"}},"required":["action","assets","tags"]},"example":{"action":"add","assets":["208d8f5f-73a9-47cd-8b04-4aa99f38af79","c2332afe-5bfd-41fe-9e2e-5462dd3df455","9166eea2-d4aa-4a99-99eb-fee1c36d6457","5fc79177-e820-4ff7-ac28-6a5a995fea8b","fc0a57cb-66fc-43a5-a628-13ef10664fe8"],"tags":["18179e00-b0e0-4fd7-be91-e9e854fe66b9","f45a48b4-50e7-41c3-afb9-2e01f5423698","fb7fae7d-8acb-48e4-928c-d93103e9e73f"]}}}},"responses":{"202":{"description":"Returns the UUID of the asynchronous asset update job.","content":{"application/json":{"schema":{"type":"object","properties":{"job_uuid":{"type":"string","format":"uuid","description":"The UUID of the asynchronous asset update job."}}},"examples":{"response":{"value":{"job_uuid":"62210d02a7056d0297f50a8ddfbd549eaef1d0bc94e1ea3fad09"}}}}}},"400":{"description":"Returned if Tenable.io cannot find the specified assets."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/tags/assets/filters":{"get":{"summary":"List asset tag filters","description":"Returns a list of filters that you can use to create the rules for applying dynamic tags. Includes the field or tag names to match, the operators that you can use with the filter, and the rules for matching the values ('control' field), for example, a list of valid values.\n\nFor definitions of asset attribute filters you might use in tag rules, see [Asset Attribute Definitions](/docs/common-asset-attributes#asset-attribute-definitions). <p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"tags-list-asset-filters","tags":["Tags"],"responses":{"200":{"description":"Returns a list of filters.","content":{"application/json":{"schema":{"type":"array","description":"A list of available filters that you can use to define the rules for applying tags to assets.","items":{"type":"object","description":"A filter definition. Includes the field to be matched, the operators that you can use with the filter, and the rules for matching the values (`control` field), for example, a list of valid values.","properties":{"name":{"type":"string","description":"The name of the asset attribute or tag."},"readable_name":{"type":"string","description":"The asset attribute name displayed in the Tenable.io user interface."},"control":{"type":"object","properties":{"readable_regex":{"type":"string","description":"Provides a human-readable \"hint\" to guide users creating tag rules in the Tenable.io user interface."},"type":{"type":"string","description":"The type of UI control that represents the filter in the Tenable.io user interface."},"regex":{"type":"string","description":"A regular expression that Tenable.io UI uses to validate input."}}},"operators":{"description":"The comparison operators that can be used for the filter. To find supported operators, use the [GET /tags/assets/filters](/reference#tags-list-asset-filters) endpoint.","type":"array","items":{"type":"string"}}}}},"examples":{"response":{"value":{"filters":[{"control":{"readable_regex":"e.g. 123e4567e89b12d3a456426655440000","type":"entry","regex":".*"},"name":"tenable_uuid","readable_name":"Tenable UUID","operators":["eq","neq"]},{"control":{"readable_regex":"e.g. 01:23:45:67:89:AB","type":"entry","regex":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$"},"name":"mac_address","readable_name":"MAC Address","operators":["eq","neq"]},{"control":{"readable_regex":"e.g. mail01","type":"entry","regex":".*"},"name":"netbios_name","readable_name":"NetBIOS Name","operators":["eq","neq","match","nmatch"]},{"control":{"type":"dropdown_multi","list":[{"name":"US  pacific","value":"US  pacific"},{"name":"US Central","value":"US Central"},{"name":"US Pacific","value":"US Pacific"}]},"name":"tag.US Timezone","readable_name":"US Timezone","operators":["set-has","set-hasnot"]},{"control":{"type":"dropdown_multi","list":[{"name":"chicago","value":"chicago"}]},"name":"tag.city","readable_name":"city","operators":["set-has","set-hasnot"]},{"control":{"type":"dropdown_multi","list":[{"name":"FreeBSD","value":"FreeBSD"},{"name":"Linux Kernel","value":"Linux Kernel"},{"name":"Solaris","value":"Solaris"}]},"name":"tag.linux","readable_name":"linux","operators":["set-has","set-hasnot"]},{"control":{"type":"dropdown_multi","list":[{"name":"aix","value":"aix"}]},"name":"tag.unix","readable_name":"unix","operators":["set-has","set-hasnot"]}]}}}}}},"400":{"description":"Returned if Tenable.io cannot find the specified assets."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/target-groups":{"post":{"summary":"Create target group","description":"Creates a new target group for the current user.<p>Requires SCAN OPERATOR [24] permissions to create <i>user target groups</i>, and ADMINISTRATOR [64] permissions to create <i>system target groups</i>. For information about target group types, see <a href=\"https://docs.tenable.com/cloud/Content/Scans/TargetGroups.htm\">Tenable.io Vulnerability Management User Guide</a>. For information about permissions, see <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"target-groups-create","tags":["Target Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name for the group."},"members":{"type":"string","description":"The members of the group. A comma-separated list of FQDNs or IP address ranges that you want to scan."},"type":{"type":"string","description":"The group type (user or system).","enum":["user","system"]},"acls":{"items":{"type":"object","properties":{"owner":{"type":"integer","description":"The unique ID of the owner of the object."},"type":{"type":"string","description":"The type of permission (default, user, group).","enum":["default","user","group"]},"permissions":{"type":"integer","description":"The permission value to grant access as described in <a href=\"/docs/permissions\">Permissions</a>.","format":"int32"},"id":{"type":"integer","description":"The unique ID of the user if type is user."},"name":{"type":"string","description":"The name of the user or group."},"display_name":{"type":"string","description":"The display-friendly name of the user or group."}}},"description":"An array containing permissions to apply to the group.","type":"array","example":"[{\"type\": \"default\", \"permissions\": 16}, {\"type\": \"target-group\", \"permissions\": 64, \"name\": \"admin\", \"id\": 1, \"owner\": 1}]"}},"required":["name","members","type"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully creates the group.","content":{"application/json":{"schema":{"type":"object","properties":{"acls":{"description":"The Access Control Lists applicable to the group.","type":"array","items":{"type":"object","properties":{"owner":{"type":"integer","description":"The unique ID of the owner of the object."},"type":{"type":"string","description":"The type of permission (default, user, group).","enum":["default","user","group"]},"permissions":{"type":"integer","description":"The permission value to grant access as described in <a href=\"/docs/permissions\">Permissions</a>.","format":"int32"},"id":{"type":"integer","description":"The unique ID of the user if type is user."},"name":{"type":"string","description":"The name of the user or group."},"display_name":{"type":"string","description":"The display-friendly name of the user or group."}}}},"id":{"type":"integer","description":"The unique ID of the group."},"default_group":{"type":"boolean","description":"If true, this group is the default."},"name":{"type":"string","description":"The name of the group."},"members":{"type":"string","description":"The members of the group."},"type":{"type":"string","description":"The group type (user or system). Only administrators can create groups using the `system` type."},"owner":{"type":"string","description":"The name of the owner of the group. A user of `nessus_ms_agent` indicates it is a system target group."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the group."},"last_modification_date":{"type":"integer","description":"The last modification date for the group in unixtime."},"shared":{"type":"integer","description":"The shared status of the group."},"user_permissions":{"type":"integer","description":"The current user permissions for the group."}}},"examples":{"response":{"value":{"acls":[{"permissions":0,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"user2@example.com","name":"user2@example.com","id":2,"type":"user"}],"default_group":0,"members":"172.204.81.53, 172.204.81.54, 172.204.81.55, 172.204.81.56, 172.204.81.57","name":"RHEL_Hosts","owner":"user2@example.com","shared":0,"user_permissions":128,"last_modification_date":1543622674,"creation_date":1543622674,"owner_id":2,"id":18}}}}}},"400":{"description":"Returned if your response message is missing a required parameter or is otherwise invalid."},"403":{"description":"Returned if you do not have permission to create a group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to create the group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List target groups","description":"Returns the current target groups.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"target-groups-list","tags":["Target Groups"],"responses":{"200":{"description":"Returns the group.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"acls":{"description":"The Access Control Lists applicable to the group.","type":"array","items":{"type":"object","properties":{"owner":{"type":"integer","description":"The unique ID of the owner of the object."},"type":{"type":"string","description":"The type of permission (default, user, group).","enum":["default","user","group"]},"permissions":{"type":"integer","description":"The permission value to grant access as described in <a href=\"/docs/permissions\">Permissions</a>.","format":"int32"},"id":{"type":"integer","description":"The unique ID of the user if type is user."},"name":{"type":"string","description":"The name of the user or group."},"display_name":{"type":"string","description":"The display-friendly name of the user or group."}}}},"id":{"type":"integer","description":"The unique ID of the group."},"default_group":{"type":"boolean","description":"If true, this group is the default."},"name":{"type":"string","description":"The name of the group."},"members":{"type":"string","description":"The members of the group."},"type":{"type":"string","description":"The group type (user or system). Only administrators can create groups using the `system` type."},"owner":{"type":"string","description":"The name of the owner of the group. A user of `nessus_ms_agent` indicates it is a system target group."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the group."},"last_modification_date":{"type":"integer","description":"The last modification date for the group in unixtime."},"shared":{"type":"integer","description":"The shared status of the group."},"user_permissions":{"type":"integer","description":"The current user permissions for the group."}}}},"examples":{"response":{"value":{"target_groups":[{"acls":[{"permissions":0,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"user2@example.com","name":"user2@example.com","id":2,"type":"user"}],"default_group":0,"type":"user","members":"172.204.81.53, 172.204.81.54, 172.204.81.55, 172.204.81.56, 172.204.81.57","name":"Centos_Hosts","owner":"user2@example.com","shared":0,"user_permissions":128,"last_modification_date":1543622642,"creation_date":1543622642,"owner_id":2,"id":17},{"acls":[{"permissions":64,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"system","name":"nessus_ms_agent","id":1,"type":"user"}],"default_group":1,"type":"system","members":"*","name":"Default","owner":"nessus_ms_agent","shared":1,"user_permissions":64,"last_modification_date":1532459326,"creation_date":1532459326,"owner_id":1,"id":7},{"acls":[{"permissions":0,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"user2@example.com","name":"user2@example.com","id":2,"type":"user"}],"default_group":0,"type":"user","members":"172.204.81.53, 172.204.81.54, 172.204.81.55, 172.204.81.56, 172.204.81.57","name":"RHEL_Hosts","owner":"user2@example.com","shared":0,"user_permissions":128,"last_modification_date":1543622674,"creation_date":1543622674,"owner_id":2,"id":18}]}}}}}},"403":{"description":"Returned if you do not have permission to view the group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/target-groups/{group_id}":{"get":{"summary":"Get target group details","description":"Returns details for the specified target group.<p>Requires BASIC [16] permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"target-groups-details","tags":["Target Groups"],"parameters":[{"description":"The ID of the group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the group details.","content":{"application/json":{"schema":{"type":"object","properties":{"acls":{"description":"The Access Control Lists applicable to the group.","type":"array","items":{"type":"object","properties":{"owner":{"type":"integer","description":"The unique ID of the owner of the object."},"type":{"type":"string","description":"The type of permission (default, user, group).","enum":["default","user","group"]},"permissions":{"type":"integer","description":"The permission value to grant access as described in <a href=\"/docs/permissions\">Permissions</a>.","format":"int32"},"id":{"type":"integer","description":"The unique ID of the user if type is user."},"name":{"type":"string","description":"The name of the user or group."},"display_name":{"type":"string","description":"The display-friendly name of the user or group."}}}},"id":{"type":"integer","description":"The unique ID of the group."},"default_group":{"type":"boolean","description":"If true, this group is the default."},"name":{"type":"string","description":"The name of the group."},"members":{"type":"string","description":"The members of the group."},"type":{"type":"string","description":"The group type (user or system). Only administrators can create groups using the `system` type."},"owner":{"type":"string","description":"The name of the owner of the group. A user of `nessus_ms_agent` indicates it is a system target group."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the group."},"last_modification_date":{"type":"integer","description":"The last modification date for the group in unixtime."},"shared":{"type":"integer","description":"The shared status of the group."},"user_permissions":{"type":"integer","description":"The current user permissions for the group."}}},"examples":{"response":{"value":{"acls":[{"permissions":0,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"user2@example.com","name":"user2@example.com","id":2,"type":"user"}],"default_group":0,"type":"user","members":"172.204.81.53, 172.204.81.54, 172.204.81.55, 172.204.81.56, 172.204.81.57","name":"Centos_Hosts","owner":"user2@example.com","shared":0,"user_permissions":128,"last_modification_date":1543622642,"creation_date":1543622642,"owner_id":2,"id":17}}}}}},"403":{"description":"Returned if you do not have permission to view the group."},"404":{"description":"Returned if Tenable.io cannot find the specified group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update target group","description":"Updates a target group.\n - User target groups: This request requires SCAN OPERATOR [24] user permissions.\n - System target groups: This request requires ADMINISTRATOR [64] user permissions.","operationId":"target-groups-edit","tags":["Target Groups"],"parameters":[{"description":"The ID of the group to edit.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the group."},"members":{"type":"string","description":"The members of the group. A comma-separated list of FQDNs or IP address ranges that you want to scan."},"type":{"type":"string","description":"The group type (user or system).","enum":["user","system"]},"acls":{"items":{"type":"object","properties":{"owner":{"type":"integer","description":"The unique ID of the owner of the object."},"type":{"type":"string","description":"The type of permission (default, user, group).","enum":["default","user","group"]},"permissions":{"type":"integer","description":"The permission value to grant access as described in <a href=\"/docs/permissions\">Permissions</a>.","format":"int32"},"id":{"type":"integer","description":"The unique ID of the user if type is user."},"name":{"type":"string","description":"The name of the user or group."},"display_name":{"type":"string","description":"The display-friendly name of the user or group."}}},"description":"An array containing permissions to apply to the group.","type":"array","example":"[{\"type\": \"default\", \"permissions\": 16}, {\"type\": \"target-group\", \"permissions\": 64, \"name\": \"admin\", \"id\": 1, \"owner\": 1}]"}},"required":["name","members","type"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully updated the target group.","content":{"application/json":{"schema":{"type":"object","properties":{"acls":{"description":"The Access Control Lists applicable to the group.","type":"array","items":{"type":"object","properties":{"owner":{"type":"integer","description":"The unique ID of the owner of the object."},"type":{"type":"string","description":"The type of permission (default, user, group).","enum":["default","user","group"]},"permissions":{"type":"integer","description":"The permission value to grant access as described in <a href=\"/docs/permissions\">Permissions</a>.","format":"int32"},"id":{"type":"integer","description":"The unique ID of the user if type is user."},"name":{"type":"string","description":"The name of the user or group."},"display_name":{"type":"string","description":"The display-friendly name of the user or group."}}}},"id":{"type":"integer","description":"The unique ID of the group."},"default_group":{"type":"boolean","description":"If true, this group is the default."},"name":{"type":"string","description":"The name of the group."},"members":{"type":"string","description":"The members of the group."},"type":{"type":"string","description":"The group type (user or system). Only administrators can create groups using the `system` type."},"owner":{"type":"string","description":"The name of the owner of the group. A user of `nessus_ms_agent` indicates it is a system target group."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the group."},"last_modification_date":{"type":"integer","description":"The last modification date for the group in unixtime."},"shared":{"type":"integer","description":"The shared status of the group."},"user_permissions":{"type":"integer","description":"The current user permissions for the group."}}},"examples":{"response":{"value":{"acls":[{"permissions":0,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"user2@example.com","name":"user2@example.com","id":2,"type":"user"}],"default_group":0,"type":"user","members":"172.204.81.53, 172.204.81.54, 172.204.81.55, 172.204.81.56, 172.204.81.57","name":"Centos_Hosts","owner":"user2@example.com","shared":0,"user_permissions":128,"last_modification_date":1543622642,"creation_date":1543622642,"owner_id":2,"id":17}}}}}},"403":{"description":"Returned if you do not have permission to update the group."},"404":{"description":"Returned if Tenable.io cannot find the specified group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to update the group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete target group","description":"Deletes a target group. \n - User target groups: This request requires SCAN OPERATOR [24] user permissions.\n - System target groups: This request requires ADMINISTRATOR [64] user permissions.","operationId":"target-groups-delete","tags":["Target Groups"],"parameters":[{"description":"The ID of the group to delete.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deletes the target group.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you do not have permission to delete the group."},"404":{"description":"Returned if Tenable.io cannot find the specified group."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/import/vulnerabilities":{"post":{"summary":"Import vulnerabilities","description":"Imports a list of vulnerabilities in JSON format. The request cannot exceed 15 MB in total size. In addition, the request can contain a maximum of 50 asset objects. For request body examples, see [Add Vulnerability Data to Tenable.io](/docs/add-vulnerability-data-to-tenableio). <p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"vulnerabilities-import","tags":["Vulnerabilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"type":"string","description":"The source of the scan that generated the vulnerability data. If you want to categorize the imported vulnerabilities in the same way that Tenable.io categorizes vulnerabilities detected in scans it manages, use the following values: \n - security_center—A Nessus scan identified the vulnerabilities you want to import. Use this value for all Nessus scans, regardless of the scan manager (Tenable.io, SecurityCenter, or Nessus Manager).\n - qualys—A Qualys scan identified the vulnerabilities you want to import.","example":"nessus"},"type":{"type":"string","description":"The type of scan that identified the vulnerabilities you want to import. If you want to categorize the imported vulnerabilities in the same way that Tenable.io categorizes vulnerabilities detected in scans it manages, use the following values: \n - vm—A Vulnerability Management scan identified the vulnerabilities.\n - was—A Web Application Scanning scan identified the vulnerabilities.\n - pc—A scan of a personal computer identified the vulnerabilities.","example":"vm"},"assets":{"type":"array","description":"An array of asset objects with vulnerabilities information. A valid asset record requires at least one valid network_interface object.\n\n**Note:** Tenable.io supports a maximum of 50 individual asset objects per request message. In addition, because Tenable.io supports a total size limit of 15 MB for the request message, you may want to limit the number of asset objects you include in an individual request, depending on the number of vulnerabilities identified on the assets and the size of the related vulnerability output.\n\n**Note:** This endpoint does not support the network_id attribute in asset objects for import. Tenable.io automatically assigns imported assets to the default network object. For more information about network objects, see [Manage Networks](/docs/manage-networks-tio).","items":{"type":"object","properties":{"network_interfaces":{"type":"array","description":"A valid network_interface object must contain at least one of the following parameters: ipv4, netbios_name, fqdn.","items":{"type":"object","properties":{"ipv4":{"type":"array","description":"A list of IPv4 address that the scan identified as associated with the network interface.","items":{"type":"string"}},"ipv6":{"type":"array","description":"A list of IPv6 addresses that the scan identified as associated with the network interface.","items":{"type":"string"}},"mac_address":{"type":"string","description":"The MAC address of the network interface."},"netbios_name":{"type":"string","description":"The NETBIOS name of the network interface."},"fqdn":{"type":"string","description":"The fully-qualified domain name (FQDN) of the network interface."}}}},"hostname":{"type":"string","description":"The asset's hostname."},"qualys_asset_id":{"type":"string","description":"The Asset ID of the asset in Qualys. For more information, see the Qualys documentation."},"qualys_host_id":{"type":"string","description":"The Host ID of the asset in Qualys. For more information, see the Qualys documentation."},"servicenow_sysid":{"type":"string","description":"The unique record identifier of the asset in ServiceNow. For more information, see the ServiceNow documentation."},"ssh_fingerprint":{"type":"string","description":"The SSH key fingerprint that the scan has associated with the asset."},"bios_uuid":{"type":"string","description":"The BIOS UUID of the asset."},"netbios_name":{"type":"string","description":"The NetBIOS name that the scan has associated with the asset."},"tenable_agent_id":{"type":"integer","description":"The unique ID of the Nessus agent installed on the asset. This parameter is supported only if the `source` parameter for the request is `security_center`."},"vulnerabilities":{"type":"array","description":"A valid vulnerability object must contain at least one of the following parameters: tenable_plugin_id, qualys_id, or cve.","items":{"type":"object","properties":{"tenable_plugin_id":{"type":"string","description":"The ID of the Nessus plugin that identified the vulnerability. This parameter is required if the vulnerability object does not specify either a qualys_id or cve value."},"qualys_id":{"type":"string","description":"The unique ID (QID) of the vulnerability in the Qualys system. For more information, see the Qualys documentation. This parameter is required if the vulnerability object does not specify either a tenable_plugin_id or cve value."},"cve":{"type":"string","description":"The Common Vulnerability and Exposure (CVE) ID for the vulnerability. This parameter is required if the vulnerability object does not specify either a tenable_plugin_id or qualys_id value."},"port":{"type":"integer","description":"The port the scanner used to communicate with the asset.","format":"int32"},"protocol":{"type":"string","description":"The protocol the scanner used to communicate with the asset."},"authenticated":{"type":"boolean","description":"A value specifying whether the scan that identified the vulnerability was an authenticated (credentialed) scan."},"first_found":{"type":"integer","description":"The date (in Unix time) when a scan first identified the vulnerability on the asset.","format":"int32"},"last_found":{"type":"integer","description":"The date (in Unix time) when a scan last identified the vulnerability on the asset.","format":"int32"},"last_fixed":{"type":"integer","description":"The date (in Unix time) when the vulnerability state was changed to `fixed`. Tenable.io updates the vulnerability state to fixed when a scan no longer detects a previously detected vulnerability on the asset.","format":"int32"},"output":{"type":"string","description":"(Required) The text output of the scanner, up to 2,000 maximum characters."}}}}}}},"checks_ran":{"type":"array","description":"An array of objects, each representing a check that the scan used to detect the vulnerabilities you are importing. This parameter supports Tenable plugin checks only. For more information, see [Plugins](https://www.tenable.com/plugins).","items":{"type":"object","properties":{"tenable_plugin_id":{"type":"string","description":"The Tenable plugin ID."},"port":{"type":"integer","description":"The port on the asset where the check ran."},"protocol":{"type":"string","description":"The protocol used to communicate with the asset while running the check."}}}}},"required":["source","type","assets"]}}}},"responses":{"200":{"description":"Returned if Tenable.io successfully imports the vulnerabilities.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"400":{"description":"Returned if you submitted an invalid request."},"403":{"description":"Returned if you do not have permission to import vulnerabilities."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an internal server error. Wait a moment, and try your request again."},"503":{"description":"Returned if a Tenable.io service is unavailable. Wait a moment, and try your request again."}},"security":[{"cloud":[]}]}},"/workbenches/vulnerabilities":{"get":{"summary":"List vulnerabilities","description":"Returns a list of recorded vulnerabilities. The list returned is limited to 5,000. To retrieve more than 5,000 vulnerabilities, use the <a href=\"#workbenches-export-request\">export-request API</a>.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-vulnerabilities","tags":["Workbenches"],"parameters":[{"description":"Lists only those vulnerabilities older than a certain number of days.","name":"age","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"Lists only authenticated vulnerabilities.","name":"authenticated","in":"query","schema":{"type":"boolean"}},{"description":"The number of days of data prior to and including today that should be returned.","name":"date_range","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"Lists only exploitable vulnerabilities.","name":"exploitable","in":"query","schema":{"type":"boolean"}},{"description":"The name of the filter to apply to the exported scan report. You can find available filters by using the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.filter","in":"query","schema":{"type":"string"},"example":"?filter.0.filter=plugin.name"},{"description":"The operator of the filter to apply to the exported scan report. You can find the operators for the filter using the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.quality","in":"query","schema":{"type":"string"},"example":"&filter.0.quality=match"},{"description":"The value of the filter to apply to the exported scan report. You can find valid values for the filter in the 'control' attribute of the objects returned by the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.value","in":"query","schema":{"type":"string"},"example":"&filter.0.value=RHEL"},{"description":"For multiple filters, specifies whether to use the AND or the OR logical operator. The default is AND. For more information about this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.search_type","in":"query","schema":{"type":"string","enum":["","and","or"]}},{"description":"Lists only those vulnerabilities with a remediation path.","name":"resolvable","in":"query","schema":{"type":"boolean"}},{"description":"Lists only vulnerabilities of a specific severity (critical, high, medium or low)","name":"severity","in":"query","schema":{"type":"string","enum":["","critical","high","medium","low"]}}],"responses":{"200":{"description":"Returns a list of vulnerabilities.","content":{"application/json":{"schema":{"type":"object","description":"A list of vulnerabilities.","properties":{"vulnerabilities":{"type":"array","description":"A list of discovered vulnerabilities.","items":{"type":"object","properties":{"count":{"type":"integer","description":"The number of times that a scan detected the vulnerability on an asset."},"plugin_family":{"type":"string","description":"The plugin's family."},"plugin_id":{"type":"integer","description":"The unique plugin ID."},"plugin_name":{"type":"string","description":"The name of the plugin that detected the vulnerability."},"vulnerability_state":{"type":"string","description":"The current state of the reported plugin. Possible states include:\n - Active—The vulnerability is currently present on an asset.\n - New—The vulnerability is active on an asset, and was first detected within the last 14 days.\n - Fixed—A subsequent scan detected that the formerly-active vulnerability is no longer present on an asset.\n - Resurfaced—The vulnerability was previously marked as fixed on an asset, but a subsequent scan detected the vulnerability on the asset again."},"vpr_score":{"type":"integer","description":"The Vulnerability Priority Rating (VPR) for the vulnerability. If a plugin is designed to detect multiple vulnerabilities, the VPR represents the highest value calculated for a vulnerability associated with the plugin. For more information, see <a href=\"https://docs.tenable.com/cloud/Content/Analysis/RiskMetrics.htm\" target=\"_blank\">Severity vs. VPR</a> in the <i>Tenable.io Vulnerability Management User Guide</i>.","format":"int32"},"accepted_count":{"type":"integer","description":"The number of times that a user in the user interface created an accept rule for this vulnerability. For more information, see <a href=\"https://docs.tenable.com/cloud/Content/Settings/AboutRecastRules.htm\" target=\"_blank\">Recast Rules</a> in the <i>Tenable.io Vulnerability Management User Guide</i>.","format":"int32"},"recasted_count":{"type":"integer","description":"The number of times that a user in the user interface created a recast rule for this vulnerability. For more information, see <a href=\"https://docs.tenable.com/cloud/Content/Settings/AboutRecastRules.htm\" target=\"_blank\">Recast Rules</a> in the <i>Tenable.io Vulnerability Management User Guide</i>.","format":"int32"},"counts by severity":{"type":"array","description":"The number of times that a scan detected the vulnerability on an asset, grouped by severity level.","items":{"type":"object","properties":{"count":{"type":"integer","description":"The number of times that a scan detected the vulnerability on an asset while the vulnerability was assigned the specified severity level.","format":"int32"},"value":{"type":"integer","description":"The severity level of the vulnerabilities in the group."}}}},"severity":{"type":"integer","description":"The severity level of the vulnerability, as defined using the Common Vulnerability Scoring System (CVSS) base score. Possible values include: \n - 0—The vulnerability has a CVSS score of 0, which corresponds to the \"info\" severity level.\n - 1—The vulnerability has a CVSS score between 0.1 and 3.9, which corresponds to the \"low\" severity level.\n - 2—The vulnerability has a CVSS score between 4.0 and 6.9, which corresponds to the \"medium\" severity level.\n - 3—The vulnerability has a CVSS score between 7.0 and 9.9, which corresponds to the \"high\" severity level.\n - 4—The vulnerability has a CVSS score of 10.0, which corresponds to the \"critical\" severity level.","format":"int32"}}}},"total_vulnerability_count":{"type":"integer","description":"The total number of discovered vulnerabilities."},"total_asset_count":{"type":"integer","description":"The total number of assets."}}},"examples":{"response":{"value":{"vulnerabilities":[{"count":319,"plugin_family":"General","plugin_id":51192,"plugin_name":"SSL Certificate Cannot Be Trusted","vulnerability_state":"Active","vpr_score":2.4,"accepted_count":0,"recasted_count":0,"counts_by_severity":[{"count":319,"value":2}],"severity":2},{"count":215,"plugin_family":"Misc.","plugin_id":70658,"plugin_name":"SSH Server CBC Mode Ciphers Enabled","vulnerability_state":"Active","vpr_score":7.4,"accepted_count":0,"recasted_count":0,"counts_by_severity":[{"count":215,"value":1}],"severity":1},{"count":168,"plugin_family":"Misc.","plugin_id":71049,"plugin_name":"SSH Weak MAC Algorithms Enabled","vulnerability_state":"Active","vpr_score":5.5,"accepted_count":0,"recasted_count":0,"counts_by_severity":[{"count":168,"value":1}],"severity":1}],"total_vulnerability_count":3,"total_asset_count":0}}}}}},"403":{"description":"Returned if you do not have permission to list vulnerabilities."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/workbenches/vulnerabilities/{plugin_id}/info":{"get":{"summary":"Get plugin details","description":"Retrieves the details for a plugin.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-vulnerability-info","tags":["Workbenches"],"parameters":[{"description":"The ID of the plugin. You can find the plugin ID by examining the output of the [GET /workbenches/vulnerabilities](#workbenches-vulnerabilities) endpoint.","required":true,"name":"plugin_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The number of days of data prior to and including today that should be returned.","name":"date_range","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The name of the filter to apply to the exported scan report. You can find available filters by using the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.filter","in":"query","schema":{"type":"string"},"example":"?filter.0.filter=plugin.name"},{"description":"The operator of the filter to apply to the exported scan report. You can find the operators for the filter using the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.quality","in":"query","schema":{"type":"string"},"example":"&filter.0.quality=match"},{"description":"The value of the filter to apply to the exported scan report. You can find valid values for the filter in the 'control' attribute of the objects returned by the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.value","in":"query","schema":{"type":"string"},"example":"&filter.0.value=RHEL"},{"description":"For multiple filters, specifies whether to use the AND or the OR logical operator. The default is AND. For more information about this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.search_type","in":"query","schema":{"type":"string","enum":["","and","or"]}}],"responses":{"200":{"description":"Returns plugin details.","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"A count of the vulnerability occurrences."},"vuln_count":{"type":"integer","format":"int32","description":""},"description":{"type":"string","description":"The description of the vulnerability."},"synopsis":{"type":"string","description":"A brief summary of the vulnerability."},"solution":{"type":"string","description":"Information on how to fix the vulnerability."},"discovery":{"type":"object","properties":{"seen_first":{"type":"string","description":"The Unix timestamp of the scan that first detected the vulnerability on an asset."},"seen_last":{"type":"string","description":"The Unix timestamp of the scan that most recently detected the vulnerability on an asset."}}},"severity":{"type":"integer","description":"The severity level of the vulnerability."},"plugin_details":{"type":"object","properties":{"family":{"type":"string","description":"The plugin family."},"modification_date":{"type":"string","description":"The ISO timestamp when Tenable last updated the plugin definition."},"name":{"type":"string","description":"The name of the plugin."},"publication_date":{"type":"string","description":"The ISO timestamp when Tenable first published the plugin definition."},"type":{"type":"string","description":"The type of scan that uses the plugin, either a network scan (`remote`) or a credentialed scan (`local`)."},"version":{"type":"string","description":"The plugin version."},"severity":{"type":"integer","format":"int32","description":"The severity level of the plugin."}}},"reference_information":{"type":"array","description":"","items":{"type":"object","properties":{"name":{"type":"string","description":"The source of the reference information about the vulnerability. Possible values include:\n - bid—Bugtraq (Symantec Connect)\n - cert—CERT/CC Vulnerability Notes Database\n - cve—NIST National Vulnerability Database (NVD)\n - edb-id—The Exploit Database\n - iava—information assurance vulnerability alert\n - osvdb—Open Sourced Vulnerability Database"},"url":{"type":"string","description":"The URL of the source site, if available."},"values":{"type":"array","description":"The unique identifier(s) for the vulnerability at the source.","items":{"type":"string"}}}}},"risk_information":{"type":"object","properties":{"risk_factor":{"type":"string","description":"The risk factor associated with the plugin. Possible values are: `Low`, `Medium`, `High`, or `Critical`."},"cvss_vector":{"type":"string","description":"The raw CVSSv2 metrics for the vulnerability. For more information, see CVSSv2 documentation."},"cvss_base_score":{"type":"string","description":"The CVSSv2 base score (intrinsic and fundamental characteristics of a vulnerability that are constant over time and user environments)."},"cvss_temporal_vector":{"type":"string","description":"The raw CVSSv2 temporal metrics for the vulnerability."},"cvss_temporal_score":{"type":"string","description":"The CVSSv2 temporal score (characteristics of a vulnerability that change over time but not among user environments)."},"cvss3_vector":{"type":"string","description":"The raw CVSSv3 metrics for the vulnerability. For more information, see CVSSv3 documentation."},"cvss3_base_score":{"type":"string","description":"The CVSSv3 base score (intrinsic and fundamental characteristics of a vulnerability that are constant over time and user environments)."},"cvss3_temporal_vector":{"type":"string","description":"CVSSv3 temporal metrics for the vulnerability."},"cvss3_temporal_score":{"type":"string","description":"The CVSSv3 temporal score (characteristics of a vulnerability that change over time but not among user environments)."},"stig_severity":{"type":"string","description":"Security Technical Implementation Guide (STIG) severity code for the vulnerability."}}},"see_also":{"type":"array","description":"Links to external websites that contain helpful information about the vulnerability.","items":{"type":"string"}},"vulnerability_information":{"type":"object","properties":{"vulnerability_publication_date":{"type":"string","description":"The ISO timestamp for the first publication date of the plugin."},"exploited_by_malware":{"type":"boolean","description":"The vulnerability discovered by this plugin is known to be exploited by malware."},"patch_publication_date":{"type":"string","description":"The ISO timestamp for date on which the vendor published a patch for the vulnerability."},"exploit_available":{"type":"boolean","description":"A value specifying whether a public exploit exists for the vulnerability."},"exploitability_ease":{"type":"string","description":"Description of how easy it is to exploit the issue."},"asset_inventory":{"type":"string","description":""},"default_account":{"type":"string","description":""},"exploited_by_nessus":{"type":"boolean","description":"A value specifying whether Nessus exploited the vulnerability during the process of identification."},"in_the_news":{"type":"boolean","description":"A value specifying whether this plugin has received media attention (for example, ShellShock, Meltdown)."},"malware":{"type":"string","description":""},"unsupported_by_vendor":{"type":"boolean","description":"Software found by this plugin is unsupported by the software's vendor (for example, Windows 95 or Firefox 3)."},"cpe":{"type":"string","description":"The Common Platform Enumeration (CPE) number for the plugin."},"exploit_frameworks":{"type":"array","description":"A list of exploit frameworks that have identified the vulnerability.","items":{"type":"object","description":"Information about the vulnerability in a specific exploit framework.","properties":{"name":{"type":"string","description":"The name of the exploit framework."},"exploits":{"type":"array","description":"A list of exploits associated with the vulnerability in the specified exploit framework.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the identified exploit."},"url":{"type":"string","description":"The URL for the exploit in the framework."}}}}}}}}},"vpr":{"type":"object","description":"Information about the Vulnerability Priority Rating (VPR) for the vulnerability.","properties":{"score":{"type":"integer","description":"The Vulnerability Priority Rating (VPR) for the vulnerability. If a plugin is designed to detect multiple vulnerabilities, the VPR represents the highest value calculated for a vulnerability associated with the plugin. For more information, see <a href=\"https://docs.tenable.com/cloud/Content/Analysis/RiskMetrics.htm\" target=\"_blank\">Severity vs. VPR</a> in the <i>Tenable.io Vulnerability Management User Guide</i>.","format":"int32"},"drivers":{"type":"object","description":"The key drivers Tenable uses to calculate a vulnerability's VPR. For more information, see <a href=\"/docs/vpr-drivers-tio\">Vulnerability Priority Rating Drivers</a>.","properties":{}},"updated":{"type":"string","description":"The ISO timestamp when Tenable.io last imported the VPR for this vulnerability. Tenable.io imports a VPR value the first time you scan a vulnerability on your network. Then, Tenable.io automatically re-imports new and updated VPR values daily."}}}}},"examples":{"response":{"value":{"info":{"count":13,"vuln_count":14,"description":"The remote web server is affected by a command injection vulnerability in GNU Bash known as Shellshock. The vulnerability is due to the processing of trailing strings after function definitions in the values of environment variables. This allows a remote attacker to execute arbitrary code via environment variable manipulation depending on the configuration of the system.","synopsis":"The remote web server is affected by a remote code execution vulnerability.","solution":"Apply the referenced patch.","discovery":{"seen_first":"2019-03-08T17:15:52.000Z","seen_last":"2019-04-05T22:53:45.000Z"},"severity":4,"plugin_details":{"family":"CGI abuses","modification_date":"2017-04-25T00:00:00Z","name":"GNU Bash Environment Variable Handling Code Injection (Shellshock)","publication_date":"2014-09-24T00:00:00Z","type":"remote","version":null,"severity":4},"reference_information":[{"name":"bid","url":"http://www.securityfocus.com/bid/","values":[70103]},{"name":"cert","url":"http://www.kb.cert.org/vuls/id/","values":["252743"]},{"name":"cve","url":"http://web.nvd.nist.gov/view/vuln/detail?vulnId=","values":["CVE-2014-6271"]},{"name":"edb-id","url":"http://www.exploit-db.com/exploits/","values":["34766","34777","34765"]},{"name":"iava","values":["2014-A-0142"]},{"name":"osvdb","values":["112004"]}],"risk_information":{"risk_factor":"Critical","cvss_vector":"AV:N/AC:L/Au:N/C:C/I:C/A:C","cvss_base_score":"10.0","cvss_temporal_vector":"E:F/RL:OF/RC:ND","cvss_temporal_score":"8.3","cvss3_vector":null,"cvss3_base_score":null,"cvss3_temporal_vector":null,"cvss3_temporal_score":null,"stig_severity":null},"see_also":["http://seclists.org/oss-sec/2014/q3/650","http://www.nessus.org/u?dacf7829","https://www.invisiblethreat.ca/post/shellshock/"],"vulnerability_information":{"vulnerability_publication_date":"2014-09-24T00:00:00Z","exploited_by_malware":true,"patch_publication_date":"2014-09-24T00:00:00Z","exploit_available":true,"exploitability_ease":null,"asset_inventory":null,"default_account":null,"exploited_by_nessus":null,"in_the_news":true,"malware":null,"unsupported_by_vendor":null,"cpe":null,"exploit_frameworks":[{"name":"Core Impact"},{"name":"Metasploit","exploits":[{"name":"Apache mod_cgi Bash Environment Variable Code Injection (Shellshock)","url":null}]}]},"vpr":{"score":9.6,"drivers":{"age_of_vuln":{"lower_bound":731,"upper_bound":0},"exploit_code_maturity":"HIGH","cvss3_impact_score":5.9,"cvss_impact_score_predicted":true,"threat_intensity_last28":"HIGH","threat_recency":{"lower_bound":0,"upper_bound":7},"threat_sources_last28":["Others","Mainstream Media","Code Repo and Paste Bins"],"product_coverage":"LOW"},"updated":"2019-04-01T10:10:57Z"}}}}}}}},"403":{"description":"Returned if you do not have permission to view plugin details."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/workbenches/vulnerabilities/{plugin_id}/outputs":{"get":{"summary":"List plugin outputs","description":"Retrieves the vulnerability outputs for a plugin. The list returned is limited to 5,000. To retrieve more than 5,000 vulnerability outputs, use the <a href=\"#workbenches-export-request\">export-request API</a>.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-vulnerability-output","tags":["Workbenches"],"parameters":[{"description":"The ID of the plugin. You can find the plugin ID by examining the output of the [GET /workbenches/vulnerabilities](#workbenches-vulnerabilities) endpoint.","required":true,"name":"plugin_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The number of days of data prior to and including today that should be returned.","name":"date_range","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The name of the filter to apply to the exported scan report. You can find available filters by using the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.filter","in":"query","schema":{"type":"string"},"example":"?filter.0.filter=plugin.name"},{"description":"The operator of the filter to apply to the exported scan report. You can find the operators for the filter using the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.quality","in":"query","schema":{"type":"string"},"example":"&filter.0.quality=match"},{"description":"The value of the filter to apply to the exported scan report. You can find valid values for the filter in the 'control' attribute of the objects returned by the [GET /filters/workbenches/vulnerabilities](#workbenches-vulnerabilities-filters) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.value","in":"query","schema":{"type":"string"},"example":"&filter.0.value=RHEL"},{"description":"For multiple filters, specifies whether to use the AND or the OR logical operator. The default is AND. For more information about this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.search_type","in":"query","schema":{"type":"string","enum":["","and","or"]}}],"responses":{"200":{"description":"Returns plugin outputs.","content":{"application/json":{"schema":{"type":"array","description":"A list of vulnerabilities discovered by the plugin.","items":{"type":"object","properties":{"plugin_output":{"type":"string","description":"The plugin's output about the vulnerability. May be an empty string."},"states":{"type":"array","description":"Vulnerability state items.","items":{"type":"object","properties":{"name":{"type":"string","description":"The current state of the reported plugin (Active, Fixed, New, etc.)"},"results":{"type":"array","items":{"type":"object","properties":{"application_protocol":{"type":"string","description":"The application protocol where this vulnerability was found."},"port":{"type":"integer","description":"The port number where this vulnerability was found."},"transport_protocol":{"type":"string","description":"The transportation protocol (TCP or UDP) where this vulnerability was found."},"assets":{"type":"array","description":"A list of assets where this output was found.","items":{"type":"object","properties":{"hostname":{"type":"string","description":"The host name of the asset."},"id":{"type":"string","description":"The ID of the asset."},"uuid":{"type":"string","description":"The UUID of the asset."},"netbios_name":{"type":"string","description":"The NetBios name of the asset."},"fqdn":{"type":"string","description":"The FQDN of the asset."},"ipv4":{"type":"string","description":"The IPV4 of the asset."},"first_seen":{"type":"string","format":"date-time","description":"Indicates when the asset was discovered by a scan."},"last_seen":{"type":"string","format":"date-time","description":"Indicates when the asset was last observed by a scan."}}}},"severity":{"type":"integer","description":"Integer [0-4] indicating how severe the vulnerability is, where 0 is info only."}}}}}}}}}},"examples":{"response":{"value":{"outputs":[{"plugin_output":"\nThe following certificate was at the top of the certificate\nchain sent by the remote host, but it is signed by an unknown\ncertificate authority :\n\n|-Subject : O=LCE Users/OU=LCE Certification Authority/L=New York/C=US/ST=NY/CN=LCE Certification Authority\n|-Issuer  : O=LCE Users/OU=LCE Certification Authority/L=New York/C=US/ST=NY/CN=LCE Certification Authority\n","states":[{"name":"Active","results":[{"application_protocol":"unknown","port":1243,"transport_protocol":"tcp","assets":[{"hostname":"172.204.81.57","id":"484f06ae-c614-4a82-83f8-a8132b31ea37","uuid":"484f06ae-c614-4a82-83f8-a8132b31ea37","netbios_name":null,"fqdn":null,"ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"},{"hostname":"172.204.81.57","id":"73261e87-8a1a-4644-9e99-d97feb3bdf48","uuid":"73261e87-8a1a-4644-9e99-d97feb3bdf48","netbios_name":null,"fqdn":null,"ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"},{"hostname":"172.204.81.57","id":"9be6d0b1-33d2-4a29-86ea-69cd52642856","uuid":"9be6d0b1-33d2-4a29-86ea-69cd52642856","netbios_name":null,"fqdn":"benchlce2.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"},{"hostname":"172.204.81.57","id":"da2f6f2b-2a82-4fc4-865e-1a3d8b393b00","uuid":"da2f6f2b-2a82-4fc4-865e-1a3d8b393b00","netbios_name":null,"fqdn":null,"ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"},{"hostname":"172.204.81.57","id":"eb970c99-08c4-4e44-ae5f-01f062b4349d","uuid":"eb970c99-08c4-4e44-ae5f-01f062b4349d","netbios_name":null,"fqdn":"centos7.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"},{"hostname":"172.204.81.57","id":"f228fdad-2f82-40c0-bb68-ad3ff2a8bebc","uuid":"f228fdad-2f82-40c0-bb68-ad3ff2a8bebc","netbios_name":null,"fqdn":null,"ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"}],"severity":2}]}]},{"plugin_output":"\nThe following certificate was at the top of the certificate\nchain sent by the remote host, but it is signed by an unknown\ncertificate authority :\n\n|-Subject : O=VMware, Inc./OU=vCenterServer_2014.07.30_111246/CN=VMware default certificate/E=support@vmware.com\n|-Issuer  : O=VMware, Inc./OU=vCenterServer_2014.07.30_111246/CN=172.204.81.57/E=support@vmware.com\n","states":[{"name":"Active","results":[{"application_protocol":"unknown","port":443,"transport_protocol":"tcp","assets":[{"hostname":"172.204.81.57","id":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","uuid":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","netbios_name":"VCENTER","fqdn":"vcenter.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"}],"severity":2},{"application_protocol":"unknown","port":8191,"transport_protocol":"tcp","assets":[{"hostname":"172.204.81.57","id":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","uuid":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","netbios_name":"VCENTER","fqdn":"vcenter.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"}],"severity":2},{"application_protocol":"unknown","port":8443,"transport_protocol":"tcp","assets":[{"hostname":"172.204.81.57","id":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","uuid":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","netbios_name":"VCENTER","fqdn":"vcenter.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"}],"severity":2},{"application_protocol":"unknown","port":31100,"transport_protocol":"tcp","assets":[{"hostname":"172.204.81.57","id":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","uuid":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","netbios_name":"VCENTER","fqdn":"vcenter.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"}],"severity":2},{"application_protocol":"unknown","port":32100,"transport_protocol":"tcp","assets":[{"hostname":"172.204.81.57","id":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","uuid":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","netbios_name":"VCENTER","fqdn":"vcenter.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"}],"severity":2}]}]},{"plugin_output":"\nThe following certificate was at the top of the certificate\nchain sent by the remote host, but it is signed by an unknown\ncertificate authority :\n\n|-Subject : CN=SSL_Self_Signed_Fallback\n|-Issuer  : CN=SSL_Self_Signed_Fallback\n","states":[{"name":"Active","results":[{"application_protocol":"unknown","port":1433,"transport_protocol":"tcp","assets":[{"hostname":"172.204.81.57","id":"159295bd-0942-4ce6-aeb2-25aa7f161ba1","uuid":"159295bd-0942-4ce6-aeb2-25aa7f161ba1","netbios_name":"SQL2014","fqdn":"sql2014.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"},{"hostname":"172.204.81.57","id":"64cd2363-849f-46cb-88cf-df1b78511d9c","uuid":"64cd2363-849f-46cb-88cf-df1b78511d9c","netbios_name":"SCCMHOST","fqdn":"sccmhost.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"},{"hostname":"172.204.81.57","id":"ca66c0ad-3058-4abc-8173-040f622d9820","uuid":"ca66c0ad-3058-4abc-8173-040f622d9820","netbios_name":"SHAREPOINT2013","fqdn":"sharepoint2013.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"},{"hostname":"sql.ad.demo.io","id":"f674a95a-ec3d-4401-88c9-2eef4be82fa8","uuid":"f674a95a-ec3d-4401-88c9-2eef4be82fa8","netbios_name":"SQL","fqdn":"sql.ad.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:57Z","last_seen":"2018-11-28T15:00:57Z"}],"severity":2},{"application_protocol":"unknown","port":51361,"transport_protocol":"tcp","assets":[{"hostname":"172.204.81.57","id":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","uuid":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","netbios_name":"VCENTER","fqdn":"vcenter.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"}],"severity":2}]}]}]}}}}}},"403":{"description":"Returned if you do not have permission to view plugin outputs."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/workbenches/assets":{"get":{"summary":"List assets","description":"Retrieves a list of assets. The list can be modified using filters. The list returned is limited to 5,000. To retrieve more than 5,000 assets, use the <a href=\"#exports-assets-request-export\">export-request API</a>.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-assets","tags":["Workbenches"],"parameters":[{"description":"The number of days of data prior to and including today that should be returned.","name":"date_range","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The name of the filter to apply to the exported scan report. You can find available filters by using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. If you specify the name of the filter, you must specify the operator as the filter.0.quality parameter and the value as the filter.0.value parameter. To use multiple filters, increment the `<INDEX>` portion of `filter.<INDEX>.filter`, for example, `filter.0.filter`.","required":false,"name":"filter.0.filter","in":"query","schema":{"type":"string"},"example":"?filter.0.filter=plugin.name"},{"description":"The operator of the filter to apply to the exported scan report. You can find the operators for the filter using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.quality","in":"query","schema":{"type":"string"},"example":"&filter.0.quality=match"},{"description":"The value of the filter to apply to the exported scan report. You can find valid values for the filter in the 'control' attribute of the objects returned by the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.value","in":"query","schema":{"type":"string"},"example":"&filter.0.value=RHEL"},{"description":"For multiple filters, specifies whether to use the AND or the OR logical operator. The default is AND. For more information about this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.search_type","in":"query","schema":{"type":"string","enum":["","and","or"]}},{"description":"A value specifying whether you want the returned data to include all fields (`full`) or only the default fields (`default`). The schema for this endpoint defines the `default` fields only. For a definition of the `full` fields, see [Common Asset Attributes](/docs/common-asset-attributes).","required":false,"name":"all_fields","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns an array of asset objects.","content":{"application/json":{"schema":{"type":"object","properties":{"assets":{"type":"array","description":"An array of asset objects.","items":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the asset."},"has_agent":{"type":"boolean","description":"A value specifying whether a Nessus agent scan detected the asset (`true`)."},"last_seen":{"type":"string","description":"The ISO timestamp of the scan that most recently detected the asset."},"last_scan_target":{"type":"string","description":"The IPv4 address, IPv6 address, or FQDN that the scanner last used to evaluate the asset."},"sources":{"type":"array","description":"A list of sources for the asset record.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity that reported the asset details. Sources can include sensors, connectors, and API imports. Source names can be customized by your organization (for example, you specify a name when you import asset records). If your organization does not customize source names, system-generated names include:\n - AWS—You obtained the asset data from an Amazon Web Services connector.\n - NESSUS_AGENT—You obtained the asset data obtained from a Nessus agent scan.\n - PVS—You obtained the asset data from a Nessus Network Monitor (NNM) scan.\n - NESSUS_SCAN—You obtained the asset data from a Nessus scan.\n - WAS—You obtained the asset data from a  Web Application Scanning scan."},"first_seen":{"type":"string","description":"The ISO timestamp when the source first reported the asset."},"last_seen":{"type":"string","description":"The ISO timestamp when the source last reported the asset."}}}},"acr_score":{"type":"integer","description":"The Asset Criticality Rating (ACR) for the asset. Tenable assigns an ACR to each asset on your network to represent the asset's relative risk as an integer from 1 to 10. This attribute is only present in assets if Lumin is added to your Tenable.io instance. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*."},"acr_drivers":{"type":"array","description":"The key drivers that Tenable uses to calculate an asset's Tenable-provided ACR. This attribute is only present in assets if Lumin is added to your Tenable.io instance. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*.","items":{"type":"object","description":"Information about an asset characteristic that factored into the ACR score calculation.","properties":{"driver_name":{"type":"string","description":"The type of characteristic."},"driver_value":{"type":"array","description":"The characteristic value.","items":{"type":"string"}}}}},"exposure_score":{"type":"integer","description":"The Asset Exposure Score (AES) for the asset. This attribute is only present in assets if Lumin is added to your Tenable.io instance. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*."},"scan_frequency":{"type":"array","description":"Information about how often scans ran against the asset during specified intervals. This attribute is only present in assets if Lumin is added to your Tenable.io instance. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*.","items":{"type":"object","description":"Information about how often scans ran against asset during a specified interval.","properties":{"interval":{"type":"integer","description":"The number of days over which Tenable searches for scans involving the asset."},"frequency":{"type":"integer","description":"The number of times that a scan ran against the asset during the specified interval."},"licensed":{"type":"boolean","description":"Indicates whether the asset was licensed at the time of the identified scans."}}}},"ipv4":{"description":"A list of ipv4 addresses for the asset.","type":"array","items":{"type":"string"}},"ipv6":{"description":"A list of ipv6 addresses for the asset.","type":"array","items":{"type":"string"}},"fqdn":{"description":"A list of fully-qualified domain names (FQDNs) for the asset.","type":"array","items":{"type":"string"}},"netbios_name":{"type":"array","description":"The NetBIOS name for the asset.","items":{"type":"string"}},"operating_system":{"type":"array","description":"The operating system installed on the asset.","items":{"type":"string"}},"agent_name":{"type":"array","description":"The names of any Nessus agents that scanned and identified the asset.","items":{"type":"string"}},"aws_ec2_name":{"type":"array","description":"The name of the virtual machine instance in AWS EC2.","items":{"type":"string"}},"mac_address":{"type":"array","description":"A list of MAC addresses for the asset.","items":{"type":"string"}},"bigfix_asset_id":{"type":"array","items":{"type":"string"},"description":"The unique identifier of the asset in IBM BigFix. For more information, see the IBM BigFix documentation."}}}},"total":{"type":"integer","description":"The total count of returned assets."}}},"examples":{"response":{"value":{"assets":[{"id":"31e37f64-cf0f-4ba0-9359-f5094a92352b","has_agent":false,"last_seen":"2018-11-28T17:28:28.000Z","last_scan_target":"172.204.81.57","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T15:00:25.000Z","last_seen":"2018-11-28T17:28:28.000Z"}],"ipv4":["172.204.81.57"],"ipv6":[],"fqdn":[],"netbios_name":["S11C"],"operating_system":["Microsoft Windows Server 2008 R2 Datacenter Service Pack 1"],"agent_name":[],"aws_ec2_name":[],"mac_address":[],"bigfix_asset_id":[]},{"id":"7e35af00-a3f0-4d43-a354-0638ba2b05ae","has_agent":false,"last_seen":"2018-11-28T17:28:28.000Z","last_scan_target":"172.204.81.58","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T15:00:25.000Z","last_seen":"2018-11-28T17:28:28.000Z"}],"acr_score":8,"acr_drivers":[{"driver_name":"device_type","driver_value":["general_purpose"]},{"driver_name":"device_capability","driver_value":["pci"]},{"driver_name":"internet_exposure","driver_value":["internal"]}],"exposure_score":753,"scan_frequency":[{"interval":90,"frequency":3,"licensed":false},{"interval":30,"frequency":1,"licensed":false},{"interval":60,"frequency":1,"licensed":false}],"ipv4":["172.204.81.58"],"ipv6":[],"fqdn":["freebsd11.dc.demo.io"],"netbios_name":[],"operating_system":["FreeBSD 11.1"],"agent_name":[],"aws_ec2_name":[],"mac_address":[],"bigfix_asset_id":[]},{"id":"466934be-abb4-4fa9-b8b8-27ace85e5523","has_agent":false,"last_seen":"2018-11-28T17:28:28.000Z","last_scan_target":"172.204.81.59","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T15:00:25.000Z","last_seen":"2018-11-28T17:28:28.000Z"}],"ipv4":["172.204.81.59"],"ipv6":[],"fqdn":["fedorawork27.dc.demo.io"],"netbios_name":[],"operating_system":["Linux Kernel 4.13.9-300.fc27.x86_64 on Fedora release 27 (Twenty Seven)"],"agent_name":[],"aws_ec2_name":[],"mac_address":[],"bigfix_asset_id":[]}],"total":3}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/workbenches/assets/vulnerabilities":{"get":{"summary":"List assets with vulnerabilities","description":"Returns a list of assets with vulnerabilities. The list is limited to 5,000. To retrieve more than 5,000 assets, use the <a href=\"#workbenches-export-request\">export-request API</a>.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-assets-vulnerabilities","tags":["Workbenches"],"parameters":[{"description":"The number of days of data prior to and including today that should be returned.","name":"date_range","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The name of the filter to apply to the exported scan report. You can find available filters by using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.filter","in":"query","schema":{"type":"string"},"example":"?filter.0.filter=plugin.name"},{"description":"The operator of the filter to apply to the exported scan report. You can find the operators for the filter using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint.For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.quality","in":"query","schema":{"type":"string"},"example":"&filter.0.quality=match"},{"description":"The value of the filter to apply to the exported scan report. You can find valid values for the filter in the 'control' attribute of the objects returned by the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.value","in":"query","schema":{"type":"string"},"example":"&filter.0.value=RHEL"},{"description":"For multiple filters, specifies whether to use the AND or the OR logical operator. The default is AND. For more information about this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.search_type","in":"query","schema":{"type":"string","enum":["","and","or"]}}],"responses":{"200":{"description":"Returned an array of assets with vulnerabilities.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the asset."},"severities":{"type":"array","description":"A count of vulnerabilities by severity.","items":{"type":"object","properties":{"count":{"type":"integer","description":"The number of vulnerabilities with the specified severity."},"level":{"type":"integer","description":"The code for the severity. Possible values include: \n - 0—The vulnerability has a CVSS score of 0, which corresponds to the \"info\" severity level.\n - 1—The vulnerability has a CVSS score between 0.1 and 3.9, which corresponds to the \"low\" severity level.\n - 2—The vulnerability has a CVSS score between 4.0 and 6.9, which corresponds to the \"medium\" severity level.\n - 3—The vulnerability has a CVSS score between 7.0 and 9.9, which corresponds to the \"high\" severity level.\n - 4—The vulnerability has a CVSS score of 10.0, which corresponds to the \"critical\" severity level."},"name":{"type":"string","description":"The severity of the vulnerability as defined using the Common Vulnerability Scoring System (CVSS) base score. Possible values include `info` (CVSS score of 0), `low` (CVSS score between 0.1 and 3.9), `medium` (CVSS score between 4.0 and 6.9), `high` (CVSS score between 7.0 and 9.9), and `critical` (CVSS score of 10.0)."}}}},"total":{"type":"integer","description":"The total number of vulnerabilities detected on the asset."},"fqdn":{"description":"A list of fully-qualified domain names (FQDNs) for the asset.","type":"array","items":{"type":"string"}},"ipv4":{"description":"A list of ipv4 addresses for the asset.","type":"array","items":{"type":"string"}},"ipv6":{"description":"A list of ipv6 addresses for the asset.","type":"array","items":{"type":"string"}},"last_seen":{"type":"string","description":"The ISO timestamp of the scan that most recently detected the asset."},"netbios_name":{"type":"array","description":"The NetBIOS name for the asset.","items":{"type":"string"}},"agent_name":{"type":"array","description":"The names of any Nessus agents that scanned and identified the asset.","items":{"type":"string"}}}}},"examples":{"response":{"value":{"assets":[{"id":"afa3a9cc-d615-4ac9-a1a4-8fd0686ffb04","severities":[{"count":0,"level":0,"name":"Info"},{"count":1,"level":1,"name":"Low"},{"count":0,"level":2,"name":"Medium"},{"count":0,"level":3,"name":"High"},{"count":0,"level":4,"name":"Critical"}],"total":1,"fqdn":[],"ipv4":["172.204.81.57"],"ipv6":[],"last_seen":"2018-11-28T17:28:28.000Z","netbios_name":[],"agent_name":[]},{"id":"bfcf0a96-cfc0-4299-8d56-bf7ea32daab1","severities":[{"count":0,"level":0,"name":"Info"},{"count":0,"level":1,"name":"Low"},{"count":1,"level":2,"name":"Medium"},{"count":0,"level":3,"name":"High"},{"count":0,"level":4,"name":"Critical"}],"total":1,"fqdn":["hpuxrisc.dc.demo.io"],"ipv4":["172.204.81.57"],"ipv6":[],"last_seen":"2018-11-28T17:28:28.000Z","netbios_name":[],"agent_name":[]},{"id":"e77201f2-d155-4bd7-b043-a60ad7561f07","severities":[{"count":0,"level":0,"name":"Info"},{"count":0,"level":1,"name":"Low"},{"count":1,"level":2,"name":"Medium"},{"count":0,"level":3,"name":"High"},{"count":0,"level":4,"name":"Critical"}],"total":1,"fqdn":["mint18.dc.demo.io"],"ipv4":["172.204.81.57"],"ipv6":[],"last_seen":"2018-11-28T17:28:28.000Z","netbios_name":[],"agent_name":[]}],"total_asset_count":3}}}}}},"403":{"description":"Returned if you do not have permission to view assets with vulnerabilities."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/workbenches/assets/{asset_id}/info":{"get":{"summary":"Get asset information","description":"Returns information about the specified asset.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-asset-info","tags":["Workbenches"],"parameters":[{"description":"The UUID of the asset. You can find the UUID by examining the output of the [GET /workbenches/assets](#workbenches-assets) endpoint.","required":true,"name":"asset_id","in":"path","schema":{"type":"string"}},{"description":"A value specifying whether you want the returned data to include all fields (`full`) or only the default fields (`default`).  The schema for this endpoint defines the `default` fields only. For a definition of the `full` fields, see [Common Asset Attributes](/docs/common-asset-attributes).","required":false,"name":"all_fields","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns asset information.","content":{"application/json":{"schema":{"type":"object","properties":{"info":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of the asset."},"uuid":{"type":"string","description":"The UUID of the asset."},"operating_system":{"type":"array","description":"The operating systems that scans have associated with the asset record.","items":{"type":"string"}},"counts":{"type":"object","description":"Counts of vulnerabilities on the asset, as well as counts of audit checks performed on the asset. For more information about this object, see [Common Asset Attributes](/docs/common-asset-attributes).","properties":{}},"has_agent":{"type":"boolean","description":"A value specifying whether a Nessus agent scan detected the asset."},"created_at":{"type":"string","description":"The time and date when Tenable.io created the asset record."},"updated_at":{"type":"string","description":"The time and date when the asset record was last updated."},"first_seen":{"type":"string","description":"The time and date when a scan first identified the asset."},"last_seen":{"type":"string","description":"The time and date of the scan that most recently identified the asset."},"last_authenticated_scan_date":{"type":"string","description":"The time and date of the last credentialed scan run on the asset."},"last_licensed_scan_date":{"type":"string","description":"The time and date of the last scan that identified the asset as licensed. Tenable.io categorizes an asset as licensed if a scan of that asset has returned results from a non-discovery plugin within the last 90 days."},"last_scan_target":{"type":"string","description":"The IPv4 address, IPv6 address, or FQDN that the scanner last used to evaluate the asset."},"sources":{"type":"array","description":"The sources of the scans that identified the asset.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity that reported the asset details. Sources can include sensors, connectors, and API imports. Source names can be customized by your organization (for example, you specify a name when you import asset records). If your organization does not customize source names, system-generated names include:\n - AWS—You obtained the asset data from an Amazon Web Services connector.\n - NESSUS_AGENT—You obtained the asset data obtained from a Nessus agent scan.\n - PVS—You obtained the asset data from a Nessus Network Monitor (NNM) scan.\n - NESSUS_SCAN—You obtained the asset data from a Nessus scan.\n - WAS—You obtained the asset data from a  Web Application Scanning scan."},"first_seen":{"type":"string","description":"The ISO timestamp when the source first reported the asset."},"last_seen":{"type":"string","description":"The ISO timestamp when the source last reported the asset."}}}},"tags":{"type":"array","description":"Category tags assigned to the asset in Tenable.io.","items":{"type":"object","properties":{"tag_uuid":{"type":"string","description":"The UUID of the tag."},"tag_key":{"type":"string","description":"The tag category (the first half of the category:value pair)."},"tag_value":{"type":"string","description":"The tag value (the second half of the category:value pair)."},"added_by":{"type":"string","description":"The UUID of the user who assigned the tag to the asset."},"added_at":{"type":"string","description":"The ISO timestamp when the tag was assigned to the asset."},"source":{"type":"string","description":"The tag type:\n - static—A user manually applied the tag to an asset. You can use the Tenable.io API to create and assign static tags to assets.\n - dynamic—Tenable.io automatically applies the tag based on asset attribute rules. For more information, see [Apply Dynamic Tags](/docs/apply-dynamic-tags)."}}}},"acr_score":{"type":"integer","description":"The Asset Criticality Rating (ACR) for the asset. Tenable assigns an ACR to each asset on your network to represent the asset's relative risk as an integer from 1 to 10. This attribute is only present in assets if Lumin is added to your Tenable.io instance. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*."},"acr_drivers":{"type":"array","description":"The key drivers that Tenable uses to calculate an asset's Tenable-provided ACR. This attribute is only present in assets if Lumin is added to your Tenable.io instance. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*.","items":{"type":"object","description":"Information about an asset characteristic that factored into the ACR score calculation.","properties":{"driver_name":{"type":"string","description":"The type of characteristic."},"driver_value":{"type":"array","description":"The characteristic value.","items":{"type":"string"}}}}},"exposure_score":{"type":"integer","description":"The Asset Exposure Score (AES) for the asset. This attribute is only present in assets if Lumin is added to your Tenable.io instance. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*."},"scan_frequency":{"type":"array","description":"Information about how often scans ran against the asset during specified intervals. This attribute is only present in assets if Lumin is added to your Tenable.io instance. For more information, see [Lumin Metrics](https://docs.tenble.com/Content/Analysis/LuminMetrics.htm) in the *Tenable.io Vulnerability Management User Guide*.","items":{"type":"object","description":"Information about how often scans ran against asset during a specified interval.","properties":{"interval":{"type":"integer","description":"The number of days over which Tenable searches for scans involving the asset."},"frequency":{"type":"integer","description":"The number of times that a scan ran against the asset during the specified interval."},"licensed":{"type":"boolean","description":"Indicates whether the asset was licensed at the time of the identified scans."}}}},"ipv4":{"type":"array","description":"The IPv4 addresses that scans have associated with the asset record.","items":{"type":"string"}},"ipv6":{"type":"array","description":"The IPv6 addresses that scans have associated with the asset record.","items":{"type":"string"}},"fqdn":{"type":"array","description":"The fully-qualified domain names that scans have associated with the asset record.","items":{"type":"string"}},"mac_address":{"type":"array","description":"The MAC addresses that scans have associated with the asset record.","items":{"type":"string"}},"netbios_name":{"type":"array","description":"The NetBIOS names that scans have associated with the asset record.","items":{"type":"string"}},"system_type":{"type":"array","description":"The system types as reported by Plugin ID 54615. Possible values include `router`, `general-purpose`, `scan-host`, and `embedded`.","items":{"type":"string"}},"hostname":{"type":"array","description":"The hostnames that scans have associated with the asset record.","items":{"type":"string"}},"agent_name":{"type":"array","description":"The names of any Nessus agents that scanned and identified the asset.","items":{"type":"string"}},"bios_uuid":{"type":"array","description":"The BIOS UUID that scans have associated with the asset.","items":{"type":"string"}},"aws_ec2_instance_id":{"type":"array","description":"The unique identifier of the Linux instance in Amazon EC2. For more information, see the Amazon Elastic Compute Cloud Documentation.","items":{"type":"string"}},"aws_ec2_instance_ami_id":{"type":"array","description":"The unique identifier of the Linux AMI image in Amazon Elastic Compute Cloud (Amazon EC2). For more information, see the Amazon Elastic Compute Cloud Documentation.","items":{"type":"string"}},"aws_owner_id":{"type":"array","description":"The canonical user identifier for the AWS account associated with the virtual machine instance. For example, `79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be`. For more information, see AWS Account Identifiers in the AWS documentation.","items":{"type":"string"}},"aws_availability_zone":{"type":"array","description":"The availability zone where Amazon Web Services hosts the virtual machine instance, for example, `us-east-1a`. Availability zones are subdivisions of AWS regions. For more information, see Regions and Availability Zones in the AWS documentation.","items":{"type":"string"}},"aws_region":{"type":"array","description":"The region where AWS hosts the virtual machine instance, for example, `us-east-1`. For more information, see Regions and Availability Zones in the AWS documentation.","items":{"type":"string"}},"aws_vpc_id":{"type":"array","description":"The unique identifier for the public cloud that hosts the AWS virtual machine instance. For more information, see the Amazon Virtual Private Cloud User Guide.","items":{"type":"string"}},"aws_ec2_instance_group_name":{"type":"array","description":"The virtual machine instance's group in AWS.","items":{"type":"string"}},"aws_ec2_instance_state_name":{"type":"array","description":"The state of the virtual machine instance in AWS at the time of the scan.","items":{"type":"string"}},"aws_ec2_instance_type":{"type":"array","description":"The type of instance in AWS EC2.","items":{"type":"string"}},"aws_subnet_id":{"type":"array","description":"The unique identifier of the AWS subnet where the virtual machine instance was running at the time of the scan.","items":{"type":"string"}},"aws_ec2_product_code":{"type":"array","description":"The product code associated with the AMI used to launch the virtual machine instance in AWS EC2.","items":{"type":"string"}},"aws_ec2_name":{"type":"array","description":"The name of the virtual machine instance in AWS EC2.","items":{"type":"string"}},"azure_vm_id":{"type":"array","description":"The unique identifier of the Microsoft Azure virtual machine instance. For more information, see \"Accessing and Using Azure VM Unique ID\" in the Microsoft Azure documentation.","items":{"type":"string"}},"azure_resource_id":{"type":"array","description":"The unique identifier of the resource in the Azure Resource Manager. For more information, see the Azure Resource Manager Documentation.","items":{"type":"string"}},"gcp_project_id":{"type":"array","description":"The customized name of the project to which the virtual machine instance belongs in Google Cloud Platform (GCP). For more information, see \"Creating and Managing Projects\" in the GCP documentation.","items":{"type":"string"}},"gcp_zone":{"type":"array","description":"The zone where the virtual machine instance runs in GCP. For more information, see \"Regions and Zones\" in the GCP documentation.","items":{"type":"string"}},"gcp_instance_id":{"type":"array","description":"The unique identifier of the virtual machine instance in GCP.","items":{"type":"string"}},"ssh_fingerprint":{"type":"array","description":"The SSH key fingerprints that scans have associated with the asset record.","items":{"type":"string"}},"mcafee_epo_guid":{"type":"array","description":"The unique identifier of the asset in McAfee ePolicy Orchestrator (ePO). For more information, see the McAfee documentation.","items":{"type":"string"}},"mcafee_epo_agent_guid":{"type":"array","description":"The unique identifier of the McAfee ePO agent that identified the asset. For more information, see the McAfee documentation.","items":{"type":"string"}},"qualys_asset_id":{"type":"array","description":"The Asset ID of the asset in Qualys. For more information, see the Qualys documentation.","items":{"type":"string"}},"qualys_host_id":{"type":"array","description":"The Host ID of the asset in Qualys. For more information, see the Qualys documentation.","items":{"type":"string"}},"servicenow_sysid":{"type":"array","description":"The unique record identifier of the asset in ServiceNow. For more information, see the ServiceNow documentation.","items":{"type":"string"}},"installed_software":{"type":"array","description":"A list of Common Platform Enumeration (CPE) values that represent software applications a scan identified as present on an asset. This attribute supports the CPE 2.2 format. For more information, see the \"Component Syntax\" section of the [CPE Specification, Version 2.2](https://cpe.mitre.org/files/cpe-specification_2.2.pdf). For assets identified in Tenable scans, this attribute contains data only if a scan using [Nessus Plugin ID 45590](https://www.tenable.com/plugins/nessus/45590) has evaluated the asset.\n\n**Note:** If no scan detects an application within 30 days of the scan that originally detected the application, Tenable.io considers the detection of that application expired. As a result, the next time a scan evaluates the asset, Tenable.io removes the expired application from the installed_software attribute. This activity is logged as a `remove` type of `attribute_change` update in the asset activity log.","items":{"type":"string"}}}}}},"examples":{"response":{"value":{"info":{"time_end":"2018-11-28T15:00:25Z","time_start":"2018-11-28T15:00:25Z","id":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","uuid":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","operating_system":["Microsoft Windows Server 2008 R2 Standard Service Pack 1"],"fqdn":["vcenter.dc.demo.io"],"mac_address":["00:50:56:bd:4b:d8"],"counts":{"vulnerabilities":{"total":573,"severities":[{"count":392,"level":0,"name":"Info"},{"count":11,"level":1,"name":"Low"},{"count":122,"level":2,"name":"Medium"},{"count":316,"level":3,"name":"High"},{"count":27,"level":4,"name":"Critical"}]},"audits":{"total":0,"statuses":[{"count":0,"level":1,"name":"Passed"},{"count":0,"level":2,"name":"Warning"},{"count":0,"level":3,"name":"Failed"}]}},"has_agent":false,"created_at":"2018-11-28T15:00:45.684Z","updated_at":"2018-11-28T17:28:46.941Z","first_seen":"2018-11-28T15:00:25.000Z","last_seen":"2018-11-28T17:28:28.000Z","last_authenticated_scan_date":"2018-11-28T17:28:28.000Z","last_licensed_scan_date":"2018-11-28T17:28:28.000Z","last_scan_target":"172.204.81.57","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T15:00:25.000Z","last_seen":"2018-11-28T17:28:28.000Z"}],"acr_score":8,"acr_drivers":[{"driver_name":"device_type","driver_value":["general_purpose"]},{"driver_name":"device_capability","driver_value":["pci"]},{"driver_name":"internet_exposure","driver_value":["internal"]}],"exposure_score":753,"scan_frequency":[{"interval":90,"frequency":3,"licensed":false},{"interval":30,"frequency":1,"licensed":false},{"interval":60,"frequency":1,"licensed":false}],"tags":[],"ipv4":["172.204.81.57"],"ipv6":[],"netbios_name":["VCENTER"],"system_type":["general-purpose"],"tenable_uuid":["02dfb8d5a8744a4d925dc8aec4c5dffb"],"hostname":["vcenter"],"agent_name":[],"bios_uuid":["32d83d42-beb4-69ee-131a-54ca30e6cc21"],"aws_ec2_instance_id":[],"aws_ec2_instance_ami_id":[],"aws_owner_id":[],"aws_availability_zone":[],"aws_region":[],"aws_vpc_id":[],"aws_ec2_instance_group_name":[],"aws_ec2_instance_state_name":[],"aws_ec2_instance_type":[],"aws_subnet_id":[],"aws_ec2_product_code":[],"aws_ec2_name":[],"azure_vm_id":[],"azure_resource_id":[],"gcp_project_id":[],"gcp_zone":[],"gcp_instance_id":[],"ssh_fingerprint":[],"mcafee_epo_guid":[],"mcafee_epo_agent_guid":[],"qualys_asset_id":[],"qualys_host_id":[],"servicenow_sysid":[],"installed_software":["cpe:/a:apple:itunes:12.8","cpe:/a:apple:quicktime:7.7.3","cpe:/a:openbsd:openssh:6.9","cpe:/a:google:chrome"],"bigfix_asset_id":[]}}}}}}},"403":{"description":"Returned if you do not have permission to view information for the specified asset."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/workbenches/assets/{asset_uuid}/activity":{"get":{"summary":"Get asset activity log","description":"<ul>Returns the activity log for the specified asset. Event types include:<li>discovered—Asset created (for example, by a network scan or import).</li><li>seen—Asset observed by a network scan without any changes to its attributes.</li><li>tagging—Tag added to or removed from asset.</li><li>attribute_change—A scan identified new or changed attributes for the asset (for example, new software applications installed on the asset).</li><li>updated—Asset updated either manually by a user or automatically by a new scan.</li></ul><br><p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p><p></p>","operationId":"workbenches-assets-activity","tags":["Workbenches"],"parameters":[{"description":"The UUID of the asset. You can find the UUID by examining the output of the [GET /workbenches/assets](#workbenches-assets) endpoint.","required":true,"name":"asset_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns activity for an asset.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Event type:\n - discovered—Asset created (for example, by a network scan or import).\n - seen—Asset observed by a network scan without any changes to its attributes.\n - tagging—Tag added to or removed from asset.\n - attribute_change—A scan identified new or changed attributes for the asset (for example, new software applications installed on the asset).\n - updated—Asset updated either manually by a user or automatically by a new scan."},"timestamp":{"type":"integer","description":"The timestamp of the event. The timestamp is reported in ISO 8601 format in UTC time."},"scan_id":{"type":"string","description":"The UUID of the scan that logged the event."},"schedule_id":{"type":"string","description":"The ID of the scheduled scan associated with the event."},"source":{"type":"string","description":"The entity that logged the event, for example, NESSUS_AGENT, NESSUS_AGENT, PVS, or WAS."},"details":{"type":"object","properties":{"assetId":{"type":"string","description":"The UUID of the asset."},"containerId":{"type":"string","description":"The UUID of your Tenable.io instance."},"createdAt":{"type":"integer","description":"The timestamp of the asset creation. The timestamp is reported in ISO 8601 format in UTC time."},"updatedAt":{"type":"integer","description":"The timestamp of the asset update time. The timestamp is reported in ISO 8601 format in UTC time."},"hasAgent":{"type":"boolean","description":"Specifies whether the asset has an agent installed."},"hasPluginResults":{"type":"boolean","description":"Specifies whether or not any plugin results match this asset."},"firstScanTime":{"type":"integer","description":"The timestamp of the completion of the scan that discovered or observed the asset for the first time. The timestamp is reported in ISO 8601 format in UTC time."},"lastScanTime":{"type":"integer","description":"The timestamp of the completion of the last asset scan. The timestamp is reported in ISO 8601 format in UTC time."},"lastAuthenticatedScanTime":{"type":"integer","description":"The timestamp of the completion of the last authenticated scan of the asset. The timestamp is reported in ISO 8601 format in UTC time."},"lastLicensedScanTime":{"type":"integer","description":"The timestamp of the scan completion time when asset was last scanned and matched license v1 requirements. The timestamp is reported in ISO 8601 format in UTC time."},"lastLicensedScanTimeV2":{"type":"integer","description":"The timestamp of the scan completion time when asset was last scanned and matched license v2 requirements. The timestamp is reported in ISO 8601 format in UTC time."},"sources":{"description":"An array of source objects representing the entity that logged the event.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity that reported the asset details. Sources can include sensors, connectors, and API imports. Source names can be customized by your organization (for example, you specify a name when you import asset records). If your organization does not customize source names, system-generated names include:\n - AWS—You obtained the asset data from an Amazon Web Services connector.\n - NESSUS_AGENT—You obtained the asset data obtained from a Nessus agent scan.\n - PVS—You obtained the asset data from a Nessus Network Monitor (NNM) scan.\n - NESSUS_SCAN—You obtained the asset data from a Nessus scan.\n - WAS—You obtained the asset data from a  Web Application Scanning scan."},"firstSeen":{"type":"string","description":"The ISO timestamp when the source first reported the asset."},"lastSeen":{"type":"string","description":"The ISO timestamp when the source last reported the asset."}}}},"terminatedAt":{"type":"integer","description":"If terminated, the timestamp of asset termination. The timestamp is reported in ISO 8601 format in UTC time."},"terminatedBy":{"type":"string","description":"The UUID of the user that terminated the asset."},"deletedAt":{"type":"integer","description":"If deleted, the timestamp of asset deletion. The timestamp is reported in ISO 8601 format in UTC time."},"deletedBy":{"type":"string","description":"The UUID of the user that deleted the asset."},"properties":{"type":"object","description":"Additional asset attributes. For attribute definitions, see [Common Asset Attributes](/docs/common-asset-attributes).","properties":{}}}},"updates":{"type":"array","description":"(attribute_change entries only) A list of updates to the asset's attributes.","items":{"type":"object","properties":{"method":{"type":"string","description":"The update method. Possible values include: \n - add—A scan identified a new software application installed on the asset.\n - remove—Tenable.io identified the specified application as expired and removed it from the installed_software attribute of the asset. Tenable.io considers an application detection expired if no scan detects the application within 30 days of the scan that originally detected the application."},"property":{"type":"string","description":"The name of the updated attribute."},"value":{"type":"string","description":"The updated value of the attribute."}}}}}}},"examples":{"response":{"value":{"activity":[{"type":"seen","timestamp":"2018-05-16T12:51:47.164Z","scan_id":"71243329-49b8-406c-87f9-64cf33ed4228","schedule_id":"template-027d96a5-d0ae-108b-de32-01ecf7f23d07423f49ea57344aef","source":"NESSUS_SCAN"},{"type":"seen","timestamp":"2018-05-09T11:43:55.975Z","scan_id":"bc9ea943-8273-431c-9113-f6827d1b4a06","schedule_id":"template-027d96a5-d0ae-108b-de32-01ecf7f23d07423f49ea57344aef","source":"NESSUS_SCAN"},{"type":"discovered","timestamp":"2018-05-04T16:50:55.418Z","scan_id":"63eca894-6da9-4eb7-9be6-b8a0510d29d4","schedule_id":"template-027d96a5-d0ae-108b-de32-01ecf7f23d07423f49ea57344aef","source":"NESSUS_SCAN","details":{"lastScanTime":"2018-05-04T16:50:55.418Z","createdAt":"2018-05-04T16:50:58.420Z","hasAgent":false,"sources":[{"name":"NESSUS_SCAN","firstSeen":"2018-05-04T16:50:55.418Z","lastSeen":"2018-05-04T16:50:55.418Z"}],"lastLicensedScanTime":"2018-05-04T16:50:55.418Z","firstScanTime":"2018-05-04T16:50:55.418Z","assetId":"39d6e01e-eaac-4951-a521-fe903f2c61bb","lastLicensedScanTimeV2":"2018-05-04T16:50:55.418Z","hasPluginResults":true,"containerId":"5043dfa2-7864-4785-aff7-80026f36efcb","properties":{"ipv4":{"lastObserved":"2018-05-04T16:50:55.418Z","values":["172.204.81.57"]}},"updatedAt":"2018-05-04T16:50:58.420Z"}},{"type":"attribute_change","timestamp":"2019-05-24T13:24:47.498Z","updates":[{"method":"add","property":"installed_software","value":"cpe:/a:apple:quicktime:7.7.1"},{"method":"add","property":"installed_software","value":"cpe:/a:apple:safari:12.0.2"},{"method":"add","property":"installed_software","value":"cpe:/a:apple:itunes:7.5"},{"method":"add","property":"installed_software","value":"cpe:/a:mariadb:mariadb:1.5"},{"method":"add","property":"installed_software","value":"cpe:/a:skype:skype:8.4"},{"method":"add","property":"installed_software","value":"cpe:/a:wireshark:wireshark:2.4.1"}]}]}}}}}},"401":{"description":"Returned if you do not have permission to view activity for an asset."},"404":{"description":"Returned if Tenable.io cannot find the specified asset."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to return activity for an asset.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/workbenches/assets/{asset_id}/vulnerabilities":{"get":{"summary":"List asset vulnerabilities","description":"Retrieves a list of the vulnerabilities recorded for a specified asset. By default, this list is sorted by vulnerability count in descending order. The list returned is limited to 5,000. To retrieve more than 5,000 vulnerabilities, use the <a href=\"#workbenches-export-request\">export-request API</a>.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-asset-vulnerabilities","tags":["Workbenches"],"parameters":[{"description":"The UUID of the asset. You can find the UUID by examining the output of the [GET /workbenches/assets](#workbenches-assets) endpoint.","required":true,"name":"asset_id","in":"path","schema":{"type":"string"}},{"description":"The number of days of data prior to and including today that should be returned.","name":"date_range","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The name of the filter to apply to the exported scan report. You can find available filters by using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.filter","in":"query","schema":{"type":"string"},"example":"?filter.0.filter=plugin.name"},{"description":"The operator of the filter to apply to the exported scan report. You can find the operators for the filter using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.quality","in":"query","schema":{"type":"string"},"example":"&filter.0.quality=match"},{"description":"The value of the filter to apply to the exported scan report. You can find valid values for the filter in the 'control' attribute of the objects returned by the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.value","in":"query","schema":{"type":"string"},"example":"&filter.0.value=RHEL"},{"description":"For multiple filters, specifies whether to use the AND or the OR logical operator. The default is AND. For more information about this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.search_type","in":"query","schema":{"type":"string","enum":["","and","or"]}}],"responses":{"200":{"description":"Returns a list of vulnerabilities for the specified asset.","content":{"application/json":{"schema":{"type":"object","description":"A list of vulnerabilities.","properties":{"vulnerabilities":{"type":"array","description":"A list of discovered vulnerabilities.","items":{"type":"object","properties":{"count":{"type":"integer","description":"The number of times that a scan detected the vulnerability on an asset."},"plugin_family":{"type":"string","description":"The plugin's family."},"plugin_id":{"type":"integer","description":"The unique plugin ID."},"plugin_name":{"type":"string","description":"The name of the plugin that detected the vulnerability."},"vulnerability_state":{"type":"string","description":"The current state of the reported plugin. Possible states include:\n - Active—The vulnerability is currently present on an asset.\n - New—The vulnerability is active on an asset, and was first detected within the last 14 days.\n - Fixed—A subsequent scan detected that the formerly-active vulnerability is no longer present on an asset.\n - Resurfaced—The vulnerability was previously marked as fixed on an asset, but a subsequent scan detected the vulnerability on the asset again."},"vpr_score":{"type":"integer","description":"The Vulnerability Priority Rating (VPR) for the vulnerability. If a plugin is designed to detect multiple vulnerabilities, the VPR represents the highest value calculated for a vulnerability associated with the plugin. For more information, see <a href=\"https://docs.tenable.com/cloud/Content/Analysis/RiskMetrics.htm\" target=\"_blank\">Severity vs. VPR</a> in the <i>Tenable.io Vulnerability Management User Guide</i>.","format":"int32"},"accepted_count":{"type":"integer","description":"The number of times that a user in the user interface created an accept rule for this vulnerability. For more information, see <a href=\"https://docs.tenable.com/cloud/Content/Settings/AboutRecastRules.htm\" target=\"_blank\">Recast Rules</a> in the <i>Tenable.io Vulnerability Management User Guide</i>.","format":"int32"},"recasted_count":{"type":"integer","description":"The number of times that a user in the user interface created a recast rule for this vulnerability. For more information, see <a href=\"https://docs.tenable.com/cloud/Content/Settings/AboutRecastRules.htm\" target=\"_blank\">Recast Rules</a> in the <i>Tenable.io Vulnerability Management User Guide</i>.","format":"int32"},"counts by severity":{"type":"array","description":"The number of times that a scan detected the vulnerability on an asset, grouped by severity level.","items":{"type":"object","properties":{"count":{"type":"integer","description":"The number of times that a scan detected the vulnerability on an asset while the vulnerability was assigned the specified severity level.","format":"int32"},"value":{"type":"integer","description":"The severity level of the vulnerabilities in the group."}}}},"severity":{"type":"integer","description":"The severity level of the vulnerability, as defined using the Common Vulnerability Scoring System (CVSS) base score. Possible values include: \n - 0—The vulnerability has a CVSS score of 0, which corresponds to the \"info\" severity level.\n - 1—The vulnerability has a CVSS score between 0.1 and 3.9, which corresponds to the \"low\" severity level.\n - 2—The vulnerability has a CVSS score between 4.0 and 6.9, which corresponds to the \"medium\" severity level.\n - 3—The vulnerability has a CVSS score between 7.0 and 9.9, which corresponds to the \"high\" severity level.\n - 4—The vulnerability has a CVSS score of 10.0, which corresponds to the \"critical\" severity level.","format":"int32"}}}},"total_vulnerability_count":{"type":"integer","description":"The total number of discovered vulnerabilities."},"total_asset_count":{"type":"integer","description":"The total number of assets."}}},"examples":{"response":{"value":{"vulnerabilities":[{"count":55,"plugin_family":"Port scanners","plugin_id":34220,"plugin_name":"Netstat Portscanner (WMI)","vulnerability_state":"Active","vpr_score":2.4,"accepted_count":0,"recasted_count":0,"counts_by_severity":[{"count":55,"value":0}],"severity":0},{"count":54,"plugin_family":"Windows","plugin_id":34252,"plugin_name":"Microsoft Windows Remote Listeners Enumeration (WMI)","vulnerability_state":"Active","vpr_score":6.3,"accepted_count":0,"recasted_count":0,"counts_by_severity":[{"count":54,"value":0}],"severity":0},{"count":21,"plugin_family":"Service detection","plugin_id":22964,"plugin_name":"Service Detection","vulnerability_state":"Active","vpr_score":4.5,"accepted_count":0,"recasted_count":0,"counts_by_severity":[{"count":21,"value":0}],"severity":0},{"count":18,"plugin_family":"Web Servers","plugin_id":24260,"plugin_name":"HyperText Transfer Protocol (HTTP) Information","vulnerability_state":"Active","vpr_score":5.5,"accepted_count":0,"recasted_count":0,"counts_by_severity":[{"count":18,"value":0}],"severity":0}],"total_vulnerability_count":3,"total_asset_count":0}}}}}},"403":{"description":"Returned if you do not have permission to list vulnerabilities for the specified asset."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/workbenches/assets/{asset_id}/vulnerabilities/{plugin_id}/info":{"get":{"summary":"Get asset vulnerability details","description":"Retrieves the details for a vulnerability recorded on a specified asset.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-asset-vulnerability-info","tags":["Workbenches"],"parameters":[{"description":"The UUID of the asset.","required":true,"name":"asset_id","in":"path","schema":{"type":"string"}},{"description":"The ID of the plugin.","required":true,"name":"plugin_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The number of days of data prior to and including today that should be returned.","name":"date_range","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The name of the filter to apply to the exported scan report. You can find available filters by using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.filter","in":"query","schema":{"type":"string"},"example":"?filter.0.filter=plugin.name"},{"description":"The operator of the filter to apply to the exported scan report. You can find the operators for the filter using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.quality","in":"query","schema":{"type":"string"},"example":"&filter.0.quality=match"},{"description":"The value of the filter to apply to the exported scan report. You can find valid values for the filter in the 'control' attribute of the objects returned by the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.value","in":"query","schema":{"type":"string"},"example":"&filter.0.value=RHEL"},{"description":"For multiple filters, specifies whether to use the AND or the OR logical operator. The default is AND. For more information about this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.search_type","in":"query","schema":{"type":"string","enum":["","and","or"]}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"info":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"A count of the vulnerability occurrences."},"vuln_count":{"type":"integer","format":"int32","description":""},"description":{"type":"string","description":"The description of the vulnerability."},"synopsis":{"type":"string","description":"A brief summary of the vulnerability."},"solution":{"type":"string","description":"Information on how to fix the vulnerability."},"discovery":{"type":"object","properties":{"seen_first":{"type":"string","description":"The Unix timestamp of the scan that first detected the vulnerability on an asset."},"seen_last":{"type":"string","description":"The Unix timestamp of the scan that most recently detected the vulnerability on an asset."}}},"severity":{"type":"integer","description":"The severity level of the vulnerability."},"plugin_details":{"type":"object","properties":{"family":{"type":"string","description":"The plugin family."},"modification_date":{"type":"string","description":"The ISO timestamp when Tenable last updated the plugin definition."},"name":{"type":"string","description":"The name of the plugin."},"publication_date":{"type":"string","description":"The ISO timestamp when Tenable first published the plugin definition."},"type":{"type":"string","description":"The type of scan that uses the plugin, either a network scan (`remote`) or a credentialed scan (`local`)."},"version":{"type":"string","description":"The plugin version."},"severity":{"type":"integer","format":"int32","description":"The severity level of the plugin."}}},"reference_information":{"type":"array","description":"","items":{"type":"object","properties":{"name":{"type":"string","description":"The source of the reference information about the vulnerability. Possible values include:\n - bid—Bugtraq (Symantec Connect)\n - cert—CERT/CC Vulnerability Notes Database\n - cve—NIST National Vulnerability Database (NVD)\n - edb-id—The Exploit Database\n - iava—information assurance vulnerability alert\n - osvdb—Open Sourced Vulnerability Database"},"url":{"type":"string","description":"The URL of the source site, if available."},"values":{"type":"array","description":"The unique identifier(s) for the vulnerability at the source.","items":{"type":"string"}}}}},"risk_information":{"type":"object","properties":{"risk_factor":{"type":"string","description":"The risk factor associated with the plugin. Possible values are: `Low`, `Medium`, `High`, or `Critical`."},"cvss_vector":{"type":"string","description":"The raw CVSSv2 metrics for the vulnerability. For more information, see CVSSv2 documentation."},"cvss_base_score":{"type":"string","description":"The CVSSv2 base score (intrinsic and fundamental characteristics of a vulnerability that are constant over time and user environments)."},"cvss_temporal_vector":{"type":"string","description":"The raw CVSSv2 temporal metrics for the vulnerability."},"cvss_temporal_score":{"type":"string","description":"The CVSSv2 temporal score (characteristics of a vulnerability that change over time but not among user environments)."},"cvss3_vector":{"type":"string","description":"The raw CVSSv3 metrics for the vulnerability. For more information, see CVSSv3 documentation."},"cvss3_base_score":{"type":"string","description":"The CVSSv3 base score (intrinsic and fundamental characteristics of a vulnerability that are constant over time and user environments)."},"cvss3_temporal_vector":{"type":"string","description":"CVSSv3 temporal metrics for the vulnerability."},"cvss3_temporal_score":{"type":"string","description":"The CVSSv3 temporal score (characteristics of a vulnerability that change over time but not among user environments)."},"stig_severity":{"type":"string","description":"Security Technical Implementation Guide (STIG) severity code for the vulnerability."}}},"see_also":{"type":"array","description":"Links to external websites that contain helpful information about the vulnerability.","items":{"type":"string"}},"vulnerability_information":{"type":"object","properties":{"vulnerability_publication_date":{"type":"string","description":"The ISO timestamp for the first publication date of the plugin."},"exploited_by_malware":{"type":"boolean","description":"The vulnerability discovered by this plugin is known to be exploited by malware."},"patch_publication_date":{"type":"string","description":"The ISO timestamp for date on which the vendor published a patch for the vulnerability."},"exploit_available":{"type":"boolean","description":"A value specifying whether a public exploit exists for the vulnerability."},"exploitability_ease":{"type":"string","description":"Description of how easy it is to exploit the issue."},"asset_inventory":{"type":"string","description":""},"default_account":{"type":"string","description":""},"exploited_by_nessus":{"type":"boolean","description":"A value specifying whether Nessus exploited the vulnerability during the process of identification."},"in_the_news":{"type":"boolean","description":"A value specifying whether this plugin has received media attention (for example, ShellShock, Meltdown)."},"malware":{"type":"string","description":""},"unsupported_by_vendor":{"type":"boolean","description":"Software found by this plugin is unsupported by the software's vendor (for example, Windows 95 or Firefox 3)."},"cpe":{"type":"string","description":"The Common Platform Enumeration (CPE) number for the plugin."},"exploit_frameworks":{"type":"array","description":"A list of exploit frameworks that have identified the vulnerability.","items":{"type":"object","description":"Information about the vulnerability in a specific exploit framework.","properties":{"name":{"type":"string","description":"The name of the exploit framework."},"exploits":{"type":"array","description":"A list of exploits associated with the vulnerability in the specified exploit framework.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the identified exploit."},"url":{"type":"string","description":"The URL for the exploit in the framework."}}}}}}}}},"vpr":{"type":"object","description":"Information about the Vulnerability Priority Rating (VPR) for the vulnerability.","properties":{"score":{"type":"integer","description":"The Vulnerability Priority Rating (VPR) for the vulnerability. If a plugin is designed to detect multiple vulnerabilities, the VPR represents the highest value calculated for a vulnerability associated with the plugin. For more information, see <a href=\"https://docs.tenable.com/cloud/Content/Analysis/RiskMetrics.htm\" target=\"_blank\">Severity vs. VPR</a> in the <i>Tenable.io Vulnerability Management User Guide</i>.","format":"int32"},"drivers":{"type":"object","description":"The key drivers Tenable uses to calculate a vulnerability's VPR. For more information, see <a href=\"/docs/vpr-drivers-tio\">Vulnerability Priority Rating Drivers</a>.","properties":{}},"updated":{"type":"string","description":"The ISO timestamp when Tenable.io last imported the VPR for this vulnerability. Tenable.io imports a VPR value the first time you scan a vulnerability on your network. Then, Tenable.io automatically re-imports new and updated VPR values daily."}}}}}}},"examples":{"response":{"value":{"info":{"count":1,"vuln_count":1,"description":"The remote Windows host contains a version of the Microsoft Foundation Class (MFC) library affected by an insecure library loading vulnerability. The path used for loading external libraries is not securely restricted.\n\nAn attacker can exploit this by tricking a user into opening an MFC application in a directory that contains a malicious DLL, resulting in arbitrary code execution.","synopsis":"Arbitrary code can be executed on the remote host through the Microsoft Foundation Class library.","solution":"Microsoft has released a set of patches for Visual Studio .NET 2003, 2005, and 2008, as well as Visual C++ 2005, 2008, and 2010.","discovery":{"seen_first":"2019-03-08T17:15:52.000Z","seen_last":"2019-03-08T17:15:52.000Z"},"severity":3,"plugin_details":{"family":"Windows : Microsoft Bulletins","modification_date":"2016-05-06T00:00:00Z","name":"MS11-025: Vulnerability in Microsoft Foundation Class (MFC) Library Could Allow Remote Code Execution (2500212)","publication_date":"2011-04-13T00:00:00Z","type":"local","version":null,"severity":3},"reference_information":[{"name":"bid","url":"http://www.securityfocus.com/bid/","values":[42811]},{"name":"cve","url":"http://web.nvd.nist.gov/view/vuln/detail?vulnId=","values":["CVE-2010-3190"]},{"name":"iavb","values":["2011-B-0046"]},{"name":"msft","url":"http://technet.microsoft.com/en-us/security/bulletin/","values":["MS11-025"]},{"name":"osvdb","values":["67674"]},{"name":"secunia","url":"http://secunia.com/advisories/","values":["41212"]}],"risk_information":{"risk_factor":"High","cvss_vector":"AV:N/AC:M/Au:N/C:C/I:C/A:C","cvss_base_score":"9.3","cvss_temporal_vector":"E:F/RL:OF/RC:ND","cvss_temporal_score":"7.7","cvss3_vector":null,"cvss3_base_score":null,"cvss3_temporal_vector":null,"cvss3_temporal_score":null,"stig_severity":null},"see_also":["[\"https://technet.microsoft.com/library/security/ms11-025\"]"],"vulnerability_information":{"vulnerability_publication_date":"2010-08-27T00:00:00Z","exploited_by_malware":null,"patch_publication_date":"2011-04-12T00:00:00Z","exploit_available":true,"exploitability_ease":null,"asset_inventory":null,"default_account":null,"exploited_by_nessus":null,"in_the_news":null,"malware":null,"unsupported_by_vendor":null,"cpe":null,"exploit_frameworks":[]},"vpr":{"score":5.9,"drivers":{"age_of_vuln":{"lower_bound":731,"upper_bound":0},"exploit_code_maturity":"UNPROVEN","cvss_impact_score_predicted":true,"threat_intensity_last28":"VERY_LOW","threat_sources_last28":["No recorded events"],"product_coverage":"MEDIUM"},"updated":"2019-02-07T10:08:58Z"}}}}}}},"description":"Returns details for the specified vulnerability recorded on the specified asset."},"403":{"description":"Returned if you do not have permission to view vulnerability details for the specified asset."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/workbenches/assets/{asset_id}/vulnerabilities/{plugin_id}/outputs":{"get":{"summary":"List asset vulnerabilties for plugin","description":"Retrieves the vulnerability outputs for a plugin recorded on a specified asset.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-asset-vulnerability-output","tags":["Workbenches"],"parameters":[{"description":"The UUID of the asset.","required":true,"name":"asset_id","in":"path","schema":{"type":"string"}},{"description":"The ID of the plugin.","required":true,"name":"plugin_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The number of days of data prior to and including today that should be returned.","name":"date_range","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The name of the filter to apply to the exported scan report. You can find available filters by using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.filter","in":"query","schema":{"type":"string"},"example":"?filter.0.filter=plugin.name"},{"description":"The operator of the filter to apply to the exported scan report. You can find the operators for the filter using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.quality","in":"query","schema":{"type":"string"},"example":"&filter.0.quality=match"},{"description":"The value of the filter to apply to the exported scan report. You can find valid values for the filter in the 'control' attribute of the objects returned by the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.value","in":"query","schema":{"type":"string"},"example":"&filter.0.value=RHEL"},{"description":"For multiple filters, specifies whether to use the AND or the OR logical operator. The default is AND. For more information about this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.search_type","in":"query","schema":{"type":"string","enum":["","and","or"]}}],"responses":{"200":{"description":"Returns a list of asset vulnerabilties for the specified plugin.","content":{"application/json":{"schema":{"type":"object","properties":{"outputs":{"type":"array","description":"A list of vulnerabilities discovered by the plugin.","items":{"type":"object","properties":{"plugin_output":{"type":"string","description":"The plugin's output about the vulnerability. May be an empty string."},"states":{"type":"array","description":"Vulnerability state items.","items":{"type":"object","properties":{"name":{"type":"string","description":"The current state of the reported plugin (Active, Fixed, New, etc.)"},"results":{"type":"array","items":{"type":"object","properties":{"application_protocol":{"type":"string","description":"The application protocol where this vulnerability was found."},"port":{"type":"integer","description":"The port number where this vulnerability was found."},"transport_protocol":{"type":"string","description":"The transportation protocol (TCP or UDP) where this vulnerability was found."},"assets":{"type":"array","description":"A list of assets where this output was found.","items":{"type":"object","properties":{"hostname":{"type":"string","description":"The host name of the asset."},"id":{"type":"string","description":"The ID of the asset."},"uuid":{"type":"string","description":"The UUID of the asset."},"netbios_name":{"type":"string","description":"The NetBios name of the asset."},"fqdn":{"type":"string","description":"The FQDN of the asset."},"ipv4":{"type":"string","description":"The IPV4 of the asset."},"first_seen":{"type":"string","format":"date-time","description":"Indicates when the asset was discovered by a scan."},"last_seen":{"type":"string","format":"date-time","description":"Indicates when the asset was last observed by a scan."}}}},"severity":{"type":"integer","description":"Integer [0-4] indicating how severe the vulnerability is, where 0 is info only."}}}}}}}}}}}},"examples":{"response":{"value":{"outputs":[{"plugin_output":"Port 80/tcp was found to be open","states":[{"name":"Active","results":[{"application_protocol":"unknown","port":80,"transport_protocol":"tcp","assets":[{"hostname":"172.204.81.57","id":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","uuid":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","netbios_name":"VCENTER","fqdn":"vcenter.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"}],"severity":0}]}]},{"plugin_output":"Port 49153/tcp was found to be open","states":[{"name":"Active","results":[{"application_protocol":"unknown","port":49153,"transport_protocol":"tcp","assets":[{"hostname":"172.204.81.57","id":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","uuid":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","netbios_name":"VCENTER","fqdn":"vcenter.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"}],"severity":0}]}]},{"plugin_output":"Port 123/udp was found to be open","states":[{"name":"Active","results":[{"application_protocol":"unknown","port":123,"transport_protocol":"udp","assets":[{"hostname":"172.204.81.57","id":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","uuid":"7ee5f61c-e768-4dd7-baa6-f76381ca6970","netbios_name":"VCENTER","fqdn":"vcenter.dc.demo.io","ipv4":"172.204.81.57","first_seen":"2018-11-28T15:00:25Z","last_seen":"2018-11-28T15:00:25Z"}],"severity":0}]}]}]}}}}}},"403":{"description":"Returned if you do not have permission to list of asset vulnerabilties for the specified plugin."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/workbenches/assets/{asset_uuid}":{"delete":{"summary":"Delete asset","description":"Deletes the specified asset. When you delete an asset, Tenable.io deletes vulnerability data associated with the asset. Deleting an asset does not immediately subtract the asset from your licensed assets count. Deleted assets continue to be included in the count until they automatically age out as inactive.<p>Requires SCAN OPERATOR [24] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-assets-delete","tags":["Workbenches"],"parameters":[{"description":"The UUID of the asset. You can find the UUID by examining the output of the [GET /workbenches/assets](#workbenches-assets) endpoint.","required":true,"name":"asset_uuid","in":"path","schema":{"type":"string"}}],"responses":{"202":{"description":"Returned if Tenable.io successfully deletes the asset.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if you do not have permission to delete the asset."},"404":{"description":"Returned if Tenable.io cannot find the specified asset."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io fails to delete the specified asset.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/workbenches/export":{"get":{"summary":"Export workbench","description":"Exports the specified workbench to a file. Once requested, the file can be downloaded using the <a href=\"#workbenches-export-download\">export download</a> method upon receiving a \"ready\" status from the <a href=\"#workbenches-export-status\">export status</a> method. \nFor more information about workbench export files, see <a href=\"docs/export-file-formats\" target=\"_blank\">Export File Formats</a>.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-export-request","tags":["Workbenches"],"parameters":[{"description":"The file format to use (Nessus, HTML, PDF, or CSV).","required":true,"name":"format","in":"query","schema":{"type":"string","enum":["nessus","html","pdf","csv"]}},{"description":"The type of workbench report to be exported","required":true,"name":"report","in":"query","schema":{"type":"string","enum":["vulnerabilities"]}},{"description":"The date (in unixtime) at which the exported results should begin to be included. Defaults to today.","name":"start_date","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"Semicolon-separated list of chapters to include for vulnerabilities/hosts reports (vuln\\_by\\_plugin, vuln\\_by\\_asset, vuln\\_hosts\\_summary) or a single chapter for Executive Summary (exec\\_summary). Currently, only vuln\\_by\\_asset is supported for .nessus workbench exports.","required":true,"name":"chapter","in":"query","schema":{"type":"string"},"example":"vuln_by_asset"},{"description":"The number of days of data prior to and including start\\_date that should be returned. If not specified, data for all dates is returned.","name":"date_range","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The name of the filter to apply to the exported scan report. You can find available filters by using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.filter","in":"query","schema":{"type":"string"},"example":"?filter.0.filter=plugin.name"},{"description":"The operator of the filter to apply to the exported scan report. You can find the operators for the filter using the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.quality","in":"query","schema":{"type":"string"},"example":"&filter.0.quality=match"},{"description":"The value of the filter to apply to the exported scan report. You can find valid values for the filter in the 'control' attribute of the objects returned by the [GET /filters/workbenches/assets](#filters-assets-filter) endpoint. For more information about the format of this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.0.value","in":"query","schema":{"type":"string"},"example":"&filter.0.value=RHEL"},{"description":"For multiple filters, specifies whether to use the AND or the OR logical operator. The default is AND. For more information about this parameter, see [Workbench Filters](/docs/workbench-filters).","required":false,"name":"filter.search_type","in":"query","schema":{"type":"string","enum":["","and","or"]}},{"description":"When `true`, Tenable.io returns only a minimal subset of scan details for each result, excluding plugin attributes. In this case, only plugin\\_output and vulnerability\\_state fields are always returned; first\\_found, last\\_found and last\\_fixed are also returned if possible.","name":"minimum_vuln_info","in":"query","schema":{"type":"boolean","enum":["false","true"]}},{"description":"A plugin ID. Restricts the export data to vulnerabilities that only the specified plugin detects.","name":"plugin_id","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The UUID of an asset. Restricts the export data to findings on the specified asset only.","name":"asset_id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully queues the export.","content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"integer","description":"The ID of the generated file."}}},"examples":{"response":{"value":{"file":"1279345678"}}}}}},"403":{"description":"Returned if you do not have permission to export the workbench."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/workbenches/export/{file_id}/status":{"get":{"summary":"Check export status","description":"Returns the status of a pending export. When an export has been requested, it is necessary to poll this endpoint until a \"ready\" status is returned, at which point the file is complete and can be downloaded using the <a href=\"#workbenches-export-download\">export download</a> endpoint.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-export-status","tags":["Workbenches"],"parameters":[{"description":"The unique identifier of the workbench report being exported. The value for this parameter can be obtained from the response of the initial export request.","required":true,"name":"file_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the export status.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The export processing status, for example, READY or LOADING."},"progress_total":{"type":"string","description":"The total number of items included in export."},"progress":{"type":"string","description":"The number of already processed items."}}},"examples":{"response":{"value":{"progress_total":"16666","progress":"4000","status":"loading"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/workbenches/export/{file_id}/download":{"get":{"summary":"Download export file","description":"Downloads a file that has been prepared for export.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"workbenches-export-download","tags":["Workbenches"],"parameters":[{"description":"The unique identifier of the workbench report being downloaded. The value for this parameter can be obtained from the response of the initial export request.","required":true,"name":"file_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the file downloaded successfully.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n    <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n    <center>\n        <h1>429 Too Many Requests</h1>\n    </center>\n    <hr>\n    <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}}},"x-explorer-enabled":true,"x-proxy-enabled":true,"x-samples-enabled":true}