Skip to main content
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.
PropertyTypeRequiredDescription
entriesarray of Shield List (Mini)NoA 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.
PropertyTypeRequiredDescription
idstringYesUnique identifier for the shield list.
typestringYesType of the object.
namestringYesName of the shield list.
enterpriseEnterprise referenceYesEnterprise for which this list belongs to.
descriptionstringNoDescription of Shield List.
created_atstringYesISO date time string when this shield list object was created.
updated_atstringYesISO date time string when this shield list object was updated.
contentShield List ContentYesSpecifies 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.
PropertyTypeRequiredDescription
idstringYesUnique global identifier for this list.
typeenum<string>YesThe type of object. Available options: shield_list.
namestringYesName of Shield List.
contentobjectYes
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.
PropertyTypeRequiredDescription
typeenum<string>YesThe type of content in the shield list. Available options: country.
country_codesarray of stringYesList 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.
PropertyTypeRequiredDescription
typeenum<string>YesThe type of content in the shield list. Available options: domain.
domainsarray of stringYesList 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.
PropertyTypeRequiredDescription
typeenum<string>YesThe type of content in the shield list. Available options: email.
email_addressesarray of stringYesList 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.
PropertyTypeRequiredDescription
typeenum<string>YesThe type of content in the shield list. Available options: integration.
integrationsarray of objectYesList 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.
PropertyTypeRequiredDescription
typeenum<string>YesThe type of content in the shield list. Available options: ip.
ip_addressesarray of stringYesList of ip addresses and CIDRs.
Example
{
  "type": "ip",
  "ip_addresses": [
    "127.0.0.1",
    "80.12.12.12/24"
  ]
}
Last modified on July 9, 2026