Update IP set
Relative path: /v1/policies/{policyUuid}/ip-sets/{ipSetUuid}:update
Update the selected IP set; attributes that can be updated:
- display_name
- description
- ip_addresses
If IP addresses are updated, there is no check for uniqueness, which means that one IP address can appear multiple times inside the IP set.
Read-only IP sets cannot be updated.
For built-in IP sets, only the ip_addresses attribute can be updated.
Request body
Display Schema instead of an Example or vice-versa
Type |
Required |
Example |
Schema |
---|---|---|---|
application/json |
No |
{ "ipSet": { "builtIn": true, "description": "string", "displayName": "string", "ipAddresses": [ "string" ], "readOnly": true } } |
{ "$ref": "NetworkAccessConfiguratorUpdateIpSetBody", "ipSet": { "$ref": "Reference to the IP set that will be updated.", "description": { "type": "string", "description": "Description of the IP set." }, "builtIn": { "type": "boolean", "description": "Some IP sets are delivered out of the box and are always present. For those, this attribute is true. User-defined IP sets have it set to false.", "readOnly": true }, "displayName": { "type": "string", "description": "Human-readable name of the IP set." }, "ipAddresses": [ { "type": "string" } ], "readOnly": { "title": "If true, the content of the IP set cannot be updated. If false, and built_in is true, the following attributes can be updated: - ip_addresses", "type": "boolean", "readOnly": true } } } |
Parameters in path
Name |
Type |
Required |
Description |
---|---|---|---|
policyUuid |
string |
Yes |
Reference to the policy. type: policy_management.v1.Policy |
ipSetUuid |
string |
Yes |
Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: "123e4567-e89b-12d3-a456-426614174000" |
Responses
Display Schema instead of an Example or vice-versa
Code |
Description |
Example |
Schema |
---|---|---|---|
200 |
Successful response. |
{ "ipSet": { "builtIn": true, "description": "string", "displayName": "string", "ipAddresses": [ "string" ], "readOnly": true, "uuid": "string" } } |
{ "$ref": "v1UpdateIpSetResponse", "ipSet": { "$ref": "v1IpSet", "description": { "type": "string", "description": "Description of the IP set." }, "builtIn": { "type": "boolean", "description": "Some IP sets are delivered out of the box and are always present. For those, this attribute is true. User-defined IP sets have it set to false.", "readOnly": true }, "displayName": { "type": "string", "description": "Human-readable name of the IP set." }, "ipAddresses": [ { "type": "string" } ], "readOnly": { "title": "If true, the content of the IP set cannot be updated. If false, and built_in is true, the following attributes can be updated: - ip_addresses", "type": "boolean", "readOnly": true }, "uuid": { "type": "string", "description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'" } } } |
202 |
Response took too long; request cached. Response can be retrieved later using the response-id header. |
null |
[] |
400 |
One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided. |
null |
[] |
401 |
Token has expired or is invalid. |
null |
[] |
403 |
Access denied. Check permissions. |
null |
[] |
404 |
Requested resource not found. |
null |
[] |
429 |
Rate limit reached. Try again later. |
null |
[] |
500 |
Internal server failure. Try again later. |
null |
[] |
502 |
Internal server failure. Try again later. |
null |
[] |
503 |
Environment under maintenance. Try again later. |
null |
[] |
504 |
Action took too long; timeout reached |
null |
[] |