Skip to content

Resources


Resources are the objects you store and manage in Everysk: portfolios, datastores, workflows, reports and so on. Each one has its own page describing the object and the operations it supports.

Most resources follow the same pattern:

Operation Request
Create POST /<resource>
List GET /<resource>
Retrieve GET /<resource>/:id
Update PUT /<resource>/:id
Delete DELETE /<resource>/:id

Portfolios, datastores, files, reports, report templates and workflows take the workspace parameter. For GET and DELETE, send it in the query string. For POST and PUT, send it in the JSON body. List requests are paginated.


Available resources


Not every resource supports every operation. Some also add operations of their own, like running a workflow or sharing a report.

Resource Path Operations
Portfolio /portfolios Create, List, Retrieve, Update, Delete
Datastore /datastores Create, List, Retrieve, Update, Delete
File /files Create, List, Retrieve, Update, Delete
Custom Index /custom_indexes Create, List, Retrieve, Update, Delete
Private Security /private_securities Create, List, Retrieve, Update, Delete
Workflow /workflows List, Retrieve, Run, Delete
Workflow Execution /workflows/:id/workflow_executions List, Retrieve
Worker Template /worker_templates List, Retrieve
Worker Execution /workflows/:id/worker_executions List, Retrieve
Webhook /integrations/:id/webhook Send
Report /reports Create, List, Filter, Retrieve, Update, Share, Email, Delete
Report Template /report_templates List, Retrieve, Delete
User App /user_apps Create, List, Retrieve, Update, Delete
Workspace /workspaces Create, List, Retrieve, Update, Delete
Audit Log /audit_logs List, Retrieve