File and DB Browse Interface

List files in a directory (hub)

GET/api/v6.1.0.26/hubs/{hub}/dirs

Query parameters	Prototype: `'path' ?: 'pattern' ?:`
Request headers	None
Request body	None
Response headers	Prototype: `X-Hvr-Hidden-Files :`
Response body (JSON)	Prototype: `{ 'path' : 'type' : 'file' \| 'dir' \| 'drive' \| 'shortcut' 'size' ?: 'modtime' ?: 'description' ?: }*`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Directory does not exist
Required permissions	ReadWrite access level on hub

Show all schemas in database

GET/api/v6.1.0.26/hubs/{hub}/locs/{loc}/db/schemas

Query parameters	Prototype: `'channel' ?:`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `'schemas' : ( + ) 'default_schema' :`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	ReadOnly access level on hub

Show supplemental logging for each table from a location

POST/api/v6.1.0.26/hubs/{hub}/locs/{loc}/db/supplemental_logging

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'tables' : ( { 'schema' ?: 'base_name' : }+ )`
Response headers	None
Response body (JSON)	Prototype: `{ 'schema' ?: 'base_name' : 'supplemental_logging' : }*`
Status codes	✅ 200 OK ❌ 400 Bad Request: Unsupported platform
Required permissions	ReadOnly access level on hub
Events	Creates no events.

List files in a directory on the location

GET/api/v6.1.0.26/hubs/{hub}/locs/{loc}/dirs

Query parameters	Prototype: `'path' ?: 'pattern' ?: 'local' ?: 'channel' ?:`
Request headers	None
Request body	None
Response headers	Prototype: `X-Hvr-Hidden-Files :`
Response body (JSON)	Prototype: `{ 'path' : 'type' : 'file' \| 'dir' \| 'drive' \| 'shortcut' 'size' ?: 'modtime' ?: 'description' ?: }*`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 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 location

GET/api/v6.1.0.26/hubs/{hub}/locs/{loc}/env/odbc_drivers

Query parameters	Prototype: `'odbcinst' ?: 'odbcsysini' ?: 'channel' ?:`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `driver_name*`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	ReadWrite access level on hub

Retrieve /etc/oratab or equivalent Windows registry values of the location

GET/api/v6.1.0.26/hubs/{hub}/locs/{loc}/env/oratab

Query parameters	Prototype: `'channel' ?:`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `{ 'oracle_sid' : 'oracle_home' : }*`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	ReadWrite access level on hub

Retrieve specified environment variables of the location

GET/api/v6.1.0.26/hubs/{hub}/locs/{loc}/env/vars

Query parameters	Prototype: `'vars' : ( 'DB2INSTANCE' \| 'II_SYSTEM' \| 'INSTHOME' \| 'ORACLE_HOME' \| 'ORACLE_SID' \| 'GOOGLE_APPLICATION_CREDENTIALS'+ ) 'channel' ?:`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `envvar +: val`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Location does not exist
Required permissions	ReadWrite access level on hub

Test Location connection

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

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'channel' ?:`
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	ReadOnly access level on hub
Events	Creates no events.

Show all schemas in new database location

POST/api/v6.1.0.26/hubs/{hub}/new_loc/db/schemas

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'channel' ?: 'props_from' ?: loc 'props' : { prop *: value \| }`
Response headers	None
Response body (JSON)	Prototype: `'schemas' : ( + )`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	ReadOnly access level on hub
Events	Creates no events.

List files in a directory on the new location

POST/api/v6.1.0.26/hubs/{hub}/new_loc/dirs

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'path' ?: 'pattern' ?: 'local' ?: 'channel' ?: 'props_from' ?: loc 'props' : { prop *: value \| }`
Response headers	Prototype: `X-Hvr-Hidden-Files :`
Response body (JSON)	Prototype: `{ 'path' : 'type' : 'file' \| 'dir' \| 'drive' \| 'shortcut' 'size' ?: 'modtime' ?: 'description' ?: }*`
Status codes	✅ 200 OK ❌ 400 Bad Request: Error connecting to location specified by 'props' ❌ 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 location

POST/api/v6.1.0.26/hubs/{hub}/new_loc/env/odbc_drivers

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'odbcinst' ?: 'odbcsysini' ?: 'channel' ?: 'props_from' ?: loc 'props' : { prop *: value \| }`
Response headers	None
Response body (JSON)	Prototype: `driver_name*`
Status codes	✅ 200 OK ❌ 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 location

POST/api/v6.1.0.26/hubs/{hub}/new_loc/env/oratab

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'channel' ?: 'props_from' ?: loc 'props' : { prop *: value \| }`
Response headers	None
Response body (JSON)	Prototype: `{ 'oracle_sid' : 'oracle_home' : }*`
Status codes	✅ 200 OK ❌ 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 location

POST/api/v6.1.0.26/hubs/{hub}/new_loc/env/vars

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'vars' : ( 'DB2INSTANCE' \| 'II_SYSTEM' \| 'INSTHOME' \| 'ORACLE_HOME' \| 'ORACLE_SID' \| 'GOOGLE_APPLICATION_CREDENTIALS'+ ) 'channel' ?: 'props_from' ?: loc 'props' : { prop *: value \| }`
Response headers	None
Response body (JSON)	Prototype: `envvar +: val`
Status codes	✅ 200 OK ❌ 400 Bad Request: Error connecting to location specified by 'props'
Required permissions	ReadWrite access level on hub
Events	Creates no events.

Test Location connection properties

POST/api/v6.1.0.26/hubs/{hub}/new_loc/test

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'channel' ?: 'props_from' ?: loc 'props' : { prop *: value \| }`
Response headers	None
Response body (JSON)	Prototype: `'discovered_props' : { prop *: value }`
Status codes	✅ 200 OK ❌ 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)

GET/api/v6.1.0.26/hubserver/dirs

Query parameters	Prototype: `'path' ?: 'pattern' ?:`
Request headers	None
Request body	None
Response headers	Prototype: `X-Hvr-Hidden-Files :`
Response body (JSON)	Prototype: `{ 'path' : 'type' : 'file' \| 'dir' \| 'drive' \| 'shortcut' 'size' ?: 'modtime' ?: 'description' ?: }*`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 403 Forbidden ❌ 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 server

GET/api/v6.1.0.26/hubserver/env/odbc_drivers

Query parameters	Prototype: `'odbcinst' ?: 'odbcsysini' ?:`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `driver_name*`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 403 Forbidden
Required permissions	SysAdmin access level Available while Setup Mode is active.

Retrieve /etc/oratab or equivalent Windows registry values of the hub server

GET/api/v6.1.0.26/hubserver/env/oratab

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `{ 'oracle_sid' : 'oracle_home' : }*`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 403 Forbidden
Required permissions	SysAdmin access level Available while Setup Mode is active.

Retrieve specified environment variables of the hub server

GET/api/v6.1.0.26/hubserver/env/vars

Query parameters	Prototype: `'vars' : ( 'DB2INSTANCE' \| 'II_SYSTEM' \| 'INSTHOME' \| 'ORACLE_HOME' \| 'ORACLE_SID' \| 'GOOGLE_APPLICATION_CREDENTIALS'+ )`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `envvar +: val`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 403 Forbidden
Required permissions	SysAdmin access level Available while Setup Mode is active.

Verify (changes) to HubServer connection properties

POST/api/v6.1.0.26/hubserver/props_test

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'props_from' ?: 'props' : { prop *: value \| }`
Response headers	None
Response body (JSON)	Prototype: `'discovered_props' : { prop *: value }`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 403 Forbidden
Required permissions	SysAdmin access level Available while Setup Mode is active.
Events	Creates no events.

Test hubserver is working correctly

POST/api/v6.1.0.26/hubserver/test

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 403 Forbidden
Required permissions	No special permission required Available while Setup Mode is active.
Events	Creates no events.