---
title: "Add whitelist ip address for an agency"
method: POST
path: "/agency/{agency_id}/ip-whitelist"
tags: ["Agency ip-whitelist"]
---

# Add whitelist ip address for an agency

`POST /agency/{agency_id}/ip-whitelist`

## Request body

- IpWhitelistModelDef
  - `ip` string, ipv4, required
  - `description` string, required

## Response `201`

The created agency ip-whitelist record will be return

- IpWhitelistResponseDef
  - `_id` string, required
  - `updated_at` string, date-time, required
  - `created_at` string, date-time, required
  - `__v` integer, required
  - `resource_type` string, required
  - `resource_id` string, required
  - `ip` string, ipv4, required
  - `description` string, required

## Other responses

- `400` — Usually caused by invalid user input
- `401` — Failed to authenticate the user making the request
- `403` — Permission denied error
- `409` — Failed when some conflicts occurred with the data
- `default` — Server error occurred

---

[API](https://skmtc.dev/staffshift/apis/staffshift-api-gateway.md) · [All operations](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/revisions/6e2cb83db3a9?raw)