Agent Configuration Interface

Detect whether hub may (re)configure agent of existing location

GET/api/v6.2.5.2/hubs/{hub}/locs/{loc}/agent

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `'setup_token' ?: name 'setup_timed' ?: active 'auth_anon' ?: 'auth_user_password' ?: 'auth_kerberos' ?: 'hvr_version' :`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: The requested hub or location does not exist
Required permissions	read access on hub

Delete agent properties of existing location

POST/api/v6.2.5.2/hubs/{hub}/locs/{loc}/agent/props_delete

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'agent_props' : ( + )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_Properties_Delete `'agent' : host_port 'props' : ( []... )`

Get agent properties of existing location

POST/api/v6.2.5.2/hubs/{hub}/locs/{loc}/agent/props_get

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Access :`
Request body (JSON)	Prototype: `'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'fetch' ?: ( + )`
Response headers	Prototype: `X-Hvr-Classified-Transport-Key : X-Hvr-Redacted-Storage :`
Response body (JSON)	Prototype: `prop *: value`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	write_locs access on hub
Events	Creates no events.

Modify agent properties of existing location

POST/api/v6.2.5.2/hubs/{hub}/locs/{loc}/agent/props_modify

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'agent_prop_args' : ( { 'key' : ( prop \| \| * ) 'value' : }+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_Properties_Change `'agent' : host_port 'props_after' : { prop : value \| } 'props_before' ?: { prop : value }`

Update agent properties of existing location

POST/api/v6.2.5.2/hubs/{hub}/locs/{loc}/agent/props_patch

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'agent_props' : { prop *: value \| }`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_Properties_Change `'agent' : host_port 'props_after' : { prop : value \| } 'props_before' ?: { prop : value }`

Set/reset agent properties of existing location

POST/api/v6.2.5.2/hubs/{hub}/locs/{loc}/agent/props_put

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'agent_props' : { prop *: value }`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_Properties_Set `'agent' : host_port 'props_after' : { prop : value } 'props_before' ?: { prop : value }`

Discover agent loc props of existing location

POST/api/v6.2.5.2/hubs/{hub}/locs/{loc}/agent/test

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password )`
Response headers	None
Response body (JSON)	Prototype: `'discovered_props' : { prop *: value }`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	read access on hub
Events	Creates no events.

Create user on agent for existing location

POST/api/v6.2.5.2/hubs/{hub}/locs/{loc}/agent/users

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'user' : 'authentication' : 'kerberos' \| 'local' \| 'pam' \| 'plugin' \| 'windows' 'password' ?:`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_User_Create `'agent' : host_port 'user' :`

Delete user on agent for existing location

POST/api/v6.2.5.2/hubs/{hub}/locs/{loc}/agent/users_delete

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'user' :`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_User_Delete `'agent' : host_port 'user' :`

Get list of users on existing agent

POST/api/v6.2.5.2/hubs/{hub}/locs/{loc}/agent/users_get

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'user' ?:`
Response headers	None
Response body (JSON)	Prototype: `user *: { 'authentication' : 'kerberos' \| 'local' \| 'pam' \| 'plugin' \| 'windows' }`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	write_locs access on hub
Events	Creates no events.

Change password of local user on agent for existing location

POST/api/v6.2.5.2/hubs/{hub}/locs/{loc}/agent/users_password

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'user' : 'new_password' : 'current_password' ?:`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_User_Password_Change `'agent' : host_port 'user' :`

Delete agent properties of new location

POST/api/v6.2.5.2/hubs/{hub}/new_loc/agent/props_delete

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'loc_props_from' ?: loc 'loc_props' : { prop *: value \| } 'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'agent_props' : ( + )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: Error connecting to location specified by 'loc_props'
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_Properties_Delete `'agent' : host_port 'props' : ( []... )`

Get agent properties of new location

POST/api/v6.2.5.2/hubs/{hub}/new_loc/agent/props_get

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Access : X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'loc_props_from' ?: loc 'loc_props' : { prop *: value \| } 'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'fetch' ?: ( + )`
Response headers	Prototype: `X-Hvr-Classified-Transport-Key : X-Hvr-Redacted-Storage :`
Response body (JSON)	Prototype: `prop *: value`
Status codes	✅ 200 OK ❌ 400 Bad Request: Error connecting to location specified by 'loc_props'
Required permissions	write_locs access on hub
Events	Creates no events.

Modify agent properties of new location

POST/api/v6.2.5.2/hubs/{hub}/new_loc/agent/props_modify

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'loc_props_from' ?: loc 'loc_props' : { prop : value \| } 'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'agent_prop_args' : ( { 'key' : ( prop \| \| ) 'value' : }+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: Error connecting to location specified by 'loc_props'
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_Properties_Change `'agent' : host_port 'props_after' : { prop : value \| } 'props_before' ?: { prop : value }`

Update agent properties of new location

POST/api/v6.2.5.2/hubs/{hub}/new_loc/agent/props_patch

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'loc_props_from' ?: loc 'loc_props' : { prop : value \| } 'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'agent_props' : { prop : value \| }`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: Error connecting to location specified by 'loc_props'
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_Properties_Change `'agent' : host_port 'props_after' : { prop : value \| } 'props_before' ?: { prop : value }`

Set/reset agent properties of new location

POST/api/v6.2.5.2/hubs/{hub}/new_loc/agent/props_put

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'loc_props_from' ?: loc 'loc_props' : { prop : value \| } 'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'agent_props' : { prop : value }`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: Error connecting to location specified by 'loc_props'
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_Properties_Set `'agent' : host_port 'props_after' : { prop : value } 'props_before' ?: { prop : value }`

Discover agent loc props of new location

POST/api/v6.2.5.2/hubs/{hub}/new_loc/agent/test

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'loc_props_from' ?: loc 'loc_props' : { prop *: value \| } 'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password )`
Response headers	None
Response body (JSON)	Prototype: `'discovered_props' : { prop *: value }`
Status codes	✅ 200 OK ❌ 400 Bad Request: Error connecting to location specified by 'loc_props'
Required permissions	read access on hub
Events	Creates no events.

Create user on agent for new location

POST/api/v6.2.5.2/hubs/{hub}/new_loc/agent/users

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'loc_props_from' ?: loc 'loc_props' : { prop *: value \| } 'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'user' : 'authentication' : 'kerberos' \| 'local' \| 'pam' \| 'plugin' \| 'windows' 'password' ?:`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: Error connecting to location specified by 'loc_props'
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_User_Create `'agent' : host_port 'user' :`

Delete user on agent for new location

POST/api/v6.2.5.2/hubs/{hub}/new_loc/agent/users_delete

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'loc_props_from' ?: loc 'loc_props' : { prop *: value \| } 'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'user' :`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: Error connecting to location specified by 'loc_props'
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_User_Delete `'agent' : host_port 'user' :`

Get list of users on new agent

POST/api/v6.2.5.2/hubs/{hub}/new_loc/agent/users_get

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'loc_props_from' ?: loc 'loc_props' : { prop *: value \| } 'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'user' ?:`
Response headers	None
Response body (JSON)	Prototype: `user *: { 'authentication' : 'kerberos' \| 'local' \| 'pam' \| 'plugin' \| 'windows' }`
Status codes	✅ 200 OK ❌ 400 Bad Request: Error connecting to location specified by 'loc_props'
Required permissions	write_locs access on hub
Events	Creates no events.

Change password of local user on agent for new location

POST/api/v6.2.5.2/hubs/{hub}/new_loc/agent/users_password

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'loc_props_from' ?: loc 'loc_props' : { prop *: value \| } 'setup_token' ?: value 'setup_timed' ?: 'auth_user_password' ?: ( user password ) 'user' : 'new_password' : 'current_password' ?:`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: Error connecting to location specified by 'loc_props'
Required permissions	write_locs access on hub
Events	Creates the following event: Agent_User_Password_Change `'agent' : host_port 'user' :`

Detect whether hub may (re)configure agent of new location

POST/api/v6.2.5.2/hubs/{hub}/new_loc/agent_get

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'loc_props_from' ?: loc 'loc_props' : { prop *: value \| }`
Response headers	None
Response body (JSON)	Prototype: `'setup_token' ?: name 'setup_timed' ?: active 'auth_anon' ?: 'auth_user_password' ?: 'auth_kerberos' ?: 'hvr_version' :`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: The requested hub does not exist
Required permissions	read access on hub
Events	Creates no events.