Platform configuration keys (full catalog)
This page lists every known platform configuration key extracted from repo sources. Operators and integrators should use the public guide: Platform configuration.
Nextra hides this folder from the public sidebar. Do not link here from public docs.
Sources
| Source | Role |
|---|---|
SetupPlatformConfigurationService.cs | Seeds public_api_v1.*, frontend.facade, runner_config.*, system.ProjectWorkerContainerImage |
SetupService.cs | Seeds report.*, system.core.auth_mode |
PlatformConfigDefaults.json | HEAT Auth dev bootstrap defaults (may not match DB) |
| Runtime / operators | qa.*, monitoring.Grafana.*, custom report.Configurations.* |
Machine-readable manifest: docs/platform-config-keys.json.
Full key catalog (generated)
Entries: 100 exact keys plus 3 patterns. Regenerate: node docs/scripts/extract-platform-config-keys.mjs --write-internal from repo root.
public_api_v1.* (seeded at setup)
| Key | Type | Default | Summary |
|---|---|---|---|
public_api_v1.AzureAdB2CSettings.BaseUrl | String | https://graph.microsoft.com/v1.0 | Azure AD B2C Settings |
public_api_v1.AzureAdB2CSettings.ClientId | String | Client Id for Azure AD B2C | |
public_api_v1.AzureAdB2CSettings.ClientSecret | String | Client secret Azure AD B2C | |
public_api_v1.AzureAdB2CSettings.Domain | String | Domain of the Azure AD B2C | |
public_api_v1.AzureAdB2CSettings.ExtensionsClientId | String | Client id of the extensions app in Azure AD B2C | |
public_api_v1.AzureAdB2CSettings.Instance | String | Instance of Azure AD B2C ex: https://ramlrsb2c.b2clogin.com | |
public_api_v1.AzureAdB2CSettings.Scopes | String | Dashboard.Management | Scopes of Azure AD B2C |
public_api_v1.AzureAdB2CSettings.SignedOutCallbackPath | String | /signout/B2C_1A_signin | Callback path of Azure AD B2C |
public_api_v1.AzureAdB2CSettings.SignUpSignInPolicyId | String | B2C_1A_signin | Callback path of Azure AD B2C |
public_api_v1.AzureAdB2CSettings.TenantId | String | TenantId of Azure AD B2C | |
public_api_v1.BlobStorageSettings.BenefitsConfigurationBlobName | String | benefits-configuration.json | Name of the file that has the benefits configuration |
public_api_v1.BlobStorageSettings.DashboardConfigurationBlobName | String | dashboard-configuration.json | Name of the file that has the DashBoard configuration |
public_api_v1.BlobStorageSettings.DashboardConfigurationContainerName | String | dashboard | Name of the Blob container |
public_api_v1.BlobStorageSettings.LayoutConfigurationName | String | layout-configuration.json | Name of the file that has the Layout configuration |
public_api_v1.BlobStorageSettings.WelcomeSurveyBlobName | String | welcome-survey.json | Name of the file that has the Welcome Survey configuration |
public_api_v1.ConnectionStrings.BlobStorageConnectionString | String | Connection String to Azure Blob Storage | |
public_api_v1.ConnectionStrings.SqlConnectionString | String | SQL Connection String | |
public_api_v1.ContactSupportSettings.ContactSupportEmailFrom | String | no-reply@vrai.ie | E-mail address that sends the support |
public_api_v1.ContactSupportSettings.ContactSupportEmailTemplateCopyId | Number | 4915663 | Id of the e-mail for the template |
public_api_v1.ContactSupportSettings.ContactSupportEmailTo | String | support@vrai.ie | Name of the file that has the DashBoard configuration |
public_api_v1.ContactSupportSettings.Organisation | String | Organization that is sending the e-mail ex: ra-mlrs | |
public_api_v1.CosmosDbSettings.AccountEndpoint | String | Endpoint for the connection to Cosmos DB | |
public_api_v1.CosmosDbSettings.AnalyticsContainerName | String | Analytics | Container name for the analytics data |
public_api_v1.CosmosDbSettings.ContainerName | String | AgnosticDataContainer | Container name for the Agnostics data |
public_api_v1.CosmosDbSettings.ContainerPartitionKey | String | /id | Name of the partition key of the container |
public_api_v1.CosmosDbSettings.ContainerThroughput | Number | 4000 | ContainerThroughput for CosmosDb |
public_api_v1.CosmosDbSettings.DatabaseName | String | HeatSimulationDb | Name of the CosmosDb DataBase |
public_api_v1.CosmosDbSettings.PrimaryKey | String | Key for the connection to CosmosDb | |
public_api_v1.CosmosDbSettings.SkipConnectionTest | Boolean | false | If the connection test for Cosmos should be skipped |
public_api_v1.CustomerSettings.EmailProvider | String | Mailjet | The e-mail provider |
public_api_v1.CustomerSettings.Name | String | The name of the customer | |
public_api_v1.CustomerSettings.ScenarioImageUrl | String | Url for the image representing a session | |
public_api_v1.CustomerSettings.SimLogoUrl | String | Url for the image representing a SIM | |
public_api_v1.DataBaseSettings.MaxRetryCount | Number | 5 | Number of maximun retrys for the database |
public_api_v1.DataBaseSettings.MaxRetryDelay | Number | 15 | The max time for the delay |
public_api_v1.FeatureToggleSettings.FeatureToggles | Json | SESSION_LIST, SESSION_DETAIL_TOP_STATS, | Name of the feature toggles enabled |
public_api_v1.InvitationEmailSettings.FromEmail | String | no-reply@vrai.ie | From email address for the invite |
public_api_v1.InvitationEmailSettings.FromName | String | HEAT | From email address for the invite |
public_api_v1.InvitationEmailSettings.InstructorWelcomeEmailTemplate | Number | 4885298 | Template id for the instructor welcome e-mail |
public_api_v1.InvitationEmailSettings.TraineeWelcomeEmailTemplate | Number | 4885298 | Template id for the Trainee welcome e-mail |
public_api_v1.InvitationEmailSettings.WebAppPublicUrl | String | Url for the Heat | |
public_api_v1.MailjetSettings.MailjetApiKey | String | Api Key for mail jet | |
public_api_v1.MailjetSettings.MailjetApiSecret | String | Api secret for mail jet | |
public_api_v1.OpenApiInfo.Contact.Email | String | development@vrai.ie | Email for contact of the api |
public_api_v1.OpenApiInfo.Contact.Name | String | Development team | Contact name for the Open Api Info |
public_api_v1.OpenApiInfo.Description | String | Web API to manage HEAT Cloud Platform | Description of the Open Api |
public_api_v1.OpenApiInfo.Title | String | Heat Cloud API | Title of the Open Api |
public_api_v1.SendGridSettings.SendGridApiKey | String | Send Grid Api Key |
HEAT Auth PlatformConfigDefaults.json (bootstrap file)
| Key | Default | Summary |
|---|---|---|
public_api_v1.auth-defaults.BlobStorageSettings.BenefitsConfigurationBlobName | benefits-configuration.json | Blob name for benefits configuration |
public_api_v1.auth-defaults.BlobStorageSettings.DashboardConfigurationBlobName | dashboard-configuration.json | Blob name for dashboard configuration |
public_api_v1.auth-defaults.BlobStorageSettings.DashboardConfigurationContainerName | dashboard | Container name for dashboard configuration |
public_api_v1.auth-defaults.BlobStorageSettings.LayoutConfigurationName | layout-configuration.json | Blob name for layout configuration |
public_api_v1.auth-defaults.BlobStorageSettings.WelcomeSurveyBlobName | welcome-survey.json | Blob name for welcome survey |
public_api_v1.auth-defaults.BlobStorageSettings.WelcomeSurveyContainerName | surveys | Container name for welcome survey |
public_api_v1.auth-defaults.ConnectionStrings.BlobStorageConnectionString | DefaultEndpointsProtocol=https;AccountName=hcunrea | Azure Blob Storage connection string |
public_api_v1.auth-defaults.ConnectionStrings.SqlConnectionString | Server=tcp:hc-dev-uksouth-demo-sqlserver.database. | SQL connection string for the primary database |
public_api_v1.auth-defaults.ContactSupportSettings.ContactSupportEmailFrom | no-reply@vrai.ie | Email address used as sender for support emails |
public_api_v1.auth-defaults.ContactSupportSettings.ContactSupportEmailTemplateCopyId | 4915663 | Template copy ID for support email |
public_api_v1.auth-defaults.ContactSupportSettings.ContactSupportEmailTemplateId | 4932637 | Template ID for support email |
public_api_v1.auth-defaults.ContactSupportSettings.ContactSupportEmailTo | support@vrai.ie | Recipient email for support requests |
public_api_v1.auth-defaults.ContactSupportSettings.ContactSupportFrom | no-reply | Display name for support sender |
public_api_v1.auth-defaults.ContactSupportSettings.Organisation | dev org | Organisation name used in communications |
public_api_v1.auth-defaults.ContactSupportSettings.PasswordResetOTPExpiryInHours | 24 | OTP expiry duration in hours |
public_api_v1.auth-defaults.ContactSupportSettings.PasswordResetTemplateId | 7761790 | Template ID for password reset emails |
public_api_v1.auth-defaults.CoreApiSettings.CoreApiUrl | http://core-api | Base URL for Core API |
public_api_v1.auth-defaults.CoreApiSettings.CoreApiUrlLocal | http://localhost:8080 | Base URL for Core API |
public_api_v1.auth-defaults.CoreApiSettings.ProjectId | 1 | Default project ID |
public_api_v1.auth-defaults.CoreApiSettings.SessionTemplateId | 6 | Default session template ID |
public_api_v1.auth-defaults.CosmosDbSettings.AccountEndpoint | https://heatnext-cosmos-unreal-demo.documents.azur | Cosmos DB account endpoint URL |
public_api_v1.auth-defaults.CosmosDbSettings.AnalyticsContainerName | Analytics | Container name for analytics data |
public_api_v1.auth-defaults.CosmosDbSettings.ContainerName | AgnosticDataContainer | Primary Cosmos DB container name |
public_api_v1.auth-defaults.CosmosDbSettings.ContainerPartitionKey | /id | Partition key for Cosmos DB container |
public_api_v1.auth-defaults.CosmosDbSettings.ContainerThroughput | 4000 | Throughput for Cosmos DB container |
public_api_v1.auth-defaults.CosmosDbSettings.DatabaseName | HeatSimulationDb | Cosmos DB database name |
public_api_v1.auth-defaults.CosmosDbSettings.PrimaryKey | ==This will need to be updated manually== | Primary key for Cosmos DB access |
public_api_v1.auth-defaults.CosmosDbSettings.SkipConnectionTest | false | Flag to skip Cosmos DB connection test |
public_api_v1.auth-defaults.CustomerSettings.EmailProvider | Mailjet | Email provider used by the system |
public_api_v1.auth-defaults.CustomerSettings.Name | unreal | Customer name |
public_api_v1.auth-defaults.CustomerSettings.ScenarioImageUrl | https://hcunrealdemosa.blob.core.windows.net/image | URL for scenario image |
public_api_v1.auth-defaults.CustomerSettings.SimLogoUrl | https://hcunrealdemosa.blob.core.windows.net/image | URL for simulation logo |
public_api_v1.auth-defaults.DataBaseSettings.MaxRetryCount | 5 | Maximum number of database retry attempts |
public_api_v1.auth-defaults.DataBaseSettings.MaxRetryDelay | 15 | Maximum delay between database retries in seconds |
public_api_v1.auth-defaults.DataIngressSettings.BlobStorageConnectionString | DefaultEndpointsProtocol=https;AccountName=hcunrea | Connection string for ingress blob storage |
public_api_v1.auth-defaults.DataIngressSettings.BlobStorageContainer | dataingressupload | Blob container for data ingress |
public_api_v1.auth-defaults.DataIngressSettings.CosmosDbBulkServiceMaxRetries | 5 | Max retries for Cosmos DB bulk service |
public_api_v1.auth-defaults.DataIngressSettings.CosmosDbConnectionString | AccountEndpoint=https://heatnext-cosmos-unreal-dem | Cosmos DB connection string for ingestion |
public_api_v1.auth-defaults.DataIngressSettings.CosmosDbContainerName | AgnosticDataContainer | Cosmos DB container for ingestion |
public_api_v1.auth-defaults.DataIngressSettings.CosmosDbDatabaseName | HeatSimulationDb | Cosmos DB database name for ingestion |
public_api_v1.auth-defaults.DataIngressSettings.IsV2DataIngestion | true | Flag to enable V2 data ingestion |
public_api_v1.auth-defaults.FeatureToggleSettings.FeatureToggles | SESSION_LIST, SESSION_DETAIL_TOP_STATS, HIDE_EMPTY | String array representing feature toggles |
public_api_v1.auth-defaults.InvitationEmailSettings.FromEmail | no-reply@vrai.ie | Sender email for invitation emails |
public_api_v1.auth-defaults.InvitationEmailSettings.FromName | HEAT | Sender name for invitation emails |
public_api_v1.auth-defaults.InvitationEmailSettings.InstructorWelcomeEmailTemplate | 4885298 | Template for instructor welcome email |
public_api_v1.auth-defaults.InvitationEmailSettings.TraineeWelcomeEmailTemplate | 4885298 | Template for trainee welcome email |
public_api_v1.auth-defaults.InvitationEmailSettings.WebAppPublicUrl | http://unreal.heat-dev.cloud | Public URL of the web application |
public_api_v1.auth-defaults.MailjetSettings.MailjetApiKey | ==This will need to be updated manually== | Mailjet API key |
public_api_v1.auth-defaults.MailjetSettings.MailjetApiSecret | ==This will need to be updated manually== | Mailjet API secret key |
public_api_v1.auth-defaults.OtpSettings.OtpSize | 4 | Number of digits in OTP |
public_api_v1.auth-defaults.OtpSettings.TimeStep | 600 | OTP validity time step in seconds |
public_api_v1.auth-defaults.SendGridSettings.SendGridApiKey | “ | SendGrid API key |
Dynamic patterns
monitoring.Grafana.Dashboards.{name}: Public dashboard path per service (for example /public-dashboards/{id}).report.Configurations.{configurationKey}.*: Per-report configuration blocks (columns, FileName, and similar) keyed by configurationKey from report.Settings.Reports.scheduler.limits.{runnerName}.*: Per-runner pod scaling limits (minimum_pods, maximum_pods, current_target).