License Interface

Fetch licenses

GET/api/v6.1.5.2/licenses

Query parameters	Prototype: `'license' ?: ( + )`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `license : { 'status' : 'NONE' \| 'VALID' \| 'EXPIRED' \| 'HOST_MISMATCH' \| 'EXCEEDED' \| 'INVALID' 'props' ?: { prop : value } }`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	No special permission required Available while Setup Mode is active.

POST/api/v6.1.5.2/licenses

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'license' : 'raw' :`
Response headers	None
Response body	None
Status codes	✅ 201 Created ❌ 400 Bad Request
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates the following event: License_Add `'license' :`

DELETE/api/v6.1.5.2/licenses/{license}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 201 Created ❌ 400 Bad Request ❌ 404 Not Found: License not found
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates the following event: License_Delete `'license' :`

GET/api/v6.1.5.2/licenses/{license}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (text)	None
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: License not found
Required permissions	sysadmin access Available while Setup Mode is active.

PUT/api/v6.1.5.2/licenses/{license}

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'raw' :`
Response headers	None
Response body	None
Status codes	✅ 201 Created ❌ 400 Bad Request
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates one or more of the following events: License_Add `'license' :` License_Replace `'license' :`

GET/api/v6.1.5.2/licensing

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `'status' : 'NONE' \| 'VALID' \| 'EXPIRED' \| 'HOST_MISMATCH' \| 'EXCEEDED' \| 'INVALID' 'licensing_expiry_warning' ?: 'licensing_upload_error' ?: 'licensing_acquire_error' ?: 'capture_restrict' ?: ( { 'classes' ?: ( + ) 'max_locs' ?: }* ) 'integrate_restrict' ?: ( { 'classes' ?: ( + ) 'max_locs' ?: }* ) 'extra_features' ?: { 'sap_unpack' ?: { 'max_locs' ?: } }`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	No special permission required Available while Setup Mode is active.

POST/api/v6.1.5.2/licensing/license_agreement_accepted

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	No special permission required
Events	Creates no events.

POST/api/v6.1.5.2/metering/compact_monthly

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `'period_end' ?: 'compacted_days' ?:`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates no events.

GET/api/v6.1.5.2/metering/download

Query parameters	Prototype: `'period_begin' ?: 'period_end' ?:`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: 'period_begin' ?: 'period_end' : 'hvr_version' : 'hubs' : ( { 'hub' : name 'hub_props' : { 'Description' ?: 'Hub_Id' : 'Hub_Server_URL' ?: } 'channels' : ( { 'channel' : ident 'loc_pairs' : ( { 'src_loc' : ident 'src_loc_props' ?: { 'Class' : 'Class_Flavor' ?: 'Class_Version' ?: 'File_Scheme' ?: 'Description' ?: } 'tgt_loc' : ident 'tgt_loc_props' ?: { 'Class' : 'Class_Flavor' ?: 'Class_Version' ?: 'File_Scheme' ?: 'Description' ?: } 'tables' : ( { 'table' : ident 'schema' ?: 'base_name' : 'records' ?: ( { 'hour' : 'mar_signature' : 'timekey' ?: 'refresh' ?: 'initial_refresh' ?: 'system_refresh' ?: }* ) 'refr_events' ?: ( { 'ev_id' : 'ev_start_tstamp' : 'tbl_begin_tstamp' ?: 'tbl_end_tstamp' ?: 'ev_finish_tstamp' ?: 'initial_refresh' : 'system_refresh' : }* ) }* ) }* ) }* ) }* )
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	readmetering access Available while Setup Mode is active.

POST/api/v6.1.5.2/metering/download_monthly

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'period_begin' ?: 'period_end' ?: 'format' ?:`
Response headers	None
Response body (JSON)	Prototype: `'ref' : download`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	readmetering access Available while Setup Mode is active.
Events	Creates no events.

POST/api/v6.1.5.2/metering/license_acquire

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request: Hub system not registered
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates no events.

POST/api/v6.1.5.2/metering/purge

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'period_end' ?:`
Response headers	None
Response body (JSON)	Prototype: `'period_end' ?: 'purged_days' ?: 'purged_hours' ?:`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates no events.

POST/api/v6.1.5.2/metering/registration_status

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `'account_name' ?: 'require_mar_begin' ?: \| 'require_usage_snapshot' ?: 'download_license' :`
Status codes	✅ 200 OK ❌ 400 Bad Request: Hub system not registered
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates no events.

POST/api/v6.1.5.2/metering/upload

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'period_begin' ?: 'period_end' ?: 'snapshots' ?:`
Response headers	None
Response body	None
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	sysadmin access Available while Setup Mode is active.
Events	Creates no events.