Update an entity by ID.

patch

https://cti.example.com/api/v2/entities/{id}

The ID can be either an internal ID or an external (STIX) ID.

Note, that an unified entity (an entity with is_unified_entity flag set to True in meta) cannot be modified by user. An attempt to modify it will result in an error.

Required permissions

modify entities

Optional permissions

read extracts Required to access the observables attached with an entity
read taxonomies Required to access the taxonomies associated with an entity
read attack Required to access the MITRE ATT&CKs associated with an entity
read intel-sets Required to access the datasets associated with an entity
read incoming-feeds Required to access the incoming feeds associated with an entity
read outgoing-feeds Required to access the outgoing feeds associated with an entity

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Entity ID. It can be either a STIX ID or an EclecticIQ ID.

Query Params

overwrite_observables

boolean

If ?overwrite_observables=false and new observables are provided, the resulting set of observables will contain both the previous and the new observables. Otherwise, the list of observables will be overwritten by the new one (default: true).

overwrite_tags

boolean

If ?overwrite_tags=false and new meta.tags are provided, the resulting set of meta.tags will contain both the previous and the new tags. Otherwise, the list of tags will be overwritten by the new one (default: true).

overwrite_datasets

boolean

If ?overwrite_datasets=false and new datasets references are provided, the resulting set of datasets will contain both the previous and the new datasets. Otherwise, the list of datasets will be overwritten by the new one (default: true).

overwrite_taxonomies

boolean

If ?overwrite_taxonomies=false and new taxonomies are provided, the resulting set of taxonomies will contain both the previous and the new taxonomies. Otherwise, the list of taxonomies will be overwritten by the new one (default: true).

overwrite_attacks

boolean

If ?overwrite_attacks=false and new attacks are provided, the resulting set of attacks will contain both the previous and the new attacks. Otherwise, the list of attacks will be overwritten by the new one (default: true).

Body Params

data

object

Responses

200The updated object

400Invalid request

401Unauthorized request

403Missing permissions

404An individual resource was not found.