Field guide / Dashboard APIReviewable source / main
Dashboard API
Contract endpoints for the portal's global-overview and risk-heatmap dashboards.
2 routes
Response metadata: x-api-version, x-request-id, and traceresponse apply to normal routed responses and are omitted from the per-operation header tables below.
GET/api/dashboard/global-overview-contract
request access
Dashboard global overview.
Permissions
| Access class | Credential | Scoping |
|---|---|---|
request | An authenticated session or API bearer token is required. | The access class is enforced first; site and environment scopes narrow resources on scoped operations. |
HTTP request
GET https://<your-host>/api/dashboard/global-overview-contractPath parameters
This operation has no path parameters.
Query parameters
This operation has no query parameters.
Request headers
| Name | Type | Requirement | Description |
|---|---|---|---|
Authorization | string | Optional | Human credential alternative: supply one Bearer rys_... session token, ryk_... API token, or validated identity-provider JWT here. Do not combine it with X-Ryuki-Session-Id or the session cookie; conflicting carriers fail closed. |
X-Ryuki-Session-Id | string | Optional | Opaque rys_... session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request. |
traceparent | string | Optional | Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation. |
Request body
This operation does not accept a request body.
Response
| Status | Description | Body |
|---|---|---|
200 | OK | Value |
200 response body
Structure: Value.
| Name | Type | Requirement | Description |
|---|---|---|---|
source | string | Required | Origin or authority of the returned data. |
dashboardGlobalOverviewMode | string | Required | Value of dashboardGlobalOverviewMode returned in the response body. |
dashboardSummaryAggregateOnly | boolean | Required | Value of dashboardSummaryAggregateOnly returned in the response body. |
siteReadinessAggregateOnly | boolean | Required | Value of siteReadinessAggregateOnly returned in the response body. |
riskSignalsReadOnly | boolean | Required | Value of riskSignalsReadOnly returned in the response body. |
evidenceReferencesOnly | boolean | Required | Value of evidenceReferencesOnly returned in the response body. |
liveQueryAllowed | boolean | Required | Value of liveQueryAllowed returned in the response body. |
dashboardMutationAllowed | boolean | Required | Value of dashboardMutationAllowed returned in the response body. |
providerCallsAllowed | boolean | Required | Value of providerCallsAllowed returned in the response body. |
notificationDispatchAllowed | boolean | Required | Value of notificationDispatchAllowed returned in the response body. |
rawRequestRowsAllowed | boolean | Required | Value of rawRequestRowsAllowed returned in the response body. |
rawOperationRowsAllowed | boolean | Required | Value of rawOperationRowsAllowed returned in the response body. |
rawInventoryRowsAllowed | boolean | Required | Value of rawInventoryRowsAllowed returned in the response body. |
rawCmdbRowsAllowed | boolean | Required | Value of rawCmdbRowsAllowed returned in the response body. |
rawBackupRowsAllowed | boolean | Required | Value of rawBackupRowsAllowed returned in the response body. |
rawMonitoringRowsAllowed | boolean | Required | Value of rawMonitoringRowsAllowed returned in the response body. |
rawUserDataAllowed | boolean | Required | Value of rawUserDataAllowed returned in the response body. |
rawRecipientDataAllowed | boolean | Required | Value of rawRecipientDataAllowed returned in the response body. |
credentialValuesAllowed | boolean | Required | Value of credentialValuesAllowed returned in the response body. |
tokenValuesAllowed | boolean | Required | Value of tokenValuesAllowed returned in the response body. |
tenantIdentifiersAllowed | boolean | Required | Value of tenantIdentifiersAllowed returned in the response body. |
objectIdentifiersAllowed | boolean | Required | Value of objectIdentifiersAllowed returned in the response body. |
principalIdentifiersAllowed | boolean | Required | Value of principalIdentifiersAllowed returned in the response body. |
privateNetworkValuesAllowed | boolean | Required | Value of privateNetworkValuesAllowed returned in the response body. |
summaryDomains | array<JSON value> | Required | Value of summaryDomains returned in the response body. |
statusBands | array<JSON value> | Required | Value of statusBands returned in the response body. |
lenses | array<JSON value> | Required | Value of lenses returned in the response body. |
requiredGuards | array<JSON value> | Required | Value of requiredGuards returned in the response body. |
blockedReasons | array<JSON value> | Required | Value of blockedReasons returned in the response body. |
requiredEvidence | array<JSON value> | Required | Value of requiredEvidence returned in the response body. |
rules | array<JSON value> | Required | Value of rules returned in the response body. |
Errors
JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.
Examples
Request
curl --silent --show-error --globoff \
--request GET \
--header 'Authorization: Bearer <token>' \
'https://<your-host>/api/dashboard/global-overview-contract'Schematic response body
Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.
Success status: 200
{
"source": "<string>",
"dashboardGlobalOverviewMode": "<string>",
"dashboardSummaryAggregateOnly": false,
"siteReadinessAggregateOnly": false,
"riskSignalsReadOnly": false,
"evidenceReferencesOnly": false,
"liveQueryAllowed": false,
"dashboardMutationAllowed": false,
"providerCallsAllowed": false,
"notificationDispatchAllowed": false,
"rawRequestRowsAllowed": false,
"rawOperationRowsAllowed": false,
"rawInventoryRowsAllowed": false,
"rawCmdbRowsAllowed": false,
"rawBackupRowsAllowed": false,
"rawMonitoringRowsAllowed": false,
"rawUserDataAllowed": false,
"rawRecipientDataAllowed": false,
"credentialValuesAllowed": false,
"tokenValuesAllowed": false,
"tenantIdentifiersAllowed": false,
"objectIdentifiersAllowed": false,
"principalIdentifiersAllowed": false,
"privateNetworkValuesAllowed": false,
"summaryDomains": [],
"statusBands": [],
"lenses": [],
"requiredGuards": [],
"blockedReasons": [],
"requiredEvidence": [],
"rules": []
}GET/api/dashboard/risk-heatmap-contract
request access
Dashboard risk heatmap.
Permissions
| Access class | Credential | Scoping |
|---|---|---|
request | An authenticated session or API bearer token is required. | The access class is enforced first; site and environment scopes narrow resources on scoped operations. |
HTTP request
GET https://<your-host>/api/dashboard/risk-heatmap-contractPath parameters
This operation has no path parameters.
Query parameters
This operation has no query parameters.
Request headers
| Name | Type | Requirement | Description |
|---|---|---|---|
Authorization | string | Optional | Human credential alternative: supply one Bearer rys_... session token, ryk_... API token, or validated identity-provider JWT here. Do not combine it with X-Ryuki-Session-Id or the session cookie; conflicting carriers fail closed. |
X-Ryuki-Session-Id | string | Optional | Opaque rys_... session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request. |
traceparent | string | Optional | Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation. |
Request body
This operation does not accept a request body.
Response
| Status | Description | Body |
|---|---|---|
200 | OK | Value |
200 response body
Structure: Value.
| Name | Type | Requirement | Description |
|---|---|---|---|
source | string | Required | Origin or authority of the returned data. |
riskHeatmapMode | string | Required | Value of riskHeatmapMode returned in the response body. |
heatmapReadOnly | boolean | Required | Value of heatmapReadOnly returned in the response body. |
trendSummaryReadOnly | boolean | Required | Value of trendSummaryReadOnly returned in the response body. |
riskBandSummaryOnly | boolean | Required | Value of riskBandSummaryOnly returned in the response body. |
evidenceReferencesReadOnly | boolean | Required | Value of evidenceReferencesReadOnly returned in the response body. |
liveMetricsQueryAllowed | boolean | Required | Value of liveMetricsQueryAllowed returned in the response body. |
liveDashboardQueryAllowed | boolean | Required | Value of liveDashboardQueryAllowed returned in the response body. |
dashboardMutationAllowed | boolean | Required | Value of dashboardMutationAllowed returned in the response body. |
workflowMutationAllowed | boolean | Required | Value of workflowMutationAllowed returned in the response body. |
providerCallsAllowed | boolean | Required | Value of providerCallsAllowed returned in the response body. |
notificationDispatchAllowed | boolean | Required | Value of notificationDispatchAllowed returned in the response body. |
rawMetricRowsAllowed | boolean | Required | Value of rawMetricRowsAllowed returned in the response body. |
rawRequestRowsAllowed | boolean | Required | Value of rawRequestRowsAllowed returned in the response body. |
rawOperationRowsAllowed | boolean | Required | Value of rawOperationRowsAllowed returned in the response body. |
rawInventoryRowsAllowed | boolean | Required | Value of rawInventoryRowsAllowed returned in the response body. |
rawCmdbRowsAllowed | boolean | Required | Value of rawCmdbRowsAllowed returned in the response body. |
rawBackupRowsAllowed | boolean | Required | Value of rawBackupRowsAllowed returned in the response body. |
rawMonitoringRowsAllowed | boolean | Required | Value of rawMonitoringRowsAllowed returned in the response body. |
rawProviderPayloadsAllowed | boolean | Required | Value of rawProviderPayloadsAllowed returned in the response body. |
rawUserDataAllowed | boolean | Required | Value of rawUserDataAllowed returned in the response body. |
rawRecipientDataAllowed | boolean | Required | Value of rawRecipientDataAllowed returned in the response body. |
credentialValuesAllowed | boolean | Required | Value of credentialValuesAllowed returned in the response body. |
tokenValuesAllowed | boolean | Required | Value of tokenValuesAllowed returned in the response body. |
tenantIdentifiersAllowed | boolean | Required | Value of tenantIdentifiersAllowed returned in the response body. |
objectIdentifiersAllowed | boolean | Required | Value of objectIdentifiersAllowed returned in the response body. |
principalIdentifiersAllowed | boolean | Required | Value of principalIdentifiersAllowed returned in the response body. |
privateNetworkValuesAllowed | boolean | Required | Value of privateNetworkValuesAllowed returned in the response body. |
dimensions | array<JSON value> | Required | Value of dimensions returned in the response body. |
riskDomains | array<JSON value> | Required | Value of riskDomains returned in the response body. |
riskBands | array<JSON value> | Required | Value of riskBands returned in the response body. |
trendWindows | array<JSON value> | Required | Value of trendWindows returned in the response body. |
requiredGuards | array<JSON value> | Required | Value of requiredGuards returned in the response body. |
blockedReasons | array<JSON value> | Required | Value of blockedReasons returned in the response body. |
requiredEvidence | array<JSON value> | Required | Value of requiredEvidence returned in the response body. |
rules | array<JSON value> | Required | Value of rules returned in the response body. |
Errors
JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.
Examples
Request
curl --silent --show-error --globoff \
--request GET \
--header 'Authorization: Bearer <token>' \
'https://<your-host>/api/dashboard/risk-heatmap-contract'Schematic response body
Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.
Success status: 200
{
"source": "<string>",
"riskHeatmapMode": "<string>",
"heatmapReadOnly": false,
"trendSummaryReadOnly": false,
"riskBandSummaryOnly": false,
"evidenceReferencesReadOnly": false,
"liveMetricsQueryAllowed": false,
"liveDashboardQueryAllowed": false,
"dashboardMutationAllowed": false,
"workflowMutationAllowed": false,
"providerCallsAllowed": false,
"notificationDispatchAllowed": false,
"rawMetricRowsAllowed": false,
"rawRequestRowsAllowed": false,
"rawOperationRowsAllowed": false,
"rawInventoryRowsAllowed": false,
"rawCmdbRowsAllowed": false,
"rawBackupRowsAllowed": false,
"rawMonitoringRowsAllowed": false,
"rawProviderPayloadsAllowed": false,
"rawUserDataAllowed": false,
"rawRecipientDataAllowed": false,
"credentialValuesAllowed": false,
"tokenValuesAllowed": false,
"tenantIdentifiersAllowed": false,
"objectIdentifiersAllowed": false,
"principalIdentifiersAllowed": false,
"privateNetworkValuesAllowed": false,
"dimensions": [],
"riskDomains": [],
"riskBands": [],
"trendWindows": [],
"requiredGuards": [],
"blockedReasons": [],
"requiredEvidence": [],
"rules": []
}