---
title: "Add a VIP"
method: POST
path: "/vips/add"
tags: ["breaches"]
---

# Add a VIP

`POST /vips/add`

## Request

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

Add a VIP to your account.

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

## Query parameters

- `email` string, required

## Response `200`

The VIP that was added

- AddVIPRespBody
  - `vip` VIP
    - `breach_ids` integer[]: The IDs of the breaches the VIP appears in
    - `date_last_breach` string: The date of the latest breach the VIP appears in (RFC 3339 format).
    - `domain` string: The domain of the VIP
    - `id` integer: The ID of the VIP
    - `name` string: The account name of the VIP
    - `num_breaches` integer: The number of breaches the VIP appears in
    - `severity` string: The highest severity of the breaches the VIP appears in. Will be one of "Critical", "High", "Medium", or "Low".

## Other responses

- `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

## Changes

- **2026-11-07** `d044bf6dc61e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/changes/vips/add/post.md)

---

[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)