Hub Config Interface

Fetch all hubs and their basic properties

GET/api/v6.1.0.26/hubs

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `hub *: { 'props' : { 'Description' ?: 'Created' ?: 'Creator' ?: user 'Hub_State' ?: 'Freeze_Time' ?: } 'current_user_access' : { 'level' : } }`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	No special permission required Available while Setup Mode is active.

POST/api/v6.1.0.26/hubs

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'hub' : 'props' ?: { prop *: value }`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: Hub already exists
Required permissions	HubCreation access level Available while Setup Mode is active.
Events	Creates the following event: Hub_Create `'hub' :`

DELETE/api/v6.1.0.26/hubs/{hub}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: The requested hub does not exist
Required permissions	HubOwner access level on hub
Events	Creates the following event: Hub_Delete `'hub' :`

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

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `'props' : { 'Description' ?: 'Created' ?: 'Creator' ?: user 'Hub_State' ?: 'Freeze_Time' ?: } 'current_user_access' : { 'level' : }`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: The requested hub does not exist
Required permissions	No special permission required

POST/api/v6.1.0.26/hubs/{hub}/freeze

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content: The hub is now frozen ❌ 400 Bad Request ❌ 404 Not Found: The requested hub does not exist
Required permissions	HubOwner access level on hub
Events	Creates the following event: Hub_Freeze

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

PATCH/api/v6.1.0.26/hubs/{hub}/props

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `prop *: value \|`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	HubOwner access level on hub Available while Setup Mode is active.
Events	Creates the following event: Hub_Property_Change `'props_after' : { prop : value \| } 'props_before' ?: { prop : value }`

PUT/api/v6.1.0.26/hubs/{hub}/props

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `prop *: value`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	HubOwner access level on hub
Events	Creates the following event: Hub_Property_Set `'props_after' : { prop : value \| } 'props_before' ?: { prop : value }`

POST/api/v6.1.0.26/hubs/{hub}/props_delete

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'props' : ( prop+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	HubOwner access level on hub
Events	Creates the following event: Hub_Property_Delete `'props' : ( prop+ )`

POST/api/v6.1.0.26/hubs/{hub}/props_modify

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'hub_prop_args' : ( { 'key' : ( prop \| \| * ) 'value' : }+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request
Required permissions	HubOwner access level on hub Available while Setup Mode is active.
Events	Creates the following event: Hub_Property_Change `'props_after' : { prop : value \| } 'props_before' ?: { prop : value }`

POST/api/v6.1.0.26/hubs/{hub}/snapshot

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Access :`
Request body (JSON)	Prototype: `'reason' ?: 'channel_focus' ?: chn 'event_trim' ?: \| 'log_trim' ?: \| 'stats_trim' ?: \| 'definition_trim' ?: \| 'dblog_dump' ?: nfiles 'txfiles' ?: nfiles`
Response headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Response body (JSON)	Prototype: `'ref' : snapshot_zip`
Status codes	✅ 200 OK ❌ 400 Bad Request: The request is not correct. ❌ 404 Not Found: The hub does not exist.
Required permissions	HubOwner access level on hub
Events	Creates no events.

POST/api/v6.1.0.26/hubs/{hub}/unfreeze

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content: The hub is now no longer frozen ❌ 400 Bad Request ❌ 404 Not Found: The requested hub does not exist
Required permissions	HubOwner access level on hub
Events	Creates the following event: Hub_Unfreeze

POST/api/v6.1.0.26/snapshot

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'ref' : snapshot_zip 'hub' : newname 'description' ?:`
Response headers	None
Response body	None
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: The snapshot does not exist.
Required permissions	HubCreation access level
Events	Creates the following event: Restore_Hub_Snapshot `'original_hub' : 'original_hvr_version' : 'original_repository_version' : 'save_user' : user 'save_tstamp' : 'reason' ?: 'channel_focus' ?: chn 'event_trim' ?: \| 'log_trim' ?: \| 'stats_trim' ?: \| 'definition_trim' ?: \|`

POST/api/v6.1.0.26/snapshot_inspect

Query parameters	None
Request headers	Prototype: `X-Hvr-Classified-Transport-Key :`
Request body (JSON)	Prototype: `'ref' : snapshot_zip`
Response headers	None
Response body (JSON)	Prototype: `'original_hub' : 'original_hvr_version' : 'original_repository_version' : 'save_user' : user 'save_tstamp' : 'reason' ?: 'channel_focus' ?: chn 'event_trim' ?: \| 'log_trim' ?: \| 'stats_trim' ?: \| 'definition_trim' ?: \| 'hub_props' : { prop *: value }`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: The snapshot does not exist.
Required permissions	No special permission required
Events	Creates no events.