Get a list of relationships.

get

http://localhost/api/v1/relationships

Required permissions

Query Params

limit

int32

≥ 1

Maximum number of items to be returned

offset

int32

≥ 0

Return results starting from the specified (zero-based) index

sort

string

Comma-separated list of fields to sort on. Prefix a field with the minus "-" sign if you intend to apply descending sorting to it

data

boolean

Set this parameter to false if you want to only retrieve the number of objects matching the query

attributes

string

Comma-separated list of attributes to be returned. Nested attributes are separated by dots - e.g. data.title

filter[key]

string

Filter by EIQ JSON relation type.

filter[subtype]

string

Filter by EIQ JSON relation subtype (e.g. stix_update_of).

filter[id]

string

Filter by relation STIX ID

filter[data.source]

string

Filter by source entity internal or STIX ID

filter[data.target]

string

Filter by target entity internal or STIX ID

Responses

Language

Credentials

Bearer

JWT

Response

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

application/json

200The requested object(s)