PATCH /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid}

Updates a Source-of-Truth tag by UUID.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Account ID.

tag_uuid String Yes

Tag UUID.

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). Omit to preserve existing.

description String No
lastSeen String No
properties Object No

Custom field values blob. When omitted, the existing value is preserved. When provided, performs a shallow per-key merge over the stored value (unmentioned keys are retained). Setting an individual key to null deletes that key. Validation runs against the merged result, so a partial update may omit a schema-required key if the stored value supplies it.

aliasGroupNames[] Array No
categoryUuid String No

Tag type (category) UUID. When changed, existing properties are re-validated against the new category's schema (400 on mismatch). Set to null to unlink (typeless; properties stop being validated).

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

Tag-level TLP marking. Omit to preserve existing. Cannot be cleared to null.

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). Omit to preserve existing.

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.