ESET Online Help

Search
Select the category
Select the topic

POST Update IP set

Relative path: /v1/policies/{policyUuid}/ip-sets/{ipSetUuid}:update

Update 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 be multiple times inside the IP set.

Read only IP sets can not be updated. Built in IP sets can only update ip_addresses attribute.

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 Ip set that will be updated",
    "builtIn": {
      "type": "boolean",
      "description": "Some IP Sets are delivered out of box and are always present. For those this attribute is true. User-defined IP Sets have it set to false."
    },
    "description": {
      "type": "string",
      "description": "Description of IP Set."
    },
    "displayName": {
      "type": "string",
      "description": "Human readable name of the IP Set."
    },
    "ipAddresses": [
      {
        "type": "string"
      }
    ],
    "readOnly": {
      "title": "If true, the content of IP Set cannot be updated. If false, and built in is true, the following attributes can be updated: - ip addresses",
      "type": "boolean"
    }
  }
}

Parameters in path

Name

Type

Required

Description

policyUuid

string

Yes

Reference to 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 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 IP Set."
    },
    "builtIn": {
      "type": "boolean",
      "description": "Some IP Sets are delivered out of box and are always present. For those this attribute is true. User-defined IP Sets have it set to false."
    },
    "displayName": {
      "type": "string",
      "description": "Human readable name of the IP Set."
    },
    "ipAddresses": [
      {
        "type": "string"
      }
    ],
    "readOnly": {
      "title": "If true, the content of IP Set cannot be updated. If false, and built in is true, the following attributes can be updated: - ip addresses",
      "type": "boolean"
    },
    "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 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
 
[]