Address groups

An address group is a named, mutable set of CIDR blocks you can reference from security group rules. Instead of pasting the same allowlist into ten security groups, you create one address group (office-cidrs) and reference it from each rule. Add or remove a CIDR from the group; every referencing rule updates immediately.

The canonical use case: corporate VPN CIDRs that change over time. Maintaining the list inline across every security group means going hunting when a CIDR moves; maintaining it in one address group means updating in one place.

What's next

Security groups — where address groups get referenced.
Networks and Subnets — the network layer address groups apply within.

Reference

GET/api/v1/address_group/

List Address Groups

Lists address groups visible to the project.

Parameters

Name	In	Required	Description
admin_domain	query	no	—
admin_project	query	no	—
name	query	no	—
description	query	no	—

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/address_group/

POST/api/v1/address_group/

Create Address Group

Creates an address group that can be referenced by security group rules.

Request body

JSON body required.

Responses

201Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/address_group/

GET/api/v1/address_group/{address_group_id}

Get Address Group

Returns the details of a single address group by ID.

Parameters

Name	In	Required	Description
address_group_id	path	yes	—

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/address_group/{address_group_id}

PUT/api/v1/address_group/{address_group_id}

Update Address Group

Updates the name or description of an existing address group.

Parameters

Name	In	Required	Description
address_group_id	path	yes	—

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/address_group/{address_group_id}

DELETE/api/v1/address_group/{address_group_id}

Delete Address Group

Deletes an address group by ID.

Parameters

Name	In	Required	Description
address_group_id	path	yes	—

Responses

204Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
422Validation Error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/address_group/{address_group_id}

PUT/api/v1/address_group/{address_group_id}/add_addresses

Add Addresses

Adds CIDR addresses to an existing address group.

Parameters

Name	In	Required	Description
address_group_id	path	yes	—

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/address_group/{address_group_id}/add_addresses

PUT/api/v1/address_group/{address_group_id}/remove_addresses

Remove Addresses

Removes CIDR addresses from an existing address group.

Parameters

Name	In	Required	Description
address_group_id	path	yes	—

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/address_group/{address_group_id}/remove_addresses

Need to make a real call? Try these endpoints in the live Swagger UI →

Edit this page on GitHub