POST: Modify Infrastructure Tags

https://api.bitsighttech.com/ratings/v1/companies/company_guid/tags/bulk

Create, modify, or delete infrastructure tags.

See examples for:

• Creating Tags
• Deleting Tags
• Modifying Tags

Parameters

* Required.

add

[Query] Create a tag.

Value: [Array]

• company_guid
• is_public
• name

add:company_guid

* Required for the add parameter.

[Path] Identify the company to modify tags for.

Value: [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

add:is_public

* Required for the add parameter.

[Query] Define the tag’s visibility.

Value: [Boolean]

• true = The tag is public.
• false = The tag is private.

add:name

* Required for the add parameter.

[Query] Assign the tag name.

Value: [String] The tag name.

delete

[Query] Delete an existing tag.

Value: [Array] guid

delete:guid

* Required for the delete parameter.

[Query] Identify the tag to delete.

Value: Tag unique identifier [tag_guid]. See GET: Infrastructure Tags.

modify

[Query] Modify an existing tag.

Value: [Array]

• guid
• is_public
• name

modify:guid

* Required for the modify parameter.

[Query] Identify the tag to modify.

Value: Tag unique identifier [tag_guid]. See GET: Infrastructure Tags.

modify:is_public

Optional if name is provided.

[Query] Define the tag’s visibility.

Value: [Boolean]

• true = The tag is public.
• false = The tag is private.

modify:name

Optional if is_public is provided.

[Query] Assign the tag name.

Value: [String] The tag name.

Create Tag Example

Example Request

cURL:

curl -H "Content-Type: application/json" -X POST -i https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/tags/bulk -u api_token: -d '{"add": [{"name": "Data Center 1","is_public": true}]}'

JSON:

{
  "add": [
    {
      "name": "Data Center 1",
      "is_public": true
    }
  ]
}

Example Response

{
  "not_added": [],
  "added": [
    {
      "is_public": true,
      "guid": "ae87bc30-a3ab-45f7-809f-61ec36978685",
      "name": "Data Center 1"
    }
  ]
}

Response Attributes

not_added

[Array] Tags that could not be added.

added

[Array] Tags that were successfully added.

Delete Tag Example

Example Request

cURL:

curl -H "Content-Type: application/json" -X POST -i https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/tags/bulk -u api_token: -d '{"delete": [{"guid": "ae87bc30-a3ab-45f7-809f-61ec36978685"}]}'

JSON:

{
  "delete": [
    {
      "guid": "ae87bc30-a3ab-45f7-809f-61ec36978685"
    }
  ]
}

Example Response

{
  "deleted":[
    {
      "guid":"ae87bc30-a3ab-45f7-809f-61ec36978685"
    }
  ],
  "not_deleted":[]
}

Response Attributes

deleted

[Array] Tags that were successfully deleted.

not_deleted

[Array] Tags that could not be deleted.

Modify Tag Example

Example Request

cURL:

curl -H "Content-Type: application/json" -X POST -i https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/tags/bulk -u api_token: -d '{"modify": [{"guid": "ae87bc30-a3ab-45f7-809f-61ec36978685","name": "Data Center 1","is_public": false}]}'

JSON:

{
  "modify": [
    {
      "guid": "ae87bc30-a3ab-45f7-809f-61ec36978685"
      "name": "Data Center 1",
      "is_public": true
    }
  ]
}

Example Response

{
  "modified":[
    {
      "is_public":false,
      "guid":"ae87bc30-a3ab-45f7-809f-61ec36978685",
      "name":"Data Center 1"
    }
  ],
  "not_modified":[]
}

Response Attributes

modified

[Array] Tags that were successfully modified.

not_modified

[Array] Tags that could not be modified.