Jump to Content
Home
Guides
API Reference
Changelog
v1.0
v2.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Stable
Home
Guides
API Reference
Changelog
Download a file by ID.
Search
JUMP TO
EclecticIQ Platform API
MITRE Attacks
Get a list of MITRE Attacks.
get
Get MITRE Attack by ID.
get
Datasets
Delete a set of datasets referenced by IDs.
delete
Get a list of datasets.
get
Create a dataset.
post
Create (or update if the name already exists) one or more datasets.
put
Delete a dataset.
delete
Get a dataset by ID.
get
Update a dataset.
patch
Enrichers
Get a list of enrichers.
get
Create a new enricher.
post
Create (or modify if the name already exists) one or more enrichers.
put
Enriches all given extracts and/or entities with a list of enrichers or with all available enrichers (if `enricher_tasks` is empty). If a list entities is provided, all entity extracts are enriched.
post
Get an enricher by ID.
get
Modify an enricher.
patch
Entities
Delete a set of entities referenced by internal or STIX IDs.
delete
Get a list of entities.
get
Create an entity.
post
Create (or update/create a new version if the STIX ID already exists) one or more entities.
put
Delete an entity by ID.
delete
Get an entity by ID.
get
Update an entity by ID.
patch
Files
Delete a set of attachments referenced by IDs.
delete
Get a list of entity attachments.
get
Create a new entity.
post
Delete an entity attachment by ID.
delete
Get an entity attachment by ID.
get
Download an entity attachment by ID.
get
Delete a set of files referenced by IDs.
delete
Get a list of workspace files.
get
Create a new file in a workspace.
post
Delete a workspace file by ID.
delete
Get a workspace file by ID.
get
Download a file by ID.
get
Groups
Delete a set of groups referenced by IDs.
delete
Returns a list of the groups on the platform.
get
Create a group.
post
Create (or modify if the name already exists) one or more groups.
put
Delete a group by ID.
delete
Get a group by ID.
get
Update a group.
patch
Incoming feeds
Delete a set of incoming feeds referenced by IDs.
delete
Get a list of incoming feeds.
get
Configure a new incoming feed. Depending on the content type it will be required to provide additional transport configuration fields. For more details see the documentation
post
Create (or update if the name already exists) an incoming feed.
put
Delete an incoming feed configuration by ID.
delete
Get an incoming feed by ID.
get
Edit an incoming feed configuration by ID.
patch
Knowledge Packs
Returns a list of knowledge packs.
get
Create a new knowledge pack.
post
Create (or modify if already exists) one or more knowledge packs.
put
Delete a knowledge pack as publisher.
delete
Get a Knowledge Pack by ID.
get
Update a knowledge pack.
patch
Observables
Delete a set of observables referenced by IDs.
delete
Get a list of observables.
get
Create a new observable.
post
Create (or update if the (`type`, `value`) pair already exists) one or more observables.
put
Delete an observable by ID.
delete
Get an observable by ID.
get
Edit an observable by ID.
patch
Outgoing feeds
Delete a set of outgoing feeds referenced by IDs.
delete
Get a list of outgoing feeds.
get
Configure a new outgoing feed. Depending on the content type it will be required to provide additional transport configuration fields. For more details see the documentation
post
Create (or update if the name already exists) one or more outgoing feeds.
put
Delete an outgoing feed configuration by ID.
delete
Get an outgoing feed by ID.
get
Edit an outgoing feed configuration by ID.
patch
Permissions
Returns a list of permissions on the platform.
get
Get a user permission by ID.
get
Relationships
Delete relationships based on source and/or target.
delete
Get a list of relationships.
get
Create a relationship.
post
Delete a relationship by ID.
delete
Get a relationship by ID.
get
Roles
Delete a set of roles referenced by IDs.
delete
Returns a list of roles on the platform.
get
Create a role.
post
Create (or modify if the name already exists) one or more roles.
put
Delete a role by ID.
delete
Get a role by ID.
get
Update a role.
patch
Discovery Rules
Delete a set of discovery_rules referenced by IDs.
delete
Get a list of discovery rules.
get
Create a new discovery rule.
post
Create (or update if the name already exists) one or more discovery rules.
put
Delete an discovery rule by ID.
delete
Get an discovery rule by ID.
get
Edit an discovery rule by ID.
patch
Enrichment Rules
Delete a set of enrichment rules referenced by IDs.
delete
Get a list of enrichment rules.
get
Create a new enrichment rule.
post
Create (or update if the name already exists) one or more enrichment rules.
put
Delete an enrichment rule by ID.
delete
Get an enrichment rule by ID.
get
Edit an enrichment rule by ID.
patch
Entity Rules
Delete a set of entity rules referenced by IDs.
delete
Get a list of entity rules.
get
Create a new entity rule.
post
Create (or update if the name already exists) one or more entity rules.
put
Delete an entity rule by ID.
delete
Get an entity rule by ID.
get
Edit an entity rule by ID.
patch
Observable Rules
Delete a set of observable rules referenced by IDs.
delete
Get a list of observable rules.
get
Create a new observable rule.
post
Create (or update if the name already exists) one or more observable rules.
put
Delete an observable rule by ID.
delete
Get an observable rule by ID.
get
Edit an observable rule by ID.
patch
Sources
Get a list of all sources.
get
Get an source by ID.
get
Tasks
Get a list of tasks.
get
Get a list of task runs.
get
Run a task.
post
Stop a task execution by task run ID.
delete
Get a task run by ID.
get
Get a task by ID.
get
Edit a task by ID.
patch
Taxonomies
Delete a set of taxonomies nodes referenced by IDs.
delete
Get a list of taxonomies.
get
Create taxonomy nodes by specifying a single node or a node path.
post
Create taxonomy nodes by specifying a single node or a node path.
put
Delete a taxonomy node or a sub-tree.
delete
Get a taxonomy node by ID.
get
Update a taxonomy node.
patch
Tickets
Delete a set of tickets referenced by IDs.
delete
Get a list of all tickets.
get
Create a ticket.
post
Delete a ticket by ID.
delete
Get a ticket by ID.
get
Update a ticket by ID.
patch
Ticket Comments
Get a ticket comment by ID.
get
Create a comment on a ticket.
post
Users
Returns a list of users on the platform.
get
Create a user.
post
Create (or update if the name already exists) one or more users.
put
Get a user by ID.
get
Update a user.
patch
Workspaces
Delete a set of workspaces referenced by IDs.
delete
Get a list of workspaces.
get
Create a new workspace.
post
Create (or update if the name already exists) one or more workspaces.
put
Delete a workspace by ID.
delete
Get a workspace by ID.
get
Edit a workspace by ID.
patch
Workspace Comments
Delete a set of workspace comments referenced by IDs.
delete
Delete a workspace comment by ID.
delete
Get a workspace comment by ID.
get
Modify a workspace comment by ID.
patch
Get the content of the comments of a workspace.
get
Create a new workspace comment.
post
Relation
Generic endpoint for bulk deleting relations based on "main object" type and id and related objects type and ids (provided in request body).
delete
Generic endpoint for bulk adding relations based on "main object" type and id and related objects type and ids (provided in request body).
put
Generic endpoint for deleting a relation based on "main object" type and id and related object type and id.
delete
Generic endpoint for adding a relation based on "main object" type and id and related object type and id.
put
Powered by
Download a file by ID.
get
http://localhost/api/v1/files/
{id}
/download
Required permissions
read files
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!