---
title: "List subdiary ips"
method: GET
path: "/subsidiary/ips"
tags: ["subsidiaries"]
---

# List subdiary ips

`GET /subsidiary/ips`

## Request

- Base URL: `https://cyber-risk.upguard.com/api/public`
- URL: `https://cyber-risk.upguard.com/api/public/subsidiary/ips`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/subsidiary/ips/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of ips for a subsidiary.

Required API key permissions: `BreachRisk` (select when creating API key in Account Settings)

## Query parameters

- `subsidiary_primary_hostname` string, required
- `labels` string[]
- `page_token` string
- `page_size` integer
- `sort_by` 'ip' | 'owner' | 'country' | 'asn' | 'as_name' | 'automated_score'
- `sort_desc` boolean

## Response `200`

A list of ips

- GetIPsV1RespBody
  - `ips` IP[]: The list of ips
    - `as_name` string: The name of the AS the IP belongs to. If no AS is available for an IP this field will be omitted.
    - `asn` integer: The ASN the IP belongs to. If no ASN is available for an IP this field will be omitted.
    - `automated_score` integer: The score of the ip. If the ip is inactive or hasn't been scanned yet this field will be absent
    - `country` string: The country the IP belongs to. If no country is available for an IP this field will be omitted.
    - `ip` string: The IP.
    - `labels` string[]: The labels associated with the IP.
    - `owner` string: The owner of the IP.
    - `services` string[]: The list of discovered services IP. If no services were detected for the IP this field will be omitted.
    - `sources` IPSource[]: The sources of the IP.
  - `next_page_token` string: The token to be used to retrieve the next page of results. Will not be returned if there are no more results.
  - `total_results` integer: The total number of ips found.

## Other responses

- `403`: Your API key does not have permission to perform this action.
- `422`: An invalid parameter was supplied or a mandatory parameter was missing
- `429`: Too many requests have been made to this endpoint.
- `500`: An internal system error occurred

---

[API](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api.md) - [All operations](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/revisions/d044bf6dc61e?raw)