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
dateOfDiscovery String No

Date the actor was discovered (ISO YYYY-MM-DD).

attributionOrganization String No
externalReferenceLinks[] Array No
value String Yes
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:

  • "white"
  • "red"
  • "amber"
  • "green"
attributionConfidenceScore Integer No
originCountryTlp String No

TLP marking for the origin-country attribution. CFONE-only: stripped from responses to non-CFONE accounts.

Valid values:

  • "white"
  • "red"
  • "amber"
  • "green"
sophisticationLevel String No
priority Number No
activeDuration String No
attributionConfidence String No
opsecLevel String No
actorCategory String No

Actor variety. Allowed values: Activist, Competitor, Customer, Crime Syndicate, Former Employee, Nation State, Organized Crime, Nation State Affiliated, Terrorist, Unaffiliated.

actorCategoryConfidence Integer No

Confidence (1-10) in the actor variety (actorCategory). CFONE-only: stripped from responses to non-CFONE accounts.

aliasGroupNames[] Array No
categoryUuid String No
analyticPriority Number No
motive String No

Actor motive. Allowed values: Convenience, Fear, Fun, Financial, Grudge, Ideology, Espionage.

aliasGroupNamesInternal[] Array No
motiveConfidence Integer No

Confidence (1-10) in the actor motive. CFONE-only: stripped from responses to non-CFONE accounts.

externalReferences[] Array No

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

externalReferences[].description String No
externalReferences[].url String Yes
internalDescription String No
originCountryConfidence Integer No

Confidence (1-10) in the origin-country attribution. CFONE-only: stripped from responses to non-CFONE accounts.

originCountryISO String 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:

  • "white"
  • "red"
  • "amber"
  • "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.