> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Shield lists resources

Shield List allows 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.

<Accordion title="Attributes and example">
  | Property  | Type                                             | Required | Description                    |
  | --------- | ------------------------------------------------ | -------- | ------------------------------ |
  | `entries` | array of [Shield List (Mini)](#shield-list-mini) | No       | A list of shield list objects. |

  ```json Example theme={null}
  {
    "entries": [
      {
        "id": "12345678-1234-1234-1234-123456789012",
        "type": "shield_list",
        "name": "My Shield List",
        "content": {
          "type": "country_code"
        }
      }
    ]
  }
  ```
</Accordion>

## Shield List

A standard representation of a Shield List.

<Accordion title="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. |

  ```json Example theme={null}
  {
    "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"
      ]
    }
  }
  ```
</Accordion>

## Shield List (Mini)

A mini representation of a Shield List.

<Accordion title="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      |                                                       |

  ```json Example theme={null}
  {
    "id": "12345678-1234-1234-1234-123456789012",
    "type": "shield_list",
    "name": "My Shield List",
    "content": {
      "type": "country_code"
    }
  }
  ```
</Accordion>

## Shield List Content (Country)

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

<Accordion title="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.                                         |

  ```json Example theme={null}
  {
    "type": "country",
    "country_codes": [
      "US",
      "PL"
    ]
  }
  ```
</Accordion>

## Shield List Content (Domain)

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

<Accordion title="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.                                                      |

  ```json Example theme={null}
  {
    "type": "domain",
    "domains": [
      "box.com",
      "example.com"
    ]
  }
  ```
</Accordion>

## Shield List Content (Email)

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

<Accordion title="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.                                                     |

  ```json Example theme={null}
  {
    "type": "email",
    "email_addresses": [
      "example1@box.com",
      "example2@gmail.com"
    ]
  }
  ```
</Accordion>

## Shield List Content (Integration)

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

<Accordion title="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.                                                      |

  ```json Example theme={null}
  {
    "type": "integration",
    "integrations": [
      {
        "id": "505e40b5-5d04-446a-9268-72a0ccc13669"
      }
    ]
  }
  ```
</Accordion>

## Shield List Content (IP)

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

<Accordion title="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.                                  |

  ```json Example theme={null}
  {
    "type": "ip",
    "ip_addresses": [
      "127.0.0.1",
      "80.12.12.12/24"
    ]
  }
  ```
</Accordion>