Generic endpoint for bulk adding relations based on "main object" type and id and related objects type and ids (provided in request body).

put https://ic-playground.eclecticiq.com/api/v2/{object_type}/{object_id}/{relation_type}

Path Params

object_type

string

required

Main object type.
Pattern "[a-zA-Z_-]+"

object_id

string

required

Main object ID.
Pattern "[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}|[0-9]+|TA[0-9]+:T[0-9]+(.[0-9]+)?"

relation_type

string

required

Related object type. These are valid values for specific object types:
entities: taxonomies, attacks, datasets, observables, attachments
outgoing-feeds: whitelistsources, datasets, whitelist_taxonomy_nodes
groups: sources, users
knowledge-packs: datasets, incoming_feeds, workspaces
observables: entities
roles: permissions, users
taxonomies: children
tickets: entities, stakeholders, workspaces
users: groups, roles
workspaces: datasets, entities, discovery_tasks, files, tickets, collaborators, groups
entity_rules: taxonomies, datasets
Pattern [a-zA-Z-]+

Body Params

data

array of strings

data

Responses

201

Relations added successfully.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://ic-playground.eclecticiq.com/api/v2/entities/object_id/relation_type \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Unauthorized request

403Missing permissions

404An individual resource was not found.