POST /accounts/{account_id}/cloudforce-one/events/tags/create

Creates a new tag to be used accross threat events.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Account ID.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
actorCategory No
dateOfDiscovery String No

Date of discovery (ISO YYYY-MM-DD). Optional.

description String No
lastSeen String No
properties Object No

Structured metadata blob. Optional. When categoryUuid is given, validated against this category's schema on write. When typeless, accepted free-form. Use {} for a tag with no custom data.

aliasGroupNames[] Array No
categoryUuid String No

Tag type (category) UUID. Optional — when present, properties is validated against this category's schema. When absent, the tag is typeless and properties are accepted free-form.

attributionOrganization No
motive No
externalReferenceLinks[] Array No
value String Yes
tlp String No

Tag-level TLP handling marking. Optional. Allowed values: red, amber, amber+strict, green, clear, purple.

Valid values:

  • "clear"
  • "red"
  • "purple"
  • "amber"
  • "amber+strict"
  • "green"
aliasGroupNamesInternal[] Array No
aliases[] Array No

Structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: stripped from responses to non-CFONE accounts.

aliases[].confidence Integer No
aliases[].value String Yes
aliases[].tlp String No

Valid values:

  • "clear"
  • "red"
  • "purple"
  • "amber"
  • "amber+strict"
  • "green"
sophisticationLevel No
priority No
confidence Integer No

Overall tag confidence (1-10). Optional.

activeDuration No
externalReferences[] Array No

Structured external references ({ url, description }). Public: returned to all accounts.

externalReferences[].description String No
externalReferences[].url String Yes
internalDescription String No
opsecLevel No
originCountryISO No
internalAliases[] Array No

Internal structured aliases ({ value, confidence 1-10, tlp }). CFONE-only: never returned to non-CFONE accounts.

internalAliases[].confidence Integer No
internalAliases[].value String Yes
internalAliases[].tlp String No

Valid values:

  • "clear"
  • "red"
  • "purple"
  • "amber"
  • "amber+strict"
  • "green"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.