# IP Address Management Address Maps
## Create Address Map
**POST** `/accounts/{account_id}/addressing/address_maps`
Create a new address map under the account.
### Responses
#### 200 Create Address Map response
> Data is at `body["result"]`
```json
{
"can_delete": "*boolean*",
"can_modify_ips": "*boolean*",
"created_at": "*string*",
"default_sni": "*string*",
"description": "*string*",
"enabled": "*boolean*",
"id": "*string*",
"ips": [
{
"created_at": null,
"ip": null
}
],
"memberships": [
{
"can_delete": null,
"created_at": null,
"identifier": null,
"kind": null
}
],
"modified_at": "*string*"
}
```
#### 4XX Create Address Map response failure
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result": {},
"success": "*boolean*"
}
```
## List Address Maps
**GET** `/accounts/{account_id}/addressing/address_maps`
List all address maps owned by the account.
### Responses
#### 200 List Address Maps response
> Data is at `body["result"]`
```json
[
{
"can_delete": "*boolean*",
"can_modify_ips": "*boolean*",
"created_at": "*string*",
"default_sni": "*string*",
"description": "*string*",
"enabled": "*boolean*",
"id": "*string*",
"modified_at": "*string*"
}
]
```
#### 4XX List Address Maps response failure
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result": {},
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
## Update Address Map
**PATCH** `/accounts/{account_id}/addressing/address_maps/{address_map_id}`
Modify properties of an address map owned by the account.
### Responses
#### 200 Update Address Map response
> Data is at `body["result"]`
```json
{
"can_delete": "*boolean*",
"can_modify_ips": "*boolean*",
"created_at": "*string*",
"default_sni": "*string*",
"description": "*string*",
"enabled": "*boolean*",
"id": "*string*",
"modified_at": "*string*"
}
```
#### 4XX Update Address Map response failure
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result": {},
"success": "*boolean*"
}
```
## Address Map Details
**GET** `/accounts/{account_id}/addressing/address_maps/{address_map_id}`
Show a particular address map owned by the account.
### Responses
#### 200 Address Map Details response
> Data is at `body["result"]`
```json
{
"can_delete": "*boolean*",
"can_modify_ips": "*boolean*",
"created_at": "*string*",
"default_sni": "*string*",
"description": "*string*",
"enabled": "*boolean*",
"id": "*string*",
"ips": [
{
"created_at": null,
"ip": null
}
],
"memberships": [
{
"can_delete": null,
"created_at": null,
"identifier": null,
"kind": null
}
],
"modified_at": "*string*"
}
```
#### 4XX Address Map Details response failure
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result": {},
"success": "*boolean*"
}
```
## Delete Address Map
**DELETE** `/accounts/{account_id}/addressing/address_maps/{address_map_id}`
Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted.
### Responses
#### 200 Delete Address Map response
> Data is at `body["result"]`
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
#### 4XX Delete Address Map response failure
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result": {},
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
## Add an account membership to an Address Map
**PUT** `/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}`
Add an account as a member of a particular address map.
### Responses
#### 200 Add an account membership to an Address Map response
> Data is at `body["result"]`
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
#### 4XX Add an account membership to an Address Map response failure
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result": {},
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
## Remove an account membership from an Address Map
**DELETE** `/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}`
Remove an account as a member of a particular address map.
### Responses
#### 200 Remove an account membership from an Address Map response
> Data is at `body["result"]`
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
#### 4XX Remove an account membership from an Address Map response failure
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result": {},
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
## Add an IP to an Address Map
**PUT** `/accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}`
Add an IP from a prefix owned by the account to a particular address map.
### Responses
#### 200 Add an IP to an Address Map response
> Data is at `body["result"]`
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
#### 4XX Add an IP to an Address Map response failure
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result": {},
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
## Remove an IP from an Address Map
**DELETE** `/accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}`
Remove an IP from a particular address map.
### Responses
#### 200 Remove an IP from an Address Map response
> Data is at `body["result"]`
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
#### 4XX Remove an IP from an Address Map response failure
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result": {},
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
## Add a zone membership to an Address Map
**PUT** `/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}`
Add a zone as a member of a particular address map.
### Responses
#### 200 Add a zone membership to an Address Map response
> Data is at `body["result"]`
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
#### 4XX Add a zone membership to an Address Map response failure
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result": {},
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
## Remove a zone membership from an Address Map
**DELETE** `/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}`
Remove a zone as a member of a particular address map.
### Responses
#### 200 Remove a zone membership from an Address Map response
> Data is at `body["result"]`
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
#### 4XX Remove a zone membership from an Address Map response failure
```json
{
"errors": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"messages": [
{
"code": "*integer*",
"documentation_url": "*string*",
"message": "*string*",
"source": {
"pointer": "*string*"
}
}
],
"result": {},
"result_info": {
"count": "*number*",
"page": "*number*",
"per_page": "*number*",
"total_count": "*number*"
},
"success": "*boolean*"
}
```
