Shield lists resources

Shield List allow an administrator to create a list which will be shared between different Shield Smart Access and Threat Detection rules.

List of Shield Lists

List of Shield List objects.

Attributes and example

Property	Type	Required	Description
`entries`	array of Shield List (Mini)	No	A list of shield list objects.

Example

{
  "entries": [
    {
      "id": "12345678-1234-1234-1234-123456789012",
      "type": "shield_list",
      "name": "My Shield List",
      "content": {
        "type": "country_code"
      }
    }
  ]
}

Shield List

A standard representation of a Shield List.

Attributes and example

Property	Type	Required	Description
`id`	`string`	Yes	Unique identifier for the shield list.
`type`	`string`	Yes	Type of the object.
`name`	`string`	Yes	Name of the shield list.
`enterprise`	`Enterprise reference`	Yes	Enterprise for which this list belongs to.
`description`	`string`	No	Description of Shield List.
`created_at`	`string`	Yes	ISO date time string when this shield list object was created.
`updated_at`	`string`	Yes	ISO date time string when this shield list object was updated.
`content`	`Shield List Content`	Yes	Specifies the type of elements in this Shield List and includes the elements themselves.

Example

{
  "id": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24",
  "type": "shield_list",
  "name": "Shield List Name",
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "description": "A list of things that are shielded",
  "created_at": "2025-01-13T15:31:01.896Z",
  "updated_at": "2025-01-13T15:31:01.896Z",
  "content": {
    "type": "country",
    "country_codes": [
      "US",
      "PL"
    ]
  }
}

Shield List (Mini)

A mini representation of a Shield List.

Attributes and example

Property	Type	Required	Description
`id`	`string`	Yes	Unique global identifier for this list.
`type`	`enum<string>`	Yes	The type of object. Available options: `shield_list`.
`name`	`string`	Yes	Name of Shield List.
`content`	`object`	Yes

Example

{
  "id": "12345678-1234-1234-1234-123456789012",
  "type": "shield_list",
  "name": "My Shield List",
  "content": {
    "type": "country_code"
  }
}

Shield List Content (Country)

Representation of content of a Shield List that contains countries data.

Attributes and example

Property	Type	Required	Description
`type`	`enum<string>`	Yes	The type of content in the shield list. Available options: `country`.
`country_codes`	array of `string`	Yes	List of country codes values.

Example

{
  "type": "country",
  "country_codes": [
    "US",
    "PL"
  ]
}

Shield List Content (Domain)

Representation of content of a Shield List that contains domains data.

Attributes and example

Property	Type	Required	Description
`type`	`enum<string>`	Yes	The type of content in the shield list. Available options: `domain`.
`domains`	array of `string`	Yes	List of domain.

Example

{
  "type": "domain",
  "domains": [
    "box.com",
    "example.com"
  ]
}

Shield List Content (Email)

Representation of content of a Shield List that contains email addresses data.

Attributes and example

Property	Type	Required	Description
`type`	`enum<string>`	Yes	The type of content in the shield list. Available options: `email`.
`email_addresses`	array of `string`	Yes	List of emails.

Example

{
  "type": "email",
  "email_addresses": [
    "example1@box.com",
    "example2@gmail.com"
  ]
}

Shield List Content (Integration)

Representation of content of a Shield List that contains integrations data.

Attributes and example

Property	Type	Required	Description
`type`	`enum<string>`	Yes	The type of content in the shield list. Available options: `integration`.
`integrations`	array of `object`	Yes	List of integration.

Example

{
  "type": "integration",
  "integrations": [
    {
      "id": "505e40b5-5d04-446a-9268-72a0ccc13669"
    }
  ]
}

Shield List Content (IP)

Representation of content of a Shield List that contains ip addresses data.

Attributes and example

Property	Type	Required	Description
`type`	`enum<string>`	Yes	The type of content in the shield list. Available options: `ip`.
`ip_addresses`	array of `string`	Yes	List of ip addresses and CIDRs.

Example

{
  "type": "ip",
  "ip_addresses": [
    "127.0.0.1",
    "80.12.12.12/24"
  ]
}

v2025.0

v2026.0

List of Shield Lists

Shield List

Shield List (Mini)

Shield List Content (Country)

Shield List Content (Domain)

Shield List Content (Email)

Shield List Content (Integration)

Shield List Content (IP)

​List of Shield Lists

​Shield List

​Shield List (Mini)

​Shield List Content (Country)

​Shield List Content (Domain)

​Shield List Content (Email)

​Shield List Content (Integration)

​Shield List Content (IP)

List of Shield Lists

Shield List

Shield List (Mini)

Shield List Content (Country)

Shield List Content (Domain)

Shield List Content (Email)

Shield List Content (Integration)

Shield List Content (IP)