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

# Add whitelist ip address for an agency group

`POST /agency-group/{agency_group_id}/ip-whitelist`

## Request

- Base URL: `http://localhost:3010/v1`
- URL: `http://localhost:3010/v1/agency-group/{agency_group_id}/ip-whitelist`
- Auth: HTTP basic

## Request body

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

## Response `201`

The created agency group 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/1f079f6b65f5?raw)