- December 14, 2020: Added example JSON body.
https://api.bitsighttech.com/ratings/v1/folders
Create a new folder. Folders can be used to organize your portfolio to better understand the security performance of certain groups of companies, such as IT vendors.
Parameters
*Required.
Parameter | Description | Values |
---|---|---|
nameQuery |
Set a way to identify the folder. | [String] The intended name for the folder. |
descriptionQuery |
Set a way to identify the folder. | [String] A description for the folder. |
content_expiry_daysQuery |
Set how long companies will remain in the folder before removal. | [Integer] The number of days. |
Example Request
The minimum requirement for creating a folder is to specify a name:
cURL:
curl 'https://api.bitsighttech.com/ratings/v1/folders' -H 'Content-Type: application/json' --data-binary '{"name":"My Folder"}' --compressed -u api_token:
JSON:
{ "name":"My Folder" }