{
  "opencollection": "1.0.0",
  "info": {
    "name": "UpGuard CyberRisk breaches subsidiaries API",
    "version": "1.13.2"
  },
  "items": [
    {
      "info": {
        "name": "subsidiaries",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a list of subsidiaries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/subsidiaries"
          },
          "docs": "Returns a list of subsidiaries.\n\nRequired API key permissions: `BreachRisk` (select when creating API key in Account Settings)"
        },
        {
          "info": {
            "name": "Retrieve details for a domain",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/subsidiary/domain",
            "params": [
              {
                "name": "subsidiary_primary_hostname",
                "value": "",
                "type": "query",
                "description": "The primary hostname of the subsidiary to show the domain detail for."
              },
              {
                "name": "hostname",
                "value": "",
                "type": "query",
                "description": "The hostname for which to return the details, e.g. \"upguard.com\""
              }
            ]
          },
          "docs": "Returns the details for a domain. It will return 422 when requesting details of an inactive domain.\n\nRequired API key permissions: `BreachRisk` (select when creating API key in Account Settings)"
        },
        {
          "info": {
            "name": "Assign labels to a domain",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/subsidiary/domain/labels",
            "params": [
              {
                "name": "subsidiary_primary_hostname",
                "value": "",
                "type": "query",
                "description": "The primary hostname of the subsidiary to update the domain labels for."
              },
              {
                "name": "hostname",
                "value": "",
                "type": "query",
                "description": "The hostname to update labels for"
              },
              {
                "name": "labels",
                "value": "",
                "type": "query",
                "description": "The labels to assign to the domain. You can pass an empty array to remove all labels."
              }
            ]
          },
          "docs": "Assign labels to a domain. To remove all labels pass an empty list.\n\nRequired API key permissions: `BreachRisk` (select when creating API key in Account Settings)"
        },
        {
          "info": {
            "name": "List subsidiary domains",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/subsidiary/domains",
            "params": [
              {
                "name": "subsidiary_primary_hostname",
                "value": "",
                "type": "query",
                "description": "The primary hostname of the subsidiary to show domains for."
              },
              {
                "name": "active",
                "value": "",
                "type": "query",
                "description": "Retrieve active domains"
              },
              {
                "name": "inactive",
                "value": "",
                "type": "query",
                "description": "Retrieve inactive domains"
              },
              {
                "name": "labels",
                "value": "",
                "type": "query",
                "description": "Filter result by the provided labels"
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query",
                "description": "The `page_token` from a previous request, use this to get the next page of results."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results to return per page."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "The value to sort the domains by\n\nIf not specified will default to `domain` and set `sort_desc` to `true`"
              },
              {
                "name": "sort_desc",
                "value": "",
                "type": "query",
                "description": "Whether or not to sort the results in descending order"
              }
            ]
          },
          "docs": "Returns a list of domains for a subsidiary.\n\nRequired API key permissions: `BreachRisk` (select when creating API key in Account Settings)"
        },
        {
          "info": {
            "name": "Retrieve details for an IP address",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/subsidiary/ip",
            "params": [
              {
                "name": "subsidiary_primary_hostname",
                "value": "",
                "type": "query",
                "description": "The primary hostname of the subsidiary to show the IP detail for."
              },
              {
                "name": "ip",
                "value": "",
                "type": "query",
                "description": "The IP address to get details for"
              }
            ]
          },
          "docs": "Returns the details of the IP address. It will return 422 when requesting details of an inactive IP address.\n\nRequired API key permissions: `BreachRisk` (select when creating API key in Account Settings)"
        },
        {
          "info": {
            "name": "Assign labels to an IP",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/subsidiary/ip/labels",
            "params": [
              {
                "name": "subsidiary_primary_hostname",
                "value": "",
                "type": "query",
                "description": "The primary hostname of the subsidiary to update the IP labels for."
              },
              {
                "name": "ip",
                "value": "",
                "type": "query",
                "description": "The IP to update labels for"
              },
              {
                "name": "labels",
                "value": "",
                "type": "query",
                "description": "The labels to assign to the IP. You can pass an empty array to remove all labels."
              }
            ]
          },
          "docs": "Assign labels to an IP. To remove all labels pass an empty list.\n\nRequired API key permissions: `BreachRisk` (select when creating API key in Account Settings)"
        },
        {
          "info": {
            "name": "List subdiary ips",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/subsidiary/ips",
            "params": [
              {
                "name": "subsidiary_primary_hostname",
                "value": "",
                "type": "query",
                "description": "The primary hostname of the subsidiary to show ips for."
              },
              {
                "name": "labels",
                "value": "",
                "type": "query",
                "description": "Filter result by the provided labels"
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query",
                "description": "The `page_token` from a previous request, use this to get the next page of results."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results to return per page."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "The value to sort the IPs by\n\nIf not specified will default to `ip` and set `sort_desc` to `true`"
              },
              {
                "name": "sort_desc",
                "value": "",
                "type": "query",
                "description": "Whether or not to sort the results in descending order"
              }
            ]
          },
          "docs": "Returns a list of ips for a subsidiary.\n\nRequired API key permissions: `BreachRisk` (select when creating API key in Account Settings)"
        },
        {
          "info": {
            "name": "List subsidiary ip ranges",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/subsidiary/ranges",
            "params": [
              {
                "name": "subsidiary_primary_hostname",
                "value": "",
                "type": "query",
                "description": "The primary hostname of the subsidiary to show ranges for."
              },
              {
                "name": "labels",
                "value": "",
                "type": "query",
                "description": "Filter result by the provided labels"
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query",
                "description": "The `page_token` from a previous request, use this to get the next page of results."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The number of results to return per page."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "The value to sort the IP ranges by\n\nIf not specified will default to `num_ips` and set `sort_desc` to `true`"
              },
              {
                "name": "sort_desc",
                "value": "",
                "type": "query",
                "description": "Whether or not to sort the results in descending order"
              }
            ]
          },
          "docs": "Returns a list of ip ranges for a subsidiary.\n\nRequired API key permissions: `BreachRisk` (select when creating API key in Account Settings)"
        }
      ]
    }
  ],
  "bundled": true
}