6.1.0.4
Activate, Refresh, and Compare Interface
Click here to see all end points in this interface.
Check replication activation status of channels
GET /api/v6.1.0.4/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 channel
GET /api/v6.1.0.4/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 event
POST /api/v6.1.0.4/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 it
POST /api/v6.1.0.4/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 Compare
GET /api/v6.1.0.4/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 variables
GET /api/v6.1.0.4/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 event
POST /api/v6.1.0.4/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 transactions
GET /api/v6.1.0.4/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: No capture tables defined or finding oldest transaction start time not possible
- STATUS 404 Not Found: Channel or channel member not found
Required Permissions
- ReadOnly access level on hub
Show integrate point
GET /api/v6.1.0.4/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 stats
POST /api/v6.1.0.4/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 empty
POST /api/v6.1.0.4/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 it
POST /api/v6.1.0.4/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 Refresh
GET /api/v6.1.0.4/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 channels
GET /api/v6.1.0.4/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 loc
GET /api/v6.1.0.4/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 channels
GET /api/v6.1.0.4/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 Interface
Click here to see all end points in this interface.
Detect whether hub may (re)configure agent of existing location
GET /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 agent
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/hubs/{hub}/new_loc/agent/props_delete
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_Delete |
|
Get agent properties of new location
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/hubs/{hub}/new_loc/agent/test
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: 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 location
POST /api/v6.1.0.4/hubs/{hub}/new_loc/agent/users
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_User_Create |
|
Delete user on agent for new location
POST /api/v6.1.0.4/hubs/{hub}/new_loc/agent/users_delete
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_User_Delete |
|
Get list of users on new agent
POST /api/v6.1.0.4/hubs/{hub}/new_loc/agent/users_get
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: 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 location
POST /api/v6.1.0.4/hubs/{hub}/new_loc/agent/users_password
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_User_Password_Change |
|
Detect whether hub may (re)configure agent of new location
POST /api/v6.1.0.4/hubs/{hub}/new_loc/agent_get
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 requested hub does not exist
Required Permissions
- ReadOnly access level on hub
Events
Creates no events.Alert Interface
Click here to see all end points in this interface.
List configured alerts
GET /api/v6.1.0.4/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 configuration
POST /api/v6.1.0.4/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 configuration
DELETE /api/v6.1.0.4/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 state
POST /api/v6.1.0.4/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 configuration
POST /api/v6.1.0.4/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 now
POST /api/v6.1.0.4/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 properties
GET /api/v6.1.0.4/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 properties
PATCH /api/v6.1.0.4/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 properties
PUT /api/v6.1.0.4/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 properties
POST /api/v6.1.0.4/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 notifications
POST /api/v6.1.0.4/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 Interface
Click here to see all end points in this interface.
Get all control ids matched by the query
GET /api/v6.1.0.4/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 id
GET /api/v6.1.0.4/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.
POST /api/v6.1.0.4/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 file
POST /api/v6.1.0.4/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 Interface
Click here to see all end points in this interface.
Fetch hub definition
GET /api/v6.1.0.4/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 action
POST /api/v6.1.0.4/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 action
POST /api/v6.1.0.4/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 events
GET /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 channel
POST /api/v6.1.0.4/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 channel
DELETE /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 channel
PATCH /api/v6.1.0.4/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 channel
PUT /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 actions
PATCH /api/v6.1.0.4/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 list
PUT /api/v6.1.0.4/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 actions
POST /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 group
POST /api/v6.1.0.4/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 group
DELETE /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 group
PUT /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 channel
PATCH /api/v6.1.0.4/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 list
PUT /api/v6.1.0.4/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 member
DELETE /api/v6.1.0.4/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 members
POST /api/v6.1.0.4/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 group
POST /api/v6.1.0.4/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 channel
POST /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 tables
PATCH /api/v6.1.0.4/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 table
POST /api/v6.1.0.4/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 list
PUT /api/v6.1.0.4/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 table
DELETE /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 table
PATCH /api/v6.1.0.4/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 table
PUT /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 columns
PATCH /api/v6.1.0.4/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 list
PUT /api/v6.1.0.4/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 columns
POST /api/v6.1.0.4/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 table
POST /api/v6.1.0.4/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 tables
POST /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 actions
PATCH /api/v6.1.0.4/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 list
PUT /api/v6.1.0.4/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 actions
POST /api/v6.1.0.4/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 changes
POST /api/v6.1.0.4/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 import
POST /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 location
DELETE /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 location
PUT /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 actions
PATCH /api/v6.1.0.4/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 list
PUT /api/v6.1.0.4/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 actions
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 definition
GET /api/v6.1.0.4/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 properties
PATCH /api/v6.1.0.4/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 property
DELETE /api/v6.1.0.4/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 properties
POST /api/v6.1.0.4/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 location
POST /api/v6.1.0.4/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 Interface
Click here to see all end points in this interface.
Create new encryption wallet
POST /api/v6.1.0.4/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 wallet
POST /api/v6.1.0.4/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 wallet
POST /api/v6.1.0.4/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 keys
POST /api/v6.1.0.4/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 keys
POST /api/v6.1.0.4/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 gracefully
POST /api/v6.1.0.4/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 properties
GET /api/v6.1.0.4/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 operation
POST /api/v6.1.0.4/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 Interface
Click here to see all end points in this interface.
Get all unique channels from hvr_event
GET /api/v6.1.0.4/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_event
GET /api/v6.1.0.4/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_event
GET /api/v6.1.0.4/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)
GET /api/v6.1.0.4/hubs/{hub}/events
Query parameter prototype: |
|