GET: Tiers

Ingrid

https://api.bitsighttech.com/ratings/v1/tiers

Get a list of your existing tiers and tier details.

Example Request

curl https://api.bitsighttech.com/ratings/v1/tiers -u api_token:

Example Response

[
  {
    "rank":1,
    "guid":"e325bd1d-b5ee-4fa5-a1ee-8e87518b0746",
    "name":"Tier 1",
    "description":"PCI or Network access",
    "companies":[
      "221c9760-60a9-4434-9805-aca970aae50a",
      "de4e1348-10d3-4c59-8c16-9817a86926ae",
      "d8fa2aae-6b5c-4b92-8793-0ab08d85dcb8"
    ],
    "email_enabled":false,
    "content_subscription_types":[
      "continuous_monitoring",
      "alerts-only"
    ]
  },
  […]
]

Response Attributes

Field	Description
rank Integer	The sorting order of this tier is based on its importance. Values: `1` as high importance and up to `5` as low importance.
guid String [`tier_guid`]	The unique identifier of this tier.
name String	The name of this tier.
description String	A description of the tier.
companies Array [`entity_guid`]	A list of the unique identifiers of companies within this tier.
email_enabled Boolean	`true` = Email alerts are enabled for this tier.
content_subscription_types Array	Subscription types that are within this tier.

April 5, 2019: Published.