Select the tab
ESET Connect – Table of Contents

PUT Update web address rule domains

Relative path: /v2/policies/{policyUuid}/web-address-rules/{addressRuleUuid}/domains

Update all domains inside the web address rule. If the web address rule is empty, it will set the specified vector of domains; otherwise, it will replace all domains inside the web address rule. Original domains that were part of the web address rule will be replaced by the list of new ones.
Only domain parts of URLs are extracted and imported.

All domains are imported once. Multiple URLs sharing the domain part are imported once. Repeated addition of the same domain adds nothing to added_domains_count.

Warning:
Even if a single element is added, the whole policy MUST BE validated.

Base URL for Europe, Germany, United States, Canada and Japan regions:






Request body

Display Schema instead of an Example or vice-versa

Type

Required

Example

Schema

application/json

Yes

 
{
  "urls": [
    "string"
  ],
  "sourceName": "string"
}
 
{
  "$ref": "WebAddressRulesConfiguratorUpdateWebAddressRuleDomainsBody",
  "urls": [
    {
      "type": "string"
    }
  ],
  "sourceName": {
    "type": "string",
    "description": "Name of the data source. Filename if the source is a file."
  }
}

Parameters in path

Name

Type

Required

Description

policyUuid

string

Yes

Reference to policy.

type: policy_management.v2.Policy

addressRuleUuid

string

Yes

Address rule where the domains will be updated.

type: WebAddressRule

Responses

Display Schema+Headers instead of an Example or vice-versa

Code

Description and Example

Description, Schema and Headers

200

Successful response.


Response example

{
  "addedDomainsCount": 0,
  "malformedDomains": [
    "string"
  ]
}

Successful response.


Response schema

{
  "$ref": "v2UpdateWebAddressRuleDomainsResponse",
  "addedDomainsCount": {
    "type": "integer",
    "description": "Count of truly imported domains, duplicate domains are skipped.",
    "format": "int64"
  },
  "malformedDomains": [
    {
      "type": "string"
    }
  ]
}


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

202

Response took too long; request cached. Response can be retrieved later using the response-id header.

Response took too long; request cached. Response can be retrieved later using the response-id header.


Response schema

[]


Headers

{
  "response-id": {
    "description": "Unique ID of a pending request. Used to retrieve cached result.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

400

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

401

Token has expired or is invalid.

Token has expired or is invalid.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

403

Access denied. Check permissions.

Access denied. Check permissions.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

404

Requested resource not found.

Requested resource not found.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

429

Rate limit reached. Try again later.

Rate limit reached. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

500

Internal server failure. Try again later.

Internal server failure. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

502

Internal server failure. Try again later.

Internal server failure. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

503

Environment under maintenance. Try again later.

Environment under maintenance. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

504

Action took too long; timeout reached

Action took too long; timeout reached


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}