Update a list

put

https://{hostname}/etp-config/v3/configs/{configId}/lists/{listId}

Modifies list properties and all items for a specific list. Full update only.

Path Params

listId

integer

required

A unique identifier for the list.

configId

integer

required

A unique identifier for the configuration.

Query Params

includeDeleted

boolean

Defaults to false

Indicates if the result set includes deleted resources, false by default.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

accessConfig

object

Provides access config details.

allowedForDnsPolicy

boolean

Allows the list per DNS policy.

createdBy

string

length ≥ 1

Name of the user who created this list.

description

string

required

length ≥ 1

A description of the list that you provide.

itemCount

integer

≥ 0

The number of entries in a list.

knownCounts

object

Contains data of known counts.

modifiedBy

string

length ≥ 1

Name of the user who most recently modified the list.

name

string

required

length ≥ 1

The name of the list.

policySecuritySettings

array of objects

length ≥ 0

Lists the security settings applied to the policy.

policySecuritySettings

remainingCount

integer

≥ 0

The number of remaining entries for all lists globally.

securityCategoryInfo

object

Specifies the security category.

suspectedCounts

object

The count of suspected domain entries in the list.

Headers

If-Match

string

required

Use the x_etag value included in the GET response. See Concurrency control for details.

Responses

200

Successful response.

`x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See Concurrency control for details.

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/problem+json

400Validation error.

401Authentication error. See Get started for help setting up your API token.

403Insufficient permissions See Get started for help setting up your API token.

404Configuration not Found.

412Precondition failed. Use the x_etag string returned in the response header as If-Match in write requests to avoid overwriting edits by any other API clients. See Concurrency control for details.

`x_etag` string returned in the response header as `If-Match` in write requests to avoid overwriting edits by any other API clients. See Concurrency control for details.