Edit on GitHub
6.1.0.0link
Activate, Refresh, and Compare Interfacelink
Click here to see all end points in this interface.
Check replication activation status of channelslink
GET /api/v6.1/hubs/{hub}/activate
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Check replication activation status of channellink
GET /api/v6.1/hubs/{hub}/channels/{channel}/activate
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Post an Hvr activate eventlink
POST /api/v6.1/hubs/{hub}/channels/{channel}/activate
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventActivate |
|
Post Compare event and schedule a job for itlink
POST /api/v6.1/hubs/{hub}/channels/{channel}/compare
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request
- STATUS 403 Forbidden: User does not have Exec access
Required Permissions
- ReadExec access level on hub
Events
Creates the following eventCompare |
|
Get event ids for tables results of recent Comparelink
GET /api/v6.1/hubs/{hub}/channels/{channel}/compare/tables_results_ids
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Show contexts and context variableslink
GET /api/v6.1/hubs/{hub}/channels/{channel}/contexts
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadOnly access level on hub
Post an Hvr deactivate eventlink
POST /api/v6.1/hubs/{hub}/channels/{channel}/deactivate
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDeactivate |
|
Show open transactionslink
GET /api/v6.1/hubs/{hub}/channels/{channel}/locs/{loc}/capture_open_tx
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Show integrate pointlink
GET /api/v6.1/hubs/{hub}/channels/{channel}/locs/{loc}/integrate_point
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or Location does not exist
Required Permissions
- ReadOnly access level on hub
Suggest slicing, based on old table results and Oracle DBMS statslink
POST /api/v6.1/hubs/{hub}/channels/{channel}/locs/{loc}/slicing_suggest
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel, location or table does not exist
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Suggest slicing boundaries based on Oracle DBMS stats. Can return emptylink
POST /api/v6.1/hubs/{hub}/channels/{channel}/locs/{loc}/tables/{table}/slicing_boundaries
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel, location, table or column does not exist
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Post Refresh event and schedule a job for itlink
POST /api/v6.1/hubs/{hub}/channels/{channel}/refresh
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request
- STATUS 403 Forbidden: User does not have Write or Refresh access
Required Permissions
- ReadExecRefresh access level on hub
Events
Creates the following eventRefresh |
|
Get event ids for tables results of recent Refreshlink
GET /api/v6.1/hubs/{hub}/channels/{channel}/refresh/tables_results_ids
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Get event ids for tables results of recent Compare for all channelslink
GET /api/v6.1/hubs/{hub}/compare/tables_results_ids
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Check replication activation status of loclink
GET /api/v6.1/hubs/{hub}/locs/{loc}/activate
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Get event ids for tables results of recent Refresh for all channelslink
GET /api/v6.1/hubs/{hub}/refresh/tables_results_ids
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Agent Configuration Interfacelink
Click here to see all end points in this interface.
Detect whether hub may (re)configure agent of existing locationlink
GET /api/v6.1/hubs/{hub}/locs/{loc}/agent
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The requested hub or location does not exist
Required Permissions
- ReadOnly access level on hub
Delete agent properties of existing locationlink
POST /api/v6.1/hubs/{hub}/locs/{loc}/agent/props_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_Properties_Delete |
|
Get agent properties of existing locationlink
POST /api/v6.1/hubs/{hub}/locs/{loc}/agent/props_get
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates no events.Update agent properties of existing locationlink
POST /api/v6.1/hubs/{hub}/locs/{loc}/agent/props_patch
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_Properties_Change |
|
Set/reset agent properties of existing locationlink
POST /api/v6.1/hubs/{hub}/locs/{loc}/agent/props_put
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_Properties_Set |
|
Discover agent loc props of existing locationlink
POST /api/v6.1/hubs/{hub}/locs/{loc}/agent/test
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Create user on agent for existing locationlink
POST /api/v6.1/hubs/{hub}/locs/{loc}/agent/users
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_User_Create |
|
Delete user on agent for existing locationlink
POST /api/v6.1/hubs/{hub}/locs/{loc}/agent/users_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_User_Delete |
|
Get list of users on existing agentlink
POST /api/v6.1/hubs/{hub}/locs/{loc}/agent/users_get
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates no events.Change password of local user on agent for existing locationlink
POST /api/v6.1/hubs/{hub}/locs/{loc}/agent/users_password
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_User_Password_Change |
|
Delete agent properties of new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/agent/props_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: Error connecting to location specified by 'loc_props'
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_Properties_Delete |
|
Get agent properties of new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/agent/props_get
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: Error connecting to location specified by 'loc_props'
Required Permissions
- ReadWrite access level on hub
Events
Creates no events.Update agent properties of new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/agent/props_patch
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: Error connecting to location specified by 'loc_props'
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_Properties_Change |
|
Set/reset agent properties of new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/agent/props_put
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: Error connecting to location specified by 'loc_props'
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_Properties_Set |
|
Discover agent loc props of new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/agent/test
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: Error connecting to location specified by 'loc_props'
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Create user on agent for new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/agent/users
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: Error connecting to location specified by 'loc_props'
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_User_Create |
|
Delete user on agent for new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/agent/users_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: Error connecting to location specified by 'loc_props'
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_User_Delete |
|
Get list of users on new agentlink
POST /api/v6.1/hubs/{hub}/new_loc/agent/users_get
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: Error connecting to location specified by 'loc_props'
Required Permissions
- ReadWrite access level on hub
Events
Creates no events.Change password of local user on agent for new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/agent/users_password
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: Error connecting to location specified by 'loc_props'
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAgent_User_Password_Change |
|
Detect whether hub may (re)configure agent of new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/agent_get
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The requested hub does not exist
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Alert Interfacelink
Click here to see all end points in this interface.
List configured alertslink
GET /api/v6.1/hubs/{hub}/alerts
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Hub not found
Required Permissions
- ReadOnly access level on hub
Create alert configurationlink
POST /api/v6.1/hubs/{hub}/alerts
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request: Alert already exists
- STATUS 404 Not Found: Hub not found
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAlert_Create |
|
Delete alert configurationlink
DELETE /api/v6.1/hubs/{hub}/alerts/{alert}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Hub or Alert not found
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAlert_Delete |
|
Clear alert statelink
POST /api/v6.1/hubs/{hub}/alerts/{alert}/clear
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Hub or Alert not found
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAlert_Clear |
|
Disable an alert configurationlink
POST /api/v6.1/hubs/{hub}/alerts/{alert}/disable
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Hub or Alert not found
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAlert_Disable |
|
Execute alert configuration nowlink
POST /api/v6.1/hubs/{hub}/alerts/{alert}/execute
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is plain text |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Hub not found
Required Permissions
- ReadExec access level on hub
Events
Creates the following eventAlert_Notification |
|
Get alert configuration propertieslink
GET /api/v6.1/hubs/{hub}/alerts/{alert}/props
Query parameter prototype: |
|
Request headers prototype: |
|
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: Specified property does not exist
- STATUS 404 Not Found: Hub or Alert not found
Required Permissions
- ReadOnly access level on hub
Modify alert configuration propertieslink
PATCH /api/v6.1/hubs/{hub}/alerts/{alert}/props
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Hub or Alert not found
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAlert_Property_Change |
|
Replace all alert configuration propertieslink
PUT /api/v6.1/hubs/{hub}/alerts/{alert}/props
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Hub or Alert not found
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAlert_Property_Set |
|
Delete alert configuration propertieslink
POST /api/v6.1/hubs/{hub}/alerts/{alert}/props_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Hub or Alert not found
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventAlert_Property_Delete |
|
Send test alert notificationslink
POST /api/v6.1/hubs/{hub}/alerts/{alert}/test
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is plain text |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Hub not found
Required Permissions
- ReadExec access level on hub
Events
Creates no events.Control Message Interfacelink
Click here to see all end points in this interface.
Get all control ids matched by the querylink
GET /api/v6.1/hubs/{hub}/channels/{channel}/controls
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: not found hub or channel
Required Permissions
- ReadOnly access level on hub
Get the control associated with the idlink
GET /api/v6.1/hubs/{hub}/channels/{channel}/controls/{ctrl_id}
No query parameters | |
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: not found hub or channel or control
Required Permissions
- ReadOnly access level on hub
Delete all the controls matched.link
POST /api/v6.1/hubs/{hub}/channels/{channel}/controls_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The control does not exist.
Required Permissions
- ReadExec access level on hub
Events
Creates the following eventControl_Delete |
|
Send a new control filelink
POST /api/v6.1/hubs/{hub}/channels/{channel}/locs/{loc}/tasks/{task}/controls
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventControl_Send |
|
Definition Interfacelink
Click here to see all end points in this interface.
Fetch hub definitionlink
GET /api/v6.1/hubs/{hub}/definition
Query parameter prototype: |
|
Request headers prototype: |
|
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Modify scope or parameters of actionlink
POST /api/v6.1/hubs/{hub}/definition/action_modify
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Action does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Replace actionlink
POST /api/v6.1/hubs/{hub}/definition/action_replace
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Action does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch definition changes from eventslink
GET /api/v6.1/hubs/{hub}/definition/change/events
Query parameter prototype: |
|
Request headers prototype: |
|
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Fetch channels from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/channels
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Channels fetched
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Add channellink
POST /api/v6.1/hubs/{hub}/definition/channels
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request: Channel already exists
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete channellink
DELETE /api/v6.1/hubs/{hub}/definition/channels/{channel}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch channel from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/channels/{channel}
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Channel fetched
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadOnly access level on hub
Modify channellink
PATCH /api/v6.1/hubs/{hub}/definition/channels/{channel}
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Add or replace channellink
PUT /api/v6.1/hubs/{hub}/definition/channels/{channel}
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch channel actions from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/channels/{channel}/actions
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Definition info fetched
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadOnly access level on hub
Add channel actionslink
PATCH /api/v6.1/hubs/{hub}/definition/channels/{channel}/actions
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Replace channel actions listlink
PUT /api/v6.1/hubs/{hub}/definition/channels/{channel}/actions
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete channel actionslink
POST /api/v6.1/hubs/{hub}/definition/channels/{channel}/actions_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch location groups from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/channels/{channel}/loc_groups
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Location groups fetched
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadOnly access level on hub
Add location grouplink
POST /api/v6.1/hubs/{hub}/definition/channels/{channel}/loc_groups
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request: Location group already exists
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete location grouplink
DELETE /api/v6.1/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or location group does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch location group from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Location group fetched
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or location group does not exist
Required Permissions
- ReadOnly access level on hub
Add or replace location grouplink
PUT /api/v6.1/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch location group members from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/members
No query parameters | |
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Location group members fetched
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or location group does not exist
Required Permissions
- ReadOnly access level on hub
Add location group members or move members from other location groups in channellink
PATCH /api/v6.1/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/members
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or location group does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Replace location group members listlink
PUT /api/v6.1/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/members
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or location group does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete location group memberlink
DELETE /api/v6.1/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/members/{member}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or location group does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete location group memberslink
POST /api/v6.1/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/members_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or location group does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Rename location grouplink
POST /api/v6.1/hubs/{hub}/definition/channels/{channel}/loc_groups/{loc_group}/rename
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request: New location group already exists
- STATUS 404 Not Found: Channel or old location group does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Rename channellink
POST /api/v6.1/hubs/{hub}/definition/channels/{channel}/rename
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request: New channel already exists
- STATUS 404 Not Found: Old channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch tables from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Tables fetched
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadOnly access level on hub
Add and replace tableslink
PATCH /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Add tablelink
POST /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request: Table already exists
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Replace tables listlink
PUT /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete tablelink
DELETE /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables/{table}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or table does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch table from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables/{table}
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Table fetched
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or table does not exist
Required Permissions
- ReadOnly access level on hub
Modify tablelink
PATCH /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables/{table}
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Add or replace tablelink
PUT /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables/{table}
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch columns from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables/{table}/cols
No query parameters | |
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Columns fetched
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or table does not exist
Required Permissions
- ReadOnly access level on hub
Add and replace columnslink
PATCH /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables/{table}/cols
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or table does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Replace columns listlink
PUT /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables/{table}/cols
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or table does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete columnslink
POST /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables/{table}/cols_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel or table does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Rename tablelink
POST /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables/{table}/rename
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request: New table already exists
- STATUS 404 Not Found: Channel or old table does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete tableslink
POST /api/v6.1/hubs/{hub}/definition/channels/{channel}/tables_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch hub actions from definitionlink
GET /api/v6.1/hubs/{hub}/definition/hub_actions
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Hub actions fetched
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Add hub actionslink
PATCH /api/v6.1/hubs/{hub}/definition/hub_actions
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Replace hub actions listlink
PUT /api/v6.1/hubs/{hub}/definition/hub_actions
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete hub actionslink
POST /api/v6.1/hubs/{hub}/definition/hub_actions_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Import set of definition changeslink
POST /api/v6.1/hubs/{hub}/definition/import
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change_Import |
|
Analyze set of definition changes for importlink
POST /api/v6.1/hubs/{hub}/definition/import/analyze
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Fetch locations from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/locs
Query parameter prototype: |
|
Request headers prototype: |
|
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Locations fetched
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Add locationlink
POST /api/v6.1/hubs/{hub}/definition/locs
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request: Location already exists
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete locationlink
DELETE /api/v6.1/hubs/{hub}/definition/locs/{loc}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch location from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/locs/{loc}
Query parameter prototype: |
|
Request headers prototype: |
|
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Location fetched
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadOnly access level on hub
Add or replace locationlink
PUT /api/v6.1/hubs/{hub}/definition/locs/{loc}
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch location actions from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/locs/{loc}/actions
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Location actions fetched
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadOnly access level on hub
Add location actionslink
PATCH /api/v6.1/hubs/{hub}/definition/locs/{loc}/actions
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Replace location actions listlink
PUT /api/v6.1/hubs/{hub}/definition/locs/{loc}/actions
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete location actionslink
POST /api/v6.1/hubs/{hub}/definition/locs/{loc}/actions_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Copy locationlink
POST /api/v6.1/hubs/{hub}/definition/locs/{loc}/copy
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request: New location already exists
- STATUS 404 Not Found: Old location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Fetch location properties from hub definitionlink
GET /api/v6.1/hubs/{hub}/definition/locs/{loc}/props
No query parameters | |
Request headers prototype: |
|
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: Location properties fetched
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadOnly access level on hub
Modify location propertieslink
PATCH /api/v6.1/hubs/{hub}/definition/locs/{loc}/props
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete location propertylink
DELETE /api/v6.1/hubs/{hub}/definition/locs/{loc}/props/{prop}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Delete location propertieslink
POST /api/v6.1/hubs/{hub}/definition/locs/{loc}/props_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Rename locationlink
POST /api/v6.1/hubs/{hub}/definition/locs/{loc}/rename
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request: New location already exists
- STATUS 404 Not Found: Old location does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventDefinition_Change |
|
Encryption Interfacelink
Click here to see all end points in this interface.
Create new encryption walletlink
POST /api/v6.1/wallet
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates one or more of the following eventsReencrypt_Secrets |
|
Wallet_Create |
|
Change reference to existing walletlink
POST /api/v6.1/wallet/change
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: No wallet configured
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventWallet_Change |
|
Disable encryption walletlink
POST /api/v6.1/wallet/disable
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: No wallet configured or already disabled
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates one or more of the following eventsReencrypt_Secrets |
|
Wallet_Disable |
|
Delete historical encryption keyslink
POST /api/v6.1/wallet/key_history_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: No wallet configured
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventWallet_Key_History_Delete |
|
Rotate encryption keyslink
POST /api/v6.1/wallet/key_rotate
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: No wallet configured
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates one or more of the following eventsReencrypt_Secrets |
|
Wallet_Key_Rotation |
|
Migrate to a new wallet configuration gracefullylink
POST /api/v6.1/wallet/migrate
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: No wallet configured
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates one or more of the following eventsReencrypt_Secrets |
|
Wallet_Migrate |
|
Get wallet propertieslink
GET /api/v6.1/wallet/props
Query parameter prototype: |
|
Request headers prototype: |
|
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: No wallet configured
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Continue previous re-encryption operationlink
POST /api/v6.1/wallet/reencrypt_continue
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventReencrypt_Secrets |
|
Event Interfacelink
Click here to see all end points in this interface.
Get all unique channels from hvr_eventlink
GET /api/v6.1/hubs/{hub}/event_channels
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Get all unique locations from hvr_eventlink
GET /api/v6.1/hubs/{hub}/event_locs
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Get all unique event types from hvr_eventlink
GET /api/v6.1/hubs/{hub}/event_types
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Fetch event(s)link
GET /api/v6.1/hubs/{hub}/events
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Get log file content during a specified eventlink
GET /api/v6.1/hubs/{hub}/events/{ev_id}/log
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is plain text |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The specified event can not be found
Required Permissions
- ReadOnly access level on hub
Cancel events. Associated jobs will be suspendedlink
POST /api/v6.1/hubs/{hub}/events_cancel
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: Only events in 'ACTIVE' state can be canceled
- STATUS 404 Not Found: Event does not exist
Required Permissions
- ReadExec access level on hub
Events
Creates the following eventEvent_Cancel |
|
Get all unique event types for reposlink
GET /api/v6.1/repos/event_types
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
Fetch the repository eventslink
GET /api/v6.1/repos/events
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
File and DB Browse Interfacelink
Click here to see all end points in this interface.
List files in a directory (hub)link
GET /api/v6.1/hubs/{hub}/dirs
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Directory does not exist
Required Permissions
- ReadWrite access level on hub
Show all schemas in databaselink
GET /api/v6.1/hubs/{hub}/locs/{loc}/db/schemas
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
List files in a directory on the locationlink
GET /api/v6.1/hubs/{hub}/locs/{loc}/dirs
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location or Directory does not exist
Required Permissions
- ReadWrite access level on hub
Get list of installed ODBC Data Source Names of the locationlink
GET /api/v6.1/hubs/{hub}/locs/{loc}/env/odbc_drivers
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Retrieve /etc/oratab or equivalent Windows registry values of the locationlink
GET /api/v6.1/hubs/{hub}/locs/{loc}/env/oratab
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Retrieve specified environment variables of the locationlink
GET /api/v6.1/hubs/{hub}/locs/{loc}/env/vars
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadWrite access level on hub
Test Location connectionlink
POST /api/v6.1/hubs/{hub}/locs/{loc}/test
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Location does not exist
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Show all schemas in new database locationlink
POST /api/v6.1/hubs/{hub}/new_loc/db/schemas
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.List files in a directory on the new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/dirs
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: Error connecting to location specified by 'props'
- STATUS 404 Not Found: Directory does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates no events.Get list of installed ODBC Data Source Names or the new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/env/odbc_drivers
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: Error connecting to location specified by 'props'
Required Permissions
- ReadWrite access level on hub
Events
Creates no events.Retrieve /etc/oratab or equivalent Windows registry values of the new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/env/oratab
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: Error connecting to location specified by 'props'
Required Permissions
- ReadWrite access level on hub
Events
Creates no events.Retrieve specified environment variables of the new locationlink
POST /api/v6.1/hubs/{hub}/new_loc/env/vars
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: Error connecting to location specified by 'props'
Required Permissions
- ReadWrite access level on hub
Events
Creates no events.Test Location connection propertieslink
POST /api/v6.1/hubs/{hub}/new_loc/test
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: Error connecting to location specified by 'props'
Required Permissions
- ReadWrite access level on hub
Events
Creates no events.List files in a directory (hubserver)link
GET /api/v6.1/hubserver/dirs
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 403 Forbidden
- STATUS 404 Not Found: Directory does not exist
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Get list of installed ODBC Data Source Names of the hub serverlink
GET /api/v6.1/hubserver/env/odbc_drivers
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 403 Forbidden
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Retrieve /etc/oratab or equivalent Windows registry values of the hub serverlink
GET /api/v6.1/hubserver/env/oratab
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 403 Forbidden
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Retrieve specified environment variables of the hub serverlink
GET /api/v6.1/hubserver/env/vars
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 403 Forbidden
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Verify (changes) to HubServer connection propertieslink
POST /api/v6.1/hubserver/props_test
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 403 Forbidden
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates no events.Test hubserver is working correctlylink
POST /api/v6.1/hubserver/test
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 403 Forbidden
Required Permissions
- No special permission required
- Available while Setup Mode is active.
Events
Creates no events.Hub Config Interfacelink
Click here to see all end points in this interface.
Fetch all hubs and their basic propertieslink
GET /api/v6.1/hubs
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
- Available while Setup Mode is active.
Create a new hublink
POST /api/v6.1/hubs
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: Hub already exists
Required Permissions
- HubCreation access level
- Available while Setup Mode is active.
Events
Creates the following eventHub_Create |
|
Delete hublink
DELETE /api/v6.1/hubs/{hub}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The requested hub does not exist
Required Permissions
- HubOwner access level on hub
Events
Creates the following eventHub_Delete |
|
Fetch basic hub propertieslink
GET /api/v6.1/hubs/{hub}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The requested hub does not exist
Required Permissions
- No special permission required
Changes the state of a hub to FROZENlink
POST /api/v6.1/hubs/{hub}/freeze
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content: The hub is now frozen
- STATUS 400 Bad Request
- STATUS 404 Not Found: The requested hub does not exist
Required Permissions
- HubOwner access level on hub
Events
Creates the following eventHub_Freeze |
Get hub propertieslink
GET /api/v6.1/hubs/{hub}/props
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Modify hub propertieslink
PATCH /api/v6.1/hubs/{hub}/props
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- HubOwner access level on hub
- Available while Setup Mode is active.
Events
Creates the following eventHub_Property_Change |
|
Replace all hub propertieslink
PUT /api/v6.1/hubs/{hub}/props
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- HubOwner access level on hub
Events
Creates the following eventHub_Property_Set |
|
Delete hub propertieslink
POST /api/v6.1/hubs/{hub}/props_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- HubOwner access level on hub
Events
Creates the following eventHub_Property_Delete |
|
Save the hub state (db content and files) to a snapshot.link
POST /api/v6.1/hubs/{hub}/snapshot
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: The request is not correct.
- STATUS 404 Not Found: The hub does not exist.
Required Permissions
- HubOwner access level on hub
Events
Creates no events.Changes the state of a hub to LIVElink
POST /api/v6.1/hubs/{hub}/unfreeze
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content: The hub is now no longer frozen
- STATUS 400 Bad Request
- STATUS 404 Not Found: The requested hub does not exist
Required Permissions
- HubOwner access level on hub
Events
Creates the following eventHub_Unfreeze |
Restore the state (db content and files) from a snapshot.link
POST /api/v6.1/snapshot
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The snapshot does not exist.
Required Permissions
- HubCreation access level
Events
Creates the following eventRestore_Hub_Snapshot |
|
Inspect the snapshot and return some information about it.link
POST /api/v6.1/snapshot_inspect
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The snapshot does not exist.
Required Permissions
- No special permission required
Events
Creates no events.HubServer Interfacelink
Click here to see all end points in this interface.
Get HubServer clocklink
GET /api/v6.1/hubserver/clock
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
- Available while Setup Mode is active.
Get HubServer propertieslink
GET /api/v6.1/hubserver/props
Query parameter prototype: |
|
Request headers prototype: |
|
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: No properties configured
Required Permissions
- No special permission required
- Available while Setup Mode is active.
Modify HubServer propertieslink
PATCH /api/v6.1/hubserver/props
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates no events.Replace/Create all HubServer propertieslink
PUT /api/v6.1/hubserver/props
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates no events.Delete some HubServer propertieslink
POST /api/v6.1/hubserver/props_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates no events.Restart HubServer internalslink
POST /api/v6.1/hubserver/restart
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 202 Accepted: Restarting has begun
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventHub_Server_Restart |
Stop HubServerlink
POST /api/v6.1/hubserver/stop
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 202 Accepted: Stopping has begun
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventHub_Server_Stop |
Create upload ref to be used to upload a file to the server.link
POST /api/v6.1/hubserver/upload
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: Invalid file name
Required Permissions
- No special permission required
Events
Creates no events.Job Interfacelink
Click here to see all end points in this interface.
Fetch job(s)link
GET /api/v6.1/hubs/{hub}/jobs
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Delete joblink
DELETE /api/v6.1/hubs/{hub}/jobs/{job}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Job does not exist
Required Permissions
- ReadExec access level on hub
Events
Creates the following eventJob_Delete |
|
Delete jobslink
POST /api/v6.1/hubs/{hub}/jobs_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Job does not exist
Required Permissions
- ReadExec access level on hub
Events
Creates the following eventJob_Delete |
|
Start jobslink
POST /api/v6.1/hubs/{hub}/jobs_start
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Job does not exist
Required Permissions
- ReadExec access level on hub
Events
Creates the following eventJob_Start |
|
Suspend jobslink
POST /api/v6.1/hubs/{hub}/jobs_suspend
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Job does not exist
Required Permissions
- ReadExec access level on hub
Events
Creates the following eventJob_Suspend |
|
Unsuspend jobslink
POST /api/v6.1/hubs/{hub}/jobs_unsuspend
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: Job does not exist
Required Permissions
- ReadExec access level on hub
Events
Creates the following eventJob_Unsuspend |
|
License Interfacelink
Click here to see all end points in this interface.
Fetch licenseslink
GET /api/v6.1/licenses
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
- Available while Setup Mode is active.
Add a new licenselink
POST /api/v6.1/licenses
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventLicense_Add |
|
Delete a licenselink
DELETE /api/v6.1/licenses/{license}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request
- STATUS 404 Not Found: License not found
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventLicense_Delete |
|
Fetch raw content of a licenselink
GET /api/v6.1/licenses/{license}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is plain text |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: License not found
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
(re)create a new licenselink
PUT /api/v6.1/licenses/{license}
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 201 Created
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates one or more of the following eventsLicense_Add |
|
License_Replace |
|
Show licensing statuslink
GET /api/v6.1/licensing
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
Set Hub Server property License_Agreement_Acceptedlink
POST /api/v6.1/licensing/license_agreement_accepted
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
Events
Creates no events.Logfile Tailing Interfacelink
Click here to see all end points in this interface.
Get log file content while a specified control was activelink
GET /api/v6.1/hubs/{hub}/jobs/{job}/controls/{ctrl_id}/log
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is plain text |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Get hub's log file contentlink
GET /api/v6.1/hubs/{hub}/logs/{file}
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is plain text |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The requested log file does not exist
Required Permissions
- ReadOnly access level on hub
Get hub's archived log file contentlink
GET /api/v6.1/hubs/{hub}/logs/{file}/archive/{archive}
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is plain text |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The requested archived log file does not exist
Required Permissions
- ReadOnly access level on hub
Search for timestamp in log file. Returns offset of first log line that starts with a timestamp bigger or equal to specified timstamp.link
GET /api/v6.1/hubs/{hub}/logs/{file}/search
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Get log file contentlink
GET /api/v6.1/logs/{file}
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is plain text |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The requested log file does not exist
Required Permissions
- SysAdmin access level
Get archived log file contentlink
GET /api/v6.1/logs/{file}/archive/{archive}
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is plain text |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The requested archived log file does not exist
Required Permissions
- SysAdmin access level
Miscellaneous Interfacelink
Click here to see all end points in this interface.
Detect API versions availablelink
GET /api
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK: API versions fetched
- STATUS 400 Bad Request
Required Permissions
- No special permission required
- Available while Setup Mode is active.
Query Interfacelink
Click here to see all end points in this interface.
For each location in each channel calculate whichtables are captured and integrated, their schema and basenames, and latency SLA.link
GET /api/v6.1/hubs/{hub}/query/channels
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Hub does not exist
Required Permissions
- ReadOnly access level on hub
For each location calculate which tables are capturedand integrated, their schema and basenames, and latency SLA.link
GET /api/v6.1/hubs/{hub}/query/channels/{channel}/locs
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadOnly access level on hub
Calculate how table is defined for a location, including effect of actionslink
GET /api/v6.1/hubs/{hub}/query/channels/{channel}/locs/{loc}/tables/{table}
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
For each table calculate its schema, basename, and the lists of locations where the table is captured or integratedlink
GET /api/v6.1/hubs/{hub}/query/channels/{channel}/tables
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadOnly access level on hub
Gets general status and health of a hublink
GET /api/v6.1/hubs/{hub}/query/status
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: The requested hub does not exist
Required Permissions
- ReadOnly access level on hub
Repository Config Interfacelink
Click here to see all end points in this interface.
Drop all repository tableslink
DELETE /api/v6.1/repos
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates no events.Check repositorylink
GET /api/v6.1/repos
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
- Available while Setup Mode is active.
Create repository tableslink
POST /api/v6.1/repos
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventRepository_Create |
Get repository propertieslink
GET /api/v6.1/repos/props
Query parameter prototype: |
|
Request headers prototype: |
|
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
- Available while Setup Mode is active.
Modify repository propertieslink
PATCH /api/v6.1/repos/props
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventRepository_Property_Change |
|
Replace all repository propertieslink
PUT /api/v6.1/repos/props
No query parameters | |
Request headers prototype: |
|
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventRepository_Property_Set |
|
Delete repository propertieslink
POST /api/v6.1/repos/props_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventRepository_Property_Delete |
|
Statistics Interfacelink
Click here to see all end points in this interface.
Fetch statisticslink
GET /api/v6.1/hubs/{hub}/stats/metrics
Query parameter prototype: |
|
No extra request headers | |
No request body | |
Response headers prototype: |
|
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Export statistics to a filelink
POST /api/v6.1/hubs/{hub}/stats/metrics/export
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Fetch oldest stats history time for time granularity and scopelink
GET /api/v6.1/hubs/{hub}/stats/oldest
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Table Adapt Interfacelink
Click here to see all end points in this interface.
Logic to Add and Replace table definition info from tables in a source (or target) databaselink
POST /api/v6.1/hubs/{hub}/channels/{channel}/locs/{loc}/adapt/apply
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadWrite access level on hub
Events
Creates the following eventTable_Definition_Adapt |
|
Logic to compare table definition info with table layouts in a source (or target) dblink
POST /api/v6.1/hubs/{hub}/channels/{channel}/locs/{loc}/adapt/check
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
- STATUS 404 Not Found: Channel does not exist
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Check table definition against the definition in a source (or target) databaselink
POST /api/v6.1/hubs/{hub}/channels/{channel}/locs/{loc}/adapt/check/{table}
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Check if tables are in other channelslink
POST /api/v6.1/hubs/{hub}/channels/{channel}/locs/{loc}/adapt/other_channels
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request: Location is a file location without external tables
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Parse adapt pattern file to mapspec in JSON formatlink
POST /api/v6.1/hubs/{hub}/mapdoc/parse
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.User Config Interfacelink
Click here to see all end points in this interface.
Get user's hub propertieslink
GET /api/v6.1/hubs/{hub}/users/{user}/props
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- CurrentUser access level
- Available while Setup Mode is active.
Modify user hub propertieslink
PATCH /api/v6.1/hubs/{hub}/users/{user}/props
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- CurrentUser access level
- Available while Setup Mode is active.
Events
Creates no events.Replace all user hub propertieslink
PUT /api/v6.1/hubs/{hub}/users/{user}/props
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- CurrentUser access level
- Available while Setup Mode is active.
Events
Creates no events.Delete user hub propertieslink
POST /api/v6.1/hubs/{hub}/users/{user}/props_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- CurrentUser access level
- Available while Setup Mode is active.
Events
Creates no events.Get list of users, including propertieslink
GET /api/v6.1/users
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
- Available while Setup Mode is active.
Create a new userlink
POST /api/v6.1/users
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: User already exists
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventUser_Create |
|
Delete a userlink
DELETE /api/v6.1/users/{user}
No query parameters | |
No extra request headers | |
No request body | |
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
- STATUS 404 Not Found: User doesn't exist
Required Permissions
- SysAdmin access level
- Available while Setup Mode is active.
Events
Creates the following eventUser_Delete |
|
Get user, including propertieslink
GET /api/v6.1/users/{user}
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
- Available while Setup Mode is active.
Reset password of user, with local authenticationlink
PUT /api/v6.1/users/{user}/password
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request: User does not have local authentication
- STATUS 404 Not Found: User doesn't exist
Required Permissions
- CurrentUser access level
- Available while Setup Mode is active.
Events
Creates the following eventUser_Password_Change |
|
Get user propertieslink
GET /api/v6.1/users/{user}/props
Query parameter prototype: |
|
No extra request headers | |
No request body | |
No extra response headers | |
Response body is JSON. Prototype: |
|
HTTP Status Codes
- STATUS 200 OK
- STATUS 400 Bad Request
Required Permissions
- No special permission required
- Available while Setup Mode is active.
Modify user propertieslink
PATCH /api/v6.1/users/{user}/props
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- CurrentUser access level
- Available while Setup Mode is active.
Events
Creates no events.Replace all user propertieslink
PUT /api/v6.1/users/{user}/props
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 204 No Content
- STATUS 400 Bad Request
Required Permissions
- CurrentUser access level
- Available while Setup Mode is active.
Events
Creates no events.Delete user propertieslink
POST /api/v6.1/users/{user}/props_delete
No query parameters | |
No extra request headers | |
Request body is JSON. Prototype: |
|
No extra response headers | |
No response body |
HTTP Status Codes
- STATUS 400 Bad Request
- STATUS 204 No Content
Required Permissions
- CurrentUser access level
- Available while Setup Mode is active.