Jump to Content
Home
Guides
Blueprints
Community
Changelog
API Reference
Get support
Home
Guides
API Reference
Changelog
Community
Home
Guides
Blueprints
Community
Changelog
API Reference
Get support
Log In
API Reference
Log In
API Reference
Get Agent by id
Search
All
Pages
Start typing to search…
JUMP TO
Agent endpoints
resources
Get agents file list
get
Get agents file content
get
task
Get Agent task by id
get
Update Agent task by id
patch
register
Register new Agent
post
My endpoints
administration
Get administration configurations
get
audit
List my Audit records
get
Create Audit record
post
bulletins
List my Bulletins by workspace
get
Get bulletin
get
Aknowledge Bulletin by key
post
locales
List Locale
get
logoff
User Logoff
get
notifications
List my Notifications
get
Bulk notifications, update notification
put
Update Notification by id
put
processes
List my Processes
get
Get Process by id
get
Get Process status
get
Get Process state
get
Get process output
get
Get process state
get
Update Process state
put
Start (Create) Process by workflow key
post
Updates Process status
put
Signal Process
put
settings
Get my Settings
get
Update my Settings
post
shortcuts
List my Shortcuts
get
Create (or update) Shortcut
post
List my Shortcuts by workspace
get
Delete Shortcut by key
del
Update (or create) Shortcut by key
put
strings
Get user strings by locale
get
Get user strings timestamp
get
users
List Users
get
workspaces
List my Workspaces
get
Create (or update) Workspace
post
Get Workspace by slug
get
Delete Workspace by slug
del
Update (or create) Workspace by slug
put
Get Workspace tag cloud by slug
get
config
Get settings
get
Get settings timestamp
get
Get settings by key
get
dashboards
Get Dashboard by slug
get
forms
Get Form by slug
get
Submit Form by slug
post
Submit Form by slug
put
Submit Form by slug and path
put
guides
Get Guide by slug
get
items
Search Items by workspace
get
Get Item by workspace
get
Export workspace items
get
List events by workspace item
get
Create (or update) event
post
options
List Options by tags
get
List Options by tags
get
resources
Get my dashboards list
get
Get my forms list
get
workflows
Get Workflow by key
get
Get Workflow BPMN contents
get
Short running synchrone (non persistent) workflows that runs max 5 minutes
post
agent
Get Agent task result
get
Create (or update) event
post
Get Agent task result
get
Get Agent task result
get
Update Agent task by id
put
Get Agent task meta
get
Get Agent task meta key
get
login
User Login
post
connector
Run Pipeline
post
Setup endpoints
database
List Indexes
get
Delete Indexes
del
List Backups
get
Backup Indexes
post
Export Configuration
get
Export Configuration
get
List attribute mappings for items
get
Copy Indexes
post
Initialize Indexes
post
Migrate Indexes
post
Reindex Indexes
post
Upgrade Indexes
post
Import Configuration
post
Restore Backups
post
Remove old backup and upgrade indexes
del
Delete Backup
del
Update mappings
put
Tools endpoints
logs
Get logs
get
Error logging
post
docs
Get documentation by path
get
elastic
Elasticsearch query tool to get data
get
Elasticsearch query tool to update data
post
Elasticsearch query tool to update data
put
Elasticsearch query tool to update data
patch
encrypt
Encrypt string
post
sendmail
Send Email
post
Admin endpoints
agents
List Agents
get
Create new Agent
post
List Agents tasks
get
Delete Agents tasks by query
del
Get Agent by id
get
Delete Agent by id
del
Update (or create) Agent
put
Update (partial) Agent
patch
Get Aget task by id
get
Delete Agent task by id
del
Get Agent status
get
audit
List Audit records
get
Create Audit record
post
Delete Audit record
del
Export Audit records
get
Import Audit records
post
bulletins
List Bulletins
get
Create (or update) Bulletin
post
Get Bulletin by key
get
Delete Bulletin by key
del
Update (or create) Bulletin by key
put
dashboards
List Dashboards
get
Create (or update) Dashboard
post
Get Dashboard by slug
get
Delete Dashboard by slug
del
Update (or create) Dashboard by slug
put
domains
List Domains
get
Create (or update) Domain
post
Get Domain by key
get
Delete Domain by key
del
Update (or create) Domain
put
Get Domain by name
get
events
List events
get
Create (or update) event
post
Delete event by query
del
Export events
get
Get events by id
get
Delete event by id
del
files
List temporary files
get
Get temporary file by id
get
forms
List Forms
get
Create (or update) Form
post
Get Form by slug
get
Delete Form by slug
del
Update (or create) Form by slug
put
guides
List Guides
get
Create (or update) Guides
post
Get guide by slug
get
Delete Guide by slug
del
Update (or create) Guide by slug
put
instances
Onify Hub instances
get
Onify Hub instances
get
items
List items
get
Create (or update) Item
post
Delete items by query
del
Export Items
get
Get Item by key
get
Delete Item by key
del
Update (or create) Item
put
Update (partial) Item
patch
Bulk Create Items
post
Bulk replace items
put
Bulk update items
patch
Bulk Delete Items
del
Delete Item action by id
del
Patch item action by id
patch
locales
List Locales
get
Create (or update) Locale
post
Get Locale by key
get
Delete Locale by key
del
Update (or create) Locale
put
notifications
List Notifications
get
Create (or update) Notification
post
Remove notifications by query
del
Get Notification by id
get
Delete Notification by id
del
Update (or create) Notification by id
put
options
List Options
get
Create (or update) Option
post
Get Option by key
get
Delete Option by key
del
Update (or create) Option
put
Update (partial) Option by key
patch
Bulk Create Options
post
Bulk Update Options
put
Bulk Delete Options by tags
del
processes
List Processes
get
Delete Processes by query
del
Export Processes
get
Get Process by id
get
Delete Process by id
del
Update (partial) Process by id
put
Get Process flowstate by id
get
Get Process bpmn
get
Get Process by id
get
Get Process by id
get
Start (Create) Process by workflow key
post
Remove completed processes data by query
del
Remove completed process data
del
Signal Process
put
resources
Get resources list
get
Create resources directory
post
Delete resources directory
del
Get file content
get
Create file
post
Delete resource by path
del
Get commits history
get
Get resources status
get
Sync local/cached files with git
post
Save file
post
Save file
put
roles
List Roles
get
Create (or update) Role
post
Get Role by key
get
Delete Role by key
del
Update (or create) Role by key
put
shortcuts
List shortcuts
get
Create (or update) Shortcut
post
Get Shortcut by key
get
Delete Shortcut by key
del
Update (or create) Shortcut by key
put
strings
List strings
get
Create (or update) string
post
Export strings
get
Get strings by id
get
Delete strings by id
del
Create (or update) string
put
Update (partial) string
patch
Import strings
post
users
List Users
get
Create (or update) User
post
Get User by key
get
Delete User by key
del
Update (or create) User by key
put
Update (partial) User by key
patch
Login user via SSO
post
workflows
List Workflows
get
Create (or update) Workflow
post
Get Workflow by key
get
Delete Workflow by key
del
Update (or create) Workflow by key
put
workspaces
List Workspaces
get
Create (or update) Workspace
post
Get Workspace by slug
get
Delete Workspace by slug
del
Update (or create) Workspace
put
config
Get settings list
get
Create (or update) settings
post
Get settings by key
get
Delete settings by key
del
Update (or create) settings by key
put
connector
List connector pipelines
get
Create new pipelines
post
List connector data source files
get
Create new data source file
post
List connector data source ldap
get
Create new data source ldap
post
List connector data source rests
get
Create new data source rest
post
List connector data source sql
get
Create new data source sql
post
Get connector pipelines by key
get
Delete connector pipelines by key
del
Create or update pipelines
put
List connector tasks index
get
Create new task index
post
List connector tasks purges
get
Create new task purge
post
List connector tasks readers
get
Create new task reader
post
List connector tasks scripts
get
Create new task script
post
List connector tasks transforms
get
Create new task transform
post
Get connector data source file by id
get
Delete connector data source file by id
del
Create or update data source file
put
Get connector data source ldap by id
get
Delete connector data source ldap by id
del
Create or update data source ldap
put
Get connector data source rest by id
get
Delete connector data source rest by id
del
Create or update data source rest
put
Get connector data source sql by id
get
Delete connector data source sql by id
del
Create or update data source sql
put
Export Pipleline including datasources and tasks
get
Get connector task index by id
get
Delete connector task index by id
del
Create or update tasks index
put
Get connector task purge by id
get
Delete connector task purge by id
del
Create or update tasks purge
put
Get connector task reader by id
get
Delete connector task reader by id
del
Create or update tasks reader
put
Get connector task script by id
get
Delete connector task script by id
del
Create or update tasks script
put
Get connector task transform by id
get
Delete connector task transform by id
del
Create or update tasks transform
put
Import Pipleline including datasources and tasks
post
Execute Pipeline
post
bulk
Bulk items, creates item and index
post
Bulk update (and create) items, update item and replace matching properties
put
Bulk patch items, tags and actions will be added or replaced
patch
Bulk notifications, creates notification and index
post
Bulk options, creates options and index
post
Bulk update options, update option and replace matching properties
put
Bulk patch options, tags locales and roles will be added or replaced
patch
Bulk transform file into items, creates item and index
post
import
Imports settings
post
Public endpoints
resources
Get public files list
get
Get public files
get
settings
Get public settings
get
strings
Get public strings
get
Files endpoints
private
Get private temporary file
get
Create private temporary file
post
public
Get public temporary file
get
Create public temporary file
post
{access}
Delete temporary file
del
Powered by
Get Agent by id
get
http://dev-api.onify.net/api/v2/admin/agents/
{id}
Language
Shell
Node
Ruby
PHP
Python
