PATCH: Edit Tiers – Bitsight Knowledge Base

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

Create or edit an existing tier. Assign a name and description.

Parameters

* Required.

Parameter	Values
rank [Body] Identify the tier by its importance.	[Integer] `1` (high importance) and up to `5` (low importance).
name * [Body] Assign a name for the tier.	[String] Up to 30 characters.
description [Body] Add a description for the tier.	[String] Up to 140 characters.
description * [Body] Identify companies in your portfolio to include in the tier.	[Array] Comma-separated company unique identifier [`entity_guid`]. See GET: Portfolio Details.

Example Request

Use the GET: Tiers to get a list of your existing tiers in conjunction with GET: Portfolio Details to get a list of companies in your portfolio.

cURL:

curl 'https://api.bitsighttech.com/ratings/v1/tiers/tier_guid' -u api_token -X PATCH -H 'Accept: application/json' -H 'Content-Type: application/json' --data-binary '{"name":"Tier 2","description":"Minimal or restricted PCI or network access","companies":["a940bb61-33c4-42c9-9231-c8194c305db3"]}' --compressed

{
  "name":"Tier 2",
  "description":"Minimal or restricted PCI or network access",
  "companies":[
    "a940bb61-33c4-42c9-9231-c8194c305db3"
  ]
}

December 10, 2019: Published.

Parameters

Example Request

Related articles