Rapid7

opencollection: 1.0.0
info:
  name: InsightVM API
  version: '3'
items:
- info:
    name: Root
    type: folder
  items:
  - info:
      name: Resources
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3'
    docs: Returns a listing of the resources (endpoints) that are available to be invoked in this API.
- info:
    name: Administration
    type: folder
  items:
  - info:
      name: Console Commands
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/api/3/administration/commands'
    docs: Executes a console command against the Security Console. <span class="authorization">Global Administrator</span>
  - info:
      name: Information
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/administration/info'
    docs: Returns system details, including host and version information.
  - info:
      name: License
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/administration/license'
    docs: Returns the enabled features and limits of the current license. <span class="authorization">Global Administrator</span>
  - info:
      name: License
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/api/3/administration/license'
      params:
      - name: key
        value: ''
        type: query
        description: A license activation key.
    docs: Licenses the product with an activation key or a provided license file. If both are provided, the license file is
      preferred. <span class="authorization">Global Administrator</span>
  - info:
      name: Properties
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/administration/properties'
    docs: Returns system details, including host and version information.
  - info:
      name: Settings
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/administration/settings'
    docs: Returns the current administration settings. <span class="authorization">Global Administrator</span>
- info:
    name: Asset Group
    type: folder
  items:
  - info:
      name: Agents
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/agents'
      params:
      - name: page
        value: ''
        type: query
        description: The index of the page (zero-based) to retrieve.
      - name: size
        value: ''
        type: query
        description: The number of records per page to retrieve.
      - name: sort
        value: ''
        type: query
        description: 'The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is
          ascending. Multiple sort criteria can be specified using multiple sort query parameters.'
    docs: Returns the details for all agents.
  - info:
      name: Asset Groups
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/asset_groups'
      params:
      - name: type
        value: ''
        type: query
        description: The type of asset group.
      - name: name
        value: ''
        type: query
        description: A search pattern for the name of the asset group. Searches are case-insensitive contains.
      - name: page
        value: ''
        type: query
        description: The index of the page (zero-based) to retrieve.
      - name: size
        value: ''
        type: query
        description: The number of records per page to retrieve.
      - name: sort
        value: ''
        type: query
        description: 'The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is
          ascending. Multiple sort criteria can be specified using multiple sort query parameters.'
    docs: Returns all asset groups.
  - info:
      name: Asset Groups
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/api/3/asset_groups'
    docs: "Creates a new asset group. The `searchCriteria` field can be passed no matter what the type of the asset group\
      \ is. The asset group `type` changes when the assets are refreshed. Dynamic asset groups constantly refreshed their\
      \ membership as assets are scanned whereas static asset groups do not change membership automatically. \nSee the <a\
      \ href=\"#section/Responses/SearchCriteria\">Search Criteria</a> for more information on using dynamic criteria."
  - info:
      name: Asset Group
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/asset_groups/:id'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Returns an asset group.
  - info:
      name: Asset Group
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/asset_groups/:id'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Updates the details of an asset group. See the search criteria endpoint (/search_criteria) for more information
      about building the search criteria and examples.
  - info:
      name: Asset Group
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/asset_groups/:id'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Deletes the asset group.
  - info:
      name: Asset Group Assets
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/asset_groups/:id/assets'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Returns hypermedia links for the assets that belong to an asset group.
  - info:
      name: Asset Group Assets
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/asset_groups/:id/assets'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Updates all the assets that belong to a static asset group.
  - info:
      name: Asset Group Assets
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/asset_groups/:id/assets'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Removes the assets from the given static asset group.
  - info:
      name: Asset Group Asset
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/asset_groups/:id/assets/:assetId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
      - name: assetId
        value: ''
        type: path
        description: The identifier of the asset.
    docs: Adds an asset to a static asset group.
  - info:
      name: Asset Group Asset
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/asset_groups/:id/assets/:assetId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
      - name: assetId
        value: ''
        type: path
        description: The identifier of the asset.
    docs: Removes an asset from an asset group.
  - info:
      name: Asset Group Search Criteria
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/asset_groups/:id/search_criteria'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Returns the search criteria of a dynamic asset group.For a reference of valid search criteria input see the <a href="#operation/getAssetsSearchUsingPOST">Asset
      Search</a> resource.
  - info:
      name: Asset Group Search Criteria
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/asset_groups/:id/search_criteria'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Updates the search criteria of a dynamic asset group. For a reference of valid search criteria input see the <a
      href="#operation/getAssetsSearchUsingPOST">Asset Search</a> resource.
  - info:
      name: Asset Group Tags
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/asset_groups/:id/tags'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Returns the tags assigned to an asset group.
  - info:
      name: Asset Group Tags
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/asset_groups/:id/tags'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Updates the tags of an asset group.
  - info:
      name: Asset Group Tags
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/asset_groups/:id/tags'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Removes all tag associations from the asset group.
  - info:
      name: Resources and operations for managing asset groups.
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/asset_groups/:id/tags/:tagId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
      - name: tagId
        value: ''
        type: path
        description: The identifier of the tag.
    docs: Adds a tag to an asset group.
  - info:
      name: Resources and operations for managing asset groups.
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/asset_groups/:id/tags/:tagId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
      - name: tagId
        value: ''
        type: path
        description: The identifier of the tag.
    docs: Removes a tag from an asset group.
  - info:
      name: Asset Group Users
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/asset_groups/:id/users'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Returns hypermedia links for the users with access to this asset group.
  - info:
      name: Asset Group Users
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/asset_groups/:id/users'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
    docs: Grants users with sufficient privileges access to an asset group.
  - info:
      name: Asset Group User
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/asset_groups/:id/users/:userId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
      - name: userId
        value: ''
        type: path
        description: The identifier of the user.
    docs: Grants a user with sufficient privileges access to the asset group.
  - info:
      name: Asset Group User
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/asset_groups/:id/users/:userId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset group.
      - name: userId
        value: ''
        type: path
        description: The identifier of the user.
    docs: Removes a user's access from an asset group.
- info:
    name: Asset
    type: folder
  items:
  - info:
      name: Assets
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets'
      params:
      - name: page
        value: ''
        type: query
        description: The index of the page (zero-based) to retrieve.
      - name: size
        value: ''
        type: query
        description: The number of records per page to retrieve.
      - name: sort
        value: ''
        type: query
        description: 'The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is
          ascending. Multiple sort criteria can be specified using multiple sort query parameters.'
    docs: Returns all assets for which you have access.
  - info:
      name: Assets
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/api/3/sites/:id/assets'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Creates or updates an asset with the specified details.
  - info:
      name: Asset Search
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/api/3/assets/search'
      params:
      - name: page
        value: ''
        type: query
        description: The index of the page (zero-based) to retrieve.
      - name: size
        value: ''
        type: query
        description: The number of records per page to retrieve.
      - name: sort
        value: ''
        type: query
        description: 'The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is
          ascending. Multiple sort criteria can be specified using multiple sort query parameters.'
    docs: Returns all assets for which you have access that match the given search criteria.
  - info:
      name: Asset
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
    docs: Returns the specified asset.
  - info:
      name: Asset
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/assets/:id'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
    docs: Deletes the specified asset.
  - info:
      name: Asset Databases
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/databases'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
    docs: Returns the databases enumerated on an asset.
  - info:
      name: Asset Files
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/files'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
    docs: Returns the files discovered on an asset.
  - info:
      name: Asset Services
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/services'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
    docs: Returns the services discovered on an asset.
  - info:
      name: Asset Service
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/services/:protocol/:port'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
      - name: protocol
        value: ''
        type: path
        description: The protocol of the service.
      - name: port
        value: ''
        type: path
        description: The port of the service.
    docs: Returns the service running a port and protocol on the asset.
  - info:
      name: Asset Service Configurations
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/services/:protocol/:port/configurations'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
      - name: protocol
        value: ''
        type: path
        description: The protocol of the service.
      - name: port
        value: ''
        type: path
        description: The port of the service.
    docs: Returns the configuration (properties) of a port and protocol on an asset.
  - info:
      name: Asset Service Databases
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/services/:protocol/:port/databases'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
      - name: protocol
        value: ''
        type: path
        description: The protocol of the service.
      - name: port
        value: ''
        type: path
        description: The port of the service.
    docs: Returns the databases running on a port and protocol on an asset.
  - info:
      name: Asset Service User Groups
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/services/:protocol/:port/user_groups'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
      - name: protocol
        value: ''
        type: path
        description: The protocol of the service.
      - name: port
        value: ''
        type: path
        description: The port of the service.
    docs: Returns the user groups enumerated on a port and protocol on an asset.
  - info:
      name: Asset Service Users
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/services/:protocol/:port/users'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
      - name: protocol
        value: ''
        type: path
        description: The protocol of the service.
      - name: port
        value: ''
        type: path
        description: The port of the service.
    docs: Returns the users enumerated on a port and protocol on an asset.
  - info:
      name: Asset Service Web Applications
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/services/:protocol/:port/web_applications'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
      - name: protocol
        value: ''
        type: path
        description: The protocol of the service.
      - name: port
        value: ''
        type: path
        description: The port of the service.
    docs: Returns the web applications running on a port and protocol on an asset.
  - info:
      name: Asset Service Web Application
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/services/:protocol/:port/web_applications/:webApplicationId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
      - name: protocol
        value: ''
        type: path
        description: The protocol of the service.
      - name: port
        value: ''
        type: path
        description: The port of the service.
      - name: webApplicationId
        value: ''
        type: path
        description: The identifier of the web application.
    docs: Returns a web application running on a port and protocol on an asset.
  - info:
      name: Asset Software
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/software'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
    docs: Returns the software on an asset.
  - info:
      name: Asset Tags
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/tags'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
    docs: Returns tags assigned to an asset.
  - info:
      name: Asset Tag
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/assets/:id/tags/:tagId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
      - name: tagId
        value: ''
        type: path
        description: The identifier of the tag.
    docs: Assigns the specified tag to the asset.
  - info:
      name: Asset Tag
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/assets/:id/tags/:tagId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
      - name: tagId
        value: ''
        type: path
        description: The identifier of the tag.
    docs: Removes the specified tag from the asset's tags.
  - info:
      name: Asset User Groups
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/user_groups'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
    docs: Returns user groups enumerated on an asset.
  - info:
      name: Asset Users
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/assets/:id/users'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the asset.
    docs: Returns users enumerated on an asset.
  - info:
      name: Operating Systems
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/operating_systems'
      params:
      - name: page
        value: ''
        type: query
        description: The index of the page (zero-based) to retrieve.
      - name: size
        value: ''
        type: query
        description: The number of records per page to retrieve.
      - name: sort
        value: ''
        type: query
        description: 'The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is
          ascending. Multiple sort criteria can be specified using multiple sort query parameters.'
    docs: 'Returns all operating systems discovered across all assets. '
  - info:
      name: Operating System
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/operating_systems/:id'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the operating system.
    docs: Returns the details for an operating system.
  - info:
      name: Software
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/software'
      params:
      - name: page
        value: ''
        type: query
        description: The index of the page (zero-based) to retrieve.
      - name: size
        value: ''
        type: query
        description: The number of records per page to retrieve.
      - name: sort
        value: ''
        type: query
        description: 'The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is
          ascending. Multiple sort criteria can be specified using multiple sort query parameters.'
    docs: Returns all software enumerated on any asset.
  - info:
      name: Software
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/software/:id'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the software.
    docs: Returns the details for software.
- info:
    name: Site
    type: folder
  items:
  - info:
      name: Site Assets
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/sites/:id/assets'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
      - name: page
        value: ''
        type: query
        description: The index of the page (zero-based) to retrieve.
      - name: size
        value: ''
        type: query
        description: The number of records per page to retrieve.
      - name: sort
        value: ''
        type: query
        description: 'The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is
          ascending. Multiple sort criteria can be specified using multiple sort query parameters.'
    docs: Retrieves a paged resource of assets linked with the specified site.
  - info:
      name: Site Assets
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/sites/:id/assets'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Removes all assets from the specified site. Assets will be deleted entirely from the Security Console if either
      Asset Linking is disabled or if Asset Linking is enabled and the asset only existed in this site.
  - info:
      name: Sites
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/sites'
      params:
      - name: page
        value: ''
        type: query
        description: The index of the page (zero-based) to retrieve.
      - name: size
        value: ''
        type: query
        description: The number of records per page to retrieve.
      - name: sort
        value: ''
        type: query
        description: 'The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is
          ascending. Multiple sort criteria can be specified using multiple sort query parameters.'
    docs: Retrieves a paged resource of accessible sites.
  - info:
      name: Sites
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/api/3/sites'
    docs: Creates a new site with the specified configuration.
  - info:
      name: Site
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/sites/:id'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Retrieves the site with the specified identifier.
  - info:
      name: Site
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/sites/:id'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Updates the configuration of the site with the specified identifier.
  - info:
      name: Site
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/sites/:id'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Deletes the site with the specified identifier.
  - info:
      name: Site Alerts
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/sites/:id/alerts'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Retrieve all alerts defined in the site.
  - info:
      name: Site Alerts
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/sites/:id/alerts'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Deletes all alerts from the site.
  - info:
      name: Site SMTP Alerts
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/sites/:id/alerts/smtp'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Retrieves all SMTP alerts defined in the site.
  - info:
      name: Site SMTP Alerts
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/api/3/sites/:id/alerts/smtp'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Creates a new SMTP alert for the specified site.
  - info:
      name: Site SMTP Alerts
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/sites/:id/alerts/smtp'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Updates all SMTP alerts for the specified site in a single request using the array of resources defined in the request
      body.
  - info:
      name: Site SMTP Alerts
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/sites/:id/alerts/smtp'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Deletes all SMTP alerts from the site.
  - info:
      name: Site SMTP Alert
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/sites/:id/alerts/smtp/:alertId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
      - name: alertId
        value: ''
        type: path
        description: The identifier of the alert.
    docs: Retrieves the specified SMTP alert.
  - info:
      name: Site SMTP Alert
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/sites/:id/alerts/smtp/:alertId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
      - name: alertId
        value: ''
        type: path
        description: The identifier of the alert.
    docs: Updates the specified SMTP alert.
  - info:
      name: Site SMTP Alert
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/sites/:id/alerts/smtp/:alertId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
      - name: alertId
        value: ''
        type: path
        description: The identifier of the alert.
    docs: Deletes the specified SMTP alert from the site.
  - info:
      name: Site SNMP Alerts
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/sites/:id/alerts/snmp'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Retrieves all SNMP alerts defined in the site.
  - info:
      name: Site SNMP Alerts
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/api/3/sites/:id/alerts/snmp'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Creates a new SNMP alert for the specified site.
  - info:
      name: Site SNMP Alerts
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/sites/:id/alerts/snmp'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Updates all SNMP alerts for the specified site in a single request using the array of resources defined in the request
      body.
  - info:
      name: Site SNMP Alerts
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/sites/:id/alerts/snmp'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Deletes all SNMP alerts from the site.
  - info:
      name: Site SNMP Alert
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/sites/:id/alerts/snmp/:alertId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
      - name: alertId
        value: ''
        type: path
        description: The identifier of the alert.
    docs: Retrieves the specified SNMP alert.
  - info:
      name: Site SNMP Alert
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/api/3/sites/:id/alerts/snmp/:alertId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
      - name: alertId
        value: ''
        type: path
        description: The identifier of the alert.
    docs: Updates the specified SNMP alert.
  - info:
      name: Site SNMP Alert
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/api/3/sites/:id/alerts/snmp/:alertId'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
      - name: alertId
        value: ''
        type: path
        description: The identifier of the alert.
    docs: Deletes the specified SNMP alert from the site.
  - info:
      name: Site Syslog Alerts
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/api/3/sites/:id/alerts/syslog'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Retrieves all Syslog alerts defined in the site.
  - info:
      name: Site Syslog Alerts
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/api/3/sites/:id/alerts/syslog'
      params:
      - name: id
        value: ''
        type: path
        description: The identifier of the site.
    docs: Creates a new Syslog alert for the specified site.
  - info:
      name: Site Syslog Aler

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