Interface: components
Defined in: src/generated/schema.ts:3480
Properties
headers
headers:
never
Defined in: src/generated/schema.ts:8114
parameters
parameters:
never
Defined in: src/generated/schema.ts:8112
pathItems
pathItems:
never
Defined in: src/generated/schema.ts:8115
requestBodies
requestBodies:
never
Defined in: src/generated/schema.ts:8113
responses
responses:
never
Defined in: src/generated/schema.ts:8111
schemas
schemas:
object
Defined in: src/generated/schema.ts:3481
AlertmanagertypesChannel
AlertmanagertypesChannel:
object
AlertmanagertypesChannel.createdAt?
optionalcreatedAt?:string
Format: date-time
AlertmanagertypesChannel.data
data:
string
AlertmanagertypesChannel.id
id:
string
AlertmanagertypesChannel.name
name:
string
AlertmanagertypesChannel.orgId
orgId:
string
AlertmanagertypesChannel.type
type:
string
AlertmanagertypesChannel.updatedAt?
optionalupdatedAt?:string
Format: date-time
AlertmanagertypesChannelConfig
AlertmanagertypesChannelConfig: {
kind:"slack";spec: {apiUrl:string;channel?:string;sendResolved?:boolean|null;text?:string;title?:string; }; } | {kind:"email";spec: {headers?: {[key:string]:string; };html?:string;sendResolved?:boolean|null;to:string; }; } | {kind:"webhook";spec: {bearerToken?:string;password?:string;sendResolved?:boolean|null;url:string;username?:string; }; } | {kind:"pagerduty";spec: {class?:string;client?:string;clientUrl?:string;component?:string;description?:string;details?: {[key:string]:string; };group?:string;routingKey:string;sendResolved?:boolean|null;severity?:string;source?:string;url?:string; }; } | {kind:"opsgenie";spec: {apiKey:string;apiUrl?:string;description?:string;details?: {[key:string]:string; };message?:string;priority?:string;sendResolved?:boolean|null;source?:string; }; } | {kind:"msteams";spec: {sendResolved?:boolean|null;text?:string;title?:string;webhookUrl:string; }; } | {kind:"googlechat";spec: {sendResolved?:boolean|null;text?:string;title?:string;webhookUrl:string; }; } | {kind:"jira";spec: {apiToken:string;customFields?: {[key:string]:unknown; };description?:string;string;issueType:string;labels?:string[];priority?:string;project:string;reopenDuration?:string;reopenTransition?:string;resolveTransition?:string;sendResolved?:boolean|null;site:string;summary?:string;wontFixResolution?:string; }; } | {kind:"jsmops";spec: {apiKey:string;description?:string;message?:string;priority?:string;sendResolved?:boolean|null;tags?:string; }; } | {kind:"incidentio";spec: {description?:string;metadata?: {[key:string]:string; };sendResolved?:boolean|null;title?:string;token:string;url:string; }; }
Union Members
Type Literal
{ kind: "slack"; spec: { apiUrl: string; channel?: string; sendResolved?: boolean | null; text?: string; title?: string; }; }
kind
kind:
"slack"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiUrl
apiUrl:
string
Format: password
spec.channel?
optionalchannel?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
Type Literal
{ kind: "email"; spec: { headers?: {[key: string]: string; }; html?: string; sendResolved?: boolean | null; to: string; }; }
kind
kind:
"email"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.headers?
optionalheaders?:object
Index Signature
[key: string]: string
spec.html?
optionalhtml?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.to
to:
string
Type Literal
{ kind: "webhook"; spec: { bearerToken?: string; password?: string; sendResolved?: boolean | null; url: string; username?: string; }; }
kind
kind:
"webhook"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.bearerToken?
optionalbearerToken?:string
Format: password
spec.password?
optionalpassword?:string
Format: password
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.url
url:
string
Format: password
spec.username?
optionalusername?:string
Type Literal
{ kind: "pagerduty"; spec: { class?: string; client?: string; clientUrl?: string; component?: string; description?: string; details?: {[key: string]: string; }; group?: string; routingKey: string; sendResolved?: boolean | null; severity?: string; source?: string; url?: string; }; }
kind
kind:
"pagerduty"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.class?
optionalclass?:string
spec.client?
optionalclient?:string
spec.clientUrl?
optionalclientUrl?:string
spec.component?
optionalcomponent?:string
spec.description?
optionaldescription?:string
spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
spec.group?
optionalgroup?:string
spec.routingKey
routingKey:
string
Format: password
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.severity?
optionalseverity?:string
spec.source?
optionalsource?:string
spec.url?
optionalurl?:string
Type Literal
{ kind: "opsgenie"; spec: { apiKey: string; apiUrl?: string; description?: string; details?: {[key: string]: string; }; message?: string; priority?: string; sendResolved?: boolean | null; source?: string; }; }
kind
kind:
"opsgenie"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiKey
apiKey:
string
Format: password
spec.apiUrl?
optionalapiUrl?:string
spec.description?
optionaldescription?:string
spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
spec.message?
optionalmessage?:string
spec.priority?
optionalpriority?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.source?
optionalsource?:string
Type Literal
{ kind: "msteams"; spec: { sendResolved?: boolean | null; text?: string; title?: string; webhookUrl: string; }; }
kind
kind:
"msteams"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
spec.webhookUrl
webhookUrl:
string
Format: password
Type Literal
{ kind: "googlechat"; spec: { sendResolved?: boolean | null; text?: string; title?: string; webhookUrl: string; }; }
kind
kind:
"googlechat"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
spec.webhookUrl
webhookUrl:
string
Format: password
Type Literal
{ kind: "jira"; spec: { apiToken: string; customFields?: {[key: string]: unknown; }; description?: string; email: string; issueType: string; labels?: string[]; priority?: string; project: string; reopenDuration?: string; reopenTransition?: string; resolveTransition?: string; sendResolved?: boolean | null; site: string; summary?: string; wontFixResolution?: string; }; }
kind
kind:
"jira"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiToken
apiToken:
string
Format: password
spec.customFields?
optionalcustomFields?:object
Index Signature
[key: string]: unknown
spec.description?
optionaldescription?:string
spec.email
email:
string
spec.issueType
issueType:
string
spec.labels?
optionallabels?:string[]
spec.priority?
optionalpriority?:string
spec.project
project:
string
spec.reopenDuration?
optionalreopenDuration?:string
spec.reopenTransition?
optionalreopenTransition?:string
spec.resolveTransition?
optionalresolveTransition?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.site
site:
string
spec.summary?
optionalsummary?:string
spec.wontFixResolution?
optionalwontFixResolution?:string
Type Literal
{ kind: "jsmops"; spec: { apiKey: string; description?: string; message?: string; priority?: string; sendResolved?: boolean | null; tags?: string; }; }
kind
kind:
"jsmops"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiKey
apiKey:
string
Format: password
spec.description?
optionaldescription?:string
spec.message?
optionalmessage?:string
spec.priority?
optionalpriority?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.tags?
optionaltags?:string
Type Literal
{ kind: "incidentio"; spec: { description?: string; metadata?: {[key: string]: string; }; sendResolved?: boolean | null; title?: string; token: string; url: string; }; }
kind
kind:
"incidentio"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.description?
optionaldescription?:string
spec.metadata?
optionalmetadata?:object
Index Signature
[key: string]: string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.title?
optionaltitle?:string
spec.token
token:
string
Format: password
spec.url
url:
string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelEmailConfig
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelEmailConfig:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelEmailConfig.kind
kind:
"email"
Description
discriminator enum property added by openapi-typescript
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelEmailConfig.spec
spec:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelEmailConfig.spec.headers?
optionalheaders?:object
Index Signature
[key: string]: string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelEmailConfig.spec.html?
optionalhtml?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelEmailConfig.spec.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelEmailConfig.spec.to
to:
string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelGoogleChatConfig
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelGoogleChatConfig:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelGoogleChatConfig.kind
kind:
"googlechat"
Description
discriminator enum property added by openapi-typescript
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelGoogleChatConfig.spec
spec:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelGoogleChatConfig.spec.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelGoogleChatConfig.spec.text?
optionaltext?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelGoogleChatConfig.spec.title?
optionaltitle?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelGoogleChatConfig.spec.webhookUrl
webhookUrl:
string
Format: password
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelIncidentIOConfig
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelIncidentIOConfig:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelIncidentIOConfig.kind
kind:
"incidentio"
Description
discriminator enum property added by openapi-typescript
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelIncidentIOConfig.spec
spec:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelIncidentIOConfig.spec.description?
optionaldescription?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelIncidentIOConfig.spec.metadata?
optionalmetadata?:object
Index Signature
[key: string]: string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelIncidentIOConfig.spec.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelIncidentIOConfig.spec.title?
optionaltitle?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelIncidentIOConfig.spec.token
token:
string
Format: password
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelIncidentIOConfig.spec.url
url:
string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.kind
kind:
"jira"
Description
discriminator enum property added by openapi-typescript
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec
spec:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.apiToken
apiToken:
string
Format: password
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.customFields?
optionalcustomFields?:object
Index Signature
[key: string]: unknown
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.description?
optionaldescription?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.email
email:
string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.issueType
issueType:
string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.labels?
optionallabels?:string[]
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.priority?
optionalpriority?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.project
project:
string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.reopenDuration?
optionalreopenDuration?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.reopenTransition?
optionalreopenTransition?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.resolveTransition?
optionalresolveTransition?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.site
site:
string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.summary?
optionalsummary?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJiraConfig.spec.wontFixResolution?
optionalwontFixResolution?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJSMOpsConfig
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJSMOpsConfig:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJSMOpsConfig.kind
kind:
"jsmops"
Description
discriminator enum property added by openapi-typescript
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJSMOpsConfig.spec
spec:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJSMOpsConfig.spec.apiKey
apiKey:
string
Format: password
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJSMOpsConfig.spec.description?
optionaldescription?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJSMOpsConfig.spec.message?
optionalmessage?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJSMOpsConfig.spec.priority?
optionalpriority?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJSMOpsConfig.spec.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelJSMOpsConfig.spec.tags?
optionaltags?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelMSTeamsConfig
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelMSTeamsConfig:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelMSTeamsConfig.kind
kind:
"msteams"
Description
discriminator enum property added by openapi-typescript
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelMSTeamsConfig.spec
spec:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelMSTeamsConfig.spec.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelMSTeamsConfig.spec.text?
optionaltext?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelMSTeamsConfig.spec.title?
optionaltitle?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelMSTeamsConfig.spec.webhookUrl
webhookUrl:
string
Format: password
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig.kind
kind:
"opsgenie"
Description
discriminator enum property added by openapi-typescript
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig.spec
spec:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig.spec.apiKey
apiKey:
string
Format: password
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig.spec.apiUrl?
optionalapiUrl?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig.spec.description?
optionaldescription?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig.spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig.spec.message?
optionalmessage?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig.spec.priority?
optionalpriority?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig.spec.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelOpsgenieConfig.spec.source?
optionalsource?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.kind
kind:
"pagerduty"
Description
discriminator enum property added by openapi-typescript
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec
spec:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.class?
optionalclass?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.client?
optionalclient?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.clientUrl?
optionalclientUrl?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.component?
optionalcomponent?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.description?
optionaldescription?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.group?
optionalgroup?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.routingKey
routingKey:
string
Format: password
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.severity?
optionalseverity?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.source?
optionalsource?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelPagerdutyConfig.spec.url?
optionalurl?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelSlackConfig
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelSlackConfig:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelSlackConfig.kind
kind:
"slack"
Description
discriminator enum property added by openapi-typescript
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelSlackConfig.spec
spec:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelSlackConfig.spec.apiUrl
apiUrl:
string
Format: password
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelSlackConfig.spec.channel?
optionalchannel?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelSlackConfig.spec.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelSlackConfig.spec.text?
optionaltext?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelSlackConfig.spec.title?
optionaltitle?:string
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelWebhookConfig
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelWebhookConfig:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelWebhookConfig.kind
kind:
"webhook"
Description
discriminator enum property added by openapi-typescript
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelWebhookConfig.spec
spec:
object
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelWebhookConfig.spec.bearerToken?
optionalbearerToken?:string
Format: password
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelWebhookConfig.spec.password?
optionalpassword?:string
Format: password
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelWebhookConfig.spec.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelWebhookConfig.spec.url
url:
string
Format: password
AlertmanagertypesChannelConfigVariantGithubComSigNozSignozPkgTypesAlertmanagertypesChannelWebhookConfig.spec.username?
optionalusername?:string
AlertmanagertypesChannelEmailConfig
AlertmanagertypesChannelEmailConfig:
object
AlertmanagertypesChannelEmailConfig.headers?
optionalheaders?:object
Index Signature
[key: string]: string
AlertmanagertypesChannelEmailConfig.html?
optionalhtml?:string
AlertmanagertypesChannelEmailConfig.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelEmailConfig.to
to:
string
AlertmanagertypesChannelGoogleChatConfig
AlertmanagertypesChannelGoogleChatConfig:
object
AlertmanagertypesChannelGoogleChatConfig.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelGoogleChatConfig.text?
optionaltext?:string
AlertmanagertypesChannelGoogleChatConfig.title?
optionaltitle?:string
AlertmanagertypesChannelGoogleChatConfig.webhookUrl
webhookUrl:
string
Format: password
AlertmanagertypesChannelIncidentIOConfig
AlertmanagertypesChannelIncidentIOConfig:
object
AlertmanagertypesChannelIncidentIOConfig.description?
optionaldescription?:string
AlertmanagertypesChannelIncidentIOConfig.metadata?
optionalmetadata?:object
Index Signature
[key: string]: string
AlertmanagertypesChannelIncidentIOConfig.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelIncidentIOConfig.title?
optionaltitle?:string
AlertmanagertypesChannelIncidentIOConfig.token
token:
string
Format: password
AlertmanagertypesChannelIncidentIOConfig.url
url:
string
AlertmanagertypesChannelJiraConfig
AlertmanagertypesChannelJiraConfig:
object
AlertmanagertypesChannelJiraConfig.apiToken
apiToken:
string
Format: password
AlertmanagertypesChannelJiraConfig.customFields?
optionalcustomFields?:object
Index Signature
[key: string]: unknown
AlertmanagertypesChannelJiraConfig.description?
optionaldescription?:string
AlertmanagertypesChannelJiraConfig.email
email:
string
AlertmanagertypesChannelJiraConfig.issueType
issueType:
string
AlertmanagertypesChannelJiraConfig.labels?
optionallabels?:string[]
AlertmanagertypesChannelJiraConfig.priority?
optionalpriority?:string
AlertmanagertypesChannelJiraConfig.project
project:
string
AlertmanagertypesChannelJiraConfig.reopenDuration?
optionalreopenDuration?:string
AlertmanagertypesChannelJiraConfig.reopenTransition?
optionalreopenTransition?:string
AlertmanagertypesChannelJiraConfig.resolveTransition?
optionalresolveTransition?:string
AlertmanagertypesChannelJiraConfig.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelJiraConfig.site
site:
string
AlertmanagertypesChannelJiraConfig.summary?
optionalsummary?:string
AlertmanagertypesChannelJiraConfig.wontFixResolution?
optionalwontFixResolution?:string
AlertmanagertypesChannelJSMOpsConfig
AlertmanagertypesChannelJSMOpsConfig:
object
AlertmanagertypesChannelJSMOpsConfig.apiKey
apiKey:
string
Format: password
AlertmanagertypesChannelJSMOpsConfig.description?
optionaldescription?:string
AlertmanagertypesChannelJSMOpsConfig.message?
optionalmessage?:string
AlertmanagertypesChannelJSMOpsConfig.priority?
optionalpriority?:string
AlertmanagertypesChannelJSMOpsConfig.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelJSMOpsConfig.tags?
optionaltags?:string
AlertmanagertypesChannelKind
AlertmanagertypesChannelKind:
"slack"|"email"|"webhook"|"pagerduty"|"opsgenie"|"msteams"|"googlechat"|"jira"|"jsmops"|"incidentio"
AlertmanagertypesChannelListOrder
AlertmanagertypesChannelListOrder:
"asc"|"desc"
AlertmanagertypesChannelListSort
AlertmanagertypesChannelListSort:
"updated_at"|"created_at"|"name"
AlertmanagertypesChannelMSTeamsConfig
AlertmanagertypesChannelMSTeamsConfig:
object
AlertmanagertypesChannelMSTeamsConfig.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelMSTeamsConfig.text?
optionaltext?:string
AlertmanagertypesChannelMSTeamsConfig.title?
optionaltitle?:string
AlertmanagertypesChannelMSTeamsConfig.webhookUrl
webhookUrl:
string
Format: password
AlertmanagertypesChannelOpsgenieConfig
AlertmanagertypesChannelOpsgenieConfig:
object
AlertmanagertypesChannelOpsgenieConfig.apiKey
apiKey:
string
Format: password
AlertmanagertypesChannelOpsgenieConfig.apiUrl?
optionalapiUrl?:string
AlertmanagertypesChannelOpsgenieConfig.description?
optionaldescription?:string
AlertmanagertypesChannelOpsgenieConfig.details?
optionaldetails?:object
Index Signature
[key: string]: string
AlertmanagertypesChannelOpsgenieConfig.message?
optionalmessage?:string
AlertmanagertypesChannelOpsgenieConfig.priority?
optionalpriority?:string
AlertmanagertypesChannelOpsgenieConfig.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelOpsgenieConfig.source?
optionalsource?:string
AlertmanagertypesChannelPagerdutyConfig
AlertmanagertypesChannelPagerdutyConfig:
object
AlertmanagertypesChannelPagerdutyConfig.class?
optionalclass?:string
AlertmanagertypesChannelPagerdutyConfig.client?
optionalclient?:string
AlertmanagertypesChannelPagerdutyConfig.clientUrl?
optionalclientUrl?:string
AlertmanagertypesChannelPagerdutyConfig.component?
optionalcomponent?:string
AlertmanagertypesChannelPagerdutyConfig.description?
optionaldescription?:string
AlertmanagertypesChannelPagerdutyConfig.details?
optionaldetails?:object
Index Signature
[key: string]: string
AlertmanagertypesChannelPagerdutyConfig.group?
optionalgroup?:string
AlertmanagertypesChannelPagerdutyConfig.routingKey
routingKey:
string
Format: password
AlertmanagertypesChannelPagerdutyConfig.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelPagerdutyConfig.severity?
optionalseverity?:string
AlertmanagertypesChannelPagerdutyConfig.source?
optionalsource?:string
AlertmanagertypesChannelPagerdutyConfig.url?
optionalurl?:string
AlertmanagertypesChannelSlackConfig
AlertmanagertypesChannelSlackConfig:
object
AlertmanagertypesChannelSlackConfig.apiUrl
apiUrl:
string
Format: password
AlertmanagertypesChannelSlackConfig.channel?
optionalchannel?:string
AlertmanagertypesChannelSlackConfig.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelSlackConfig.text?
optionaltext?:string
AlertmanagertypesChannelSlackConfig.title?
optionaltitle?:string
AlertmanagertypesChannelWebhookConfig
AlertmanagertypesChannelWebhookConfig:
object
AlertmanagertypesChannelWebhookConfig.bearerToken?
optionalbearerToken?:string
Format: password
AlertmanagertypesChannelWebhookConfig.password?
optionalpassword?:string
Format: password
AlertmanagertypesChannelWebhookConfig.sendResolved?
optionalsendResolved?:boolean|null
AlertmanagertypesChannelWebhookConfig.url
url:
string
Format: password
AlertmanagertypesChannelWebhookConfig.username?
optionalusername?:string
AlertmanagertypesDeprecatedGettableAlert
AlertmanagertypesDeprecatedGettableAlert:
object
AlertmanagertypesDeprecatedGettableAlert.annotations?
optionalannotations?:object
Index Signature
[key: string]: string
AlertmanagertypesDeprecatedGettableAlert.endsAt?
optionalendsAt?:string
Format: date-time
AlertmanagertypesDeprecatedGettableAlert.fingerprint?
optionalfingerprint?:string
AlertmanagertypesDeprecatedGettableAlert.generatorURL?
optionalgeneratorURL?:string
AlertmanagertypesDeprecatedGettableAlert.labels?
optionallabels?:object
Index Signature
[key: string]: string
AlertmanagertypesDeprecatedGettableAlert.receivers?
optionalreceivers?:string[] |null
AlertmanagertypesDeprecatedGettableAlert.startsAt?
optionalstartsAt?:string
Format: date-time
AlertmanagertypesDeprecatedGettableAlert.status?
optionalstatus?:object
AlertmanagertypesDeprecatedGettableAlert.status.inhibitedBy?
optionalinhibitedBy?:string[] |null
AlertmanagertypesDeprecatedGettableAlert.status.silencedBy?
optionalsilencedBy?:string[] |null
AlertmanagertypesDeprecatedGettableAlert.status.state?
optionalstate?:string
AlertmanagertypesExpressionKind
AlertmanagertypesExpressionKind:
"rule"|"policy"
AlertmanagertypesGettableNotificationChannel
AlertmanagertypesGettableNotificationChannel:
object
AlertmanagertypesGettableNotificationChannel.config
config: {
kind:"slack";spec: {apiUrl:string;channel?:string;sendResolved?:boolean|null;text?:string;title?:string; }; } | {kind:"email";spec: {headers?: {[key:string]:string; };html?:string;sendResolved?:boolean|null;to:string; }; } | {kind:"webhook";spec: {bearerToken?:string;password?:string;sendResolved?:boolean|null;url:string;username?:string; }; } | {kind:"pagerduty";spec: {class?:string;client?:string;clientUrl?:string;component?:string;description?:string;details?: {[key:string]:string; };group?:string;routingKey:string;sendResolved?:boolean|null;severity?:string;source?:string;url?:string; }; } | {kind:"opsgenie";spec: {apiKey:string;apiUrl?:string;description?:string;details?: {[key:string]:string; };message?:string;priority?:string;sendResolved?:boolean|null;source?:string; }; } | {kind:"msteams";spec: {sendResolved?:boolean|null;text?:string;title?:string;webhookUrl:string; }; } | {kind:"googlechat";spec: {sendResolved?:boolean|null;text?:string;title?:string;webhookUrl:string; }; } | {kind:"jira";spec: {apiToken:string;customFields?: {[key:string]:unknown; };description?:string;string;issueType:string;labels?:string[];priority?:string;project:string;reopenDuration?:string;reopenTransition?:string;resolveTransition?:string;sendResolved?:boolean|null;site:string;summary?:string;wontFixResolution?:string; }; } | {kind:"jsmops";spec: {apiKey:string;description?:string;message?:string;priority?:string;sendResolved?:boolean|null;tags?:string; }; } | {kind:"incidentio";spec: {description?:string;metadata?: {[key:string]:string; };sendResolved?:boolean|null;title?:string;token:string;url:string; }; }
Union Members
Type Literal
{ kind: "slack"; spec: { apiUrl: string; channel?: string; sendResolved?: boolean | null; text?: string; title?: string; }; }
kind
kind:
"slack"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiUrl
apiUrl:
string
Format: password
spec.channel?
optionalchannel?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
Type Literal
{ kind: "email"; spec: { headers?: {[key: string]: string; }; html?: string; sendResolved?: boolean | null; to: string; }; }
kind
kind:
"email"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.headers?
optionalheaders?:object
Index Signature
[key: string]: string
spec.html?
optionalhtml?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.to
to:
string
Type Literal
{ kind: "webhook"; spec: { bearerToken?: string; password?: string; sendResolved?: boolean | null; url: string; username?: string; }; }
kind
kind:
"webhook"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.bearerToken?
optionalbearerToken?:string
Format: password
spec.password?
optionalpassword?:string
Format: password
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.url
url:
string
Format: password
spec.username?
optionalusername?:string
Type Literal
{ kind: "pagerduty"; spec: { class?: string; client?: string; clientUrl?: string; component?: string; description?: string; details?: {[key: string]: string; }; group?: string; routingKey: string; sendResolved?: boolean | null; severity?: string; source?: string; url?: string; }; }
kind
kind:
"pagerduty"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.class?
optionalclass?:string
spec.client?
optionalclient?:string
spec.clientUrl?
optionalclientUrl?:string
spec.component?
optionalcomponent?:string
spec.description?
optionaldescription?:string
spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
spec.group?
optionalgroup?:string
spec.routingKey
routingKey:
string
Format: password
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.severity?
optionalseverity?:string
spec.source?
optionalsource?:string
spec.url?
optionalurl?:string
Type Literal
{ kind: "opsgenie"; spec: { apiKey: string; apiUrl?: string; description?: string; details?: {[key: string]: string; }; message?: string; priority?: string; sendResolved?: boolean | null; source?: string; }; }
kind
kind:
"opsgenie"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiKey
apiKey:
string
Format: password
spec.apiUrl?
optionalapiUrl?:string
spec.description?
optionaldescription?:string
spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
spec.message?
optionalmessage?:string
spec.priority?
optionalpriority?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.source?
optionalsource?:string
Type Literal
{ kind: "msteams"; spec: { sendResolved?: boolean | null; text?: string; title?: string; webhookUrl: string; }; }
kind
kind:
"msteams"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
spec.webhookUrl
webhookUrl:
string
Format: password
Type Literal
{ kind: "googlechat"; spec: { sendResolved?: boolean | null; text?: string; title?: string; webhookUrl: string; }; }
kind
kind:
"googlechat"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
spec.webhookUrl
webhookUrl:
string
Format: password
Type Literal
{ kind: "jira"; spec: { apiToken: string; customFields?: {[key: string]: unknown; }; description?: string; email: string; issueType: string; labels?: string[]; priority?: string; project: string; reopenDuration?: string; reopenTransition?: string; resolveTransition?: string; sendResolved?: boolean | null; site: string; summary?: string; wontFixResolution?: string; }; }
kind
kind:
"jira"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiToken
apiToken:
string
Format: password
spec.customFields?
optionalcustomFields?:object
Index Signature
[key: string]: unknown
spec.description?
optionaldescription?:string
spec.email
email:
string
spec.issueType
issueType:
string
spec.labels?
optionallabels?:string[]
spec.priority?
optionalpriority?:string
spec.project
project:
string
spec.reopenDuration?
optionalreopenDuration?:string
spec.reopenTransition?
optionalreopenTransition?:string
spec.resolveTransition?
optionalresolveTransition?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.site
site:
string
spec.summary?
optionalsummary?:string
spec.wontFixResolution?
optionalwontFixResolution?:string
Type Literal
{ kind: "jsmops"; spec: { apiKey: string; description?: string; message?: string; priority?: string; sendResolved?: boolean | null; tags?: string; }; }
kind
kind:
"jsmops"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiKey
apiKey:
string
Format: password
spec.description?
optionaldescription?:string
spec.message?
optionalmessage?:string
spec.priority?
optionalpriority?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.tags?
optionaltags?:string
Type Literal
{ kind: "incidentio"; spec: { description?: string; metadata?: {[key: string]: string; }; sendResolved?: boolean | null; title?: string; token: string; url: string; }; }
kind
kind:
"incidentio"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.description?
optionaldescription?:string
spec.metadata?
optionalmetadata?:object
Index Signature
[key: string]: string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.title?
optionaltitle?:string
spec.token
token:
string
Format: password
spec.url
url:
string
AlertmanagertypesGettableNotificationChannel.createdAt
createdAt:
string
Format: date-time
AlertmanagertypesGettableNotificationChannel.displayName
displayName:
string
AlertmanagertypesGettableNotificationChannel.id
id:
string
AlertmanagertypesGettableNotificationChannel.name
name:
string
AlertmanagertypesGettableNotificationChannel.updatedAt
updatedAt:
string
Format: date-time
AlertmanagertypesGettableRoutePolicy
AlertmanagertypesGettableRoutePolicy:
object
AlertmanagertypesGettableRoutePolicy.channels
channels:
string[] |null
AlertmanagertypesGettableRoutePolicy.createdAt
createdAt:
string
Format: date-time
AlertmanagertypesGettableRoutePolicy.createdBy?
optionalcreatedBy?:string|null
AlertmanagertypesGettableRoutePolicy.description?
optionaldescription?:string
AlertmanagertypesGettableRoutePolicy.expression
expression:
string
AlertmanagertypesGettableRoutePolicy.id
id:
string
AlertmanagertypesGettableRoutePolicy.kind?
optionalkind?:"rule"|"policy"
AlertmanagertypesGettableRoutePolicy.name
name:
string
AlertmanagertypesGettableRoutePolicy.tags?
optionaltags?:string[] |null
AlertmanagertypesGettableRoutePolicy.updatedAt
updatedAt:
string
Format: date-time
AlertmanagertypesGettableRoutePolicy.updatedBy?
optionalupdatedBy?:string|null
AlertmanagertypesGoogleChatReceiverConfig
AlertmanagertypesGoogleChatReceiverConfig:
object
AlertmanagertypesGoogleChatReceiverConfig.http_config?
optionalhttp_config?:object
AlertmanagertypesGoogleChatReceiverConfig.http_config.authorization?
optionalauthorization?:object
AlertmanagertypesGoogleChatReceiverConfig.http_config.authorization.credentials?
optionalcredentials?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.authorization.type?
optionaltype?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.basic_auth?
optionalbasic_auth?:object
AlertmanagertypesGoogleChatReceiverConfig.http_config.basic_auth.password?
optionalpassword?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.basic_auth.username?
optionalusername?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.bearer_token?
optionalbearer_token?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.enable_http2?
optionalenable_http2?:boolean
AlertmanagertypesGoogleChatReceiverConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
AlertmanagertypesGoogleChatReceiverConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
AlertmanagertypesGoogleChatReceiverConfig.http_config.no_proxy?
optionalno_proxy?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2?
optionaloauth2?:object
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.audience?
optionalaudience?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.client_id?
optionalclient_id?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.iss?
optionaliss?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
AlertmanagertypesGoogleChatReceiverConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
AlertmanagertypesGoogleChatReceiverConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config?
optionaltls_config?:object
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.ca?
optionalca?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.ca_file?
optionalca_file?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.cert?
optionalcert?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.key?
optionalkey?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.key_file?
optionalkey_file?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.max_version?
optionalmax_version?:number
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.min_version?
optionalmin_version?:number
AlertmanagertypesGoogleChatReceiverConfig.http_config.tls_config.server_name?
optionalserver_name?:string
AlertmanagertypesGoogleChatReceiverConfig.send_resolved?
optionalsend_resolved?:boolean
AlertmanagertypesGoogleChatReceiverConfig.text?
optionaltext?:string
AlertmanagertypesGoogleChatReceiverConfig.title?
optionaltitle?:string
AlertmanagertypesGoogleChatReceiverConfig.webhook_url?
optionalwebhook_url?:Record<string,never>
AlertmanagertypesIncidentIOReceiverConfig
AlertmanagertypesIncidentIOReceiverConfig:
object
AlertmanagertypesIncidentIOReceiverConfig.description?
optionaldescription?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config?
optionalhttp_config?:object
AlertmanagertypesIncidentIOReceiverConfig.http_config.authorization?
optionalauthorization?:object
AlertmanagertypesIncidentIOReceiverConfig.http_config.authorization.credentials?
optionalcredentials?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.authorization.type?
optionaltype?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.basic_auth?
optionalbasic_auth?:object
AlertmanagertypesIncidentIOReceiverConfig.http_config.basic_auth.password?
optionalpassword?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.basic_auth.username?
optionalusername?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.bearer_token?
optionalbearer_token?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.enable_http2?
optionalenable_http2?:boolean
AlertmanagertypesIncidentIOReceiverConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
AlertmanagertypesIncidentIOReceiverConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
AlertmanagertypesIncidentIOReceiverConfig.http_config.no_proxy?
optionalno_proxy?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2?
optionaloauth2?:object
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.audience?
optionalaudience?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.client_id?
optionalclient_id?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.iss?
optionaliss?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
AlertmanagertypesIncidentIOReceiverConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
AlertmanagertypesIncidentIOReceiverConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config?
optionaltls_config?:object
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.ca?
optionalca?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.ca_file?
optionalca_file?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.cert?
optionalcert?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.key?
optionalkey?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.key_file?
optionalkey_file?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.max_version?
optionalmax_version?:number
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.min_version?
optionalmin_version?:number
AlertmanagertypesIncidentIOReceiverConfig.http_config.tls_config.server_name?
optionalserver_name?:string
AlertmanagertypesIncidentIOReceiverConfig.metadata?
optionalmetadata?:object
Index Signature
[key: string]: string
AlertmanagertypesIncidentIOReceiverConfig.send_resolved?
optionalsend_resolved?:boolean
AlertmanagertypesIncidentIOReceiverConfig.title?
optionaltitle?:string
AlertmanagertypesIncidentIOReceiverConfig.token?
optionaltoken?:string
AlertmanagertypesIncidentIOReceiverConfig.url?
optionalurl?:string
AlertmanagertypesJiraReceiverConfig
AlertmanagertypesJiraReceiverConfig:
object
AlertmanagertypesJiraReceiverConfig.custom_fields?
optionalcustom_fields?:object
Index Signature
[key: string]: unknown
AlertmanagertypesJiraReceiverConfig.description?
optionaldescription?:string
AlertmanagertypesJiraReceiverConfig.http_config?
optionalhttp_config?:object
AlertmanagertypesJiraReceiverConfig.http_config.authorization?
optionalauthorization?:object
AlertmanagertypesJiraReceiverConfig.http_config.authorization.credentials?
optionalcredentials?:string
AlertmanagertypesJiraReceiverConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
AlertmanagertypesJiraReceiverConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
AlertmanagertypesJiraReceiverConfig.http_config.authorization.type?
optionaltype?:string
AlertmanagertypesJiraReceiverConfig.http_config.basic_auth?
optionalbasic_auth?:object
AlertmanagertypesJiraReceiverConfig.http_config.basic_auth.password?
optionalpassword?:string
AlertmanagertypesJiraReceiverConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
AlertmanagertypesJiraReceiverConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
AlertmanagertypesJiraReceiverConfig.http_config.basic_auth.username?
optionalusername?:string
AlertmanagertypesJiraReceiverConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
AlertmanagertypesJiraReceiverConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
AlertmanagertypesJiraReceiverConfig.http_config.bearer_token?
optionalbearer_token?:string
AlertmanagertypesJiraReceiverConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
AlertmanagertypesJiraReceiverConfig.http_config.enable_http2?
optionalenable_http2?:boolean
AlertmanagertypesJiraReceiverConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
AlertmanagertypesJiraReceiverConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
AlertmanagertypesJiraReceiverConfig.http_config.no_proxy?
optionalno_proxy?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2?
optionaloauth2?:object
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.audience?
optionalaudience?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.client_id?
optionalclient_id?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.iss?
optionaliss?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
AlertmanagertypesJiraReceiverConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
AlertmanagertypesJiraReceiverConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
AlertmanagertypesJiraReceiverConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
AlertmanagertypesJiraReceiverConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
AlertmanagertypesJiraReceiverConfig.http_config.tls_config?
optionaltls_config?:object
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.ca?
optionalca?:string
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.ca_file?
optionalca_file?:string
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.cert?
optionalcert?:string
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.key?
optionalkey?:string
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.key_file?
optionalkey_file?:string
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.max_version?
optionalmax_version?:number
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.min_version?
optionalmin_version?:number
AlertmanagertypesJiraReceiverConfig.http_config.tls_config.server_name?
optionalserver_name?:string
AlertmanagertypesJiraReceiverConfig.issue_type?
optionalissue_type?:string
AlertmanagertypesJiraReceiverConfig.labels?
optionallabels?:string[]
AlertmanagertypesJiraReceiverConfig.priority?
optionalpriority?:string
AlertmanagertypesJiraReceiverConfig.project?
optionalproject?:string
AlertmanagertypesJiraReceiverConfig.reopen_duration?
optionalreopen_duration?:number
AlertmanagertypesJiraReceiverConfig.reopen_transition?
optionalreopen_transition?:string
AlertmanagertypesJiraReceiverConfig.resolve_transition?
optionalresolve_transition?:string
AlertmanagertypesJiraReceiverConfig.send_resolved?
optionalsend_resolved?:boolean
AlertmanagertypesJiraReceiverConfig.site?
optionalsite?:string
AlertmanagertypesJiraReceiverConfig.summary?
optionalsummary?:string
AlertmanagertypesJiraReceiverConfig.wont_fix_resolution?
optionalwont_fix_resolution?:string
AlertmanagertypesJSMOpsReceiverConfig
AlertmanagertypesJSMOpsReceiverConfig:
object
AlertmanagertypesJSMOpsReceiverConfig.api_key?
optionalapi_key?:string
AlertmanagertypesJSMOpsReceiverConfig.description?
optionaldescription?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config?
optionalhttp_config?:object
AlertmanagertypesJSMOpsReceiverConfig.http_config.authorization?
optionalauthorization?:object
AlertmanagertypesJSMOpsReceiverConfig.http_config.authorization.credentials?
optionalcredentials?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.authorization.type?
optionaltype?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.basic_auth?
optionalbasic_auth?:object
AlertmanagertypesJSMOpsReceiverConfig.http_config.basic_auth.password?
optionalpassword?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.basic_auth.username?
optionalusername?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.bearer_token?
optionalbearer_token?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.enable_http2?
optionalenable_http2?:boolean
AlertmanagertypesJSMOpsReceiverConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
AlertmanagertypesJSMOpsReceiverConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
AlertmanagertypesJSMOpsReceiverConfig.http_config.no_proxy?
optionalno_proxy?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2?
optionaloauth2?:object
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.audience?
optionalaudience?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.client_id?
optionalclient_id?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.iss?
optionaliss?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
AlertmanagertypesJSMOpsReceiverConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
AlertmanagertypesJSMOpsReceiverConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config?
optionaltls_config?:object
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.ca?
optionalca?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.ca_file?
optionalca_file?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.cert?
optionalcert?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.key?
optionalkey?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.key_file?
optionalkey_file?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.max_version?
optionalmax_version?:number
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.min_version?
optionalmin_version?:number
AlertmanagertypesJSMOpsReceiverConfig.http_config.tls_config.server_name?
optionalserver_name?:string
AlertmanagertypesJSMOpsReceiverConfig.message?
optionalmessage?:string
AlertmanagertypesJSMOpsReceiverConfig.priority?
optionalpriority?:string
AlertmanagertypesJSMOpsReceiverConfig.send_resolved?
optionalsend_resolved?:boolean
AlertmanagertypesJSMOpsReceiverConfig.tags?
optionaltags?:string
AlertmanagertypesListableNotificationChannel
AlertmanagertypesListableNotificationChannel:
object
AlertmanagertypesListableNotificationChannel.channels
channels:
object[]
AlertmanagertypesListableNotificationChannel.total
total:
number
Format: int64
AlertmanagertypesListedNotificationChannel
AlertmanagertypesListedNotificationChannel:
object
AlertmanagertypesListedNotificationChannel.createdAt
createdAt:
string
Format: date-time
AlertmanagertypesListedNotificationChannel.displayName
displayName:
string
AlertmanagertypesListedNotificationChannel.id
id:
string
AlertmanagertypesListedNotificationChannel.kind
kind:
"slack"|"email"|"webhook"|"pagerduty"|"opsgenie"|"msteams"|"googlechat"|"jira"|"jsmops"|"incidentio"
AlertmanagertypesListedNotificationChannel.name
name:
string
AlertmanagertypesListedNotificationChannel.updatedAt
updatedAt:
string
Format: date-time
AlertmanagertypesMaintenanceKind
AlertmanagertypesMaintenanceKind:
"fixed"|"recurring"
AlertmanagertypesMaintenanceStatus
AlertmanagertypesMaintenanceStatus:
"active"|"upcoming"|"expired"
AlertmanagertypesPlannedMaintenance
AlertmanagertypesPlannedMaintenance:
object
AlertmanagertypesPlannedMaintenance.alertIds?
optionalalertIds?:string[] |null
AlertmanagertypesPlannedMaintenance.createdAt?
optionalcreatedAt?:string
Format: date-time
AlertmanagertypesPlannedMaintenance.createdBy?
optionalcreatedBy?:string
AlertmanagertypesPlannedMaintenance.description?
optionaldescription?:string
AlertmanagertypesPlannedMaintenance.id
id:
string
AlertmanagertypesPlannedMaintenance.kind
kind:
"fixed"|"recurring"
AlertmanagertypesPlannedMaintenance.name
name:
string
AlertmanagertypesPlannedMaintenance.schedule
schedule:
object
AlertmanagertypesPlannedMaintenance.schedule.endTime?
optionalendTime?:string
Format: date-time
AlertmanagertypesPlannedMaintenance.schedule.recurrence?
optionalrecurrence?:object
AlertmanagertypesPlannedMaintenance.schedule.recurrence.duration
duration:
string
AlertmanagertypesPlannedMaintenance.schedule.recurrence.repeatOn?
optionalrepeatOn?: ("sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday")[] |null
AlertmanagertypesPlannedMaintenance.schedule.recurrence.repeatType
repeatType:
"daily"|"weekly"|"monthly"
AlertmanagertypesPlannedMaintenance.schedule.startTime
startTime:
string
Format: date-time
AlertmanagertypesPlannedMaintenance.schedule.timezone
timezone:
string
AlertmanagertypesPlannedMaintenance.scope?
optionalscope?:string
AlertmanagertypesPlannedMaintenance.status
status:
"active"|"upcoming"|"expired"
AlertmanagertypesPlannedMaintenance.updatedAt?
optionalupdatedAt?:string
Format: date-time
AlertmanagertypesPlannedMaintenance.updatedBy?
optionalupdatedBy?:string
AlertmanagertypesPostableChannel
AlertmanagertypesPostableChannel:
object
AlertmanagertypesPostableChannel.discord_configs?
optionaldiscord_configs?:object[]
AlertmanagertypesPostableChannel.email_configs?
optionalemail_configs?:object[]
AlertmanagertypesPostableChannel.googlechat_configs?
optionalgooglechat_configs?:object[]
AlertmanagertypesPostableChannel.incidentio_configs?
optionalincidentio_configs?:object[]
AlertmanagertypesPostableChannel.jira_configs?
optionaljira_configs?:object[]
AlertmanagertypesPostableChannel.jsmops_configs?
optionaljsmops_configs?:object[]
AlertmanagertypesPostableChannel.mattermost_configs?
optionalmattermost_configs?:object[]
AlertmanagertypesPostableChannel.msteams_configs?
optionalmsteams_configs?:object[]
AlertmanagertypesPostableChannel.msteamsv2_configs?
optionalmsteamsv2_configs?:object[]
AlertmanagertypesPostableChannel.name
name:
string
AlertmanagertypesPostableChannel.opsgenie_configs?
optionalopsgenie_configs?:object[]
AlertmanagertypesPostableChannel.pagerduty_configs?
optionalpagerduty_configs?:object[]
AlertmanagertypesPostableChannel.pushover_configs?
optionalpushover_configs?:object[]
AlertmanagertypesPostableChannel.rocketchat_configs?
optionalrocketchat_configs?:object[]
AlertmanagertypesPostableChannel.slack_configs?
optionalslack_configs?:object[]
AlertmanagertypesPostableChannel.sns_configs?
optionalsns_configs?:object[]
AlertmanagertypesPostableChannel.telegram_configs?
optionaltelegram_configs?:object[]
AlertmanagertypesPostableChannel.victorops_configs?
optionalvictorops_configs?:object[]
AlertmanagertypesPostableChannel.webex_configs?
optionalwebex_configs?:object[]
AlertmanagertypesPostableChannel.webhook_configs?
optionalwebhook_configs?:object[]
AlertmanagertypesPostableChannel.wechat_configs?
optionalwechat_configs?:object[]
AlertmanagertypesPostableNotificationChannel
AlertmanagertypesPostableNotificationChannel:
object
AlertmanagertypesPostableNotificationChannel.config
config: {
kind:"slack";spec: {apiUrl:string;channel?:string;sendResolved?:boolean|null;text?:string;title?:string; }; } | {kind:"email";spec: {headers?: {[key:string]:string; };html?:string;sendResolved?:boolean|null;to:string; }; } | {kind:"webhook";spec: {bearerToken?:string;password?:string;sendResolved?:boolean|null;url:string;username?:string; }; } | {kind:"pagerduty";spec: {class?:string;client?:string;clientUrl?:string;component?:string;description?:string;details?: {[key:string]:string; };group?:string;routingKey:string;sendResolved?:boolean|null;severity?:string;source?:string;url?:string; }; } | {kind:"opsgenie";spec: {apiKey:string;apiUrl?:string;description?:string;details?: {[key:string]:string; };message?:string;priority?:string;sendResolved?:boolean|null;source?:string; }; } | {kind:"msteams";spec: {sendResolved?:boolean|null;text?:string;title?:string;webhookUrl:string; }; } | {kind:"googlechat";spec: {sendResolved?:boolean|null;text?:string;title?:string;webhookUrl:string; }; } | {kind:"jira";spec: {apiToken:string;customFields?: {[key:string]:unknown; };description?:string;string;issueType:string;labels?:string[];priority?:string;project:string;reopenDuration?:string;reopenTransition?:string;resolveTransition?:string;sendResolved?:boolean|null;site:string;summary?:string;wontFixResolution?:string; }; } | {kind:"jsmops";spec: {apiKey:string;description?:string;message?:string;priority?:string;sendResolved?:boolean|null;tags?:string; }; } | {kind:"incidentio";spec: {description?:string;metadata?: {[key:string]:string; };sendResolved?:boolean|null;title?:string;token:string;url:string; }; }
Union Members
Type Literal
{ kind: "slack"; spec: { apiUrl: string; channel?: string; sendResolved?: boolean | null; text?: string; title?: string; }; }
kind
kind:
"slack"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiUrl
apiUrl:
string
Format: password
spec.channel?
optionalchannel?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
Type Literal
{ kind: "email"; spec: { headers?: {[key: string]: string; }; html?: string; sendResolved?: boolean | null; to: string; }; }
kind
kind:
"email"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.headers?
optionalheaders?:object
Index Signature
[key: string]: string
spec.html?
optionalhtml?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.to
to:
string
Type Literal
{ kind: "webhook"; spec: { bearerToken?: string; password?: string; sendResolved?: boolean | null; url: string; username?: string; }; }
kind
kind:
"webhook"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.bearerToken?
optionalbearerToken?:string
Format: password
spec.password?
optionalpassword?:string
Format: password
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.url
url:
string
Format: password
spec.username?
optionalusername?:string
Type Literal
{ kind: "pagerduty"; spec: { class?: string; client?: string; clientUrl?: string; component?: string; description?: string; details?: {[key: string]: string; }; group?: string; routingKey: string; sendResolved?: boolean | null; severity?: string; source?: string; url?: string; }; }
kind
kind:
"pagerduty"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.class?
optionalclass?:string
spec.client?
optionalclient?:string
spec.clientUrl?
optionalclientUrl?:string
spec.component?
optionalcomponent?:string
spec.description?
optionaldescription?:string
spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
spec.group?
optionalgroup?:string
spec.routingKey
routingKey:
string
Format: password
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.severity?
optionalseverity?:string
spec.source?
optionalsource?:string
spec.url?
optionalurl?:string
Type Literal
{ kind: "opsgenie"; spec: { apiKey: string; apiUrl?: string; description?: string; details?: {[key: string]: string; }; message?: string; priority?: string; sendResolved?: boolean | null; source?: string; }; }
kind
kind:
"opsgenie"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiKey
apiKey:
string
Format: password
spec.apiUrl?
optionalapiUrl?:string
spec.description?
optionaldescription?:string
spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
spec.message?
optionalmessage?:string
spec.priority?
optionalpriority?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.source?
optionalsource?:string
Type Literal
{ kind: "msteams"; spec: { sendResolved?: boolean | null; text?: string; title?: string; webhookUrl: string; }; }
kind
kind:
"msteams"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
spec.webhookUrl
webhookUrl:
string
Format: password
Type Literal
{ kind: "googlechat"; spec: { sendResolved?: boolean | null; text?: string; title?: string; webhookUrl: string; }; }
kind
kind:
"googlechat"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
spec.webhookUrl
webhookUrl:
string
Format: password
Type Literal
{ kind: "jira"; spec: { apiToken: string; customFields?: {[key: string]: unknown; }; description?: string; email: string; issueType: string; labels?: string[]; priority?: string; project: string; reopenDuration?: string; reopenTransition?: string; resolveTransition?: string; sendResolved?: boolean | null; site: string; summary?: string; wontFixResolution?: string; }; }
kind
kind:
"jira"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiToken
apiToken:
string
Format: password
spec.customFields?
optionalcustomFields?:object
Index Signature
[key: string]: unknown
spec.description?
optionaldescription?:string
spec.email
email:
string
spec.issueType
issueType:
string
spec.labels?
optionallabels?:string[]
spec.priority?
optionalpriority?:string
spec.project
project:
string
spec.reopenDuration?
optionalreopenDuration?:string
spec.reopenTransition?
optionalreopenTransition?:string
spec.resolveTransition?
optionalresolveTransition?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.site
site:
string
spec.summary?
optionalsummary?:string
spec.wontFixResolution?
optionalwontFixResolution?:string
Type Literal
{ kind: "jsmops"; spec: { apiKey: string; description?: string; message?: string; priority?: string; sendResolved?: boolean | null; tags?: string; }; }
kind
kind:
"jsmops"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiKey
apiKey:
string
Format: password
spec.description?
optionaldescription?:string
spec.message?
optionalmessage?:string
spec.priority?
optionalpriority?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.tags?
optionaltags?:string
Type Literal
{ kind: "incidentio"; spec: { description?: string; metadata?: {[key: string]: string; }; sendResolved?: boolean | null; title?: string; token: string; url: string; }; }
kind
kind:
"incidentio"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.description?
optionaldescription?:string
spec.metadata?
optionalmetadata?:object
Index Signature
[key: string]: string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.title?
optionaltitle?:string
spec.token
token:
string
Format: password
spec.url
url:
string
AlertmanagertypesPostableNotificationChannel.displayName?
optionaldisplayName?:string
AlertmanagertypesPostableNotificationChannel.generateName?
optionalgenerateName?:boolean
AlertmanagertypesPostableNotificationChannel.name?
optionalname?:string
AlertmanagertypesPostablePlannedMaintenance
AlertmanagertypesPostablePlannedMaintenance:
object
AlertmanagertypesPostablePlannedMaintenance.alertIds?
optionalalertIds?:string[] |null
AlertmanagertypesPostablePlannedMaintenance.description?
optionaldescription?:string
AlertmanagertypesPostablePlannedMaintenance.name
name:
string
AlertmanagertypesPostablePlannedMaintenance.schedule
schedule:
object
AlertmanagertypesPostablePlannedMaintenance.schedule.endTime?
optionalendTime?:string
Format: date-time
AlertmanagertypesPostablePlannedMaintenance.schedule.recurrence?
optionalrecurrence?:object
AlertmanagertypesPostablePlannedMaintenance.schedule.recurrence.duration
duration:
string
AlertmanagertypesPostablePlannedMaintenance.schedule.recurrence.repeatOn?
optionalrepeatOn?: ("sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday")[] |null
AlertmanagertypesPostablePlannedMaintenance.schedule.recurrence.repeatType
repeatType:
"daily"|"weekly"|"monthly"
AlertmanagertypesPostablePlannedMaintenance.schedule.startTime
startTime:
string
Format: date-time
AlertmanagertypesPostablePlannedMaintenance.schedule.timezone
timezone:
string
AlertmanagertypesPostablePlannedMaintenance.scope?
optionalscope?:string
AlertmanagertypesPostableRoutePolicy
AlertmanagertypesPostableRoutePolicy:
object
AlertmanagertypesPostableRoutePolicy.channels
channels:
string[] |null
AlertmanagertypesPostableRoutePolicy.description?
optionaldescription?:string
AlertmanagertypesPostableRoutePolicy.expression
expression:
string
AlertmanagertypesPostableRoutePolicy.kind?
optionalkind?:"rule"|"policy"
AlertmanagertypesPostableRoutePolicy.name
name:
string
AlertmanagertypesPostableRoutePolicy.tags?
optionaltags?:string[] |null
AlertmanagertypesReceiver
AlertmanagertypesReceiver:
object
AlertmanagertypesReceiver.discord_configs?
optionaldiscord_configs?:object[]
AlertmanagertypesReceiver.email_configs?
optionalemail_configs?:object[]
AlertmanagertypesReceiver.googlechat_configs?
optionalgooglechat_configs?:object[]
AlertmanagertypesReceiver.incidentio_configs?
optionalincidentio_configs?:object[]
AlertmanagertypesReceiver.jira_configs?
optionaljira_configs?:object[]
AlertmanagertypesReceiver.jsmops_configs?
optionaljsmops_configs?:object[]
AlertmanagertypesReceiver.mattermost_configs?
optionalmattermost_configs?:object[]
AlertmanagertypesReceiver.msteams_configs?
optionalmsteams_configs?:object[]
AlertmanagertypesReceiver.msteamsv2_configs?
optionalmsteamsv2_configs?:object[]
AlertmanagertypesReceiver.name?
optionalname?:string
AlertmanagertypesReceiver.opsgenie_configs?
optionalopsgenie_configs?:object[]
AlertmanagertypesReceiver.pagerduty_configs?
optionalpagerduty_configs?:object[]
AlertmanagertypesReceiver.pushover_configs?
optionalpushover_configs?:object[]
AlertmanagertypesReceiver.rocketchat_configs?
optionalrocketchat_configs?:object[]
AlertmanagertypesReceiver.slack_configs?
optionalslack_configs?:object[]
AlertmanagertypesReceiver.sns_configs?
optionalsns_configs?:object[]
AlertmanagertypesReceiver.telegram_configs?
optionaltelegram_configs?:object[]
AlertmanagertypesReceiver.victorops_configs?
optionalvictorops_configs?:object[]
AlertmanagertypesReceiver.webex_configs?
optionalwebex_configs?:object[]
AlertmanagertypesReceiver.webhook_configs?
optionalwebhook_configs?:object[]
AlertmanagertypesReceiver.wechat_configs?
optionalwechat_configs?:object[]
AlertmanagertypesRecurrence
AlertmanagertypesRecurrence:
object
AlertmanagertypesRecurrence.duration
duration:
string
AlertmanagertypesRecurrence.repeatOn?
optionalrepeatOn?: ("sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday")[] |null
AlertmanagertypesRecurrence.repeatType
repeatType:
"daily"|"weekly"|"monthly"
AlertmanagertypesRepeatOn
AlertmanagertypesRepeatOn:
"sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday"
AlertmanagertypesRepeatType
AlertmanagertypesRepeatType:
"daily"|"weekly"|"monthly"
AlertmanagertypesSchedule
AlertmanagertypesSchedule:
object
AlertmanagertypesSchedule.endTime?
optionalendTime?:string
Format: date-time
AlertmanagertypesSchedule.recurrence?
optionalrecurrence?:object
AlertmanagertypesSchedule.recurrence.duration
duration:
string
AlertmanagertypesSchedule.recurrence.repeatOn?
optionalrepeatOn?: ("sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday")[] |null
AlertmanagertypesSchedule.recurrence.repeatType
repeatType:
"daily"|"weekly"|"monthly"
AlertmanagertypesSchedule.startTime
startTime:
string
Format: date-time
AlertmanagertypesSchedule.timezone
timezone:
string
AlertmanagertypesTestableNotificationChannel
AlertmanagertypesTestableNotificationChannel:
object
AlertmanagertypesTestableNotificationChannel.config
config: {
kind:"slack";spec: {apiUrl:string;channel?:string;sendResolved?:boolean|null;text?:string;title?:string; }; } | {kind:"email";spec: {headers?: {[key:string]:string; };html?:string;sendResolved?:boolean|null;to:string; }; } | {kind:"webhook";spec: {bearerToken?:string;password?:string;sendResolved?:boolean|null;url:string;username?:string; }; } | {kind:"pagerduty";spec: {class?:string;client?:string;clientUrl?:string;component?:string;description?:string;details?: {[key:string]:string; };group?:string;routingKey:string;sendResolved?:boolean|null;severity?:string;source?:string;url?:string; }; } | {kind:"opsgenie";spec: {apiKey:string;apiUrl?:string;description?:string;details?: {[key:string]:string; };message?:string;priority?:string;sendResolved?:boolean|null;source?:string; }; } | {kind:"msteams";spec: {sendResolved?:boolean|null;text?:string;title?:string;webhookUrl:string; }; } | {kind:"googlechat";spec: {sendResolved?:boolean|null;text?:string;title?:string;webhookUrl:string; }; } | {kind:"jira";spec: {apiToken:string;customFields?: {[key:string]:unknown; };description?:string;string;issueType:string;labels?:string[];priority?:string;project:string;reopenDuration?:string;reopenTransition?:string;resolveTransition?:string;sendResolved?:boolean|null;site:string;summary?:string;wontFixResolution?:string; }; } | {kind:"jsmops";spec: {apiKey:string;description?:string;message?:string;priority?:string;sendResolved?:boolean|null;tags?:string; }; } | {kind:"incidentio";spec: {description?:string;metadata?: {[key:string]:string; };sendResolved?:boolean|null;title?:string;token:string;url:string; }; }
Union Members
Type Literal
{ kind: "slack"; spec: { apiUrl: string; channel?: string; sendResolved?: boolean | null; text?: string; title?: string; }; }
kind
kind:
"slack"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiUrl
apiUrl:
string
Format: password
spec.channel?
optionalchannel?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
Type Literal
{ kind: "email"; spec: { headers?: {[key: string]: string; }; html?: string; sendResolved?: boolean | null; to: string; }; }
kind
kind:
"email"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.headers?
optionalheaders?:object
Index Signature
[key: string]: string
spec.html?
optionalhtml?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.to
to:
string
Type Literal
{ kind: "webhook"; spec: { bearerToken?: string; password?: string; sendResolved?: boolean | null; url: string; username?: string; }; }
kind
kind:
"webhook"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.bearerToken?
optionalbearerToken?:string
Format: password
spec.password?
optionalpassword?:string
Format: password
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.url
url:
string
Format: password
spec.username?
optionalusername?:string
Type Literal
{ kind: "pagerduty"; spec: { class?: string; client?: string; clientUrl?: string; component?: string; description?: string; details?: {[key: string]: string; }; group?: string; routingKey: string; sendResolved?: boolean | null; severity?: string; source?: string; url?: string; }; }
kind
kind:
"pagerduty"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.class?
optionalclass?:string
spec.client?
optionalclient?:string
spec.clientUrl?
optionalclientUrl?:string
spec.component?
optionalcomponent?:string
spec.description?
optionaldescription?:string
spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
spec.group?
optionalgroup?:string
spec.routingKey
routingKey:
string
Format: password
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.severity?
optionalseverity?:string
spec.source?
optionalsource?:string
spec.url?
optionalurl?:string
Type Literal
{ kind: "opsgenie"; spec: { apiKey: string; apiUrl?: string; description?: string; details?: {[key: string]: string; }; message?: string; priority?: string; sendResolved?: boolean | null; source?: string; }; }
kind
kind:
"opsgenie"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiKey
apiKey:
string
Format: password
spec.apiUrl?
optionalapiUrl?:string
spec.description?
optionaldescription?:string
spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
spec.message?
optionalmessage?:string
spec.priority?
optionalpriority?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.source?
optionalsource?:string
Type Literal
{ kind: "msteams"; spec: { sendResolved?: boolean | null; text?: string; title?: string; webhookUrl: string; }; }
kind
kind:
"msteams"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
spec.webhookUrl
webhookUrl:
string
Format: password
Type Literal
{ kind: "googlechat"; spec: { sendResolved?: boolean | null; text?: string; title?: string; webhookUrl: string; }; }
kind
kind:
"googlechat"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
spec.webhookUrl
webhookUrl:
string
Format: password
Type Literal
{ kind: "jira"; spec: { apiToken: string; customFields?: {[key: string]: unknown; }; description?: string; email: string; issueType: string; labels?: string[]; priority?: string; project: string; reopenDuration?: string; reopenTransition?: string; resolveTransition?: string; sendResolved?: boolean | null; site: string; summary?: string; wontFixResolution?: string; }; }
kind
kind:
"jira"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiToken
apiToken:
string
Format: password
spec.customFields?
optionalcustomFields?:object
Index Signature
[key: string]: unknown
spec.description?
optionaldescription?:string
spec.email
email:
string
spec.issueType
issueType:
string
spec.labels?
optionallabels?:string[]
spec.priority?
optionalpriority?:string
spec.project
project:
string
spec.reopenDuration?
optionalreopenDuration?:string
spec.reopenTransition?
optionalreopenTransition?:string
spec.resolveTransition?
optionalresolveTransition?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.site
site:
string
spec.summary?
optionalsummary?:string
spec.wontFixResolution?
optionalwontFixResolution?:string
Type Literal
{ kind: "jsmops"; spec: { apiKey: string; description?: string; message?: string; priority?: string; sendResolved?: boolean | null; tags?: string; }; }
kind
kind:
"jsmops"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiKey
apiKey:
string
Format: password
spec.description?
optionaldescription?:string
spec.message?
optionalmessage?:string
spec.priority?
optionalpriority?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.tags?
optionaltags?:string
Type Literal
{ kind: "incidentio"; spec: { description?: string; metadata?: {[key: string]: string; }; sendResolved?: boolean | null; title?: string; token: string; url: string; }; }
kind
kind:
"incidentio"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.description?
optionaldescription?:string
spec.metadata?
optionalmetadata?:object
Index Signature
[key: string]: string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.title?
optionaltitle?:string
spec.token
token:
string
Format: password
spec.url
url:
string
AlertmanagertypesUpdatableNotificationChannel
AlertmanagertypesUpdatableNotificationChannel:
object
AlertmanagertypesUpdatableNotificationChannel.config
config: {
kind:"slack";spec: {apiUrl:string;channel?:string;sendResolved?:boolean|null;text?:string;title?:string; }; } | {kind:"email";spec: {headers?: {[key:string]:string; };html?:string;sendResolved?:boolean|null;to:string; }; } | {kind:"webhook";spec: {bearerToken?:string;password?:string;sendResolved?:boolean|null;url:string;username?:string; }; } | {kind:"pagerduty";spec: {class?:string;client?:string;clientUrl?:string;component?:string;description?:string;details?: {[key:string]:string; };group?:string;routingKey:string;sendResolved?:boolean|null;severity?:string;source?:string;url?:string; }; } | {kind:"opsgenie";spec: {apiKey:string;apiUrl?:string;description?:string;details?: {[key:string]:string; };message?:string;priority?:string;sendResolved?:boolean|null;source?:string; }; } | {kind:"msteams";spec: {sendResolved?:boolean|null;text?:string;title?:string;webhookUrl:string; }; } | {kind:"googlechat";spec: {sendResolved?:boolean|null;text?:string;title?:string;webhookUrl:string; }; } | {kind:"jira";spec: {apiToken:string;customFields?: {[key:string]:unknown; };description?:string;string;issueType:string;labels?:string[];priority?:string;project:string;reopenDuration?:string;reopenTransition?:string;resolveTransition?:string;sendResolved?:boolean|null;site:string;summary?:string;wontFixResolution?:string; }; } | {kind:"jsmops";spec: {apiKey:string;description?:string;message?:string;priority?:string;sendResolved?:boolean|null;tags?:string; }; } | {kind:"incidentio";spec: {description?:string;metadata?: {[key:string]:string; };sendResolved?:boolean|null;title?:string;token:string;url:string; }; }
Union Members
Type Literal
{ kind: "slack"; spec: { apiUrl: string; channel?: string; sendResolved?: boolean | null; text?: string; title?: string; }; }
kind
kind:
"slack"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiUrl
apiUrl:
string
Format: password
spec.channel?
optionalchannel?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
Type Literal
{ kind: "email"; spec: { headers?: {[key: string]: string; }; html?: string; sendResolved?: boolean | null; to: string; }; }
kind
kind:
"email"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.headers?
optionalheaders?:object
Index Signature
[key: string]: string
spec.html?
optionalhtml?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.to
to:
string
Type Literal
{ kind: "webhook"; spec: { bearerToken?: string; password?: string; sendResolved?: boolean | null; url: string; username?: string; }; }
kind
kind:
"webhook"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.bearerToken?
optionalbearerToken?:string
Format: password
spec.password?
optionalpassword?:string
Format: password
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.url
url:
string
Format: password
spec.username?
optionalusername?:string
Type Literal
{ kind: "pagerduty"; spec: { class?: string; client?: string; clientUrl?: string; component?: string; description?: string; details?: {[key: string]: string; }; group?: string; routingKey: string; sendResolved?: boolean | null; severity?: string; source?: string; url?: string; }; }
kind
kind:
"pagerduty"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.class?
optionalclass?:string
spec.client?
optionalclient?:string
spec.clientUrl?
optionalclientUrl?:string
spec.component?
optionalcomponent?:string
spec.description?
optionaldescription?:string
spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
spec.group?
optionalgroup?:string
spec.routingKey
routingKey:
string
Format: password
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.severity?
optionalseverity?:string
spec.source?
optionalsource?:string
spec.url?
optionalurl?:string
Type Literal
{ kind: "opsgenie"; spec: { apiKey: string; apiUrl?: string; description?: string; details?: {[key: string]: string; }; message?: string; priority?: string; sendResolved?: boolean | null; source?: string; }; }
kind
kind:
"opsgenie"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiKey
apiKey:
string
Format: password
spec.apiUrl?
optionalapiUrl?:string
spec.description?
optionaldescription?:string
spec.details?
optionaldetails?:object
Index Signature
[key: string]: string
spec.message?
optionalmessage?:string
spec.priority?
optionalpriority?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.source?
optionalsource?:string
Type Literal
{ kind: "msteams"; spec: { sendResolved?: boolean | null; text?: string; title?: string; webhookUrl: string; }; }
kind
kind:
"msteams"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
spec.webhookUrl
webhookUrl:
string
Format: password
Type Literal
{ kind: "googlechat"; spec: { sendResolved?: boolean | null; text?: string; title?: string; webhookUrl: string; }; }
kind
kind:
"googlechat"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.text?
optionaltext?:string
spec.title?
optionaltitle?:string
spec.webhookUrl
webhookUrl:
string
Format: password
Type Literal
{ kind: "jira"; spec: { apiToken: string; customFields?: {[key: string]: unknown; }; description?: string; email: string; issueType: string; labels?: string[]; priority?: string; project: string; reopenDuration?: string; reopenTransition?: string; resolveTransition?: string; sendResolved?: boolean | null; site: string; summary?: string; wontFixResolution?: string; }; }
kind
kind:
"jira"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiToken
apiToken:
string
Format: password
spec.customFields?
optionalcustomFields?:object
Index Signature
[key: string]: unknown
spec.description?
optionaldescription?:string
spec.email
email:
string
spec.issueType
issueType:
string
spec.labels?
optionallabels?:string[]
spec.priority?
optionalpriority?:string
spec.project
project:
string
spec.reopenDuration?
optionalreopenDuration?:string
spec.reopenTransition?
optionalreopenTransition?:string
spec.resolveTransition?
optionalresolveTransition?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.site
site:
string
spec.summary?
optionalsummary?:string
spec.wontFixResolution?
optionalwontFixResolution?:string
Type Literal
{ kind: "jsmops"; spec: { apiKey: string; description?: string; message?: string; priority?: string; sendResolved?: boolean | null; tags?: string; }; }
kind
kind:
"jsmops"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.apiKey
apiKey:
string
Format: password
spec.description?
optionaldescription?:string
spec.message?
optionalmessage?:string
spec.priority?
optionalpriority?:string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.tags?
optionaltags?:string
Type Literal
{ kind: "incidentio"; spec: { description?: string; metadata?: {[key: string]: string; }; sendResolved?: boolean | null; title?: string; token: string; url: string; }; }
kind
kind:
"incidentio"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.description?
optionaldescription?:string
spec.metadata?
optionalmetadata?:object
Index Signature
[key: string]: string
spec.sendResolved?
optionalsendResolved?:boolean|null
spec.title?
optionaltitle?:string
spec.token
token:
string
Format: password
spec.url
url:
string
AuthtypesAttributeMapping
AuthtypesAttributeMapping:
object
AuthtypesAttributeMapping.email?
optionalemail?:string
AuthtypesAttributeMapping.groups?
optionalgroups?:string
AuthtypesAttributeMapping.name?
optionalname?:string
AuthtypesAttributeMapping.role?
optionalrole?:string
AuthtypesAuthDomainConfig
AuthtypesAuthDomainConfig: {
kind:"saml";spec: {attributeMapping?: {email?:string;groups?:string;name?:string;role?:string; };certificate:string;entityId:string;insecureSkipAuthNRequestsSigned?:boolean;location:string; }; } | {kind:"google";spec: {allowedGroups?:string[];clientId:string;clientSecret:string;domainToAdminEmail?: {[key:string]:string; };fetchGroups?:boolean;fetchTransitiveGroupMembership?:boolean;insecureSkipEmailVerified?:boolean;serviceAccountJson?:string; }; } | {kind:"oidc";spec: {claimMapping?: {email?:string;groups?:string;name?:string;role?:string; };clientId:string;clientSecret:string;getUserInfo?:boolean;insecureSkipEmailVerified?:boolean;issuer:string;issuerAlias?:string; }; }
Union Members
Type Literal
{ kind: "saml"; spec: { attributeMapping?: { email?: string; groups?: string; name?: string; role?: string; }; certificate: string; entityId: string; insecureSkipAuthNRequestsSigned?: boolean; location: string; }; }
kind
kind:
"saml"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.attributeMapping?
optionalattributeMapping?:object
spec.attributeMapping.email?
optionalemail?:string
spec.attributeMapping.groups?
optionalgroups?:string
spec.attributeMapping.name?
optionalname?:string
spec.attributeMapping.role?
optionalrole?:string
spec.certificate
certificate:
string
spec.entityId
entityId:
string
spec.insecureSkipAuthNRequestsSigned?
optionalinsecureSkipAuthNRequestsSigned?:boolean
spec.location
location:
string
Type Literal
{ kind: "google"; spec: { allowedGroups?: string[]; clientId: string; clientSecret: string; domainToAdminEmail?: {[key: string]: string; }; fetchGroups?: boolean; fetchTransitiveGroupMembership?: boolean; insecureSkipEmailVerified?: boolean; serviceAccountJson?: string; }; }
kind
kind:
"google"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.allowedGroups?
optionalallowedGroups?:string[]
spec.clientId
clientId:
string
spec.clientSecret
clientSecret:
string
Format: password
spec.domainToAdminEmail?
optionaldomainToAdminEmail?:object
Index Signature
[key: string]: string
spec.fetchGroups?
optionalfetchGroups?:boolean
spec.fetchTransitiveGroupMembership?
optionalfetchTransitiveGroupMembership?:boolean
spec.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
spec.serviceAccountJson?
optionalserviceAccountJson?:string
Format: password
Type Literal
{ kind: "oidc"; spec: { claimMapping?: { email?: string; groups?: string; name?: string; role?: string; }; clientId: string; clientSecret: string; getUserInfo?: boolean; insecureSkipEmailVerified?: boolean; issuer: string; issuerAlias?: string; }; }
kind
kind:
"oidc"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.claimMapping?
optionalclaimMapping?:object
spec.claimMapping.email?
optionalemail?:string
spec.claimMapping.groups?
optionalgroups?:string
spec.claimMapping.name?
optionalname?:string
spec.claimMapping.role?
optionalrole?:string
spec.clientId
clientId:
string
spec.clientSecret
clientSecret:
string
Format: password
spec.getUserInfo?
optionalgetUserInfo?:boolean
spec.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
spec.issuer
issuer:
string
spec.issuerAlias?
optionalissuerAlias?:string
AuthtypesAuthDomainConfigGoogle
AuthtypesAuthDomainConfigGoogle:
object
AuthtypesAuthDomainConfigGoogle.kind
kind:
"google"
Description
discriminator enum property added by openapi-typescript
AuthtypesAuthDomainConfigGoogle.spec
spec:
object
AuthtypesAuthDomainConfigGoogle.spec.allowedGroups?
optionalallowedGroups?:string[]
AuthtypesAuthDomainConfigGoogle.spec.clientId
clientId:
string
AuthtypesAuthDomainConfigGoogle.spec.clientSecret
clientSecret:
string
Format: password
AuthtypesAuthDomainConfigGoogle.spec.domainToAdminEmail?
optionaldomainToAdminEmail?:object
Index Signature
[key: string]: string
AuthtypesAuthDomainConfigGoogle.spec.fetchGroups?
optionalfetchGroups?:boolean
AuthtypesAuthDomainConfigGoogle.spec.fetchTransitiveGroupMembership?
optionalfetchTransitiveGroupMembership?:boolean
AuthtypesAuthDomainConfigGoogle.spec.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
AuthtypesAuthDomainConfigGoogle.spec.serviceAccountJson?
optionalserviceAccountJson?:string
Format: password
AuthtypesAuthDomainConfigOIDC
AuthtypesAuthDomainConfigOIDC:
object
AuthtypesAuthDomainConfigOIDC.kind
kind:
"oidc"
Description
discriminator enum property added by openapi-typescript
AuthtypesAuthDomainConfigOIDC.spec
spec:
object
AuthtypesAuthDomainConfigOIDC.spec.claimMapping?
optionalclaimMapping?:object
AuthtypesAuthDomainConfigOIDC.spec.claimMapping.email?
optionalemail?:string
AuthtypesAuthDomainConfigOIDC.spec.claimMapping.groups?
optionalgroups?:string
AuthtypesAuthDomainConfigOIDC.spec.claimMapping.name?
optionalname?:string
AuthtypesAuthDomainConfigOIDC.spec.claimMapping.role?
optionalrole?:string
AuthtypesAuthDomainConfigOIDC.spec.clientId
clientId:
string
AuthtypesAuthDomainConfigOIDC.spec.clientSecret
clientSecret:
string
Format: password
AuthtypesAuthDomainConfigOIDC.spec.getUserInfo?
optionalgetUserInfo?:boolean
AuthtypesAuthDomainConfigOIDC.spec.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
AuthtypesAuthDomainConfigOIDC.spec.issuer
issuer:
string
AuthtypesAuthDomainConfigOIDC.spec.issuerAlias?
optionalissuerAlias?:string
AuthtypesAuthDomainConfigSAML
AuthtypesAuthDomainConfigSAML:
object
AuthtypesAuthDomainConfigSAML.kind
kind:
"saml"
Description
discriminator enum property added by openapi-typescript
AuthtypesAuthDomainConfigSAML.spec
spec:
object
AuthtypesAuthDomainConfigSAML.spec.attributeMapping?
optionalattributeMapping?:object
AuthtypesAuthDomainConfigSAML.spec.attributeMapping.email?
optionalemail?:string
AuthtypesAuthDomainConfigSAML.spec.attributeMapping.groups?
optionalgroups?:string
AuthtypesAuthDomainConfigSAML.spec.attributeMapping.name?
optionalname?:string
AuthtypesAuthDomainConfigSAML.spec.attributeMapping.role?
optionalrole?:string
AuthtypesAuthDomainConfigSAML.spec.certificate
certificate:
string
AuthtypesAuthDomainConfigSAML.spec.entityId
entityId:
string
AuthtypesAuthDomainConfigSAML.spec.insecureSkipAuthNRequestsSigned?
optionalinsecureSkipAuthNRequestsSigned?:boolean
AuthtypesAuthDomainConfigSAML.spec.location
location:
string
AuthtypesAuthNProvider
AuthtypesAuthNProvider:
"saml"|"google"|"oidc"|"email_password"
AuthtypesAuthNProviderInfo
AuthtypesAuthNProviderInfo:
object
AuthtypesAuthNProviderInfo.relayStatePath?
optionalrelayStatePath?:string|null
AuthtypesAuthNSupport
AuthtypesAuthNSupport:
object
AuthtypesAuthNSupport.callback?
optionalcallback?:object[] |null
AuthtypesAuthNSupport.password?
optionalpassword?:object[] |null
AuthtypesCallbackAuthNSupport
AuthtypesCallbackAuthNSupport:
object
AuthtypesCallbackAuthNSupport.provider?
optionalprovider?:"saml"|"google"|"oidc"|"email_password"
AuthtypesCallbackAuthNSupport.url?
optionalurl?:string
AuthtypesDeprecatedPostableUserRole
AuthtypesDeprecatedPostableUserRole:
object
AuthtypesDeprecatedPostableUserRole.id
id:
string
AuthtypesGettableAuthDomain
AuthtypesGettableAuthDomain:
object
AuthtypesGettableAuthDomain.authNProviderInfo?
optionalauthNProviderInfo?:object
AuthtypesGettableAuthDomain.authNProviderInfo.relayStatePath?
optionalrelayStatePath?:string|null
AuthtypesGettableAuthDomain.config?
optionalconfig?: {kind:"saml";spec: {attributeMapping?: {email?:string;groups?:string;name?:string;role?:string; };certificate:string;entityId:string;insecureSkipAuthNRequestsSigned?:boolean;location:string; }; } | {kind:"google";spec: {allowedGroups?:string[];clientId:string;clientSecret:string;domainToAdminEmail?: {[key:string]:string; };fetchGroups?:boolean;fetchTransitiveGroupMembership?:boolean;insecureSkipEmailVerified?:boolean;serviceAccountJson?:string; }; } | {kind:"oidc";spec: {claimMapping?: {email?:string;groups?:string;name?:string;role?:string; };clientId:string;clientSecret:string;getUserInfo?:boolean;insecureSkipEmailVerified?:boolean;issuer:string;issuerAlias?:string; }; }
Union Members
Type Literal
{ kind: "saml"; spec: { attributeMapping?: { email?: string; groups?: string; name?: string; role?: string; }; certificate: string; entityId: string; insecureSkipAuthNRequestsSigned?: boolean; location: string; }; }
kind
kind:
"saml"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.attributeMapping?
optionalattributeMapping?:object
spec.attributeMapping.email?
optionalemail?:string
spec.attributeMapping.groups?
optionalgroups?:string
spec.attributeMapping.name?
optionalname?:string
spec.attributeMapping.role?
optionalrole?:string
spec.certificate
certificate:
string
spec.entityId
entityId:
string
spec.insecureSkipAuthNRequestsSigned?
optionalinsecureSkipAuthNRequestsSigned?:boolean
spec.location
location:
string
Type Literal
{ kind: "google"; spec: { allowedGroups?: string[]; clientId: string; clientSecret: string; domainToAdminEmail?: {[key: string]: string; }; fetchGroups?: boolean; fetchTransitiveGroupMembership?: boolean; insecureSkipEmailVerified?: boolean; serviceAccountJson?: string; }; }
kind
kind:
"google"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.allowedGroups?
optionalallowedGroups?:string[]
spec.clientId
clientId:
string
spec.clientSecret
clientSecret:
string
Format: password
spec.domainToAdminEmail?
optionaldomainToAdminEmail?:object
Index Signature
[key: string]: string
spec.fetchGroups?
optionalfetchGroups?:boolean
spec.fetchTransitiveGroupMembership?
optionalfetchTransitiveGroupMembership?:boolean
spec.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
spec.serviceAccountJson?
optionalserviceAccountJson?:string
Format: password
Type Literal
{ kind: "oidc"; spec: { claimMapping?: { email?: string; groups?: string; name?: string; role?: string; }; clientId: string; clientSecret: string; getUserInfo?: boolean; insecureSkipEmailVerified?: boolean; issuer: string; issuerAlias?: string; }; }
kind
kind:
"oidc"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.claimMapping?
optionalclaimMapping?:object
spec.claimMapping.email?
optionalemail?:string
spec.claimMapping.groups?
optionalgroups?:string
spec.claimMapping.name?
optionalname?:string
spec.claimMapping.role?
optionalrole?:string
spec.clientId
clientId:
string
spec.clientSecret
clientSecret:
string
Format: password
spec.getUserInfo?
optionalgetUserInfo?:boolean
spec.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
spec.issuer
issuer:
string
spec.issuerAlias?
optionalissuerAlias?:string
AuthtypesGettableAuthDomain.createdAt?
optionalcreatedAt?:string
Format: date-time
AuthtypesGettableAuthDomain.enabled?
optionalenabled?:boolean
AuthtypesGettableAuthDomain.id
id:
string
AuthtypesGettableAuthDomain.name?
optionalname?:string
AuthtypesGettableAuthDomain.orgId?
optionalorgId?:string
AuthtypesGettableAuthDomain.roleMapping?
optionalroleMapping?:object
AuthtypesGettableAuthDomain.roleMapping.defaultRole?
optionaldefaultRole?:string
AuthtypesGettableAuthDomain.roleMapping.groupMappings?
optionalgroupMappings?: {[key:string]:string; } |null
AuthtypesGettableAuthDomain.roleMapping.useRoleAttribute?
optionaluseRoleAttribute?:boolean
AuthtypesGettableAuthDomain.updatedAt?
optionalupdatedAt?:string
Format: date-time
AuthtypesGettableRole
AuthtypesGettableRole:
object
AuthtypesGettableRole.createdAt?
optionalcreatedAt?:string
Format: date-time
AuthtypesGettableRole.description
description:
string
AuthtypesGettableRole.id
id:
string
AuthtypesGettableRole.name
name:
string
AuthtypesGettableRole.orgId
orgId:
string
AuthtypesGettableRole.type
type:
string
AuthtypesGettableRole.updatedAt?
optionalupdatedAt?:string
Format: date-time
AuthtypesGettableToken
AuthtypesGettableToken:
object
AuthtypesGettableToken.accessToken?
optionalaccessToken?:string
AuthtypesGettableToken.expiresIn?
optionalexpiresIn?:number
AuthtypesGettableToken.refreshToken?
optionalrefreshToken?:string
AuthtypesGettableToken.tokenType?
optionaltokenType?:string
AuthtypesGettableTransaction
AuthtypesGettableTransaction:
object
AuthtypesGettableTransaction.authorized
authorized:
boolean
AuthtypesGettableTransaction.object
object:
object
AuthtypesGettableTransaction.object.resource
resource:
object
AuthtypesGettableTransaction.object.resource.kind
kind:
"session"|"rule"|"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"notification-channel"|"route-policy"|"apdex-setting"|"auth-domain"|"cloud-integration"|"cloud-integration-service"|"integration"|"dashboard"|"public-dashboard"|"ingestion-key"|"ingestion-limit"|"pipeline"|"user-preference"|"org-preference"|"quick-filter"|"ttl-setting"|"planned-maintenance"|"saved-view"|"trace-funnel"|"factor-password"|"factor-api-key"|"license"|"subscription"|"deployment-host"|"logs"|"traces"|"metrics"|"audit-logs"|"meter-metrics"|"logs-field"|"traces-field"
AuthtypesGettableTransaction.object.resource.type
type:
"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"metaresource"|"telemetryresource"
AuthtypesGettableTransaction.object.selector
selector:
string
AuthtypesGettableTransaction.relation
relation:
"delete"|"create"|"read"|"update"|"list"|"assignee"|"attach"|"detach"
AuthtypesGoogleConfig
AuthtypesGoogleConfig:
object
AuthtypesGoogleConfig.allowedGroups?
optionalallowedGroups?:string[]
AuthtypesGoogleConfig.clientId
clientId:
string
AuthtypesGoogleConfig.clientSecret
clientSecret:
string
Format: password
AuthtypesGoogleConfig.domainToAdminEmail?
optionaldomainToAdminEmail?:object
Index Signature
[key: string]: string
AuthtypesGoogleConfig.fetchGroups?
optionalfetchGroups?:boolean
AuthtypesGoogleConfig.fetchTransitiveGroupMembership?
optionalfetchTransitiveGroupMembership?:boolean
AuthtypesGoogleConfig.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
AuthtypesGoogleConfig.serviceAccountJson?
optionalserviceAccountJson?:string
Format: password
AuthtypesOIDCConfig
AuthtypesOIDCConfig:
object
AuthtypesOIDCConfig.claimMapping?
optionalclaimMapping?:object
AuthtypesOIDCConfig.claimMapping.email?
optionalemail?:string
AuthtypesOIDCConfig.claimMapping.groups?
optionalgroups?:string
AuthtypesOIDCConfig.claimMapping.name?
optionalname?:string
AuthtypesOIDCConfig.claimMapping.role?
optionalrole?:string
AuthtypesOIDCConfig.clientId
clientId:
string
AuthtypesOIDCConfig.clientSecret
clientSecret:
string
Format: password
AuthtypesOIDCConfig.getUserInfo?
optionalgetUserInfo?:boolean
AuthtypesOIDCConfig.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
AuthtypesOIDCConfig.issuer
issuer:
string
AuthtypesOIDCConfig.issuerAlias?
optionalissuerAlias?:string
AuthtypesOrgSessionContext
AuthtypesOrgSessionContext:
object
AuthtypesOrgSessionContext.authNSupport?
optionalauthNSupport?:object
AuthtypesOrgSessionContext.authNSupport.callback?
optionalcallback?:object[] |null
AuthtypesOrgSessionContext.authNSupport.password?
optionalpassword?:object[] |null
AuthtypesOrgSessionContext.id?
optionalid?:string
AuthtypesOrgSessionContext.name?
optionalname?:string
AuthtypesOrgSessionContext.warning?
optionalwarning?:object
AuthtypesOrgSessionContext.warning.code
code:
string
AuthtypesOrgSessionContext.warning.errors
errors:
object[]
AuthtypesOrgSessionContext.warning.message
message:
string
AuthtypesOrgSessionContext.warning.retry?
optionalretry?:object
AuthtypesOrgSessionContext.warning.retry.delay
delay:
number
AuthtypesOrgSessionContext.warning.suggestions
suggestions:
string[]
AuthtypesOrgSessionContext.warning.type
type:
string
AuthtypesOrgSessionContext.warning.url?
optionalurl?:string
AuthtypesPasswordAuthNSupport
AuthtypesPasswordAuthNSupport:
object
AuthtypesPasswordAuthNSupport.provider?
optionalprovider?:"saml"|"google"|"oidc"|"email_password"
AuthtypesPostableAuthDomain
AuthtypesPostableAuthDomain:
object
AuthtypesPostableAuthDomain.config
config: {
kind:"saml";spec: {attributeMapping?: {email?:string;groups?:string;name?:string;role?:string; };certificate:string;entityId:string;insecureSkipAuthNRequestsSigned?:boolean;location:string; }; } | {kind:"google";spec: {allowedGroups?:string[];clientId:string;clientSecret:string;domainToAdminEmail?: {[key:string]:string; };fetchGroups?:boolean;fetchTransitiveGroupMembership?:boolean;insecureSkipEmailVerified?:boolean;serviceAccountJson?:string; }; } | {kind:"oidc";spec: {claimMapping?: {email?:string;groups?:string;name?:string;role?:string; };clientId:string;clientSecret:string;getUserInfo?:boolean;insecureSkipEmailVerified?:boolean;issuer:string;issuerAlias?:string; }; }
Union Members
Type Literal
{ kind: "saml"; spec: { attributeMapping?: { email?: string; groups?: string; name?: string; role?: string; }; certificate: string; entityId: string; insecureSkipAuthNRequestsSigned?: boolean; location: string; }; }
kind
kind:
"saml"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.attributeMapping?
optionalattributeMapping?:object
spec.attributeMapping.email?
optionalemail?:string
spec.attributeMapping.groups?
optionalgroups?:string
spec.attributeMapping.name?
optionalname?:string
spec.attributeMapping.role?
optionalrole?:string
spec.certificate
certificate:
string
spec.entityId
entityId:
string
spec.insecureSkipAuthNRequestsSigned?
optionalinsecureSkipAuthNRequestsSigned?:boolean
spec.location
location:
string
Type Literal
{ kind: "google"; spec: { allowedGroups?: string[]; clientId: string; clientSecret: string; domainToAdminEmail?: {[key: string]: string; }; fetchGroups?: boolean; fetchTransitiveGroupMembership?: boolean; insecureSkipEmailVerified?: boolean; serviceAccountJson?: string; }; }
kind
kind:
"google"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.allowedGroups?
optionalallowedGroups?:string[]
spec.clientId
clientId:
string
spec.clientSecret
clientSecret:
string
Format: password
spec.domainToAdminEmail?
optionaldomainToAdminEmail?:object
Index Signature
[key: string]: string
spec.fetchGroups?
optionalfetchGroups?:boolean
spec.fetchTransitiveGroupMembership?
optionalfetchTransitiveGroupMembership?:boolean
spec.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
spec.serviceAccountJson?
optionalserviceAccountJson?:string
Format: password
Type Literal
{ kind: "oidc"; spec: { claimMapping?: { email?: string; groups?: string; name?: string; role?: string; }; clientId: string; clientSecret: string; getUserInfo?: boolean; insecureSkipEmailVerified?: boolean; issuer: string; issuerAlias?: string; }; }
kind
kind:
"oidc"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.claimMapping?
optionalclaimMapping?:object
spec.claimMapping.email?
optionalemail?:string
spec.claimMapping.groups?
optionalgroups?:string
spec.claimMapping.name?
optionalname?:string
spec.claimMapping.role?
optionalrole?:string
spec.clientId
clientId:
string
spec.clientSecret
clientSecret:
string
Format: password
spec.getUserInfo?
optionalgetUserInfo?:boolean
spec.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
spec.issuer
issuer:
string
spec.issuerAlias?
optionalissuerAlias?:string
AuthtypesPostableAuthDomain.enabled?
optionalenabled?:boolean
AuthtypesPostableAuthDomain.name
name:
string
AuthtypesPostableAuthDomain.roleMapping?
optionalroleMapping?:object
AuthtypesPostableAuthDomain.roleMapping.defaultRole?
optionaldefaultRole?:string
AuthtypesPostableAuthDomain.roleMapping.groupMappings?
optionalgroupMappings?: {[key:string]:string; } |null
AuthtypesPostableAuthDomain.roleMapping.useRoleAttribute?
optionaluseRoleAttribute?:boolean
AuthtypesPostableEmailPasswordSession
AuthtypesPostableEmailPasswordSession:
object
AuthtypesPostableEmailPasswordSession.email?
optionalemail?:string
AuthtypesPostableEmailPasswordSession.orgId?
optionalorgId?:string
AuthtypesPostableEmailPasswordSession.password?
optionalpassword?:string
AuthtypesPostableRole
AuthtypesPostableRole:
object
AuthtypesPostableRole.description?
optionaldescription?:string
AuthtypesPostableRole.name
name:
string
AuthtypesPostableRole.transactionGroups?
optionaltransactionGroups?:object[]
AuthtypesPostableRotateToken
AuthtypesPostableRotateToken:
object
AuthtypesPostableRotateToken.refreshToken?
optionalrefreshToken?:string
AuthtypesPostableUser
AuthtypesPostableUser:
object
AuthtypesPostableUser.displayName?
optionaldisplayName?:string
AuthtypesPostableUser.email
email:
string
AuthtypesPostableUser.frontendBaseUrl?
optionalfrontendBaseUrl?:string
AuthtypesPostableUser.userRoles?
optionaluserRoles?:object[]
AuthtypesPostableUserRole
AuthtypesPostableUserRole:
object
AuthtypesPostableUserRole.roleId
roleId:
string
AuthtypesPostableUserRole.userId
userId:
string
AuthtypesRelation
AuthtypesRelation:
"delete"|"create"|"read"|"update"|"list"|"assignee"|"attach"|"detach"
AuthtypesRole
AuthtypesRole:
object
AuthtypesRole.createdAt?
optionalcreatedAt?:string
Format: date-time
AuthtypesRole.description
description:
string
AuthtypesRole.id
id:
string
AuthtypesRole.name
name:
string
AuthtypesRole.orgId
orgId:
string
AuthtypesRole.transactionGroups
transactionGroups:
object[]
AuthtypesRole.type
type:
string
AuthtypesRole.updatedAt?
optionalupdatedAt?:string
Format: date-time
AuthtypesRoleMapping
AuthtypesRoleMapping:
object
AuthtypesRoleMapping.defaultRole?
optionaldefaultRole?:string
AuthtypesRoleMapping.groupMappings?
optionalgroupMappings?: {[key:string]:string; } |null
AuthtypesRoleMapping.useRoleAttribute?
optionaluseRoleAttribute?:boolean
AuthtypesSamlConfig
AuthtypesSamlConfig:
object
AuthtypesSamlConfig.attributeMapping?
optionalattributeMapping?:object
AuthtypesSamlConfig.attributeMapping.email?
optionalemail?:string
AuthtypesSamlConfig.attributeMapping.groups?
optionalgroups?:string
AuthtypesSamlConfig.attributeMapping.name?
optionalname?:string
AuthtypesSamlConfig.attributeMapping.role?
optionalrole?:string
AuthtypesSamlConfig.certificate
certificate:
string
AuthtypesSamlConfig.entityId
entityId:
string
AuthtypesSamlConfig.insecureSkipAuthNRequestsSigned?
optionalinsecureSkipAuthNRequestsSigned?:boolean
AuthtypesSamlConfig.location
location:
string
AuthtypesSessionContext
AuthtypesSessionContext:
object
AuthtypesSessionContext.exists?
optionalexists?:boolean
AuthtypesSessionContext.orgs?
optionalorgs?:object[] |null
AuthtypesTransaction
AuthtypesTransaction:
object
AuthtypesTransaction.object
object:
object
AuthtypesTransaction.object.resource
resource:
object
AuthtypesTransaction.object.resource.kind
kind:
"session"|"rule"|"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"notification-channel"|"route-policy"|"apdex-setting"|"auth-domain"|"cloud-integration"|"cloud-integration-service"|"integration"|"dashboard"|"public-dashboard"|"ingestion-key"|"ingestion-limit"|"pipeline"|"user-preference"|"org-preference"|"quick-filter"|"ttl-setting"|"planned-maintenance"|"saved-view"|"trace-funnel"|"factor-password"|"factor-api-key"|"license"|"subscription"|"deployment-host"|"logs"|"traces"|"metrics"|"audit-logs"|"meter-metrics"|"logs-field"|"traces-field"
AuthtypesTransaction.object.resource.type
type:
"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"metaresource"|"telemetryresource"
AuthtypesTransaction.object.selector
selector:
string
AuthtypesTransaction.relation
relation:
"delete"|"create"|"read"|"update"|"list"|"assignee"|"attach"|"detach"
AuthtypesTransactionGroup
AuthtypesTransactionGroup:
object
AuthtypesTransactionGroup.objectGroup
objectGroup:
object
AuthtypesTransactionGroup.objectGroup.resource
resource:
object
AuthtypesTransactionGroup.objectGroup.resource.kind
kind:
"session"|"rule"|"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"notification-channel"|"route-policy"|"apdex-setting"|"auth-domain"|"cloud-integration"|"cloud-integration-service"|"integration"|"dashboard"|"public-dashboard"|"ingestion-key"|"ingestion-limit"|"pipeline"|"user-preference"|"org-preference"|"quick-filter"|"ttl-setting"|"planned-maintenance"|"saved-view"|"trace-funnel"|"factor-password"|"factor-api-key"|"license"|"subscription"|"deployment-host"|"logs"|"traces"|"metrics"|"audit-logs"|"meter-metrics"|"logs-field"|"traces-field"
AuthtypesTransactionGroup.objectGroup.resource.type
type:
"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"metaresource"|"telemetryresource"
AuthtypesTransactionGroup.objectGroup.selectors
selectors:
string[]
AuthtypesTransactionGroup.relation
relation:
"delete"|"create"|"read"|"update"|"list"|"assignee"|"attach"|"detach"
AuthtypesTransactionGroups
AuthtypesTransactionGroups:
object[]
AuthtypesUpdatableAuthDomain
AuthtypesUpdatableAuthDomain:
object
AuthtypesUpdatableAuthDomain.config
config: {
kind:"saml";spec: {attributeMapping?: {email?:string;groups?:string;name?:string;role?:string; };certificate:string;entityId:string;insecureSkipAuthNRequestsSigned?:boolean;location:string; }; } | {kind:"google";spec: {allowedGroups?:string[];clientId:string;clientSecret:string;domainToAdminEmail?: {[key:string]:string; };fetchGroups?:boolean;fetchTransitiveGroupMembership?:boolean;insecureSkipEmailVerified?:boolean;serviceAccountJson?:string; }; } | {kind:"oidc";spec: {claimMapping?: {email?:string;groups?:string;name?:string;role?:string; };clientId:string;clientSecret:string;getUserInfo?:boolean;insecureSkipEmailVerified?:boolean;issuer:string;issuerAlias?:string; }; }
Union Members
Type Literal
{ kind: "saml"; spec: { attributeMapping?: { email?: string; groups?: string; name?: string; role?: string; }; certificate: string; entityId: string; insecureSkipAuthNRequestsSigned?: boolean; location: string; }; }
kind
kind:
"saml"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.attributeMapping?
optionalattributeMapping?:object
spec.attributeMapping.email?
optionalemail?:string
spec.attributeMapping.groups?
optionalgroups?:string
spec.attributeMapping.name?
optionalname?:string
spec.attributeMapping.role?
optionalrole?:string
spec.certificate
certificate:
string
spec.entityId
entityId:
string
spec.insecureSkipAuthNRequestsSigned?
optionalinsecureSkipAuthNRequestsSigned?:boolean
spec.location
location:
string
Type Literal
{ kind: "google"; spec: { allowedGroups?: string[]; clientId: string; clientSecret: string; domainToAdminEmail?: {[key: string]: string; }; fetchGroups?: boolean; fetchTransitiveGroupMembership?: boolean; insecureSkipEmailVerified?: boolean; serviceAccountJson?: string; }; }
kind
kind:
"google"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.allowedGroups?
optionalallowedGroups?:string[]
spec.clientId
clientId:
string
spec.clientSecret
clientSecret:
string
Format: password
spec.domainToAdminEmail?
optionaldomainToAdminEmail?:object
Index Signature
[key: string]: string
spec.fetchGroups?
optionalfetchGroups?:boolean
spec.fetchTransitiveGroupMembership?
optionalfetchTransitiveGroupMembership?:boolean
spec.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
spec.serviceAccountJson?
optionalserviceAccountJson?:string
Format: password
Type Literal
{ kind: "oidc"; spec: { claimMapping?: { email?: string; groups?: string; name?: string; role?: string; }; clientId: string; clientSecret: string; getUserInfo?: boolean; insecureSkipEmailVerified?: boolean; issuer: string; issuerAlias?: string; }; }
kind
kind:
"oidc"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.claimMapping?
optionalclaimMapping?:object
spec.claimMapping.email?
optionalemail?:string
spec.claimMapping.groups?
optionalgroups?:string
spec.claimMapping.name?
optionalname?:string
spec.claimMapping.role?
optionalrole?:string
spec.clientId
clientId:
string
spec.clientSecret
clientSecret:
string
Format: password
spec.getUserInfo?
optionalgetUserInfo?:boolean
spec.insecureSkipEmailVerified?
optionalinsecureSkipEmailVerified?:boolean
spec.issuer
issuer:
string
spec.issuerAlias?
optionalissuerAlias?:string
AuthtypesUpdatableAuthDomain.enabled?
optionalenabled?:boolean
AuthtypesUpdatableAuthDomain.roleMapping?
optionalroleMapping?:object
AuthtypesUpdatableAuthDomain.roleMapping.defaultRole?
optionaldefaultRole?:string
AuthtypesUpdatableAuthDomain.roleMapping.groupMappings?
optionalgroupMappings?: {[key:string]:string; } |null
AuthtypesUpdatableAuthDomain.roleMapping.useRoleAttribute?
optionaluseRoleAttribute?:boolean
AuthtypesUpdatableRole
AuthtypesUpdatableRole:
object
AuthtypesUpdatableRole.description
description:
string
AuthtypesUpdatableRole.transactionGroups
transactionGroups:
object[]
AuthtypesUserRole
AuthtypesUserRole:
object
AuthtypesUserRole.createdAt
createdAt:
string
Format: date-time
AuthtypesUserRole.id
id:
string
AuthtypesUserRole.role
role:
object
AuthtypesUserRole.role.createdAt?
optionalcreatedAt?:string
Format: date-time
AuthtypesUserRole.role.description
description:
string
AuthtypesUserRole.role.id
id:
string
AuthtypesUserRole.role.name
name:
string
AuthtypesUserRole.role.orgId
orgId:
string
AuthtypesUserRole.role.transactionGroups
transactionGroups:
object[]
AuthtypesUserRole.role.type
type:
string
AuthtypesUserRole.role.updatedAt?
optionalupdatedAt?:string
Format: date-time
AuthtypesUserRole.roleId
roleId:
string
AuthtypesUserRole.updatedAt
updatedAt:
string
Format: date-time
AuthtypesUserRole.userId
userId:
string
AuthtypesUserWithRoles
AuthtypesUserWithRoles:
object
AuthtypesUserWithRoles.createdAt?
optionalcreatedAt?:string
Format: date-time
AuthtypesUserWithRoles.displayName?
optionaldisplayName?:string
AuthtypesUserWithRoles.email?
optionalemail?:string
AuthtypesUserWithRoles.id
id:
string
AuthtypesUserWithRoles.isRoot?
optionalisRoot?:boolean
AuthtypesUserWithRoles.orgId?
optionalorgId?:string
AuthtypesUserWithRoles.status?
optionalstatus?:string
AuthtypesUserWithRoles.updatedAt?
optionalupdatedAt?:string
Format: date-time
AuthtypesUserWithRoles.userRoles?
optionaluserRoles?:object[] |null
CloudintegrationtypesAccount
CloudintegrationtypesAccount:
object
CloudintegrationtypesAccount.agentReport
agentReport: {
data: {[key:string]:unknown; } |null;timestampMillis:number; } |null
Union Members
Type Literal
{ data: {[key: string]: unknown; } | null; timestampMillis: number; }
data
data: {[
key:string]:unknown; } |null
timestampMillis
timestampMillis:
number
Format: int64
null
CloudintegrationtypesAccount.config
config:
object
CloudintegrationtypesAccount.config.aws?
optionalaws?:object
CloudintegrationtypesAccount.config.aws.regions
regions:
string[]
CloudintegrationtypesAccount.config.azure?
optionalazure?:object
CloudintegrationtypesAccount.config.azure.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesAccount.config.azure.resourceGroups
resourceGroups:
string[]
CloudintegrationtypesAccount.config.gcp?
optionalgcp?:object
CloudintegrationtypesAccount.config.gcp.deploymentProjectId
deploymentProjectId:
string
CloudintegrationtypesAccount.config.gcp.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesAccount.config.gcp.projectIds
projectIds:
string[]
CloudintegrationtypesAccount.createdAt?
optionalcreatedAt?:string
Format: date-time
CloudintegrationtypesAccount.id
id:
string
CloudintegrationtypesAccount.orgId
orgId:
string
CloudintegrationtypesAccount.provider
provider:
string
CloudintegrationtypesAccount.providerAccountId
providerAccountId:
string|null
CloudintegrationtypesAccount.removedAt
removedAt:
string|null
Format: date-time
CloudintegrationtypesAccount.updatedAt?
optionalupdatedAt?:string
Format: date-time
CloudintegrationtypesAccountConfig
CloudintegrationtypesAccountConfig:
object
CloudintegrationtypesAccountConfig.aws?
optionalaws?:object
CloudintegrationtypesAccountConfig.aws.regions
regions:
string[]
CloudintegrationtypesAccountConfig.azure?
optionalazure?:object
CloudintegrationtypesAccountConfig.azure.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesAccountConfig.azure.resourceGroups
resourceGroups:
string[]
CloudintegrationtypesAccountConfig.gcp?
optionalgcp?:object
CloudintegrationtypesAccountConfig.gcp.deploymentProjectId
deploymentProjectId:
string
CloudintegrationtypesAccountConfig.gcp.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesAccountConfig.gcp.projectIds
projectIds:
string[]
CloudintegrationtypesAgentReport
CloudintegrationtypesAgentReport: {
data: {[key:string]:unknown; } |null;timestampMillis:number; } |null
Union Members
Type Literal
{ data: {[key: string]: unknown; } | null; timestampMillis: number; }
data
data: {[
key:string]:unknown; } |null
timestampMillis
timestampMillis:
number
Format: int64
null
CloudintegrationtypesAWSAccountConfig
CloudintegrationtypesAWSAccountConfig:
object
CloudintegrationtypesAWSAccountConfig.regions
regions:
string[]
CloudintegrationtypesAWSCloudWatchLogsSubscription
CloudintegrationtypesAWSCloudWatchLogsSubscription:
object
CloudintegrationtypesAWSCloudWatchLogsSubscription.filterPattern
filterPattern:
string
CloudintegrationtypesAWSCloudWatchLogsSubscription.logGroupNamePrefix
logGroupNamePrefix:
string
CloudintegrationtypesAWSCloudWatchMetricStreamFilter
CloudintegrationtypesAWSCloudWatchMetricStreamFilter:
object
CloudintegrationtypesAWSCloudWatchMetricStreamFilter.metricNames?
optionalmetricNames?:string[]
CloudintegrationtypesAWSCloudWatchMetricStreamFilter.namespace
namespace:
string
CloudintegrationtypesAWSConnectionArtifact
CloudintegrationtypesAWSConnectionArtifact:
object
CloudintegrationtypesAWSConnectionArtifact.connectionUrl
connectionUrl:
string
CloudintegrationtypesAWSIntegrationConfig
CloudintegrationtypesAWSIntegrationConfig:
object
CloudintegrationtypesAWSIntegrationConfig.enabledRegions
enabledRegions:
string[]
CloudintegrationtypesAWSIntegrationConfig.telemetryCollectionStrategy
telemetryCollectionStrategy:
object
CloudintegrationtypesAWSIntegrationConfig.telemetryCollectionStrategy.logs?
optionallogs?:object
CloudintegrationtypesAWSIntegrationConfig.telemetryCollectionStrategy.logs.subscriptions
subscriptions:
object[]
CloudintegrationtypesAWSIntegrationConfig.telemetryCollectionStrategy.metrics?
optionalmetrics?:object
CloudintegrationtypesAWSIntegrationConfig.telemetryCollectionStrategy.metrics.streamFilters
streamFilters:
object[]
CloudintegrationtypesAWSIntegrationConfig.telemetryCollectionStrategy.s3Buckets?
optionals3Buckets?:object
Index Signature
[key: string]: string[]
CloudintegrationtypesAWSLogsCollectionStrategy
CloudintegrationtypesAWSLogsCollectionStrategy:
object
CloudintegrationtypesAWSLogsCollectionStrategy.subscriptions
subscriptions:
object[]
CloudintegrationtypesAWSMetricsCollectionStrategy
CloudintegrationtypesAWSMetricsCollectionStrategy:
object
CloudintegrationtypesAWSMetricsCollectionStrategy.streamFilters
streamFilters:
object[]
CloudintegrationtypesAWSPostableAccountConfig
CloudintegrationtypesAWSPostableAccountConfig:
object
CloudintegrationtypesAWSPostableAccountConfig.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesAWSPostableAccountConfig.regions
regions:
string[]
CloudintegrationtypesAWSServiceConfig
CloudintegrationtypesAWSServiceConfig:
object
CloudintegrationtypesAWSServiceConfig.logs?
optionallogs?:object
CloudintegrationtypesAWSServiceConfig.logs.enabled?
optionalenabled?:boolean
CloudintegrationtypesAWSServiceConfig.logs.s3Buckets?
optionals3Buckets?:object
Index Signature
[key: string]: string[]
CloudintegrationtypesAWSServiceConfig.metrics?
optionalmetrics?:object
CloudintegrationtypesAWSServiceConfig.metrics.enabled?
optionalenabled?:boolean
CloudintegrationtypesAWSServiceLogsConfig
CloudintegrationtypesAWSServiceLogsConfig:
object
CloudintegrationtypesAWSServiceLogsConfig.enabled?
optionalenabled?:boolean
CloudintegrationtypesAWSServiceLogsConfig.s3Buckets?
optionals3Buckets?:object
Index Signature
[key: string]: string[]
CloudintegrationtypesAWSServiceMetricsConfig
CloudintegrationtypesAWSServiceMetricsConfig:
object
CloudintegrationtypesAWSServiceMetricsConfig.enabled?
optionalenabled?:boolean
CloudintegrationtypesAWSTelemetryCollectionStrategy
CloudintegrationtypesAWSTelemetryCollectionStrategy:
object
CloudintegrationtypesAWSTelemetryCollectionStrategy.logs?
optionallogs?:object
CloudintegrationtypesAWSTelemetryCollectionStrategy.logs.subscriptions
subscriptions:
object[]
CloudintegrationtypesAWSTelemetryCollectionStrategy.metrics?
optionalmetrics?:object
CloudintegrationtypesAWSTelemetryCollectionStrategy.metrics.streamFilters
streamFilters:
object[]
CloudintegrationtypesAWSTelemetryCollectionStrategy.s3Buckets?
optionals3Buckets?:object
Index Signature
[key: string]: string[]
CloudintegrationtypesAzureAccountConfig
CloudintegrationtypesAzureAccountConfig:
object
CloudintegrationtypesAzureAccountConfig.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesAzureAccountConfig.resourceGroups
resourceGroups:
string[]
CloudintegrationtypesAzureConnectionArtifact
CloudintegrationtypesAzureConnectionArtifact:
object
CloudintegrationtypesAzureConnectionArtifact.cliCommand
cliCommand:
string
CloudintegrationtypesAzureConnectionArtifact.cloudPowerShellCommand
cloudPowerShellCommand:
string
CloudintegrationtypesAzureIntegrationConfig
CloudintegrationtypesAzureIntegrationConfig:
object
CloudintegrationtypesAzureIntegrationConfig.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesAzureIntegrationConfig.resourceGroups
resourceGroups:
string[]
CloudintegrationtypesAzureIntegrationConfig.telemetryCollectionStrategy
telemetryCollectionStrategy:
object[]
CloudintegrationtypesAzureLogsCollectionStrategy
CloudintegrationtypesAzureLogsCollectionStrategy:
object
CloudintegrationtypesAzureLogsCollectionStrategy.categoryGroups
categoryGroups:
string[]
CloudintegrationtypesAzureMetricsCollectionStrategy
CloudintegrationtypesAzureMetricsCollectionStrategy:
Record<string,never>
CloudintegrationtypesAzureServiceConfig
CloudintegrationtypesAzureServiceConfig:
object
CloudintegrationtypesAzureServiceConfig.logs
logs:
object
CloudintegrationtypesAzureServiceConfig.logs.enabled?
optionalenabled?:boolean
CloudintegrationtypesAzureServiceConfig.metrics
metrics:
object
CloudintegrationtypesAzureServiceConfig.metrics.enabled?
optionalenabled?:boolean
CloudintegrationtypesAzureServiceLogsConfig
CloudintegrationtypesAzureServiceLogsConfig:
object
CloudintegrationtypesAzureServiceLogsConfig.enabled?
optionalenabled?:boolean
CloudintegrationtypesAzureServiceMetricsConfig
CloudintegrationtypesAzureServiceMetricsConfig:
object
CloudintegrationtypesAzureServiceMetricsConfig.enabled?
optionalenabled?:boolean
CloudintegrationtypesAzureTelemetryCollectionStrategy
CloudintegrationtypesAzureTelemetryCollectionStrategy:
object
CloudintegrationtypesAzureTelemetryCollectionStrategy.logs?
optionallogs?:object
CloudintegrationtypesAzureTelemetryCollectionStrategy.logs.categoryGroups
categoryGroups:
string[]
CloudintegrationtypesAzureTelemetryCollectionStrategy.metrics?
optionalmetrics?:Record<string,never>
CloudintegrationtypesAzureTelemetryCollectionStrategy.resourceProvider
resourceProvider:
string
CloudintegrationtypesAzureTelemetryCollectionStrategy.resourceType
resourceType:
string
CloudintegrationtypesCloudIntegrationService
CloudintegrationtypesCloudIntegrationService: {
cloudIntegrationId?:string;config?: {aws?: {logs?: {enabled?:boolean;s3Buckets?: {[key: ...]: ...; }; };metrics?: {enabled?:boolean; }; };azure?: {logs: {enabled?:boolean; };metrics: {enabled?:boolean; }; };gcp?: {logs?: {enabled:boolean; };metrics?: {enabled:boolean; }; }; };createdAt?:string;id:string;type?:"alb"|"api-gateway"|"dynamodb"|"ec2"|"ecs"|"eks"|"elasticache"|"lambda"|"msk"|"rds"|"s3sync"|"sns"|"sqs"|"storageaccountsblob"|"cdnprofile"|"virtualmachine"|"appservice"|"containerapp"|"aks"|"sqldatabase"|"sqldatabasemi"|"mysqlflexibleserver"|"postgresqlflexibleserver"|"mongodb"|"cosmosdb"|"cassandradb"|"redis"|"cloudsql_postgres"|"memorystore_redis"|"computeengine"|"gke"|"cloudstorage"|"cloudsql_mysql";updatedAt?:string; } |null
Union Members
Type Literal
{ cloudIntegrationId?: string; config?: { aws?: { logs?: { enabled?: boolean; s3Buckets?: {[key: ...]: ...; }; }; metrics?: { enabled?: boolean; }; }; azure?: { logs: { enabled?: boolean; }; metrics: { enabled?: boolean; }; }; gcp?: { logs?: { enabled: boolean; }; metrics?: { enabled: boolean; }; }; }; createdAt?: string; id: string; type?: "alb" | "api-gateway" | "dynamodb" | "ec2" | "ecs" | "eks" | "elasticache" | "lambda" | "msk" | "rds" | "s3sync" | "sns" | "sqs" | "storageaccountsblob" | "cdnprofile" | "virtualmachine" | "appservice" | "containerapp" | "aks" | "sqldatabase" | "sqldatabasemi" | "mysqlflexibleserver" | "postgresqlflexibleserver" | "mongodb" | "cosmosdb" | "cassandradb" | "redis" | "cloudsql_postgres" | "memorystore_redis" | "computeengine" | "gke" | "cloudstorage" | "cloudsql_mysql"; updatedAt?: string; }
cloudIntegrationId?
optionalcloudIntegrationId?:string
config?
optionalconfig?:object
config.aws?
optionalaws?:object
config.aws.logs?
optionallogs?:object
config.aws.logs.enabled?
optionalenabled?:boolean
config.aws.logs.s3Buckets?
optionals3Buckets?:object
Index Signature
[key: ...]: ...
config.aws.metrics?
optionalmetrics?:object
config.aws.metrics.enabled?
optionalenabled?:boolean
config.azure?
optionalazure?:object
config.azure.logs
logs:
object
config.azure.logs.enabled?
optionalenabled?:boolean
config.azure.metrics
metrics:
object
config.azure.metrics.enabled?
optionalenabled?:boolean
config.gcp?
optionalgcp?:object
config.gcp.logs?
optionallogs?:object
config.gcp.logs.enabled
enabled:
boolean
config.gcp.metrics?
optionalmetrics?:object
config.gcp.metrics.enabled
enabled:
boolean
createdAt?
optionalcreatedAt?:string
Format: date-time
id
id:
string
type?
optionaltype?:"alb"|"api-gateway"|"dynamodb"|"ec2"|"ecs"|"eks"|"elasticache"|"lambda"|"msk"|"rds"|"s3sync"|"sns"|"sqs"|"storageaccountsblob"|"cdnprofile"|"virtualmachine"|"appservice"|"containerapp"|"aks"|"sqldatabase"|"sqldatabasemi"|"mysqlflexibleserver"|"postgresqlflexibleserver"|"mongodb"|"cosmosdb"|"cassandradb"|"redis"|"cloudsql_postgres"|"memorystore_redis"|"computeengine"|"gke"|"cloudstorage"|"cloudsql_mysql"
updatedAt?
optionalupdatedAt?:string
Format: date-time
null
CloudintegrationtypesCollectedLogAttribute
CloudintegrationtypesCollectedLogAttribute:
object
CloudintegrationtypesCollectedLogAttribute.name?
optionalname?:string
CloudintegrationtypesCollectedLogAttribute.path?
optionalpath?:string
CloudintegrationtypesCollectedLogAttribute.type?
optionaltype?:string
CloudintegrationtypesCollectedMetric
CloudintegrationtypesCollectedMetric:
object
CloudintegrationtypesCollectedMetric.description?
optionaldescription?:string
CloudintegrationtypesCollectedMetric.name?
optionalname?:string
CloudintegrationtypesCollectedMetric.type?
optionaltype?:string
CloudintegrationtypesCollectedMetric.unit?
optionalunit?:string
CloudintegrationtypesConnectionArtifact
CloudintegrationtypesConnectionArtifact:
object
CloudintegrationtypesConnectionArtifact.aws?
optionalaws?:object
CloudintegrationtypesConnectionArtifact.aws.connectionUrl
connectionUrl:
string
CloudintegrationtypesConnectionArtifact.azure?
optionalazure?:object
CloudintegrationtypesConnectionArtifact.azure.cliCommand
cliCommand:
string
CloudintegrationtypesConnectionArtifact.azure.cloudPowerShellCommand
cloudPowerShellCommand:
string
CloudintegrationtypesConnectionArtifact.gcp?
optionalgcp?:Record<string,never>
CloudintegrationtypesCredentials
CloudintegrationtypesCredentials:
object
CloudintegrationtypesCredentials.ingestionKey
ingestionKey:
string
CloudintegrationtypesCredentials.ingestionUrl
ingestionUrl:
string
CloudintegrationtypesCredentials.sigNozApiKey
sigNozApiKey:
string
CloudintegrationtypesCredentials.sigNozApiUrl
sigNozApiUrl:
string
CloudintegrationtypesDataCollected
CloudintegrationtypesDataCollected:
object
CloudintegrationtypesDataCollected.logs?
optionallogs?:object[] |null
CloudintegrationtypesDataCollected.metrics?
optionalmetrics?:object[] |null
CloudintegrationtypesGCPAccountConfig
CloudintegrationtypesGCPAccountConfig:
object
CloudintegrationtypesGCPAccountConfig.deploymentProjectId
deploymentProjectId:
string
CloudintegrationtypesGCPAccountConfig.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesGCPAccountConfig.projectIds
projectIds:
string[]
CloudintegrationtypesGCPConnectionArtifact
CloudintegrationtypesGCPConnectionArtifact:
Record<string,never>
CloudintegrationtypesGCPIntegrationConfig
CloudintegrationtypesGCPIntegrationConfig:
Record<string,never>
CloudintegrationtypesGCPServiceConfig
CloudintegrationtypesGCPServiceConfig:
object
CloudintegrationtypesGCPServiceConfig.logs?
optionallogs?:object
CloudintegrationtypesGCPServiceConfig.logs.enabled
enabled:
boolean
CloudintegrationtypesGCPServiceConfig.metrics?
optionalmetrics?:object
CloudintegrationtypesGCPServiceConfig.metrics.enabled
enabled:
boolean
CloudintegrationtypesGCPServiceLogsConfig
CloudintegrationtypesGCPServiceLogsConfig:
object
CloudintegrationtypesGCPServiceLogsConfig.enabled
enabled:
boolean
CloudintegrationtypesGCPServiceMetricsConfig
CloudintegrationtypesGCPServiceMetricsConfig:
object
CloudintegrationtypesGCPServiceMetricsConfig.enabled
enabled:
boolean
CloudintegrationtypesGettableAccounts
CloudintegrationtypesGettableAccounts:
object
CloudintegrationtypesGettableAccounts.accounts
accounts:
object[]
CloudintegrationtypesGettableAccountWithConnectionArtifact
CloudintegrationtypesGettableAccountWithConnectionArtifact:
object
CloudintegrationtypesGettableAccountWithConnectionArtifact.connectionArtifact
connectionArtifact:
object
CloudintegrationtypesGettableAccountWithConnectionArtifact.connectionArtifact.aws?
optionalaws?:object
CloudintegrationtypesGettableAccountWithConnectionArtifact.connectionArtifact.aws.connectionUrl
connectionUrl:
string
CloudintegrationtypesGettableAccountWithConnectionArtifact.connectionArtifact.azure?
optionalazure?:object
CloudintegrationtypesGettableAccountWithConnectionArtifact.connectionArtifact.azure.cliCommand
cliCommand:
string
CloudintegrationtypesGettableAccountWithConnectionArtifact.connectionArtifact.azure.cloudPowerShellCommand
cloudPowerShellCommand:
string
CloudintegrationtypesGettableAccountWithConnectionArtifact.connectionArtifact.gcp?
optionalgcp?:Record<string,never>
CloudintegrationtypesGettableAccountWithConnectionArtifact.id
id:
string
CloudintegrationtypesGettableAgentCheckIn
CloudintegrationtypesGettableAgentCheckIn:
object
CloudintegrationtypesGettableAgentCheckIn.account_id
account_id:
string
CloudintegrationtypesGettableAgentCheckIn.cloud_account_id
cloud_account_id:
string
CloudintegrationtypesGettableAgentCheckIn.cloudIntegrationId
cloudIntegrationId:
string
CloudintegrationtypesGettableAgentCheckIn.integration_config
integration_config: {
enabled_regions:string[];telemetry: {aws_logs?: {cloudwatch_logs_subscriptions?:object[] |null; };aws_metrics?: {cloudwatch_metric_stream_filters?:object[] |null; };provider?:string;s3_buckets?: {[key:string]:string[]; }; }; } |null
CloudintegrationtypesGettableAgentCheckIn.integrationConfig
integrationConfig:
object
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.aws?
optionalaws?:object
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.aws.enabledRegions
enabledRegions:
string[]
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.aws.telemetryCollectionStrategy
telemetryCollectionStrategy:
object
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.aws.telemetryCollectionStrategy.logs?
optionallogs?:object
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.aws.telemetryCollectionStrategy.logs.subscriptions
subscriptions:
object[]
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.aws.telemetryCollectionStrategy.metrics?
optionalmetrics?:object
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.aws.telemetryCollectionStrategy.metrics.streamFilters
streamFilters:
object[]
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.aws.telemetryCollectionStrategy.s3Buckets?
optionals3Buckets?:object
Index Signature
[key: string]: string[]
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.azure?
optionalazure?:object
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.azure.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.azure.resourceGroups
resourceGroups:
string[]
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.azure.telemetryCollectionStrategy
telemetryCollectionStrategy:
object[]
CloudintegrationtypesGettableAgentCheckIn.integrationConfig.gcp?
optionalgcp?:Record<string,never>
CloudintegrationtypesGettableAgentCheckIn.providerAccountId
providerAccountId:
string
CloudintegrationtypesGettableAgentCheckIn.removed_at
removed_at:
string|null
Format: date-time
CloudintegrationtypesGettableAgentCheckIn.removedAt
removedAt:
string|null
Format: date-time
CloudintegrationtypesGettableServicesMetadata
CloudintegrationtypesGettableServicesMetadata:
object
CloudintegrationtypesGettableServicesMetadata.services
services:
object[]
CloudintegrationtypesIntegrationConfig
CloudintegrationtypesIntegrationConfig: {
enabled_regions:string[];telemetry: {aws_logs?: {cloudwatch_logs_subscriptions?:object[] |null; };aws_metrics?: {cloudwatch_metric_stream_filters?:object[] |null; };provider?:string;s3_buckets?: {[key:string]:string[]; }; }; } |null
CloudintegrationtypesOldAWSCollectionStrategy
CloudintegrationtypesOldAWSCollectionStrategy:
object
CloudintegrationtypesOldAWSCollectionStrategy.aws_logs?
optionalaws_logs?:object
CloudintegrationtypesOldAWSCollectionStrategy.aws_logs.cloudwatch_logs_subscriptions?
optionalcloudwatch_logs_subscriptions?:object[] |null
CloudintegrationtypesOldAWSCollectionStrategy.aws_metrics?
optionalaws_metrics?:object
CloudintegrationtypesOldAWSCollectionStrategy.aws_metrics.cloudwatch_metric_stream_filters?
optionalcloudwatch_metric_stream_filters?:object[] |null
CloudintegrationtypesOldAWSCollectionStrategy.provider?
optionalprovider?:string
CloudintegrationtypesOldAWSCollectionStrategy.s3_buckets?
optionals3_buckets?:object
Index Signature
[key: string]: string[]
CloudintegrationtypesOldAWSLogsStrategy
CloudintegrationtypesOldAWSLogsStrategy:
object
CloudintegrationtypesOldAWSLogsStrategy.cloudwatch_logs_subscriptions?
optionalcloudwatch_logs_subscriptions?:object[] |null
CloudintegrationtypesOldAWSMetricsStrategy
CloudintegrationtypesOldAWSMetricsStrategy:
object
CloudintegrationtypesOldAWSMetricsStrategy.cloudwatch_metric_stream_filters?
optionalcloudwatch_metric_stream_filters?:object[] |null
CloudintegrationtypesPostableAccount
CloudintegrationtypesPostableAccount:
object
CloudintegrationtypesPostableAccount.config
config:
object
CloudintegrationtypesPostableAccount.config.aws?
optionalaws?:object
CloudintegrationtypesPostableAccount.config.aws.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesPostableAccount.config.aws.regions
regions:
string[]
CloudintegrationtypesPostableAccount.config.azure?
optionalazure?:object
CloudintegrationtypesPostableAccount.config.azure.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesPostableAccount.config.azure.resourceGroups
resourceGroups:
string[]
CloudintegrationtypesPostableAccount.config.gcp?
optionalgcp?:object
CloudintegrationtypesPostableAccount.config.gcp.deploymentProjectId
deploymentProjectId:
string
CloudintegrationtypesPostableAccount.config.gcp.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesPostableAccount.config.gcp.projectIds
projectIds:
string[]
CloudintegrationtypesPostableAccount.credentials
credentials:
object
CloudintegrationtypesPostableAccount.credentials.ingestionKey
ingestionKey:
string
CloudintegrationtypesPostableAccount.credentials.ingestionUrl
ingestionUrl:
string
CloudintegrationtypesPostableAccount.credentials.sigNozApiKey
sigNozApiKey:
string
CloudintegrationtypesPostableAccount.credentials.sigNozApiUrl
sigNozApiUrl:
string
CloudintegrationtypesPostableAccountConfig
CloudintegrationtypesPostableAccountConfig:
object
CloudintegrationtypesPostableAccountConfig.aws?
optionalaws?:object
CloudintegrationtypesPostableAccountConfig.aws.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesPostableAccountConfig.aws.regions
regions:
string[]
CloudintegrationtypesPostableAccountConfig.azure?
optionalazure?:object
CloudintegrationtypesPostableAccountConfig.azure.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesPostableAccountConfig.azure.resourceGroups
resourceGroups:
string[]
CloudintegrationtypesPostableAccountConfig.gcp?
optionalgcp?:object
CloudintegrationtypesPostableAccountConfig.gcp.deploymentProjectId
deploymentProjectId:
string
CloudintegrationtypesPostableAccountConfig.gcp.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesPostableAccountConfig.gcp.projectIds
projectIds:
string[]
CloudintegrationtypesPostableAgentCheckIn
CloudintegrationtypesPostableAgentCheckIn:
object
CloudintegrationtypesPostableAgentCheckIn.account_id?
optionalaccount_id?:string
CloudintegrationtypesPostableAgentCheckIn.cloud_account_id?
optionalcloud_account_id?:string
CloudintegrationtypesPostableAgentCheckIn.cloudIntegrationId?
optionalcloudIntegrationId?:string
CloudintegrationtypesPostableAgentCheckIn.data
data: {[
key:string]:unknown; } |null
CloudintegrationtypesPostableAgentCheckIn.providerAccountId?
optionalproviderAccountId?:string
CloudintegrationtypesProviderIntegrationConfig
CloudintegrationtypesProviderIntegrationConfig:
object
CloudintegrationtypesProviderIntegrationConfig.aws?
optionalaws?:object
CloudintegrationtypesProviderIntegrationConfig.aws.enabledRegions
enabledRegions:
string[]
CloudintegrationtypesProviderIntegrationConfig.aws.telemetryCollectionStrategy
telemetryCollectionStrategy:
object
CloudintegrationtypesProviderIntegrationConfig.aws.telemetryCollectionStrategy.logs?
optionallogs?:object
CloudintegrationtypesProviderIntegrationConfig.aws.telemetryCollectionStrategy.logs.subscriptions
subscriptions:
object[]
CloudintegrationtypesProviderIntegrationConfig.aws.telemetryCollectionStrategy.metrics?
optionalmetrics?:object
CloudintegrationtypesProviderIntegrationConfig.aws.telemetryCollectionStrategy.metrics.streamFilters
streamFilters:
object[]
CloudintegrationtypesProviderIntegrationConfig.aws.telemetryCollectionStrategy.s3Buckets?
optionals3Buckets?:object
Index Signature
[key: string]: string[]
CloudintegrationtypesProviderIntegrationConfig.azure?
optionalazure?:object
CloudintegrationtypesProviderIntegrationConfig.azure.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesProviderIntegrationConfig.azure.resourceGroups
resourceGroups:
string[]
CloudintegrationtypesProviderIntegrationConfig.azure.telemetryCollectionStrategy
telemetryCollectionStrategy:
object[]
CloudintegrationtypesProviderIntegrationConfig.gcp?
optionalgcp?:Record<string,never>
CloudintegrationtypesService
CloudintegrationtypesService:
object
CloudintegrationtypesService.assets
assets:
object
CloudintegrationtypesService.assets.dashboards
dashboards:
object[]
CloudintegrationtypesService.cloudIntegrationService
cloudIntegrationService: {
cloudIntegrationId?:string;config?: {aws?: {logs?: {enabled?: ... | ... | ...;s3Buckets?: ... | ...; };metrics?: {enabled?: ... | ... | ...; }; };azure?: {logs: {enabled?:boolean; };metrics: {enabled?:boolean; }; };gcp?: {logs?: {enabled:boolean; };metrics?: {enabled:boolean; }; }; };createdAt?:string;id:string;type?:"alb"|"api-gateway"|"dynamodb"|"ec2"|"ecs"|"eks"|"elasticache"|"lambda"|"msk"|"rds"|"s3sync"|"sns"|"sqs"|"storageaccountsblob"|"cdnprofile"|"virtualmachine"|"appservice"|"containerapp"|"aks"|"sqldatabase"|"sqldatabasemi"|"mysqlflexibleserver"|"postgresqlflexibleserver"|"mongodb"|"cosmosdb"|"cassandradb"|"redis"|"cloudsql_postgres"|"memorystore_redis"|"computeengine"|"gke"|"cloudstorage"|"cloudsql_mysql";updatedAt?:string; } |null
Union Members
Type Literal
{ cloudIntegrationId?: string; config?: { aws?: { logs?: { enabled?: ... | ... | ...; s3Buckets?: ... | ...; }; metrics?: { enabled?: ... | ... | ...; }; }; azure?: { logs: { enabled?: boolean; }; metrics: { enabled?: boolean; }; }; gcp?: { logs?: { enabled: boolean; }; metrics?: { enabled: boolean; }; }; }; createdAt?: string; id: string; type?: "alb" | "api-gateway" | "dynamodb" | "ec2" | "ecs" | "eks" | "elasticache" | "lambda" | "msk" | "rds" | "s3sync" | "sns" | "sqs" | "storageaccountsblob" | "cdnprofile" | "virtualmachine" | "appservice" | "containerapp" | "aks" | "sqldatabase" | "sqldatabasemi" | "mysqlflexibleserver" | "postgresqlflexibleserver" | "mongodb" | "cosmosdb" | "cassandradb" | "redis" | "cloudsql_postgres" | "memorystore_redis" | "computeengine" | "gke" | "cloudstorage" | "cloudsql_mysql"; updatedAt?: string; }
cloudIntegrationId?
optionalcloudIntegrationId?:string
config?
optionalconfig?:object
config.aws?
optionalaws?:object
config.aws.logs?
optionallogs?:object
config.aws.logs.enabled?
optionalenabled?: ... | ... | ...
config.aws.logs.s3Buckets?
optionals3Buckets?: ... | ...
config.aws.metrics?
optionalmetrics?:object
config.aws.metrics.enabled?
optionalenabled?: ... | ... | ...
config.azure?
optionalazure?:object
config.azure.logs
logs:
object
config.azure.logs.enabled?
optionalenabled?:boolean
config.azure.metrics
metrics:
object
config.azure.metrics.enabled?
optionalenabled?:boolean
config.gcp?
optionalgcp?:object
config.gcp.logs?
optionallogs?:object
config.gcp.logs.enabled
enabled:
boolean
config.gcp.metrics?
optionalmetrics?:object
config.gcp.metrics.enabled
enabled:
boolean
createdAt?
optionalcreatedAt?:string
Format: date-time
id
id:
string
type?
optionaltype?:"alb"|"api-gateway"|"dynamodb"|"ec2"|"ecs"|"eks"|"elasticache"|"lambda"|"msk"|"rds"|"s3sync"|"sns"|"sqs"|"storageaccountsblob"|"cdnprofile"|"virtualmachine"|"appservice"|"containerapp"|"aks"|"sqldatabase"|"sqldatabasemi"|"mysqlflexibleserver"|"postgresqlflexibleserver"|"mongodb"|"cosmosdb"|"cassandradb"|"redis"|"cloudsql_postgres"|"memorystore_redis"|"computeengine"|"gke"|"cloudstorage"|"cloudsql_mysql"
updatedAt?
optionalupdatedAt?:string
Format: date-time
null
CloudintegrationtypesService.dataCollected
dataCollected:
object
CloudintegrationtypesService.dataCollected.logs?
optionallogs?:object[] |null
CloudintegrationtypesService.dataCollected.metrics?
optionalmetrics?:object[] |null
CloudintegrationtypesService.icon
icon:
string
CloudintegrationtypesService.id
id:
string
CloudintegrationtypesService.overview
overview:
string
CloudintegrationtypesService.supportedSignals
supportedSignals:
object
CloudintegrationtypesService.supportedSignals.logs?
optionallogs?:boolean
CloudintegrationtypesService.supportedSignals.metrics?
optionalmetrics?:boolean
CloudintegrationtypesService.title
title:
string
CloudintegrationtypesServiceAssets
CloudintegrationtypesServiceAssets:
object
CloudintegrationtypesServiceAssets.dashboards
dashboards:
object[]
CloudintegrationtypesServiceConfig
CloudintegrationtypesServiceConfig:
object
CloudintegrationtypesServiceConfig.aws?
optionalaws?:object
CloudintegrationtypesServiceConfig.aws.logs?
optionallogs?:object
CloudintegrationtypesServiceConfig.aws.logs.enabled?
optionalenabled?:boolean
CloudintegrationtypesServiceConfig.aws.logs.s3Buckets?
optionals3Buckets?:object
Index Signature
[key: string]: string[]
CloudintegrationtypesServiceConfig.aws.metrics?
optionalmetrics?:object
CloudintegrationtypesServiceConfig.aws.metrics.enabled?
optionalenabled?:boolean
CloudintegrationtypesServiceConfig.azure?
optionalazure?:object
CloudintegrationtypesServiceConfig.azure.logs
logs:
object
CloudintegrationtypesServiceConfig.azure.logs.enabled?
optionalenabled?:boolean
CloudintegrationtypesServiceConfig.azure.metrics
metrics:
object
CloudintegrationtypesServiceConfig.azure.metrics.enabled?
optionalenabled?:boolean
CloudintegrationtypesServiceConfig.gcp?
optionalgcp?:object
CloudintegrationtypesServiceConfig.gcp.logs?
optionallogs?:object
CloudintegrationtypesServiceConfig.gcp.logs.enabled
enabled:
boolean
CloudintegrationtypesServiceConfig.gcp.metrics?
optionalmetrics?:object
CloudintegrationtypesServiceConfig.gcp.metrics.enabled
enabled:
boolean
CloudintegrationtypesServiceDashboard
CloudintegrationtypesServiceDashboard:
object
CloudintegrationtypesServiceDashboard.description
description:
string
CloudintegrationtypesServiceDashboard.integrationDashboard?
optionalintegrationDashboard?:object
CloudintegrationtypesServiceDashboard.integrationDashboard.createdAt
createdAt:
string
Format: date-time
CloudintegrationtypesServiceDashboard.integrationDashboard.dashboardId
dashboardId:
string
CloudintegrationtypesServiceDashboard.integrationDashboard.id
id:
string
CloudintegrationtypesServiceDashboard.integrationDashboard.provider
provider:
string
CloudintegrationtypesServiceDashboard.integrationDashboard.slug
slug:
string
CloudintegrationtypesServiceDashboard.integrationDashboard.updatedAt
updatedAt:
string
Format: date-time
CloudintegrationtypesServiceDashboard.title
title:
string
CloudintegrationtypesServiceID
CloudintegrationtypesServiceID:
"alb"|"api-gateway"|"dynamodb"|"ec2"|"ecs"|"eks"|"elasticache"|"lambda"|"msk"|"rds"|"s3sync"|"sns"|"sqs"|"storageaccountsblob"|"cdnprofile"|"virtualmachine"|"appservice"|"containerapp"|"aks"|"sqldatabase"|"sqldatabasemi"|"mysqlflexibleserver"|"postgresqlflexibleserver"|"mongodb"|"cosmosdb"|"cassandradb"|"redis"|"cloudsql_postgres"|"memorystore_redis"|"computeengine"|"gke"|"cloudstorage"|"cloudsql_mysql"
CloudintegrationtypesServiceMetadata
CloudintegrationtypesServiceMetadata:
object
CloudintegrationtypesServiceMetadata.enabled
enabled:
boolean
CloudintegrationtypesServiceMetadata.icon
icon:
string
CloudintegrationtypesServiceMetadata.id
id:
string
CloudintegrationtypesServiceMetadata.title
title:
string
CloudintegrationtypesStorableIntegrationDashboard
CloudintegrationtypesStorableIntegrationDashboard:
object
CloudintegrationtypesStorableIntegrationDashboard.createdAt
createdAt:
string
Format: date-time
CloudintegrationtypesStorableIntegrationDashboard.dashboardId
dashboardId:
string
CloudintegrationtypesStorableIntegrationDashboard.id
id:
string
CloudintegrationtypesStorableIntegrationDashboard.provider
provider:
string
CloudintegrationtypesStorableIntegrationDashboard.slug
slug:
string
CloudintegrationtypesStorableIntegrationDashboard.updatedAt
updatedAt:
string
Format: date-time
CloudintegrationtypesSupportedSignals
CloudintegrationtypesSupportedSignals:
object
CloudintegrationtypesSupportedSignals.logs?
optionallogs?:boolean
CloudintegrationtypesSupportedSignals.metrics?
optionalmetrics?:boolean
CloudintegrationtypesUpdatableAccount
CloudintegrationtypesUpdatableAccount:
object
CloudintegrationtypesUpdatableAccount.config
config:
object
CloudintegrationtypesUpdatableAccount.config.aws?
optionalaws?:object
CloudintegrationtypesUpdatableAccount.config.aws.regions
regions:
string[]
CloudintegrationtypesUpdatableAccount.config.azure?
optionalazure?:object
CloudintegrationtypesUpdatableAccount.config.azure.resourceGroups
resourceGroups:
string[]
CloudintegrationtypesUpdatableAccount.config.gcp?
optionalgcp?:object
CloudintegrationtypesUpdatableAccount.config.gcp.deploymentProjectId
deploymentProjectId:
string
CloudintegrationtypesUpdatableAccount.config.gcp.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesUpdatableAccount.config.gcp.projectIds
projectIds:
string[] |null
CloudintegrationtypesUpdatableAccountConfig
CloudintegrationtypesUpdatableAccountConfig:
object
CloudintegrationtypesUpdatableAccountConfig.aws?
optionalaws?:object
CloudintegrationtypesUpdatableAccountConfig.aws.regions
regions:
string[]
CloudintegrationtypesUpdatableAccountConfig.azure?
optionalazure?:object
CloudintegrationtypesUpdatableAccountConfig.azure.resourceGroups
resourceGroups:
string[]
CloudintegrationtypesUpdatableAccountConfig.gcp?
optionalgcp?:object
CloudintegrationtypesUpdatableAccountConfig.gcp.deploymentProjectId
deploymentProjectId:
string
CloudintegrationtypesUpdatableAccountConfig.gcp.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesUpdatableAccountConfig.gcp.projectIds
projectIds:
string[] |null
CloudintegrationtypesUpdatableAzureAccountConfig
CloudintegrationtypesUpdatableAzureAccountConfig:
object
CloudintegrationtypesUpdatableAzureAccountConfig.resourceGroups
resourceGroups:
string[]
CloudintegrationtypesUpdatableGCPAccountConfig
CloudintegrationtypesUpdatableGCPAccountConfig:
object
CloudintegrationtypesUpdatableGCPAccountConfig.deploymentProjectId
deploymentProjectId:
string
CloudintegrationtypesUpdatableGCPAccountConfig.deploymentRegion
deploymentRegion:
string
CloudintegrationtypesUpdatableGCPAccountConfig.projectIds
projectIds:
string[] |null
CloudintegrationtypesUpdatableService
CloudintegrationtypesUpdatableService:
object
CloudintegrationtypesUpdatableService.config
config:
object
CloudintegrationtypesUpdatableService.config.aws?
optionalaws?:object
CloudintegrationtypesUpdatableService.config.aws.logs?
optionallogs?:object
CloudintegrationtypesUpdatableService.config.aws.logs.enabled?
optionalenabled?:boolean
CloudintegrationtypesUpdatableService.config.aws.logs.s3Buckets?
optionals3Buckets?:object
Index Signature
[key: string]: string[]
CloudintegrationtypesUpdatableService.config.aws.metrics?
optionalmetrics?:object
CloudintegrationtypesUpdatableService.config.aws.metrics.enabled?
optionalenabled?:boolean
CloudintegrationtypesUpdatableService.config.azure?
optionalazure?:object
CloudintegrationtypesUpdatableService.config.azure.logs
logs:
object
CloudintegrationtypesUpdatableService.config.azure.logs.enabled?
optionalenabled?:boolean
CloudintegrationtypesUpdatableService.config.azure.metrics
metrics:
object
CloudintegrationtypesUpdatableService.config.azure.metrics.enabled?
optionalenabled?:boolean
CloudintegrationtypesUpdatableService.config.gcp?
optionalgcp?:object
CloudintegrationtypesUpdatableService.config.gcp.logs?
optionallogs?:object
CloudintegrationtypesUpdatableService.config.gcp.logs.enabled
enabled:
boolean
CloudintegrationtypesUpdatableService.config.gcp.metrics?
optionalmetrics?:object
CloudintegrationtypesUpdatableService.config.gcp.metrics.enabled
enabled:
boolean
CommonJSONRef
CommonJSONRef:
object
CommonJSONRef.$ref?
optional$ref?:string
ConfigAuthorization
ConfigAuthorization:
object
ConfigAuthorization.credentials?
optionalcredentials?:string
ConfigAuthorization.credentials_file?
optionalcredentials_file?:string
ConfigAuthorization.credentials_ref?
optionalcredentials_ref?:string
ConfigAuthorization.type?
optionaltype?:string
ConfigBasicAuth
ConfigBasicAuth:
object
ConfigBasicAuth.password?
optionalpassword?:string
ConfigBasicAuth.password_file?
optionalpassword_file?:string
ConfigBasicAuth.password_ref?
optionalpassword_ref?:string
ConfigBasicAuth.username?
optionalusername?:string
ConfigBasicAuth.username_file?
optionalusername_file?:string
ConfigBasicAuth.username_ref?
optionalusername_ref?:string
ConfigDiscordConfig
ConfigDiscordConfig:
object
ConfigDiscordConfig.avatar_url?
optionalavatar_url?:string
ConfigDiscordConfig.content?
optionalcontent?:string
ConfigDiscordConfig.http_config?
optionalhttp_config?:object
ConfigDiscordConfig.http_config.authorization?
optionalauthorization?:object
ConfigDiscordConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigDiscordConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigDiscordConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigDiscordConfig.http_config.authorization.type?
optionaltype?:string
ConfigDiscordConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigDiscordConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigDiscordConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigDiscordConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigDiscordConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigDiscordConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigDiscordConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigDiscordConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigDiscordConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigDiscordConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigDiscordConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigDiscordConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigDiscordConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigDiscordConfig.http_config.oauth2?
optionaloauth2?:object
ConfigDiscordConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigDiscordConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigDiscordConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigDiscordConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigDiscordConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigDiscordConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigDiscordConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigDiscordConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigDiscordConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigDiscordConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigDiscordConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigDiscordConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigDiscordConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigDiscordConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigDiscordConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigDiscordConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigDiscordConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigDiscordConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigDiscordConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigDiscordConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigDiscordConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigDiscordConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigDiscordConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigDiscordConfig.http_config.tls_config?
optionaltls_config?:object
ConfigDiscordConfig.http_config.tls_config.ca?
optionalca?:string
ConfigDiscordConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigDiscordConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigDiscordConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigDiscordConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigDiscordConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigDiscordConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigDiscordConfig.http_config.tls_config.key?
optionalkey?:string
ConfigDiscordConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigDiscordConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigDiscordConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigDiscordConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigDiscordConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigDiscordConfig.message?
optionalmessage?:string
ConfigDiscordConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigDiscordConfig.title?
optionaltitle?:string
ConfigDiscordConfig.username?
optionalusername?:string
ConfigDiscordConfig.webhook_url?
optionalwebhook_url?:Record<string,never>
ConfigDiscordConfig.webhook_url_file?
optionalwebhook_url_file?:string
ConfigDuration
ConfigDuration:
string
Format: int64
ConfigEmailConfig
ConfigEmailConfig:
object
ConfigEmailConfig.auth_identity?
optionalauth_identity?:string
ConfigEmailConfig.auth_password?
optionalauth_password?:string
ConfigEmailConfig.auth_password_file?
optionalauth_password_file?:string
ConfigEmailConfig.auth_secret?
optionalauth_secret?:string
ConfigEmailConfig.auth_secret_file?
optionalauth_secret_file?:string
ConfigEmailConfig.auth_username?
optionalauth_username?:string
ConfigEmailConfig.force_implicit_tls?
optionalforce_implicit_tls?:boolean|null
ConfigEmailConfig.from?
optionalfrom?:string
ConfigEmailConfig.headers?
optionalheaders?:object
Index Signature
[key: string]: string
ConfigEmailConfig.hello?
optionalhello?:string
ConfigEmailConfig.html?
optionalhtml?:string
ConfigEmailConfig.require_tls?
optionalrequire_tls?:boolean|null
ConfigEmailConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigEmailConfig.smarthost?
optionalsmarthost?:Record<string,never>
ConfigEmailConfig.text?
optionaltext?:string
ConfigEmailConfig.threading?
optionalthreading?:object
ConfigEmailConfig.threading.enabled?
optionalenabled?:boolean
ConfigEmailConfig.threading.thread_by_date?
optionalthread_by_date?:string
ConfigEmailConfig.tls_config?
optionaltls_config?:object
ConfigEmailConfig.tls_config.ca?
optionalca?:string
ConfigEmailConfig.tls_config.ca_file?
optionalca_file?:string
ConfigEmailConfig.tls_config.ca_ref?
optionalca_ref?:string
ConfigEmailConfig.tls_config.cert?
optionalcert?:string
ConfigEmailConfig.tls_config.cert_file?
optionalcert_file?:string
ConfigEmailConfig.tls_config.cert_ref?
optionalcert_ref?:string
ConfigEmailConfig.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigEmailConfig.tls_config.key?
optionalkey?:string
ConfigEmailConfig.tls_config.key_file?
optionalkey_file?:string
ConfigEmailConfig.tls_config.key_ref?
optionalkey_ref?:string
ConfigEmailConfig.tls_config.max_version?
optionalmax_version?:number
ConfigEmailConfig.tls_config.min_version?
optionalmin_version?:number
ConfigEmailConfig.tls_config.server_name?
optionalserver_name?:string
ConfigEmailConfig.to?
optionalto?:string
ConfigHeaders
ConfigHeaders:
Record<string,never>
ConfigHostPort
ConfigHostPort:
Record<string,never>
ConfigHTTPClientConfig
ConfigHTTPClientConfig:
object
ConfigHTTPClientConfig.authorization?
optionalauthorization?:object
ConfigHTTPClientConfig.authorization.credentials?
optionalcredentials?:string
ConfigHTTPClientConfig.authorization.credentials_file?
optionalcredentials_file?:string
ConfigHTTPClientConfig.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigHTTPClientConfig.authorization.type?
optionaltype?:string
ConfigHTTPClientConfig.basic_auth?
optionalbasic_auth?:object
ConfigHTTPClientConfig.basic_auth.password?
optionalpassword?:string
ConfigHTTPClientConfig.basic_auth.password_file?
optionalpassword_file?:string
ConfigHTTPClientConfig.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigHTTPClientConfig.basic_auth.username?
optionalusername?:string
ConfigHTTPClientConfig.basic_auth.username_file?
optionalusername_file?:string
ConfigHTTPClientConfig.basic_auth.username_ref?
optionalusername_ref?:string
ConfigHTTPClientConfig.bearer_token?
optionalbearer_token?:string
ConfigHTTPClientConfig.bearer_token_file?
optionalbearer_token_file?:string
ConfigHTTPClientConfig.enable_http2?
optionalenable_http2?:boolean
ConfigHTTPClientConfig.follow_redirects?
optionalfollow_redirects?:boolean
ConfigHTTPClientConfig.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigHTTPClientConfig.no_proxy?
optionalno_proxy?:string
ConfigHTTPClientConfig.oauth2?
optionaloauth2?:object
ConfigHTTPClientConfig.oauth2.audience?
optionalaudience?:string
ConfigHTTPClientConfig.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigHTTPClientConfig.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigHTTPClientConfig.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigHTTPClientConfig.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigHTTPClientConfig.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigHTTPClientConfig.oauth2.client_id?
optionalclient_id?:string
ConfigHTTPClientConfig.oauth2.client_secret?
optionalclient_secret?:string
ConfigHTTPClientConfig.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigHTTPClientConfig.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigHTTPClientConfig.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigHTTPClientConfig.oauth2.grant_type?
optionalgrant_type?:string
ConfigHTTPClientConfig.oauth2.iss?
optionaliss?:string
ConfigHTTPClientConfig.oauth2.no_proxy?
optionalno_proxy?:string
ConfigHTTPClientConfig.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigHTTPClientConfig.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigHTTPClientConfig.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigHTTPClientConfig.oauth2.scopes?
optionalscopes?:string[]
ConfigHTTPClientConfig.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigHTTPClientConfig.oauth2.token_url?
optionaltoken_url?:string
ConfigHTTPClientConfig.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigHTTPClientConfig.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigHTTPClientConfig.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigHTTPClientConfig.tls_config?
optionaltls_config?:object
ConfigHTTPClientConfig.tls_config.ca?
optionalca?:string
ConfigHTTPClientConfig.tls_config.ca_file?
optionalca_file?:string
ConfigHTTPClientConfig.tls_config.ca_ref?
optionalca_ref?:string
ConfigHTTPClientConfig.tls_config.cert?
optionalcert?:string
ConfigHTTPClientConfig.tls_config.cert_file?
optionalcert_file?:string
ConfigHTTPClientConfig.tls_config.cert_ref?
optionalcert_ref?:string
ConfigHTTPClientConfig.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigHTTPClientConfig.tls_config.key?
optionalkey?:string
ConfigHTTPClientConfig.tls_config.key_file?
optionalkey_file?:string
ConfigHTTPClientConfig.tls_config.key_ref?
optionalkey_ref?:string
ConfigHTTPClientConfig.tls_config.max_version?
optionalmax_version?:number
ConfigHTTPClientConfig.tls_config.min_version?
optionalmin_version?:number
ConfigHTTPClientConfig.tls_config.server_name?
optionalserver_name?:string
ConfigIncidentioConfig
ConfigIncidentioConfig:
object
ConfigIncidentioConfig.alert_source_token?
optionalalert_source_token?:string
ConfigIncidentioConfig.alert_source_token_file?
optionalalert_source_token_file?:string
ConfigIncidentioConfig.http_config?
optionalhttp_config?:object
ConfigIncidentioConfig.http_config.authorization?
optionalauthorization?:object
ConfigIncidentioConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigIncidentioConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigIncidentioConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigIncidentioConfig.http_config.authorization.type?
optionaltype?:string
ConfigIncidentioConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigIncidentioConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigIncidentioConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigIncidentioConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigIncidentioConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigIncidentioConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigIncidentioConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigIncidentioConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigIncidentioConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigIncidentioConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigIncidentioConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigIncidentioConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigIncidentioConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigIncidentioConfig.http_config.oauth2?
optionaloauth2?:object
ConfigIncidentioConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigIncidentioConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigIncidentioConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigIncidentioConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigIncidentioConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigIncidentioConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigIncidentioConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigIncidentioConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigIncidentioConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigIncidentioConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigIncidentioConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigIncidentioConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigIncidentioConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigIncidentioConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigIncidentioConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigIncidentioConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigIncidentioConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigIncidentioConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigIncidentioConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigIncidentioConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigIncidentioConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigIncidentioConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigIncidentioConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigIncidentioConfig.http_config.tls_config?
optionaltls_config?:object
ConfigIncidentioConfig.http_config.tls_config.ca?
optionalca?:string
ConfigIncidentioConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigIncidentioConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigIncidentioConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigIncidentioConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigIncidentioConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigIncidentioConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigIncidentioConfig.http_config.tls_config.key?
optionalkey?:string
ConfigIncidentioConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigIncidentioConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigIncidentioConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigIncidentioConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigIncidentioConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigIncidentioConfig.max_alerts?
optionalmax_alerts?:number
ConfigIncidentioConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigIncidentioConfig.timeout?
optionaltimeout?:number
ConfigIncidentioConfig.url?
optionalurl?:Record<string,never>
ConfigIncidentioConfig.url_file?
optionalurl_file?:string
ConfigJiraConfig
ConfigJiraConfig:
object
ConfigJiraConfig.api_type?
optionalapi_type?:string
ConfigJiraConfig.api_url?
optionalapi_url?:Record<string,never>
ConfigJiraConfig.custom_fields?
optionalcustom_fields?:object
Index Signature
[key: string]: unknown
ConfigJiraConfig.description?
optionaldescription?:object
ConfigJiraConfig.description.enable_update?
optionalenable_update?:boolean|null
ConfigJiraConfig.description.template?
optionaltemplate?:string
ConfigJiraConfig.http_config?
optionalhttp_config?:object
ConfigJiraConfig.http_config.authorization?
optionalauthorization?:object
ConfigJiraConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigJiraConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigJiraConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigJiraConfig.http_config.authorization.type?
optionaltype?:string
ConfigJiraConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigJiraConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigJiraConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigJiraConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigJiraConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigJiraConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigJiraConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigJiraConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigJiraConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigJiraConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigJiraConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigJiraConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigJiraConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigJiraConfig.http_config.oauth2?
optionaloauth2?:object
ConfigJiraConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigJiraConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigJiraConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigJiraConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigJiraConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigJiraConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigJiraConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigJiraConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigJiraConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigJiraConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigJiraConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigJiraConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigJiraConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigJiraConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigJiraConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigJiraConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigJiraConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigJiraConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigJiraConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigJiraConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigJiraConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigJiraConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigJiraConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigJiraConfig.http_config.tls_config?
optionaltls_config?:object
ConfigJiraConfig.http_config.tls_config.ca?
optionalca?:string
ConfigJiraConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigJiraConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigJiraConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigJiraConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigJiraConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigJiraConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigJiraConfig.http_config.tls_config.key?
optionalkey?:string
ConfigJiraConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigJiraConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigJiraConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigJiraConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigJiraConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigJiraConfig.issue_type?
optionalissue_type?:string
ConfigJiraConfig.labels?
optionallabels?:string[]
ConfigJiraConfig.priority?
optionalpriority?:string
ConfigJiraConfig.project?
optionalproject?:string
ConfigJiraConfig.reopen_duration?
optionalreopen_duration?:number
ConfigJiraConfig.reopen_transition?
optionalreopen_transition?:string
ConfigJiraConfig.resolve_transition?
optionalresolve_transition?:string
ConfigJiraConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigJiraConfig.summary?
optionalsummary?:object
ConfigJiraConfig.summary.enable_update?
optionalenable_update?:boolean|null
ConfigJiraConfig.summary.template?
optionaltemplate?:string
ConfigJiraConfig.wont_fix_resolution?
optionalwont_fix_resolution?:string
ConfigJiraFieldConfig
ConfigJiraFieldConfig:
object
ConfigJiraFieldConfig.enable_update?
optionalenable_update?:boolean|null
ConfigJiraFieldConfig.template?
optionaltemplate?:string
ConfigMattermostAttachment
ConfigMattermostAttachment:
object
ConfigMattermostAttachment.author_icon?
optionalauthor_icon?:string
ConfigMattermostAttachment.author_link?
optionalauthor_link?:string
ConfigMattermostAttachment.author_name?
optionalauthor_name?:string
ConfigMattermostAttachment.color?
optionalcolor?:string
ConfigMattermostAttachment.fallback?
optionalfallback?:string
ConfigMattermostAttachment.fields?
optionalfields?:object[]
ConfigMattermostAttachment.footer?
optionalfooter?:string
ConfigMattermostAttachment.footer_icon?
optionalfooter_icon?:string
ConfigMattermostAttachment.image_url?
optionalimage_url?:string
ConfigMattermostAttachment.pretext?
optionalpretext?:string
ConfigMattermostAttachment.text?
optionaltext?:string
ConfigMattermostAttachment.thumb_url?
optionalthumb_url?:string
ConfigMattermostAttachment.title?
optionaltitle?:string
ConfigMattermostAttachment.title_link?
optionaltitle_link?:string
ConfigMattermostConfig
ConfigMattermostConfig:
object
ConfigMattermostConfig.attachments?
optionalattachments?:object[]
ConfigMattermostConfig.channel?
optionalchannel?:string
ConfigMattermostConfig.http_config?
optionalhttp_config?:object
ConfigMattermostConfig.http_config.authorization?
optionalauthorization?:object
ConfigMattermostConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigMattermostConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigMattermostConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigMattermostConfig.http_config.authorization.type?
optionaltype?:string
ConfigMattermostConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigMattermostConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigMattermostConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigMattermostConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigMattermostConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigMattermostConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigMattermostConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigMattermostConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigMattermostConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigMattermostConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigMattermostConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigMattermostConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigMattermostConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigMattermostConfig.http_config.oauth2?
optionaloauth2?:object
ConfigMattermostConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigMattermostConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigMattermostConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigMattermostConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigMattermostConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigMattermostConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigMattermostConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigMattermostConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigMattermostConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigMattermostConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigMattermostConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigMattermostConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigMattermostConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigMattermostConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigMattermostConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigMattermostConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigMattermostConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigMattermostConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigMattermostConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigMattermostConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigMattermostConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigMattermostConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigMattermostConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigMattermostConfig.http_config.tls_config?
optionaltls_config?:object
ConfigMattermostConfig.http_config.tls_config.ca?
optionalca?:string
ConfigMattermostConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigMattermostConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigMattermostConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigMattermostConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigMattermostConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigMattermostConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigMattermostConfig.http_config.tls_config.key?
optionalkey?:string
ConfigMattermostConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigMattermostConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigMattermostConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigMattermostConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigMattermostConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigMattermostConfig.icon_emoji?
optionalicon_emoji?:string
ConfigMattermostConfig.icon_url?
optionalicon_url?:string
ConfigMattermostConfig.priority?
optionalpriority?:object
ConfigMattermostConfig.priority.persistent_notifications?
optionalpersistent_notifications?:boolean
ConfigMattermostConfig.priority.priority?
optionalpriority?:string
ConfigMattermostConfig.priority.requested_ack?
optionalrequested_ack?:boolean
ConfigMattermostConfig.props?
optionalprops?:object
ConfigMattermostConfig.props.card?
optionalcard?:string
ConfigMattermostConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigMattermostConfig.text?
optionaltext?:string
ConfigMattermostConfig.type?
optionaltype?:string
ConfigMattermostConfig.username?
optionalusername?:string
ConfigMattermostConfig.webhook_url?
optionalwebhook_url?:Record<string,never>
ConfigMattermostConfig.webhook_url_file?
optionalwebhook_url_file?:string
ConfigMattermostField
ConfigMattermostField:
object
ConfigMattermostField.short?
optionalshort?:boolean|null
ConfigMattermostField.title?
optionaltitle?:string
ConfigMattermostField.value?
optionalvalue?:string
ConfigMattermostPriority
ConfigMattermostPriority:
object
ConfigMattermostPriority.persistent_notifications?
optionalpersistent_notifications?:boolean
ConfigMattermostPriority.priority?
optionalpriority?:string
ConfigMattermostPriority.requested_ack?
optionalrequested_ack?:boolean
ConfigMattermostProps
ConfigMattermostProps:
object
ConfigMattermostProps.card?
optionalcard?:string
ConfigMSTeamsConfig
ConfigMSTeamsConfig:
object
ConfigMSTeamsConfig.http_config?
optionalhttp_config?:object
ConfigMSTeamsConfig.http_config.authorization?
optionalauthorization?:object
ConfigMSTeamsConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigMSTeamsConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigMSTeamsConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigMSTeamsConfig.http_config.authorization.type?
optionaltype?:string
ConfigMSTeamsConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigMSTeamsConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigMSTeamsConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigMSTeamsConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigMSTeamsConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigMSTeamsConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigMSTeamsConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigMSTeamsConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigMSTeamsConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigMSTeamsConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigMSTeamsConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigMSTeamsConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigMSTeamsConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigMSTeamsConfig.http_config.oauth2?
optionaloauth2?:object
ConfigMSTeamsConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigMSTeamsConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigMSTeamsConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigMSTeamsConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigMSTeamsConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigMSTeamsConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigMSTeamsConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigMSTeamsConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigMSTeamsConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigMSTeamsConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigMSTeamsConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigMSTeamsConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigMSTeamsConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigMSTeamsConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigMSTeamsConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigMSTeamsConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigMSTeamsConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigMSTeamsConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigMSTeamsConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigMSTeamsConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigMSTeamsConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigMSTeamsConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigMSTeamsConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigMSTeamsConfig.http_config.tls_config?
optionaltls_config?:object
ConfigMSTeamsConfig.http_config.tls_config.ca?
optionalca?:string
ConfigMSTeamsConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigMSTeamsConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigMSTeamsConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigMSTeamsConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigMSTeamsConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigMSTeamsConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigMSTeamsConfig.http_config.tls_config.key?
optionalkey?:string
ConfigMSTeamsConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigMSTeamsConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigMSTeamsConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigMSTeamsConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigMSTeamsConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigMSTeamsConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigMSTeamsConfig.summary?
optionalsummary?:string
ConfigMSTeamsConfig.text?
optionaltext?:string
ConfigMSTeamsConfig.title?
optionaltitle?:string
ConfigMSTeamsConfig.webhook_url?
optionalwebhook_url?:Record<string,never>
ConfigMSTeamsConfig.webhook_url_file?
optionalwebhook_url_file?:string
ConfigMSTeamsV2Config
ConfigMSTeamsV2Config:
object
ConfigMSTeamsV2Config.http_config?
optionalhttp_config?:object
ConfigMSTeamsV2Config.http_config.authorization?
optionalauthorization?:object
ConfigMSTeamsV2Config.http_config.authorization.credentials?
optionalcredentials?:string
ConfigMSTeamsV2Config.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigMSTeamsV2Config.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigMSTeamsV2Config.http_config.authorization.type?
optionaltype?:string
ConfigMSTeamsV2Config.http_config.basic_auth?
optionalbasic_auth?:object
ConfigMSTeamsV2Config.http_config.basic_auth.password?
optionalpassword?:string
ConfigMSTeamsV2Config.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigMSTeamsV2Config.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigMSTeamsV2Config.http_config.basic_auth.username?
optionalusername?:string
ConfigMSTeamsV2Config.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigMSTeamsV2Config.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigMSTeamsV2Config.http_config.bearer_token?
optionalbearer_token?:string
ConfigMSTeamsV2Config.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigMSTeamsV2Config.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigMSTeamsV2Config.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigMSTeamsV2Config.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigMSTeamsV2Config.http_config.no_proxy?
optionalno_proxy?:string
ConfigMSTeamsV2Config.http_config.oauth2?
optionaloauth2?:object
ConfigMSTeamsV2Config.http_config.oauth2.audience?
optionalaudience?:string
ConfigMSTeamsV2Config.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigMSTeamsV2Config.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigMSTeamsV2Config.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigMSTeamsV2Config.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigMSTeamsV2Config.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigMSTeamsV2Config.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigMSTeamsV2Config.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigMSTeamsV2Config.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigMSTeamsV2Config.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigMSTeamsV2Config.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigMSTeamsV2Config.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigMSTeamsV2Config.http_config.oauth2.iss?
optionaliss?:string
ConfigMSTeamsV2Config.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigMSTeamsV2Config.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigMSTeamsV2Config.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigMSTeamsV2Config.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigMSTeamsV2Config.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigMSTeamsV2Config.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigMSTeamsV2Config.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigMSTeamsV2Config.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigMSTeamsV2Config.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigMSTeamsV2Config.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigMSTeamsV2Config.http_config.tls_config?
optionaltls_config?:object
ConfigMSTeamsV2Config.http_config.tls_config.ca?
optionalca?:string
ConfigMSTeamsV2Config.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigMSTeamsV2Config.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigMSTeamsV2Config.http_config.tls_config.cert?
optionalcert?:string
ConfigMSTeamsV2Config.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigMSTeamsV2Config.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigMSTeamsV2Config.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigMSTeamsV2Config.http_config.tls_config.key?
optionalkey?:string
ConfigMSTeamsV2Config.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigMSTeamsV2Config.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigMSTeamsV2Config.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigMSTeamsV2Config.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigMSTeamsV2Config.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigMSTeamsV2Config.send_resolved?
optionalsend_resolved?:boolean
ConfigMSTeamsV2Config.text?
optionaltext?:string
ConfigMSTeamsV2Config.title?
optionaltitle?:string
ConfigMSTeamsV2Config.webhook_url?
optionalwebhook_url?:Record<string,never>
ConfigMSTeamsV2Config.webhook_url_file?
optionalwebhook_url_file?:string
ConfigOAuth2
ConfigOAuth2:
object
ConfigOAuth2.audience?
optionalaudience?:string
ConfigOAuth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigOAuth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigOAuth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigOAuth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigOAuth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigOAuth2.client_id?
optionalclient_id?:string
ConfigOAuth2.client_secret?
optionalclient_secret?:string
ConfigOAuth2.client_secret_file?
optionalclient_secret_file?:string
ConfigOAuth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigOAuth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigOAuth2.grant_type?
optionalgrant_type?:string
ConfigOAuth2.iss?
optionaliss?:string
ConfigOAuth2.no_proxy?
optionalno_proxy?:string
ConfigOAuth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigOAuth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigOAuth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigOAuth2.scopes?
optionalscopes?:string[]
ConfigOAuth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigOAuth2.token_url?
optionaltoken_url?:string
ConfigOpsGenieConfig
ConfigOpsGenieConfig:
object
ConfigOpsGenieConfig.actions?
optionalactions?:string
ConfigOpsGenieConfig.api_key?
optionalapi_key?:string
ConfigOpsGenieConfig.api_key_file?
optionalapi_key_file?:string
ConfigOpsGenieConfig.api_url?
optionalapi_url?:Record<string,never>
ConfigOpsGenieConfig.description?
optionaldescription?:string
ConfigOpsGenieConfig.details?
optionaldetails?:object
Index Signature
[key: string]: string
ConfigOpsGenieConfig.entity?
optionalentity?:string
ConfigOpsGenieConfig.http_config?
optionalhttp_config?:object
ConfigOpsGenieConfig.http_config.authorization?
optionalauthorization?:object
ConfigOpsGenieConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigOpsGenieConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigOpsGenieConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigOpsGenieConfig.http_config.authorization.type?
optionaltype?:string
ConfigOpsGenieConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigOpsGenieConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigOpsGenieConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigOpsGenieConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigOpsGenieConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigOpsGenieConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigOpsGenieConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigOpsGenieConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigOpsGenieConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigOpsGenieConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigOpsGenieConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigOpsGenieConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigOpsGenieConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigOpsGenieConfig.http_config.oauth2?
optionaloauth2?:object
ConfigOpsGenieConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigOpsGenieConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigOpsGenieConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigOpsGenieConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigOpsGenieConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigOpsGenieConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigOpsGenieConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigOpsGenieConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigOpsGenieConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigOpsGenieConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigOpsGenieConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigOpsGenieConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigOpsGenieConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigOpsGenieConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigOpsGenieConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigOpsGenieConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigOpsGenieConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigOpsGenieConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigOpsGenieConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigOpsGenieConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigOpsGenieConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigOpsGenieConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigOpsGenieConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigOpsGenieConfig.http_config.tls_config?
optionaltls_config?:object
ConfigOpsGenieConfig.http_config.tls_config.ca?
optionalca?:string
ConfigOpsGenieConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigOpsGenieConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigOpsGenieConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigOpsGenieConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigOpsGenieConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigOpsGenieConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigOpsGenieConfig.http_config.tls_config.key?
optionalkey?:string
ConfigOpsGenieConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigOpsGenieConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigOpsGenieConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigOpsGenieConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigOpsGenieConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigOpsGenieConfig.message?
optionalmessage?:string
ConfigOpsGenieConfig.note?
optionalnote?:string
ConfigOpsGenieConfig.priority?
optionalpriority?:string
ConfigOpsGenieConfig.responders?
optionalresponders?:object[]
ConfigOpsGenieConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigOpsGenieConfig.source?
optionalsource?:string
ConfigOpsGenieConfig.tags?
optionaltags?:string
ConfigOpsGenieConfig.update_alerts?
optionalupdate_alerts?:boolean
ConfigOpsGenieConfigResponder
ConfigOpsGenieConfigResponder:
object
ConfigOpsGenieConfigResponder.id?
optionalid?:string
ConfigOpsGenieConfigResponder.name?
optionalname?:string
ConfigOpsGenieConfigResponder.type?
optionaltype?:string
ConfigOpsGenieConfigResponder.username?
optionalusername?:string
ConfigPagerdutyConfig
ConfigPagerdutyConfig:
object
ConfigPagerdutyConfig.class?
optionalclass?:string
ConfigPagerdutyConfig.client?
optionalclient?:string
ConfigPagerdutyConfig.client_url?
optionalclient_url?:string
ConfigPagerdutyConfig.component?
optionalcomponent?:string
ConfigPagerdutyConfig.description?
optionaldescription?:string
ConfigPagerdutyConfig.details?
optionaldetails?:object
Index Signature
[key: string]: unknown
ConfigPagerdutyConfig.group?
optionalgroup?:string
ConfigPagerdutyConfig.http_config?
optionalhttp_config?:object
ConfigPagerdutyConfig.http_config.authorization?
optionalauthorization?:object
ConfigPagerdutyConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigPagerdutyConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigPagerdutyConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigPagerdutyConfig.http_config.authorization.type?
optionaltype?:string
ConfigPagerdutyConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigPagerdutyConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigPagerdutyConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigPagerdutyConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigPagerdutyConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigPagerdutyConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigPagerdutyConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigPagerdutyConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigPagerdutyConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigPagerdutyConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigPagerdutyConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigPagerdutyConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigPagerdutyConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigPagerdutyConfig.http_config.oauth2?
optionaloauth2?:object
ConfigPagerdutyConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigPagerdutyConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigPagerdutyConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigPagerdutyConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigPagerdutyConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigPagerdutyConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigPagerdutyConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigPagerdutyConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigPagerdutyConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigPagerdutyConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigPagerdutyConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigPagerdutyConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigPagerdutyConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigPagerdutyConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigPagerdutyConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigPagerdutyConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigPagerdutyConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigPagerdutyConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigPagerdutyConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigPagerdutyConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigPagerdutyConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigPagerdutyConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigPagerdutyConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigPagerdutyConfig.http_config.tls_config?
optionaltls_config?:object
ConfigPagerdutyConfig.http_config.tls_config.ca?
optionalca?:string
ConfigPagerdutyConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigPagerdutyConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigPagerdutyConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigPagerdutyConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigPagerdutyConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigPagerdutyConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigPagerdutyConfig.http_config.tls_config.key?
optionalkey?:string
ConfigPagerdutyConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigPagerdutyConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigPagerdutyConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigPagerdutyConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigPagerdutyConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigPagerdutyConfig.images?
optionalimages?:object[]
ConfigPagerdutyConfig.links?
optionallinks?:object[]
ConfigPagerdutyConfig.routing_key?
optionalrouting_key?:string
ConfigPagerdutyConfig.routing_key_file?
optionalrouting_key_file?:string
ConfigPagerdutyConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigPagerdutyConfig.service_key?
optionalservice_key?:string
ConfigPagerdutyConfig.service_key_file?
optionalservice_key_file?:string
ConfigPagerdutyConfig.severity?
optionalseverity?:string
ConfigPagerdutyConfig.source?
optionalsource?:string
ConfigPagerdutyConfig.timeout?
optionaltimeout?:number
ConfigPagerdutyConfig.url?
optionalurl?:Record<string,never>
ConfigPagerdutyImage
ConfigPagerdutyImage:
object
ConfigPagerdutyImage.alt?
optionalalt?:string
ConfigPagerdutyImage.href?
optionalhref?:string
ConfigPagerdutyImage.src?
optionalsrc?:string
ConfigPagerdutyLink
ConfigPagerdutyLink:
object
ConfigPagerdutyLink.href?
optionalhref?:string
ConfigPagerdutyLink.text?
optionaltext?:string
ConfigProxyHeader
ConfigProxyHeader:
object
Index Signature
[key: string]: string[]
ConfigPushoverConfig
ConfigPushoverConfig:
object
ConfigPushoverConfig.device?
optionaldevice?:string
ConfigPushoverConfig.expire?
optionalexpire?:string
ConfigPushoverConfig.html?
optionalhtml?:boolean
ConfigPushoverConfig.http_config?
optionalhttp_config?:object
ConfigPushoverConfig.http_config.authorization?
optionalauthorization?:object
ConfigPushoverConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigPushoverConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigPushoverConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigPushoverConfig.http_config.authorization.type?
optionaltype?:string
ConfigPushoverConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigPushoverConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigPushoverConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigPushoverConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigPushoverConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigPushoverConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigPushoverConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigPushoverConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigPushoverConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigPushoverConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigPushoverConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigPushoverConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigPushoverConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigPushoverConfig.http_config.oauth2?
optionaloauth2?:object
ConfigPushoverConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigPushoverConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigPushoverConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigPushoverConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigPushoverConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigPushoverConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigPushoverConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigPushoverConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigPushoverConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigPushoverConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigPushoverConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigPushoverConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigPushoverConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigPushoverConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigPushoverConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigPushoverConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigPushoverConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigPushoverConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigPushoverConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigPushoverConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigPushoverConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigPushoverConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigPushoverConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigPushoverConfig.http_config.tls_config?
optionaltls_config?:object
ConfigPushoverConfig.http_config.tls_config.ca?
optionalca?:string
ConfigPushoverConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigPushoverConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigPushoverConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigPushoverConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigPushoverConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigPushoverConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigPushoverConfig.http_config.tls_config.key?
optionalkey?:string
ConfigPushoverConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigPushoverConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigPushoverConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigPushoverConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigPushoverConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigPushoverConfig.message?
optionalmessage?:string
ConfigPushoverConfig.monospace?
optionalmonospace?:boolean
ConfigPushoverConfig.priority?
optionalpriority?:string
ConfigPushoverConfig.retry?
optionalretry?:string
ConfigPushoverConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigPushoverConfig.sound?
optionalsound?:string
ConfigPushoverConfig.title?
optionaltitle?:string
ConfigPushoverConfig.token?
optionaltoken?:string
ConfigPushoverConfig.token_file?
optionaltoken_file?:string
ConfigPushoverConfig.ttl?
optionalttl?:string
ConfigPushoverConfig.url?
optionalurl?:string
ConfigPushoverConfig.url_title?
optionalurl_title?:string
ConfigPushoverConfig.user_key?
optionaluser_key?:string
ConfigPushoverConfig.user_key_file?
optionaluser_key_file?:string
ConfigRocketchatAttachmentAction
ConfigRocketchatAttachmentAction:
object
ConfigRocketchatAttachmentAction.image_url?
optionalimage_url?:string
ConfigRocketchatAttachmentAction.is_webview?
optionalis_webview?:boolean
ConfigRocketchatAttachmentAction.msg?
optionalmsg?:string
ConfigRocketchatAttachmentAction.msg_in_chat_window?
optionalmsg_in_chat_window?:boolean
ConfigRocketchatAttachmentAction.msg_processing_type?
optionalmsg_processing_type?:string
ConfigRocketchatAttachmentAction.text?
optionaltext?:string
ConfigRocketchatAttachmentAction.type?
optionaltype?:string
ConfigRocketchatAttachmentAction.url?
optionalurl?:string
ConfigRocketchatAttachmentAction.webview_height_ratio?
optionalwebview_height_ratio?:string
ConfigRocketchatAttachmentField
ConfigRocketchatAttachmentField:
object
ConfigRocketchatAttachmentField.short?
optionalshort?:boolean|null
ConfigRocketchatAttachmentField.title?
optionaltitle?:string
ConfigRocketchatAttachmentField.value?
optionalvalue?:string
ConfigRocketchatConfig
ConfigRocketchatConfig:
object
ConfigRocketchatConfig.actions?
optionalactions?:object[]
ConfigRocketchatConfig.api_url?
optionalapi_url?:Record<string,never>
ConfigRocketchatConfig.channel?
optionalchannel?:string
ConfigRocketchatConfig.color?
optionalcolor?:string
ConfigRocketchatConfig.emoji?
optionalemoji?:string
ConfigRocketchatConfig.fields?
optionalfields?:object[]
ConfigRocketchatConfig.http_config?
optionalhttp_config?:object
ConfigRocketchatConfig.http_config.authorization?
optionalauthorization?:object
ConfigRocketchatConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigRocketchatConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigRocketchatConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigRocketchatConfig.http_config.authorization.type?
optionaltype?:string
ConfigRocketchatConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigRocketchatConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigRocketchatConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigRocketchatConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigRocketchatConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigRocketchatConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigRocketchatConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigRocketchatConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigRocketchatConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigRocketchatConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigRocketchatConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigRocketchatConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigRocketchatConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigRocketchatConfig.http_config.oauth2?
optionaloauth2?:object
ConfigRocketchatConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigRocketchatConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigRocketchatConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigRocketchatConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigRocketchatConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigRocketchatConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigRocketchatConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigRocketchatConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigRocketchatConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigRocketchatConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigRocketchatConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigRocketchatConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigRocketchatConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigRocketchatConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigRocketchatConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigRocketchatConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigRocketchatConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigRocketchatConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigRocketchatConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigRocketchatConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigRocketchatConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigRocketchatConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigRocketchatConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigRocketchatConfig.http_config.tls_config?
optionaltls_config?:object
ConfigRocketchatConfig.http_config.tls_config.ca?
optionalca?:string
ConfigRocketchatConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigRocketchatConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigRocketchatConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigRocketchatConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigRocketchatConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigRocketchatConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigRocketchatConfig.http_config.tls_config.key?
optionalkey?:string
ConfigRocketchatConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigRocketchatConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigRocketchatConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigRocketchatConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigRocketchatConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigRocketchatConfig.icon_url?
optionalicon_url?:string
ConfigRocketchatConfig.image_url?
optionalimage_url?:string
ConfigRocketchatConfig.link_names?
optionallink_names?:boolean
ConfigRocketchatConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigRocketchatConfig.short_fields?
optionalshort_fields?:boolean
ConfigRocketchatConfig.text?
optionaltext?:string
ConfigRocketchatConfig.thumb_url?
optionalthumb_url?:string
ConfigRocketchatConfig.title?
optionaltitle?:string
ConfigRocketchatConfig.title_link?
optionaltitle_link?:string
ConfigRocketchatConfig.token?
optionaltoken?:string
ConfigRocketchatConfig.token_file?
optionaltoken_file?:string
ConfigRocketchatConfig.token_id?
optionaltoken_id?:string
ConfigRocketchatConfig.token_id_file?
optionaltoken_id_file?:string
ConfigSecretURL
ConfigSecretURL:
Record<string,never>
ConfigSlackAction
ConfigSlackAction:
object
ConfigSlackAction.confirm?
optionalconfirm?:object
ConfigSlackAction.confirm.dismiss_text?
optionaldismiss_text?:string
ConfigSlackAction.confirm.ok_text?
optionalok_text?:string
ConfigSlackAction.confirm.text?
optionaltext?:string
ConfigSlackAction.confirm.title?
optionaltitle?:string
ConfigSlackAction.name?
optionalname?:string
ConfigSlackAction.style?
optionalstyle?:string
ConfigSlackAction.text?
optionaltext?:string
ConfigSlackAction.type?
optionaltype?:string
ConfigSlackAction.url?
optionalurl?:string
ConfigSlackAction.value?
optionalvalue?:string
ConfigSlackConfig
ConfigSlackConfig:
object
ConfigSlackConfig.actions?
optionalactions?:object[]
ConfigSlackConfig.api_url?
optionalapi_url?:Record<string,never>
ConfigSlackConfig.api_url_file?
optionalapi_url_file?:string
ConfigSlackConfig.app_token?
optionalapp_token?:string
ConfigSlackConfig.app_token_file?
optionalapp_token_file?:string
ConfigSlackConfig.app_url?
optionalapp_url?:Record<string,never>
ConfigSlackConfig.callback_id?
optionalcallback_id?:string
ConfigSlackConfig.channel?
optionalchannel?:string
ConfigSlackConfig.color?
optionalcolor?:string
ConfigSlackConfig.fallback?
optionalfallback?:string
ConfigSlackConfig.fields?
optionalfields?:object[]
ConfigSlackConfig.footer?
optionalfooter?:string
ConfigSlackConfig.http_config?
optionalhttp_config?:object
ConfigSlackConfig.http_config.authorization?
optionalauthorization?:object
ConfigSlackConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigSlackConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigSlackConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigSlackConfig.http_config.authorization.type?
optionaltype?:string
ConfigSlackConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigSlackConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigSlackConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigSlackConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigSlackConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigSlackConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigSlackConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigSlackConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigSlackConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigSlackConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigSlackConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigSlackConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigSlackConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigSlackConfig.http_config.oauth2?
optionaloauth2?:object
ConfigSlackConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigSlackConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigSlackConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigSlackConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigSlackConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigSlackConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigSlackConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigSlackConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigSlackConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigSlackConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigSlackConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigSlackConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigSlackConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigSlackConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigSlackConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigSlackConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigSlackConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigSlackConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigSlackConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigSlackConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigSlackConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigSlackConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigSlackConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigSlackConfig.http_config.tls_config?
optionaltls_config?:object
ConfigSlackConfig.http_config.tls_config.ca?
optionalca?:string
ConfigSlackConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigSlackConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigSlackConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigSlackConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigSlackConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigSlackConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigSlackConfig.http_config.tls_config.key?
optionalkey?:string
ConfigSlackConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigSlackConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigSlackConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigSlackConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigSlackConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigSlackConfig.icon_emoji?
optionalicon_emoji?:string
ConfigSlackConfig.icon_url?
optionalicon_url?:string
ConfigSlackConfig.image_url?
optionalimage_url?:string
ConfigSlackConfig.link_names?
optionallink_names?:boolean
ConfigSlackConfig.message_text?
optionalmessage_text?:string
ConfigSlackConfig.mrkdwn_in?
optionalmrkdwn_in?:string[]
ConfigSlackConfig.pretext?
optionalpretext?:string
ConfigSlackConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigSlackConfig.short_fields?
optionalshort_fields?:boolean
ConfigSlackConfig.text?
optionaltext?:string
ConfigSlackConfig.thumb_url?
optionalthumb_url?:string
ConfigSlackConfig.timeout?
optionaltimeout?:number
ConfigSlackConfig.title?
optionaltitle?:string
ConfigSlackConfig.title_link?
optionaltitle_link?:string
ConfigSlackConfig.username?
optionalusername?:string
ConfigSlackConfirmationField
ConfigSlackConfirmationField:
object
ConfigSlackConfirmationField.dismiss_text?
optionaldismiss_text?:string
ConfigSlackConfirmationField.ok_text?
optionalok_text?:string
ConfigSlackConfirmationField.text?
optionaltext?:string
ConfigSlackConfirmationField.title?
optionaltitle?:string
ConfigSlackField
ConfigSlackField:
object
ConfigSlackField.short?
optionalshort?:boolean|null
ConfigSlackField.title?
optionaltitle?:string
ConfigSlackField.value?
optionalvalue?:string
ConfigSNSConfig
ConfigSNSConfig:
object
ConfigSNSConfig.api_url?
optionalapi_url?:string
ConfigSNSConfig.attributes?
optionalattributes?:object
Index Signature
[key: string]: string
ConfigSNSConfig.http_config?
optionalhttp_config?:object
ConfigSNSConfig.http_config.authorization?
optionalauthorization?:object
ConfigSNSConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigSNSConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigSNSConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigSNSConfig.http_config.authorization.type?
optionaltype?:string
ConfigSNSConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigSNSConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigSNSConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigSNSConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigSNSConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigSNSConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigSNSConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigSNSConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigSNSConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigSNSConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigSNSConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigSNSConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigSNSConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigSNSConfig.http_config.oauth2?
optionaloauth2?:object
ConfigSNSConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigSNSConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigSNSConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigSNSConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigSNSConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigSNSConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigSNSConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigSNSConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigSNSConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigSNSConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigSNSConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigSNSConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigSNSConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigSNSConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigSNSConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigSNSConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigSNSConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigSNSConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigSNSConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigSNSConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigSNSConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigSNSConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigSNSConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigSNSConfig.http_config.tls_config?
optionaltls_config?:object
ConfigSNSConfig.http_config.tls_config.ca?
optionalca?:string
ConfigSNSConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigSNSConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigSNSConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigSNSConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigSNSConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigSNSConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigSNSConfig.http_config.tls_config.key?
optionalkey?:string
ConfigSNSConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigSNSConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigSNSConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigSNSConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigSNSConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigSNSConfig.message?
optionalmessage?:string
ConfigSNSConfig.phone_number?
optionalphone_number?:string
ConfigSNSConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigSNSConfig.sigv4?
optionalsigv4?:Record<string,never>
ConfigSNSConfig.subject?
optionalsubject?:string
ConfigSNSConfig.target_arn?
optionaltarget_arn?:string
ConfigSNSConfig.topic_arn?
optionaltopic_arn?:string
ConfigTelegramConfig
ConfigTelegramConfig:
object
ConfigTelegramConfig.api_url?
optionalapi_url?:Record<string,never>
ConfigTelegramConfig.chat?
optionalchat?:number
Format: int64
ConfigTelegramConfig.chat_file?
optionalchat_file?:string
ConfigTelegramConfig.disable_notifications?
optionaldisable_notifications?:boolean
ConfigTelegramConfig.http_config?
optionalhttp_config?:object
ConfigTelegramConfig.http_config.authorization?
optionalauthorization?:object
ConfigTelegramConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigTelegramConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigTelegramConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigTelegramConfig.http_config.authorization.type?
optionaltype?:string
ConfigTelegramConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigTelegramConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigTelegramConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigTelegramConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigTelegramConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigTelegramConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigTelegramConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigTelegramConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigTelegramConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigTelegramConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigTelegramConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigTelegramConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigTelegramConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigTelegramConfig.http_config.oauth2?
optionaloauth2?:object
ConfigTelegramConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigTelegramConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigTelegramConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigTelegramConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigTelegramConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigTelegramConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigTelegramConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigTelegramConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigTelegramConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigTelegramConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigTelegramConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigTelegramConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigTelegramConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigTelegramConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigTelegramConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigTelegramConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigTelegramConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigTelegramConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigTelegramConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigTelegramConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigTelegramConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigTelegramConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigTelegramConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigTelegramConfig.http_config.tls_config?
optionaltls_config?:object
ConfigTelegramConfig.http_config.tls_config.ca?
optionalca?:string
ConfigTelegramConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigTelegramConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigTelegramConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigTelegramConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigTelegramConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigTelegramConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigTelegramConfig.http_config.tls_config.key?
optionalkey?:string
ConfigTelegramConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigTelegramConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigTelegramConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigTelegramConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigTelegramConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigTelegramConfig.message?
optionalmessage?:string
ConfigTelegramConfig.message_thread_id?
optionalmessage_thread_id?:number
ConfigTelegramConfig.parse_mode?
optionalparse_mode?:string
ConfigTelegramConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigTelegramConfig.token?
optionaltoken?:string
ConfigTelegramConfig.token_file?
optionaltoken_file?:string
ConfigThreadingConfig
ConfigThreadingConfig:
object
ConfigThreadingConfig.enabled?
optionalenabled?:boolean
ConfigThreadingConfig.thread_by_date?
optionalthread_by_date?:string
ConfigTLSConfig
ConfigTLSConfig:
object
ConfigTLSConfig.ca?
optionalca?:string
ConfigTLSConfig.ca_file?
optionalca_file?:string
ConfigTLSConfig.ca_ref?
optionalca_ref?:string
ConfigTLSConfig.cert?
optionalcert?:string
ConfigTLSConfig.cert_file?
optionalcert_file?:string
ConfigTLSConfig.cert_ref?
optionalcert_ref?:string
ConfigTLSConfig.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigTLSConfig.key?
optionalkey?:string
ConfigTLSConfig.key_file?
optionalkey_file?:string
ConfigTLSConfig.key_ref?
optionalkey_ref?:string
ConfigTLSConfig.max_version?
optionalmax_version?:number
ConfigTLSConfig.min_version?
optionalmin_version?:number
ConfigTLSConfig.server_name?
optionalserver_name?:string
ConfigURL
ConfigURL:
Record<string,never>
ConfigURLType2
ConfigURLType2:
Record<string,never>
ConfigVictorOpsConfig
ConfigVictorOpsConfig:
object
ConfigVictorOpsConfig.api_key?
optionalapi_key?:string
ConfigVictorOpsConfig.api_key_file?
optionalapi_key_file?:string
ConfigVictorOpsConfig.api_url?
optionalapi_url?:Record<string,never>
ConfigVictorOpsConfig.custom_fields?
optionalcustom_fields?:object
Index Signature
[key: string]: string
ConfigVictorOpsConfig.entity_display_name?
optionalentity_display_name?:string
ConfigVictorOpsConfig.http_config?
optionalhttp_config?:object
ConfigVictorOpsConfig.http_config.authorization?
optionalauthorization?:object
ConfigVictorOpsConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigVictorOpsConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigVictorOpsConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigVictorOpsConfig.http_config.authorization.type?
optionaltype?:string
ConfigVictorOpsConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigVictorOpsConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigVictorOpsConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigVictorOpsConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigVictorOpsConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigVictorOpsConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigVictorOpsConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigVictorOpsConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigVictorOpsConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigVictorOpsConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigVictorOpsConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigVictorOpsConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigVictorOpsConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigVictorOpsConfig.http_config.oauth2?
optionaloauth2?:object
ConfigVictorOpsConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigVictorOpsConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigVictorOpsConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigVictorOpsConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigVictorOpsConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigVictorOpsConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigVictorOpsConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigVictorOpsConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigVictorOpsConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigVictorOpsConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigVictorOpsConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigVictorOpsConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigVictorOpsConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigVictorOpsConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigVictorOpsConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigVictorOpsConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigVictorOpsConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigVictorOpsConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigVictorOpsConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigVictorOpsConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigVictorOpsConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigVictorOpsConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigVictorOpsConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigVictorOpsConfig.http_config.tls_config?
optionaltls_config?:object
ConfigVictorOpsConfig.http_config.tls_config.ca?
optionalca?:string
ConfigVictorOpsConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigVictorOpsConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigVictorOpsConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigVictorOpsConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigVictorOpsConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigVictorOpsConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigVictorOpsConfig.http_config.tls_config.key?
optionalkey?:string
ConfigVictorOpsConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigVictorOpsConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigVictorOpsConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigVictorOpsConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigVictorOpsConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigVictorOpsConfig.message_type?
optionalmessage_type?:string
ConfigVictorOpsConfig.monitoring_tool?
optionalmonitoring_tool?:string
ConfigVictorOpsConfig.routing_key?
optionalrouting_key?:string
ConfigVictorOpsConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigVictorOpsConfig.state_message?
optionalstate_message?:string
ConfigWebexConfig
ConfigWebexConfig:
object
ConfigWebexConfig.api_url?
optionalapi_url?:Record<string,never>
ConfigWebexConfig.http_config?
optionalhttp_config?:object
ConfigWebexConfig.http_config.authorization?
optionalauthorization?:object
ConfigWebexConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigWebexConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigWebexConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigWebexConfig.http_config.authorization.type?
optionaltype?:string
ConfigWebexConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigWebexConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigWebexConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigWebexConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigWebexConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigWebexConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigWebexConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigWebexConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigWebexConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigWebexConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigWebexConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigWebexConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigWebexConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigWebexConfig.http_config.oauth2?
optionaloauth2?:object
ConfigWebexConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigWebexConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigWebexConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigWebexConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigWebexConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigWebexConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigWebexConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigWebexConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigWebexConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigWebexConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigWebexConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigWebexConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigWebexConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigWebexConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigWebexConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigWebexConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigWebexConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigWebexConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigWebexConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigWebexConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigWebexConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigWebexConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigWebexConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigWebexConfig.http_config.tls_config?
optionaltls_config?:object
ConfigWebexConfig.http_config.tls_config.ca?
optionalca?:string
ConfigWebexConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigWebexConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigWebexConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigWebexConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigWebexConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigWebexConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigWebexConfig.http_config.tls_config.key?
optionalkey?:string
ConfigWebexConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigWebexConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigWebexConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigWebexConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigWebexConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigWebexConfig.message?
optionalmessage?:string
ConfigWebexConfig.room_id?
optionalroom_id?:string
ConfigWebexConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigWebhookConfig
ConfigWebhookConfig:
object
ConfigWebhookConfig.http_config?
optionalhttp_config?:object
ConfigWebhookConfig.http_config.authorization?
optionalauthorization?:object
ConfigWebhookConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigWebhookConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigWebhookConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigWebhookConfig.http_config.authorization.type?
optionaltype?:string
ConfigWebhookConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigWebhookConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigWebhookConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigWebhookConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigWebhookConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigWebhookConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigWebhookConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigWebhookConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigWebhookConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigWebhookConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigWebhookConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigWebhookConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigWebhookConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigWebhookConfig.http_config.oauth2?
optionaloauth2?:object
ConfigWebhookConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigWebhookConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigWebhookConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigWebhookConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigWebhookConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigWebhookConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigWebhookConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigWebhookConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigWebhookConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigWebhookConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigWebhookConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigWebhookConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigWebhookConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigWebhookConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigWebhookConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigWebhookConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigWebhookConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigWebhookConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigWebhookConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigWebhookConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigWebhookConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigWebhookConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigWebhookConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigWebhookConfig.http_config.tls_config?
optionaltls_config?:object
ConfigWebhookConfig.http_config.tls_config.ca?
optionalca?:string
ConfigWebhookConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigWebhookConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigWebhookConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigWebhookConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigWebhookConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigWebhookConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigWebhookConfig.http_config.tls_config.key?
optionalkey?:string
ConfigWebhookConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigWebhookConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigWebhookConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigWebhookConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigWebhookConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigWebhookConfig.max_alerts?
optionalmax_alerts?:number
ConfigWebhookConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigWebhookConfig.timeout?
optionaltimeout?:number
ConfigWebhookConfig.url?
optionalurl?:string
ConfigWebhookConfig.url_file?
optionalurl_file?:string
ConfigWechatConfig
ConfigWechatConfig:
object
ConfigWechatConfig.agent_id?
optionalagent_id?:string
ConfigWechatConfig.api_secret?
optionalapi_secret?:string
ConfigWechatConfig.api_secret_file?
optionalapi_secret_file?:string
ConfigWechatConfig.api_url?
optionalapi_url?:Record<string,never>
ConfigWechatConfig.corp_id?
optionalcorp_id?:string
ConfigWechatConfig.http_config?
optionalhttp_config?:object
ConfigWechatConfig.http_config.authorization?
optionalauthorization?:object
ConfigWechatConfig.http_config.authorization.credentials?
optionalcredentials?:string
ConfigWechatConfig.http_config.authorization.credentials_file?
optionalcredentials_file?:string
ConfigWechatConfig.http_config.authorization.credentials_ref?
optionalcredentials_ref?:string
ConfigWechatConfig.http_config.authorization.type?
optionaltype?:string
ConfigWechatConfig.http_config.basic_auth?
optionalbasic_auth?:object
ConfigWechatConfig.http_config.basic_auth.password?
optionalpassword?:string
ConfigWechatConfig.http_config.basic_auth.password_file?
optionalpassword_file?:string
ConfigWechatConfig.http_config.basic_auth.password_ref?
optionalpassword_ref?:string
ConfigWechatConfig.http_config.basic_auth.username?
optionalusername?:string
ConfigWechatConfig.http_config.basic_auth.username_file?
optionalusername_file?:string
ConfigWechatConfig.http_config.basic_auth.username_ref?
optionalusername_ref?:string
ConfigWechatConfig.http_config.bearer_token?
optionalbearer_token?:string
ConfigWechatConfig.http_config.bearer_token_file?
optionalbearer_token_file?:string
ConfigWechatConfig.http_config.enable_http2?
optionalenable_http2?:boolean
ConfigWechatConfig.http_config.follow_redirects?
optionalfollow_redirects?:boolean
ConfigWechatConfig.http_config.http_headers?
optionalhttp_headers?:Record<string,never>
ConfigWechatConfig.http_config.no_proxy?
optionalno_proxy?:string
ConfigWechatConfig.http_config.oauth2?
optionaloauth2?:object
ConfigWechatConfig.http_config.oauth2.audience?
optionalaudience?:string
ConfigWechatConfig.http_config.oauth2.claims?
optionalclaims?:object
Index Signature
[key: string]: unknown
ConfigWechatConfig.http_config.oauth2.client_certificate_key?
optionalclient_certificate_key?:string
ConfigWechatConfig.http_config.oauth2.client_certificate_key_file?
optionalclient_certificate_key_file?:string
ConfigWechatConfig.http_config.oauth2.client_certificate_key_id?
optionalclient_certificate_key_id?:string
ConfigWechatConfig.http_config.oauth2.client_certificate_key_ref?
optionalclient_certificate_key_ref?:string
ConfigWechatConfig.http_config.oauth2.client_id?
optionalclient_id?:string
ConfigWechatConfig.http_config.oauth2.client_secret?
optionalclient_secret?:string
ConfigWechatConfig.http_config.oauth2.client_secret_file?
optionalclient_secret_file?:string
ConfigWechatConfig.http_config.oauth2.client_secret_ref?
optionalclient_secret_ref?:string
ConfigWechatConfig.http_config.oauth2.endpoint_params?
optionalendpoint_params?:object
Index Signature
[key: string]: string
ConfigWechatConfig.http_config.oauth2.grant_type?
optionalgrant_type?:string
ConfigWechatConfig.http_config.oauth2.iss?
optionaliss?:string
ConfigWechatConfig.http_config.oauth2.no_proxy?
optionalno_proxy?:string
ConfigWechatConfig.http_config.oauth2.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigWechatConfig.http_config.oauth2.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigWechatConfig.http_config.oauth2.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigWechatConfig.http_config.oauth2.scopes?
optionalscopes?:string[]
ConfigWechatConfig.http_config.oauth2.signature_algorithm?
optionalsignature_algorithm?:string
ConfigWechatConfig.http_config.oauth2.token_url?
optionaltoken_url?:string
ConfigWechatConfig.http_config.proxy_connect_header?
optionalproxy_connect_header?:object
Index Signature
[key: string]: string[]
ConfigWechatConfig.http_config.proxy_from_environment?
optionalproxy_from_environment?:boolean
ConfigWechatConfig.http_config.proxy_url?
optionalproxy_url?:Record<string,never>
ConfigWechatConfig.http_config.tls_config?
optionaltls_config?:object
ConfigWechatConfig.http_config.tls_config.ca?
optionalca?:string
ConfigWechatConfig.http_config.tls_config.ca_file?
optionalca_file?:string
ConfigWechatConfig.http_config.tls_config.ca_ref?
optionalca_ref?:string
ConfigWechatConfig.http_config.tls_config.cert?
optionalcert?:string
ConfigWechatConfig.http_config.tls_config.cert_file?
optionalcert_file?:string
ConfigWechatConfig.http_config.tls_config.cert_ref?
optionalcert_ref?:string
ConfigWechatConfig.http_config.tls_config.insecure_skip_verify?
optionalinsecure_skip_verify?:boolean
ConfigWechatConfig.http_config.tls_config.key?
optionalkey?:string
ConfigWechatConfig.http_config.tls_config.key_file?
optionalkey_file?:string
ConfigWechatConfig.http_config.tls_config.key_ref?
optionalkey_ref?:string
ConfigWechatConfig.http_config.tls_config.max_version?
optionalmax_version?:number
ConfigWechatConfig.http_config.tls_config.min_version?
optionalmin_version?:number
ConfigWechatConfig.http_config.tls_config.server_name?
optionalserver_name?:string
ConfigWechatConfig.message?
optionalmessage?:string
ConfigWechatConfig.message_type?
optionalmessage_type?:string
ConfigWechatConfig.send_resolved?
optionalsend_resolved?:boolean
ConfigWechatConfig.to_party?
optionalto_party?:string
ConfigWechatConfig.to_tag?
optionalto_tag?:string
ConfigWechatConfig.to_user?
optionalto_user?:string
CoretypesKind
CoretypesKind:
"session"|"rule"|"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"notification-channel"|"route-policy"|"apdex-setting"|"auth-domain"|"cloud-integration"|"cloud-integration-service"|"integration"|"dashboard"|"public-dashboard"|"ingestion-key"|"ingestion-limit"|"pipeline"|"user-preference"|"org-preference"|"quick-filter"|"ttl-setting"|"planned-maintenance"|"saved-view"|"trace-funnel"|"factor-password"|"factor-api-key"|"license"|"subscription"|"deployment-host"|"logs"|"traces"|"metrics"|"audit-logs"|"meter-metrics"|"logs-field"|"traces-field"
CoretypesObject
CoretypesObject:
object
CoretypesObject.resource
resource:
object
CoretypesObject.resource.kind
kind:
"session"|"rule"|"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"notification-channel"|"route-policy"|"apdex-setting"|"auth-domain"|"cloud-integration"|"cloud-integration-service"|"integration"|"dashboard"|"public-dashboard"|"ingestion-key"|"ingestion-limit"|"pipeline"|"user-preference"|"org-preference"|"quick-filter"|"ttl-setting"|"planned-maintenance"|"saved-view"|"trace-funnel"|"factor-password"|"factor-api-key"|"license"|"subscription"|"deployment-host"|"logs"|"traces"|"metrics"|"audit-logs"|"meter-metrics"|"logs-field"|"traces-field"
CoretypesObject.resource.type
type:
"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"metaresource"|"telemetryresource"
CoretypesObject.selector
selector:
string
CoretypesObjectGroup
CoretypesObjectGroup:
object
CoretypesObjectGroup.resource
resource:
object
CoretypesObjectGroup.resource.kind
kind:
"session"|"rule"|"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"notification-channel"|"route-policy"|"apdex-setting"|"auth-domain"|"cloud-integration"|"cloud-integration-service"|"integration"|"dashboard"|"public-dashboard"|"ingestion-key"|"ingestion-limit"|"pipeline"|"user-preference"|"org-preference"|"quick-filter"|"ttl-setting"|"planned-maintenance"|"saved-view"|"trace-funnel"|"factor-password"|"factor-api-key"|"license"|"subscription"|"deployment-host"|"logs"|"traces"|"metrics"|"audit-logs"|"meter-metrics"|"logs-field"|"traces-field"
CoretypesObjectGroup.resource.type
type:
"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"metaresource"|"telemetryresource"
CoretypesObjectGroup.selectors
selectors:
string[]
CoretypesResourceRef
CoretypesResourceRef:
object
CoretypesResourceRef.kind
kind:
"session"|"rule"|"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"notification-channel"|"route-policy"|"apdex-setting"|"auth-domain"|"cloud-integration"|"cloud-integration-service"|"integration"|"dashboard"|"public-dashboard"|"ingestion-key"|"ingestion-limit"|"pipeline"|"user-preference"|"org-preference"|"quick-filter"|"ttl-setting"|"planned-maintenance"|"saved-view"|"trace-funnel"|"factor-password"|"factor-api-key"|"license"|"subscription"|"deployment-host"|"logs"|"traces"|"metrics"|"audit-logs"|"meter-metrics"|"logs-field"|"traces-field"
CoretypesResourceRef.type
type:
"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"metaresource"|"telemetryresource"
CoretypesType
CoretypesType:
"anonymous"|"organization"|"role"|"serviceaccount"|"user"|"metaresource"|"telemetryresource"
DashboardGridItem
DashboardGridItem:
object
DashboardGridItem.content?
optionalcontent?:object
DashboardGridItem.content.$ref?
optional$ref?:string
DashboardGridItem.height?
optionalheight?:number
DashboardGridItem.width?
optionalwidth?:number
DashboardGridItem.x?
optionalx?:number
DashboardGridItem.y?
optionaly?:number
DashboardGridLayoutCollapse
DashboardGridLayoutCollapse:
object
DashboardGridLayoutCollapse.open?
optionalopen?:boolean
DashboardGridLayoutDisplay
DashboardGridLayoutDisplay:
object
DashboardGridLayoutDisplay.collapse?
optionalcollapse?:object
DashboardGridLayoutDisplay.collapse.open?
optionalopen?:boolean
DashboardGridLayoutDisplay.title?
optionaltitle?:string
DashboardGridLayoutSpec
DashboardGridLayoutSpec:
object
DashboardGridLayoutSpec.display?
optionaldisplay?:object
DashboardGridLayoutSpec.display.collapse?
optionalcollapse?:object
DashboardGridLayoutSpec.display.collapse.open?
optionalopen?:boolean
DashboardGridLayoutSpec.display.title?
optionaltitle?:string
DashboardGridLayoutSpec.items?
optionalitems?:object[] |null
DashboardGridLayoutSpec.repeatVariable?
optionalrepeatVariable?:string
DashboardtypesAxes
DashboardtypesAxes:
object
DashboardtypesAxes.isLogScale?
optionalisLogScale?:boolean
DashboardtypesAxes.softMax?
optionalsoftMax?:number|null
DashboardtypesAxes.softMin?
optionalsoftMin?:number|null
DashboardtypesBarChartPanelSpec
DashboardtypesBarChartPanelSpec:
object
DashboardtypesBarChartPanelSpec.axes?
optionalaxes?:object
DashboardtypesBarChartPanelSpec.axes.isLogScale?
optionalisLogScale?:boolean
DashboardtypesBarChartPanelSpec.axes.softMax?
optionalsoftMax?:number|null
DashboardtypesBarChartPanelSpec.axes.softMin?
optionalsoftMin?:number|null
DashboardtypesBarChartPanelSpec.formatting?
optionalformatting?:object
DashboardtypesBarChartPanelSpec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesBarChartPanelSpec.formatting.unit?
optionalunit?:string
DashboardtypesBarChartPanelSpec.legend?
optionallegend?:object
DashboardtypesBarChartPanelSpec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
DashboardtypesBarChartPanelSpec.legend.mode?
optionalmode?:"list"
DashboardtypesBarChartPanelSpec.legend.position?
optionalposition?:"bottom"|"right"
DashboardtypesBarChartPanelSpec.thresholds?
optionalthresholds?:object[] |null
DashboardtypesBarChartPanelSpec.visualization?
optionalvisualization?:object
DashboardtypesBarChartPanelSpec.visualization.fillSpans?
optionalfillSpans?:boolean
DashboardtypesBarChartPanelSpec.visualization.stackedBarChart?
optionalstackedBarChart?:boolean
DashboardtypesBarChartPanelSpec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesBarChartVisualization
DashboardtypesBarChartVisualization:
object
DashboardtypesBarChartVisualization.fillSpans?
optionalfillSpans?:boolean
DashboardtypesBarChartVisualization.stackedBarChart?
optionalstackedBarChart?:boolean
DashboardtypesBarChartVisualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesBasicVisualization
DashboardtypesBasicVisualization:
object
DashboardtypesBasicVisualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesBuilderQuerySpec
DashboardtypesBuilderQuerySpec: {
aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; }
Union Members
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"logs"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"metrics"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"traces"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
DashboardtypesComparisonOperator
DashboardtypesComparisonOperator:
"above"|"below"|"above_or_equal"|"below_or_equal"|"equal"|"not_equal"
DashboardtypesComparisonThreshold
DashboardtypesComparisonThreshold:
object
DashboardtypesComparisonThreshold.color
color:
string
DashboardtypesComparisonThreshold.format?
optionalformat?:"text"|"background"
DashboardtypesComparisonThreshold.operator?
optionaloperator?:"above"|"below"|"above_or_equal"|"below_or_equal"|"equal"|"not_equal"
DashboardtypesComparisonThreshold.unit?
optionalunit?:string
DashboardtypesComparisonThreshold.value
value:
number
Format: double
DashboardtypesCustomVariableSpec
DashboardtypesCustomVariableSpec:
object
DashboardtypesCustomVariableSpec.customValue
customValue:
string
DashboardtypesDashboard
DashboardtypesDashboard:
object
DashboardtypesDashboard.createdAt?
optionalcreatedAt?:string
Format: date-time
DashboardtypesDashboard.createdBy?
optionalcreatedBy?:string
DashboardtypesDashboard.data?
optionaldata?:object
Index Signature
[key: string]: unknown
DashboardtypesDashboard.id?
optionalid?:string
DashboardtypesDashboard.locked?
optionallocked?:boolean
DashboardtypesDashboard.org_id?
optionalorg_id?:string
DashboardtypesDashboard.source?
optionalsource?:"user"|"integration"|"system"
DashboardtypesDashboard.updatedAt?
optionalupdatedAt?:string
Format: date-time
DashboardtypesDashboard.updatedBy?
optionalupdatedBy?:string
DashboardtypesDashboardPanelRef
DashboardtypesDashboardPanelRef:
object
DashboardtypesDashboardPanelRef.dashboardId
dashboardId:
string
DashboardtypesDashboardPanelRef.dashboardName
dashboardName:
string
DashboardtypesDashboardPanelRef.filterBy?
optionalfilterBy?:string[]
DashboardtypesDashboardPanelRef.groupBy?
optionalgroupBy?:string[]
DashboardtypesDashboardPanelRef.panelId
panelId:
string
DashboardtypesDashboardPanelRef.panelName
panelName:
string
DashboardtypesDashboardSpec
DashboardtypesDashboardSpec:
object
DashboardtypesDashboardSpec.display
display:
object
DashboardtypesDashboardSpec.display.description?
optionaldescription?:string
DashboardtypesDashboardSpec.display.name
name:
string
DashboardtypesDashboardSpec.duration?
optionalduration?:string
DashboardtypesDashboardSpec.layouts
layouts:
object[]
DashboardtypesDashboardSpec.links?
optionallinks?:object[] |null
DashboardtypesDashboardSpec.panels
panels:
object
Index Signature
[key: string]: object
DashboardtypesDashboardSpec.refreshInterval?
optionalrefreshInterval?:string
DashboardtypesDashboardSpec.variables
variables: ({
kind:"ListVariable";spec: {allowAllValue?:boolean;allowMultiple?:boolean;capturingRegexp?:string;customAllValue?:string;defaultValue?:string|string[];display: {description?:string;name:string; };name:string;plugin?: {kind:"signoz/DynamicVariable";spec: {name:string;signal:"logs"|"traces"|"metrics"|"all"; }; } | {kind:"signoz/QueryVariable";spec: {queryValue:string; }; } | {kind:"signoz/CustomVariable";spec: {customValue:string; }; };sort?:"none"|"alphabetical-asc"|"alphabetical-desc"|"numerical-asc"|"numerical-desc"|"alphabetical-ci-asc"|"alphabetical-ci-desc"; }; } | {kind:"TextVariable";spec: {constant?:boolean;display: {description?:string;name:string; };name:string;value:string; }; })[]
DashboardtypesDashboardView
DashboardtypesDashboardView:
object
DashboardtypesDashboardView.createdAt?
optionalcreatedAt?:string
Format: date-time
DashboardtypesDashboardView.data
data:
object
DashboardtypesDashboardView.data.order?
optionalorder?:"asc"|"desc"
DashboardtypesDashboardView.data.query?
optionalquery?:string
DashboardtypesDashboardView.data.sort?
optionalsort?:"updated_at"|"created_at"|"name"
DashboardtypesDashboardView.data.version
version:
string
DashboardtypesDashboardView.id
id:
string
DashboardtypesDashboardView.name
name:
string
DashboardtypesDashboardView.orgId
orgId:
string
DashboardtypesDashboardView.updatedAt?
optionalupdatedAt?:string
Format: date-time
DashboardtypesDashboardViewData
DashboardtypesDashboardViewData:
object
DashboardtypesDashboardViewData.order?
optionalorder?:"asc"|"desc"
DashboardtypesDashboardViewData.query?
optionalquery?:string
DashboardtypesDashboardViewData.sort?
optionalsort?:"updated_at"|"created_at"|"name"
DashboardtypesDashboardViewData.version
version:
string
DashboardtypesDisplay
DashboardtypesDisplay:
object
DashboardtypesDisplay.description?
optionaldescription?:string
DashboardtypesDisplay.name
name:
string
DashboardtypesDynamicVariableSignal
DashboardtypesDynamicVariableSignal:
"logs"|"traces"|"metrics"|"all"
DashboardtypesDynamicVariableSpec
DashboardtypesDynamicVariableSpec:
object
DashboardtypesDynamicVariableSpec.name
name:
string
DashboardtypesDynamicVariableSpec.signal
signal:
"logs"|"traces"|"metrics"|"all"
DashboardtypesFillMode
DashboardtypesFillMode:
"solid"|"gradient"|"none"
DashboardtypesGettableDashboardV2
DashboardtypesGettableDashboardV2:
object
DashboardtypesGettableDashboardV2.createdAt?
optionalcreatedAt?:string
Format: date-time
DashboardtypesGettableDashboardV2.createdBy?
optionalcreatedBy?:string
DashboardtypesGettableDashboardV2.id
id:
string
DashboardtypesGettableDashboardV2.image?
optionalimage?:string
DashboardtypesGettableDashboardV2.locked
locked:
boolean
DashboardtypesGettableDashboardV2.name
name:
string
DashboardtypesGettableDashboardV2.orgId
orgId:
string
DashboardtypesGettableDashboardV2.schemaVersion
schemaVersion:
string
DashboardtypesGettableDashboardV2.source
source:
"user"|"integration"|"system"
DashboardtypesGettableDashboardV2.spec
spec:
object
DashboardtypesGettableDashboardV2.spec.display
display:
object
DashboardtypesGettableDashboardV2.spec.display.description?
optionaldescription?:string
DashboardtypesGettableDashboardV2.spec.display.name
name:
string
DashboardtypesGettableDashboardV2.spec.duration?
optionalduration?:string
DashboardtypesGettableDashboardV2.spec.layouts
layouts:
object[]
DashboardtypesGettableDashboardV2.spec.links?
optionallinks?:object[] |null
DashboardtypesGettableDashboardV2.spec.panels
panels:
object
Index Signature
[key: string]: object
DashboardtypesGettableDashboardV2.spec.refreshInterval?
optionalrefreshInterval?:string
DashboardtypesGettableDashboardV2.spec.variables
variables: ({
kind:"ListVariable";spec: {allowAllValue?:boolean;allowMultiple?:boolean;capturingRegexp?:string;customAllValue?:string;defaultValue?:string|string[];display: {description?:string;name:string; };name:string;plugin?: {kind:"signoz/DynamicVariable";spec: {name:string;signal: ... | ... | ... | ...; }; } | {kind:"signoz/QueryVariable";spec: {queryValue:string; }; } | {kind:"signoz/CustomVariable";spec: {customValue:string; }; };sort?:"none"|"alphabetical-asc"|"alphabetical-desc"|"numerical-asc"|"numerical-desc"|"alphabetical-ci-asc"|"alphabetical-ci-desc"; }; } | {kind:"TextVariable";spec: {constant?:boolean;display: {description?:string;name:string; };name:string;value:string; }; })[]
DashboardtypesGettableDashboardV2.tags
tags:
object[] |null
DashboardtypesGettableDashboardV2.updatedAt?
optionalupdatedAt?:string
Format: date-time
DashboardtypesGettableDashboardV2.updatedBy?
optionalupdatedBy?:string
DashboardtypesGettablePublicDasbhboard
DashboardtypesGettablePublicDasbhboard:
object
DashboardtypesGettablePublicDasbhboard.defaultTimeRange?
optionaldefaultTimeRange?:string
DashboardtypesGettablePublicDasbhboard.publicPath?
optionalpublicPath?:string
DashboardtypesGettablePublicDasbhboard.timeRangeEnabled?
optionaltimeRangeEnabled?:boolean
DashboardtypesGettablePublicDashboardData
DashboardtypesGettablePublicDashboardData:
object
DashboardtypesGettablePublicDashboardData.dashboard?
optionaldashboard?:object
DashboardtypesGettablePublicDashboardData.dashboard.createdAt?
optionalcreatedAt?:string
Format: date-time
DashboardtypesGettablePublicDashboardData.dashboard.createdBy?
optionalcreatedBy?:string
DashboardtypesGettablePublicDashboardData.dashboard.data?
optionaldata?:object
Index Signature
[key: string]: unknown
DashboardtypesGettablePublicDashboardData.dashboard.id?
optionalid?:string
DashboardtypesGettablePublicDashboardData.dashboard.locked?
optionallocked?:boolean
DashboardtypesGettablePublicDashboardData.dashboard.org_id?
optionalorg_id?:string
DashboardtypesGettablePublicDashboardData.dashboard.source?
optionalsource?:"user"|"integration"|"system"
DashboardtypesGettablePublicDashboardData.dashboard.updatedAt?
optionalupdatedAt?:string
Format: date-time
DashboardtypesGettablePublicDashboardData.dashboard.updatedBy?
optionalupdatedBy?:string
DashboardtypesGettablePublicDashboardData.publicDashboard?
optionalpublicDashboard?:object
DashboardtypesGettablePublicDashboardData.publicDashboard.defaultTimeRange?
optionaldefaultTimeRange?:string
DashboardtypesGettablePublicDashboardData.publicDashboard.publicPath?
optionalpublicPath?:string
DashboardtypesGettablePublicDashboardData.publicDashboard.timeRangeEnabled?
optionaltimeRangeEnabled?:boolean
DashboardtypesGettablePublicDashboardDataV2
DashboardtypesGettablePublicDashboardDataV2:
object
DashboardtypesGettablePublicDashboardDataV2.dashboard?
optionaldashboard?:object
DashboardtypesGettablePublicDashboardDataV2.dashboard.createdAt?
optionalcreatedAt?:string
Format: date-time
DashboardtypesGettablePublicDashboardDataV2.dashboard.createdBy?
optionalcreatedBy?:string
DashboardtypesGettablePublicDashboardDataV2.dashboard.id
id:
string
DashboardtypesGettablePublicDashboardDataV2.dashboard.image?
optionalimage?:string
DashboardtypesGettablePublicDashboardDataV2.dashboard.locked
locked:
boolean
DashboardtypesGettablePublicDashboardDataV2.dashboard.name
name:
string
DashboardtypesGettablePublicDashboardDataV2.dashboard.orgId
orgId:
string
DashboardtypesGettablePublicDashboardDataV2.dashboard.schemaVersion
schemaVersion:
string
DashboardtypesGettablePublicDashboardDataV2.dashboard.source
source:
"user"|"integration"|"system"
DashboardtypesGettablePublicDashboardDataV2.dashboard.spec
spec:
object
DashboardtypesGettablePublicDashboardDataV2.dashboard.spec.display
display:
object
DashboardtypesGettablePublicDashboardDataV2.dashboard.spec.display.description?
optionaldescription?:string
DashboardtypesGettablePublicDashboardDataV2.dashboard.spec.display.name
name:
string
DashboardtypesGettablePublicDashboardDataV2.dashboard.spec.duration?
optionalduration?:string
DashboardtypesGettablePublicDashboardDataV2.dashboard.spec.layouts
layouts:
object[]
DashboardtypesGettablePublicDashboardDataV2.dashboard.spec.links?
optionallinks?:object[] |null
DashboardtypesGettablePublicDashboardDataV2.dashboard.spec.panels
panels:
object
Index Signature
[key: string]: object
DashboardtypesGettablePublicDashboardDataV2.dashboard.spec.refreshInterval?
optionalrefreshInterval?:string
DashboardtypesGettablePublicDashboardDataV2.dashboard.spec.variables
variables: ({
kind:"ListVariable";spec: {allowAllValue?:boolean;allowMultiple?:boolean;capturingRegexp?:string;customAllValue?:string;defaultValue?:string| ...[];display: {description?: ... | ...;name:string; };name:string;plugin?: {kind: ...;spec: ...; } | {kind: ...;spec: ...; } | {kind: ...;spec: ...; };sort?:"none"|"alphabetical-asc"|"alphabetical-desc"|"numerical-asc"|"numerical-desc"|"alphabetical-ci-asc"|"alphabetical-ci-desc"; }; } | {kind:"TextVariable";spec: {constant?:boolean;display: {description?: ... | ...;name:string; };name:string;value:string; }; })[]
DashboardtypesGettablePublicDashboardDataV2.dashboard.tags
tags:
object[] |null
DashboardtypesGettablePublicDashboardDataV2.dashboard.updatedAt?
optionalupdatedAt?:string
Format: date-time
DashboardtypesGettablePublicDashboardDataV2.dashboard.updatedBy?
optionalupdatedBy?:string
DashboardtypesGettablePublicDashboardDataV2.publicDashboard?
optionalpublicDashboard?:object
DashboardtypesGettablePublicDashboardDataV2.publicDashboard.defaultTimeRange?
optionaldefaultTimeRange?:string
DashboardtypesGettablePublicDashboardDataV2.publicDashboard.publicPath?
optionalpublicPath?:string
DashboardtypesGettablePublicDashboardDataV2.publicDashboard.timeRangeEnabled?
optionaltimeRangeEnabled?:boolean
DashboardtypesGettableSystemDashboard
DashboardtypesGettableSystemDashboard:
object
DashboardtypesGettableSystemDashboard.createdAt?
optionalcreatedAt?:string
Format: date-time
DashboardtypesGettableSystemDashboard.createdBy?
optionalcreatedBy?:string
DashboardtypesGettableSystemDashboard.image?
optionalimage?:string
DashboardtypesGettableSystemDashboard.locked
locked:
boolean
DashboardtypesGettableSystemDashboard.name
name:
string
DashboardtypesGettableSystemDashboard.orgId
orgId:
string
DashboardtypesGettableSystemDashboard.schemaVersion
schemaVersion:
string
DashboardtypesGettableSystemDashboard.source
source:
"user"|"integration"|"system"
DashboardtypesGettableSystemDashboard.spec
spec:
object
DashboardtypesGettableSystemDashboard.spec.display
display:
object
DashboardtypesGettableSystemDashboard.spec.display.description?
optionaldescription?:string
DashboardtypesGettableSystemDashboard.spec.display.name
name:
string
DashboardtypesGettableSystemDashboard.spec.duration?
optionalduration?:string
DashboardtypesGettableSystemDashboard.spec.layouts
layouts:
object[]
DashboardtypesGettableSystemDashboard.spec.links?
optionallinks?:object[] |null
DashboardtypesGettableSystemDashboard.spec.panels
panels:
object
Index Signature
[key: string]: object
DashboardtypesGettableSystemDashboard.spec.refreshInterval?
optionalrefreshInterval?:string
DashboardtypesGettableSystemDashboard.spec.variables
variables: ({
kind:"ListVariable";spec: {allowAllValue?:boolean;allowMultiple?:boolean;capturingRegexp?:string;customAllValue?:string;defaultValue?:string|string[];display: {description?:string;name:string; };name:string;plugin?: {kind:"signoz/DynamicVariable";spec: {name:string;signal: ... | ... | ... | ...; }; } | {kind:"signoz/QueryVariable";spec: {queryValue:string; }; } | {kind:"signoz/CustomVariable";spec: {customValue:string; }; };sort?:"none"|"alphabetical-asc"|"alphabetical-desc"|"numerical-asc"|"numerical-desc"|"alphabetical-ci-asc"|"alphabetical-ci-desc"; }; } | {kind:"TextVariable";spec: {constant?:boolean;display: {description?:string;name:string; };name:string;value:string; }; })[]
DashboardtypesGettableSystemDashboard.tags
tags:
object[] |null
DashboardtypesGettableSystemDashboard.updatedAt?
optionalupdatedAt?:string
Format: date-time
DashboardtypesGettableSystemDashboard.updatedBy?
optionalupdatedBy?:string
DashboardtypesHeaderOptions
DashboardtypesHeaderOptions:
object
DashboardtypesHeaderOptions.hide?
optionalhide?:boolean
DashboardtypesHistogramBuckets
DashboardtypesHistogramBuckets:
object
DashboardtypesHistogramBuckets.bucketCount?
optionalbucketCount?:number|null
DashboardtypesHistogramBuckets.bucketWidth?
optionalbucketWidth?:number|null
DashboardtypesHistogramBuckets.mergeAllActiveQueries?
optionalmergeAllActiveQueries?:boolean
DashboardtypesHistogramPanelSpec
DashboardtypesHistogramPanelSpec:
object
DashboardtypesHistogramPanelSpec.histogramBuckets?
optionalhistogramBuckets?:object
DashboardtypesHistogramPanelSpec.histogramBuckets.bucketCount?
optionalbucketCount?:number|null
DashboardtypesHistogramPanelSpec.histogramBuckets.bucketWidth?
optionalbucketWidth?:number|null
DashboardtypesHistogramPanelSpec.histogramBuckets.mergeAllActiveQueries?
optionalmergeAllActiveQueries?:boolean
DashboardtypesHistogramPanelSpec.legend?
optionallegend?:object
DashboardtypesHistogramPanelSpec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
DashboardtypesHistogramPanelSpec.legend.mode?
optionalmode?:"list"
DashboardtypesHistogramPanelSpec.legend.position?
optionalposition?:"bottom"|"right"
DashboardtypesJSONPatchOperation
DashboardtypesJSONPatchOperation:
object
DashboardtypesJSONPatchOperation.from?
optionalfrom?:string
Description
Source JSON Pointer for move/copy ops; ignored for other ops.
DashboardtypesJSONPatchOperation.op
op:
"add"|"remove"|"replace"|"move"|"copy"|"test"
DashboardtypesJSONPatchOperation.path
path:
string
Description
JSON Pointer (RFC 6901) into the dashboard's postable shape — e.g. /spec/display/name, /spec/panels/
DashboardtypesJSONPatchOperation.value?
optionalvalue?:unknown
Description
Value to add/replace/test against. The expected type depends on the path. Common shapes (see referenced schemas for the exact field set): /spec/panels/
DashboardtypesLayout
DashboardtypesLayout:
object
DashboardtypesLayout.kind
kind:
"Grid"
Description
discriminator enum property added by openapi-typescript
DashboardtypesLayout.spec
spec:
object
DashboardtypesLayout.spec.display?
optionaldisplay?:object
DashboardtypesLayout.spec.display.collapse?
optionalcollapse?:object
DashboardtypesLayout.spec.display.collapse.open?
optionalopen?:boolean
DashboardtypesLayout.spec.display.title?
optionaltitle?:string
DashboardtypesLayout.spec.items?
optionalitems?:object[] |null
DashboardtypesLayout.spec.repeatVariable?
optionalrepeatVariable?:string
DashboardtypesLayoutEnvelopeGithubComPersesSpecGoDashboardGridLayoutSpec
DashboardtypesLayoutEnvelopeGithubComPersesSpecGoDashboardGridLayoutSpec:
object
DashboardtypesLayoutEnvelopeGithubComPersesSpecGoDashboardGridLayoutSpec.kind
kind:
"Grid"
Description
discriminator enum property added by openapi-typescript
DashboardtypesLayoutEnvelopeGithubComPersesSpecGoDashboardGridLayoutSpec.spec
spec:
object
DashboardtypesLayoutEnvelopeGithubComPersesSpecGoDashboardGridLayoutSpec.spec.display?
optionaldisplay?:object
DashboardtypesLayoutEnvelopeGithubComPersesSpecGoDashboardGridLayoutSpec.spec.display.collapse?
optionalcollapse?:object
DashboardtypesLayoutEnvelopeGithubComPersesSpecGoDashboardGridLayoutSpec.spec.display.collapse.open?
optionalopen?:boolean
DashboardtypesLayoutEnvelopeGithubComPersesSpecGoDashboardGridLayoutSpec.spec.display.title?
optionaltitle?:string
DashboardtypesLayoutEnvelopeGithubComPersesSpecGoDashboardGridLayoutSpec.spec.items?
optionalitems?:object[] |null
DashboardtypesLayoutEnvelopeGithubComPersesSpecGoDashboardGridLayoutSpec.spec.repeatVariable?
optionalrepeatVariable?:string
DashboardtypesLegend
DashboardtypesLegend:
object
DashboardtypesLegend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
DashboardtypesLegend.mode?
optionalmode?:"list"
DashboardtypesLegend.position?
optionalposition?:"bottom"|"right"
DashboardtypesLegendMode
DashboardtypesLegendMode:
"list"
DashboardtypesLegendPosition
DashboardtypesLegendPosition:
"bottom"|"right"
DashboardtypesLineInterpolation
DashboardtypesLineInterpolation:
"linear"|"spline"|"step_after"|"step_before"
DashboardtypesLineStyle
DashboardtypesLineStyle:
"solid"|"dashed"
DashboardtypesLink
DashboardtypesLink:
object
DashboardtypesLink.name?
optionalname?:string
DashboardtypesLink.renderVariables?
optionalrenderVariables?:boolean
DashboardtypesLink.targetBlank?
optionaltargetBlank?:boolean
DashboardtypesLink.tooltip?
optionaltooltip?:string
DashboardtypesLink.url?
optionalurl?:string
DashboardtypesListableDashboardForUserV2
DashboardtypesListableDashboardForUserV2:
object
DashboardtypesListableDashboardForUserV2.dashboards
dashboards:
object[]
DashboardtypesListableDashboardForUserV2.reservedKeywords
reservedKeywords:
string[]
DashboardtypesListableDashboardForUserV2.tags
tags:
object[]
DashboardtypesListableDashboardForUserV2.total
total:
number
Format: int64
DashboardtypesListableDashboardV2
DashboardtypesListableDashboardV2:
object
DashboardtypesListableDashboardV2.dashboards
dashboards:
object[]
DashboardtypesListableDashboardV2.reservedKeywords
reservedKeywords:
string[]
DashboardtypesListableDashboardV2.tags
tags:
object[]
DashboardtypesListableDashboardV2.total
total:
number
Format: int64
DashboardtypesListableDashboardView
DashboardtypesListableDashboardView:
object
DashboardtypesListableDashboardView.views
views:
object[]
DashboardtypesListedDashboardForUserV2
DashboardtypesListedDashboardForUserV2:
object
DashboardtypesListedDashboardForUserV2.createdAt?
optionalcreatedAt?:string
Format: date-time
DashboardtypesListedDashboardForUserV2.createdBy?
optionalcreatedBy?:string
DashboardtypesListedDashboardForUserV2.id
id:
string
DashboardtypesListedDashboardForUserV2.image?
optionalimage?:string
DashboardtypesListedDashboardForUserV2.legacy
legacy:
boolean
DashboardtypesListedDashboardForUserV2.locked
locked:
boolean
DashboardtypesListedDashboardForUserV2.name
name:
string
DashboardtypesListedDashboardForUserV2.orgId
orgId:
string
DashboardtypesListedDashboardForUserV2.pinned
pinned:
boolean
DashboardtypesListedDashboardForUserV2.schemaVersion
schemaVersion:
string
DashboardtypesListedDashboardForUserV2.source
source:
"user"|"integration"|"system"
DashboardtypesListedDashboardForUserV2.spec
spec:
object
DashboardtypesListedDashboardForUserV2.spec.display?
optionaldisplay?:object
DashboardtypesListedDashboardForUserV2.spec.display.description?
optionaldescription?:string
DashboardtypesListedDashboardForUserV2.spec.display.name
name:
string
DashboardtypesListedDashboardForUserV2.tags
tags:
object[]
DashboardtypesListedDashboardForUserV2.updatedAt?
optionalupdatedAt?:string
Format: date-time
DashboardtypesListedDashboardForUserV2.updatedBy?
optionalupdatedBy?:string
DashboardtypesListedDashboardV2
DashboardtypesListedDashboardV2:
object
DashboardtypesListedDashboardV2.createdAt?
optionalcreatedAt?:string
Format: date-time
DashboardtypesListedDashboardV2.createdBy?
optionalcreatedBy?:string
DashboardtypesListedDashboardV2.id
id:
string
DashboardtypesListedDashboardV2.image?
optionalimage?:string
DashboardtypesListedDashboardV2.legacy
legacy:
boolean
DashboardtypesListedDashboardV2.locked
locked:
boolean
DashboardtypesListedDashboardV2.name
name:
string
DashboardtypesListedDashboardV2.orgId
orgId:
string
DashboardtypesListedDashboardV2.schemaVersion
schemaVersion:
string
DashboardtypesListedDashboardV2.source
source:
"user"|"integration"|"system"
DashboardtypesListedDashboardV2.spec
spec:
object
DashboardtypesListedDashboardV2.spec.display?
optionaldisplay?:object
DashboardtypesListedDashboardV2.spec.display.description?
optionaldescription?:string
DashboardtypesListedDashboardV2.spec.display.name
name:
string
DashboardtypesListedDashboardV2.tags
tags:
object[]
DashboardtypesListedDashboardV2.updatedAt?
optionalupdatedAt?:string
Format: date-time
DashboardtypesListedDashboardV2.updatedBy?
optionalupdatedBy?:string
DashboardtypesListedDashboardV2Spec
DashboardtypesListedDashboardV2Spec:
object
DashboardtypesListedDashboardV2Spec.display?
optionaldisplay?:object
DashboardtypesListedDashboardV2Spec.display.description?
optionaldescription?:string
DashboardtypesListedDashboardV2Spec.display.name
name:
string
DashboardtypesListOrder
DashboardtypesListOrder:
"asc"|"desc"
DashboardtypesListPanelSpec
DashboardtypesListPanelSpec:
object
DashboardtypesListPanelSpec.selectFields?
optionalselectFields?:object[] |null
DashboardtypesListSort
DashboardtypesListSort:
"updated_at"|"created_at"|"name"
DashboardtypesListVariableSpec
DashboardtypesListVariableSpec:
object
DashboardtypesListVariableSpec.allowAllValue?
optionalallowAllValue?:boolean
DashboardtypesListVariableSpec.allowMultiple?
optionalallowMultiple?:boolean
DashboardtypesListVariableSpec.capturingRegexp?
optionalcapturingRegexp?:string
DashboardtypesListVariableSpec.customAllValue?
optionalcustomAllValue?:string
DashboardtypesListVariableSpec.defaultValue?
optionaldefaultValue?:string|string[]
DashboardtypesListVariableSpec.display
display:
object
DashboardtypesListVariableSpec.display.description?
optionaldescription?:string
DashboardtypesListVariableSpec.display.name
name:
string
DashboardtypesListVariableSpec.name
name:
string
DashboardtypesListVariableSpec.plugin?
optionalplugin?: {kind:"signoz/DynamicVariable";spec: {name:string;signal:"logs"|"traces"|"metrics"|"all"; }; } | {kind:"signoz/QueryVariable";spec: {queryValue:string; }; } | {kind:"signoz/CustomVariable";spec: {customValue:string; }; }
Union Members
Type Literal
{ kind: "signoz/DynamicVariable"; spec: { name: string; signal: "logs" | "traces" | "metrics" | "all"; }; }
kind
kind:
"signoz/DynamicVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.name
name:
string
spec.signal
signal:
"logs"|"traces"|"metrics"|"all"
Type Literal
{ kind: "signoz/QueryVariable"; spec: { queryValue: string; }; }
kind
kind:
"signoz/QueryVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.queryValue
queryValue:
string
Type Literal
{ kind: "signoz/CustomVariable"; spec: { customValue: string; }; }
kind
kind:
"signoz/CustomVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.customValue
customValue:
string
DashboardtypesListVariableSpec.sort?
optionalsort?:"none"|"alphabetical-asc"|"alphabetical-desc"|"numerical-asc"|"numerical-desc"|"alphabetical-ci-asc"|"alphabetical-ci-desc"
DashboardtypesListVariableSpecSort
DashboardtypesListVariableSpecSort:
"none"|"alphabetical-asc"|"alphabetical-desc"|"numerical-asc"|"numerical-desc"|"alphabetical-ci-asc"|"alphabetical-ci-desc"
DashboardtypesNumberPanelSpec
DashboardtypesNumberPanelSpec:
object
DashboardtypesNumberPanelSpec.formatting?
optionalformatting?:object
DashboardtypesNumberPanelSpec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesNumberPanelSpec.formatting.unit?
optionalunit?:string
DashboardtypesNumberPanelSpec.thresholds?
optionalthresholds?:object[] |null
DashboardtypesNumberPanelSpec.visualization?
optionalvisualization?:object
DashboardtypesNumberPanelSpec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesPanel
DashboardtypesPanel:
object
DashboardtypesPanel.kind
kind:
"Panel"
DashboardtypesPanel.spec
spec:
object
DashboardtypesPanel.spec.display
display:
object
DashboardtypesPanel.spec.display.description?
optionaldescription?:string
DashboardtypesPanel.spec.display.name
name:
string
DashboardtypesPanel.spec.links?
optionallinks?:object[] |null
DashboardtypesPanel.spec.plugin
plugin: {
kind:"signoz/TimeSeriesPanel";spec: {axes?: {isLogScale?:boolean;softMax?:number|null;softMin?:number|null; };chartAppearance?: {fillMode?:"solid"|"gradient"|"none";lineInterpolation?:"linear"|"spline"|"step_after"|"step_before";lineStyle?:"solid"|"dashed";showPoints?:boolean;spanGaps?: {fillLessThan?: ... | ...;fillOnlyBelow?: ... | ... | ...; }; };formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; };thresholds?:object[] |null;visualization?: {fillSpans?:boolean;timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/BarChartPanel";spec: {axes?: {isLogScale?:boolean;softMax?:number|null;softMin?:number|null; };formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; };thresholds?:object[] |null;visualization?: {fillSpans?:boolean;stackedBarChart?:boolean;timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/NumberPanel";spec: {formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };thresholds?:object[] |null;visualization?: {timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/PieChartPanel";spec: {formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; };visualization?: {timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/TablePanel";spec: {formatting?: {columnUnits?: {[key:string]:string; } |null;decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"; };thresholds?:object[] |null;visualization?: {timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/HistogramPanel";spec: {histogramBuckets?: {bucketCount?:number|null;bucketWidth?:number|null;mergeAllActiveQueries?:boolean; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; }; }; } | {kind:"signoz/ListPanel";spec: {selectFields?:object[] |null; }; } | {kind:"signoz/TextPanel";spec: {headerOptions?: {hide?:boolean; };mode?:"markdown";presentation?: {background?:string|null;textAlign?:"right"|"left"|"center";verticalAlign?:"bottom"|"center"|"top"; };text?:string; }; }
Union Members
Type Literal
{ kind: "signoz/TimeSeriesPanel"; spec: { axes?: { isLogScale?: boolean; softMax?: number | null; softMin?: number | null; }; chartAppearance?: { fillMode?: "solid" | "gradient" | "none"; lineInterpolation?: "linear" | "spline" | "step_after" | "step_before"; lineStyle?: "solid" | "dashed"; showPoints?: boolean; spanGaps?: { fillLessThan?: ... | ...; fillOnlyBelow?: ... | ... | ...; }; }; formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; thresholds?: object[] | null; visualization?: { fillSpans?: boolean; timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/TimeSeriesPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.axes?
optionalaxes?:object
spec.axes.isLogScale?
optionalisLogScale?:boolean
spec.axes.softMax?
optionalsoftMax?:number|null
spec.axes.softMin?
optionalsoftMin?:number|null
spec.chartAppearance?
optionalchartAppearance?:object
spec.chartAppearance.fillMode?
optionalfillMode?:"solid"|"gradient"|"none"
spec.chartAppearance.lineInterpolation?
optionallineInterpolation?:"linear"|"spline"|"step_after"|"step_before"
spec.chartAppearance.lineStyle?
optionallineStyle?:"solid"|"dashed"
spec.chartAppearance.showPoints?
optionalshowPoints?:boolean
spec.chartAppearance.spanGaps?
optionalspanGaps?:object
spec.chartAppearance.spanGaps.fillLessThan?
optionalfillLessThan?: ... | ...
Description
The maximum gap size to connect when fillOnlyBelow is true. Gaps larger than this duration are left disconnected.
spec.chartAppearance.spanGaps.fillOnlyBelow?
optionalfillOnlyBelow?: ... | ... | ...
Description
Controls whether lines connect across null values. When false (default), all gaps are connected. When true, only gaps smaller than fillLessThan are connected.
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.fillSpans?
optionalfillSpans?:boolean
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/BarChartPanel"; spec: { axes?: { isLogScale?: boolean; softMax?: number | null; softMin?: number | null; }; formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; thresholds?: object[] | null; visualization?: { fillSpans?: boolean; stackedBarChart?: boolean; timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/BarChartPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.axes?
optionalaxes?:object
spec.axes.isLogScale?
optionalisLogScale?:boolean
spec.axes.softMax?
optionalsoftMax?:number|null
spec.axes.softMin?
optionalsoftMin?:number|null
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.fillSpans?
optionalfillSpans?:boolean
spec.visualization.stackedBarChart?
optionalstackedBarChart?:boolean
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/NumberPanel"; spec: { formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; thresholds?: object[] | null; visualization?: { timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/NumberPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/PieChartPanel"; spec: { formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; visualization?: { timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/PieChartPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
spec.visualization?
optionalvisualization?:object
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/TablePanel"; spec: { formatting?: { columnUnits?: {[key: string]: string; } | null; decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; }; thresholds?: object[] | null; visualization?: { timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/TablePanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.formatting?
optionalformatting?:object
spec.formatting.columnUnits?
optionalcolumnUnits?: {[key:string]:string; } |null
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/HistogramPanel"; spec: { histogramBuckets?: { bucketCount?: number | null; bucketWidth?: number | null; mergeAllActiveQueries?: boolean; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; }; }
kind
kind:
"signoz/HistogramPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.histogramBuckets?
optionalhistogramBuckets?:object
spec.histogramBuckets.bucketCount?
optionalbucketCount?:number|null
spec.histogramBuckets.bucketWidth?
optionalbucketWidth?:number|null
spec.histogramBuckets.mergeAllActiveQueries?
optionalmergeAllActiveQueries?:boolean
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
Type Literal
{ kind: "signoz/ListPanel"; spec: { selectFields?: object[] | null; }; }
kind
kind:
"signoz/ListPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.selectFields?
optionalselectFields?:object[] |null
Type Literal
{ kind: "signoz/TextPanel"; spec: { headerOptions?: { hide?: boolean; }; mode?: "markdown"; presentation?: { background?: string | null; textAlign?: "right" | "left" | "center"; verticalAlign?: "bottom" | "center" | "top"; }; text?: string; }; }
kind
kind:
"signoz/TextPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.headerOptions?
optionalheaderOptions?:object
spec.headerOptions.hide?
optionalhide?:boolean
spec.mode?
optionalmode?:"markdown"
spec.presentation?
optionalpresentation?:object
spec.presentation.background?
optionalbackground?:string|null
spec.presentation.textAlign?
optionaltextAlign?:"right"|"left"|"center"
spec.presentation.verticalAlign?
optionalverticalAlign?:"bottom"|"center"|"top"
spec.text?
optionaltext?:string
DashboardtypesPanel.spec.queries
queries:
object[]
DashboardtypesPanelFormatting
DashboardtypesPanelFormatting:
object
DashboardtypesPanelFormatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesPanelFormatting.unit?
optionalunit?:string
DashboardtypesPanelKind
DashboardtypesPanelKind:
"Panel"
DashboardtypesPanelPlugin
DashboardtypesPanelPlugin: {
kind:"signoz/TimeSeriesPanel";spec: {axes?: {isLogScale?:boolean;softMax?:number|null;softMin?:number|null; };chartAppearance?: {fillMode?:"solid"|"gradient"|"none";lineInterpolation?:"linear"|"spline"|"step_after"|"step_before";lineStyle?:"solid"|"dashed";showPoints?:boolean;spanGaps?: {fillLessThan?:string;fillOnlyBelow?:boolean; }; };formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; };thresholds?:object[] |null;visualization?: {fillSpans?:boolean;timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/BarChartPanel";spec: {axes?: {isLogScale?:boolean;softMax?:number|null;softMin?:number|null; };formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; };thresholds?:object[] |null;visualization?: {fillSpans?:boolean;stackedBarChart?:boolean;timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/NumberPanel";spec: {formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };thresholds?:object[] |null;visualization?: {timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/PieChartPanel";spec: {formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; };visualization?: {timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/TablePanel";spec: {formatting?: {columnUnits?: {[key:string]:string; } |null;decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"; };thresholds?:object[] |null;visualization?: {timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/HistogramPanel";spec: {histogramBuckets?: {bucketCount?:number|null;bucketWidth?:number|null;mergeAllActiveQueries?:boolean; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; }; }; } | {kind:"signoz/ListPanel";spec: {selectFields?:object[] |null; }; } | {kind:"signoz/TextPanel";spec: {headerOptions?: {hide?:boolean; };mode?:"markdown";presentation?: {background?:string|null;textAlign?:"right"|"left"|"center";verticalAlign?:"bottom"|"center"|"top"; };text?:string; }; }
Union Members
Type Literal
{ kind: "signoz/TimeSeriesPanel"; spec: { axes?: { isLogScale?: boolean; softMax?: number | null; softMin?: number | null; }; chartAppearance?: { fillMode?: "solid" | "gradient" | "none"; lineInterpolation?: "linear" | "spline" | "step_after" | "step_before"; lineStyle?: "solid" | "dashed"; showPoints?: boolean; spanGaps?: { fillLessThan?: string; fillOnlyBelow?: boolean; }; }; formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; thresholds?: object[] | null; visualization?: { fillSpans?: boolean; timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/TimeSeriesPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.axes?
optionalaxes?:object
spec.axes.isLogScale?
optionalisLogScale?:boolean
spec.axes.softMax?
optionalsoftMax?:number|null
spec.axes.softMin?
optionalsoftMin?:number|null
spec.chartAppearance?
optionalchartAppearance?:object
spec.chartAppearance.fillMode?
optionalfillMode?:"solid"|"gradient"|"none"
spec.chartAppearance.lineInterpolation?
optionallineInterpolation?:"linear"|"spline"|"step_after"|"step_before"
spec.chartAppearance.lineStyle?
optionallineStyle?:"solid"|"dashed"
spec.chartAppearance.showPoints?
optionalshowPoints?:boolean
spec.chartAppearance.spanGaps?
optionalspanGaps?:object
spec.chartAppearance.spanGaps.fillLessThan?
optionalfillLessThan?:string
Description
The maximum gap size to connect when fillOnlyBelow is true. Gaps larger than this duration are left disconnected.
spec.chartAppearance.spanGaps.fillOnlyBelow?
optionalfillOnlyBelow?:boolean
Description
Controls whether lines connect across null values. When false (default), all gaps are connected. When true, only gaps smaller than fillLessThan are connected.
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.fillSpans?
optionalfillSpans?:boolean
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/BarChartPanel"; spec: { axes?: { isLogScale?: boolean; softMax?: number | null; softMin?: number | null; }; formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; thresholds?: object[] | null; visualization?: { fillSpans?: boolean; stackedBarChart?: boolean; timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/BarChartPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.axes?
optionalaxes?:object
spec.axes.isLogScale?
optionalisLogScale?:boolean
spec.axes.softMax?
optionalsoftMax?:number|null
spec.axes.softMin?
optionalsoftMin?:number|null
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.fillSpans?
optionalfillSpans?:boolean
spec.visualization.stackedBarChart?
optionalstackedBarChart?:boolean
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/NumberPanel"; spec: { formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; thresholds?: object[] | null; visualization?: { timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/NumberPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/PieChartPanel"; spec: { formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; visualization?: { timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/PieChartPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
spec.visualization?
optionalvisualization?:object
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/TablePanel"; spec: { formatting?: { columnUnits?: {[key: string]: string; } | null; decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; }; thresholds?: object[] | null; visualization?: { timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/TablePanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.formatting?
optionalformatting?:object
spec.formatting.columnUnits?
optionalcolumnUnits?: {[key:string]:string; } |null
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/HistogramPanel"; spec: { histogramBuckets?: { bucketCount?: number | null; bucketWidth?: number | null; mergeAllActiveQueries?: boolean; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; }; }
kind
kind:
"signoz/HistogramPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.histogramBuckets?
optionalhistogramBuckets?:object
spec.histogramBuckets.bucketCount?
optionalbucketCount?:number|null
spec.histogramBuckets.bucketWidth?
optionalbucketWidth?:number|null
spec.histogramBuckets.mergeAllActiveQueries?
optionalmergeAllActiveQueries?:boolean
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
Type Literal
{ kind: "signoz/ListPanel"; spec: { selectFields?: object[] | null; }; }
kind
kind:
"signoz/ListPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.selectFields?
optionalselectFields?:object[] |null
Type Literal
{ kind: "signoz/TextPanel"; spec: { headerOptions?: { hide?: boolean; }; mode?: "markdown"; presentation?: { background?: string | null; textAlign?: "right" | "left" | "center"; verticalAlign?: "bottom" | "center" | "top"; }; text?: string; }; }
kind
kind:
"signoz/TextPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.headerOptions?
optionalheaderOptions?:object
spec.headerOptions.hide?
optionalhide?:boolean
spec.mode?
optionalmode?:"markdown"
spec.presentation?
optionalpresentation?:object
spec.presentation.background?
optionalbackground?:string|null
spec.presentation.textAlign?
optionaltextAlign?:"right"|"left"|"center"
spec.presentation.verticalAlign?
optionalverticalAlign?:"bottom"|"center"|"top"
spec.text?
optionaltext?:string
DashboardtypesPanelPluginKind
DashboardtypesPanelPluginKind:
"signoz/TimeSeriesPanel"|"signoz/BarChartPanel"|"signoz/NumberPanel"|"signoz/PieChartPanel"|"signoz/TablePanel"|"signoz/HistogramPanel"|"signoz/ListPanel"|"signoz/TextPanel"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.kind
kind:
"signoz/BarChartPanel"
Description
discriminator enum property added by openapi-typescript
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec
spec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.axes?
optionalaxes?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.axes.isLogScale?
optionalisLogScale?:boolean
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.axes.softMax?
optionalsoftMax?:number|null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.axes.softMin?
optionalsoftMin?:number|null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.formatting?
optionalformatting?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.formatting.unit?
optionalunit?:string
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.legend?
optionallegend?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.legend.mode?
optionalmode?:"list"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.legend.position?
optionalposition?:"bottom"|"right"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.thresholds?
optionalthresholds?:object[] |null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.visualization?
optionalvisualization?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.visualization.fillSpans?
optionalfillSpans?:boolean
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.visualization.stackedBarChart?
optionalstackedBarChart?:boolean
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBarChartPanelSpec.spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec.kind
kind:
"signoz/HistogramPanel"
Description
discriminator enum property added by openapi-typescript
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec.spec
spec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec.spec.histogramBuckets?
optionalhistogramBuckets?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec.spec.histogramBuckets.bucketCount?
optionalbucketCount?:number|null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec.spec.histogramBuckets.bucketWidth?
optionalbucketWidth?:number|null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec.spec.histogramBuckets.mergeAllActiveQueries?
optionalmergeAllActiveQueries?:boolean
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec.spec.legend?
optionallegend?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec.spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec.spec.legend.mode?
optionalmode?:"list"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesHistogramPanelSpec.spec.legend.position?
optionalposition?:"bottom"|"right"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesListPanelSpec
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesListPanelSpec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesListPanelSpec.kind
kind:
"signoz/ListPanel"
Description
discriminator enum property added by openapi-typescript
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesListPanelSpec.spec
spec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesListPanelSpec.spec.selectFields?
optionalselectFields?:object[] |null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesNumberPanelSpec
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesNumberPanelSpec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesNumberPanelSpec.kind
kind:
"signoz/NumberPanel"
Description
discriminator enum property added by openapi-typescript
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesNumberPanelSpec.spec
spec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesNumberPanelSpec.spec.formatting?
optionalformatting?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesNumberPanelSpec.spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesNumberPanelSpec.spec.formatting.unit?
optionalunit?:string
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesNumberPanelSpec.spec.thresholds?
optionalthresholds?:object[] |null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesNumberPanelSpec.spec.visualization?
optionalvisualization?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesNumberPanelSpec.spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec.kind
kind:
"signoz/PieChartPanel"
Description
discriminator enum property added by openapi-typescript
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec.spec
spec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec.spec.formatting?
optionalformatting?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec.spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec.spec.formatting.unit?
optionalunit?:string
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec.spec.legend?
optionallegend?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec.spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec.spec.legend.mode?
optionalmode?:"list"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec.spec.legend.position?
optionalposition?:"bottom"|"right"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec.spec.visualization?
optionalvisualization?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesPieChartPanelSpec.spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTablePanelSpec
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTablePanelSpec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTablePanelSpec.kind
kind:
"signoz/TablePanel"
Description
discriminator enum property added by openapi-typescript
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTablePanelSpec.spec
spec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTablePanelSpec.spec.formatting?
optionalformatting?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTablePanelSpec.spec.formatting.columnUnits?
optionalcolumnUnits?: {[key:string]:string; } |null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTablePanelSpec.spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTablePanelSpec.spec.thresholds?
optionalthresholds?:object[] |null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTablePanelSpec.spec.visualization?
optionalvisualization?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTablePanelSpec.spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec.kind
kind:
"signoz/TextPanel"
Description
discriminator enum property added by openapi-typescript
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec.spec
spec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec.spec.headerOptions?
optionalheaderOptions?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec.spec.headerOptions.hide?
optionalhide?:boolean
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec.spec.mode?
optionalmode?:"markdown"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec.spec.presentation?
optionalpresentation?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec.spec.presentation.background?
optionalbackground?:string|null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec.spec.presentation.textAlign?
optionaltextAlign?:"right"|"left"|"center"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec.spec.presentation.verticalAlign?
optionalverticalAlign?:"bottom"|"center"|"top"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTextPanelSpec.spec.text?
optionaltext?:string
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.kind
kind:
"signoz/TimeSeriesPanel"
Description
discriminator enum property added by openapi-typescript
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec
spec:
object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.axes?
optionalaxes?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.axes.isLogScale?
optionalisLogScale?:boolean
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.axes.softMax?
optionalsoftMax?:number|null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.axes.softMin?
optionalsoftMin?:number|null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.chartAppearance?
optionalchartAppearance?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.chartAppearance.fillMode?
optionalfillMode?:"solid"|"gradient"|"none"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.chartAppearance.lineInterpolation?
optionallineInterpolation?:"linear"|"spline"|"step_after"|"step_before"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.chartAppearance.lineStyle?
optionallineStyle?:"solid"|"dashed"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.chartAppearance.showPoints?
optionalshowPoints?:boolean
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.chartAppearance.spanGaps?
optionalspanGaps?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.chartAppearance.spanGaps.fillLessThan?
optionalfillLessThan?:string
Description
The maximum gap size to connect when fillOnlyBelow is true. Gaps larger than this duration are left disconnected.
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.chartAppearance.spanGaps.fillOnlyBelow?
optionalfillOnlyBelow?:boolean
Description
Controls whether lines connect across null values. When false (default), all gaps are connected. When true, only gaps smaller than fillLessThan are connected.
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.formatting?
optionalformatting?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.formatting.unit?
optionalunit?:string
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.legend?
optionallegend?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.legend.mode?
optionalmode?:"list"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.legend.position?
optionalposition?:"bottom"|"right"
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.thresholds?
optionalthresholds?:object[] |null
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.visualization?
optionalvisualization?:object
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.visualization.fillSpans?
optionalfillSpans?:boolean
DashboardtypesPanelPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesTimeSeriesPanelSpec.spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesPanelSpec
DashboardtypesPanelSpec:
object
DashboardtypesPanelSpec.display
display:
object
DashboardtypesPanelSpec.display.description?
optionaldescription?:string
DashboardtypesPanelSpec.display.name
name:
string
DashboardtypesPanelSpec.links?
optionallinks?:object[] |null
DashboardtypesPanelSpec.plugin
plugin: {
kind:"signoz/TimeSeriesPanel";spec: {axes?: {isLogScale?:boolean;softMax?:number|null;softMin?:number|null; };chartAppearance?: {fillMode?:"solid"|"gradient"|"none";lineInterpolation?:"linear"|"spline"|"step_after"|"step_before";lineStyle?:"solid"|"dashed";showPoints?:boolean;spanGaps?: {fillLessThan?:string;fillOnlyBelow?:boolean; }; };formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; };thresholds?:object[] |null;visualization?: {fillSpans?:boolean;timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/BarChartPanel";spec: {axes?: {isLogScale?:boolean;softMax?:number|null;softMin?:number|null; };formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; };thresholds?:object[] |null;visualization?: {fillSpans?:boolean;stackedBarChart?:boolean;timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/NumberPanel";spec: {formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };thresholds?:object[] |null;visualization?: {timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/PieChartPanel";spec: {formatting?: {decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full";unit?:string; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; };visualization?: {timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/TablePanel";spec: {formatting?: {columnUnits?: {[key:string]:string; } |null;decimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"; };thresholds?:object[] |null;visualization?: {timePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"; }; }; } | {kind:"signoz/HistogramPanel";spec: {histogramBuckets?: {bucketCount?:number|null;bucketWidth?:number|null;mergeAllActiveQueries?:boolean; };legend?: {customColors?: {[key:string]:string; } |null;mode?:"list";position?:"bottom"|"right"; }; }; } | {kind:"signoz/ListPanel";spec: {selectFields?:object[] |null; }; } | {kind:"signoz/TextPanel";spec: {headerOptions?: {hide?:boolean; };mode?:"markdown";presentation?: {background?:string|null;textAlign?:"right"|"left"|"center";verticalAlign?:"bottom"|"center"|"top"; };text?:string; }; }
Union Members
Type Literal
{ kind: "signoz/TimeSeriesPanel"; spec: { axes?: { isLogScale?: boolean; softMax?: number | null; softMin?: number | null; }; chartAppearance?: { fillMode?: "solid" | "gradient" | "none"; lineInterpolation?: "linear" | "spline" | "step_after" | "step_before"; lineStyle?: "solid" | "dashed"; showPoints?: boolean; spanGaps?: { fillLessThan?: string; fillOnlyBelow?: boolean; }; }; formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; thresholds?: object[] | null; visualization?: { fillSpans?: boolean; timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/TimeSeriesPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.axes?
optionalaxes?:object
spec.axes.isLogScale?
optionalisLogScale?:boolean
spec.axes.softMax?
optionalsoftMax?:number|null
spec.axes.softMin?
optionalsoftMin?:number|null
spec.chartAppearance?
optionalchartAppearance?:object
spec.chartAppearance.fillMode?
optionalfillMode?:"solid"|"gradient"|"none"
spec.chartAppearance.lineInterpolation?
optionallineInterpolation?:"linear"|"spline"|"step_after"|"step_before"
spec.chartAppearance.lineStyle?
optionallineStyle?:"solid"|"dashed"
spec.chartAppearance.showPoints?
optionalshowPoints?:boolean
spec.chartAppearance.spanGaps?
optionalspanGaps?:object
spec.chartAppearance.spanGaps.fillLessThan?
optionalfillLessThan?:string
Description
The maximum gap size to connect when fillOnlyBelow is true. Gaps larger than this duration are left disconnected.
spec.chartAppearance.spanGaps.fillOnlyBelow?
optionalfillOnlyBelow?:boolean
Description
Controls whether lines connect across null values. When false (default), all gaps are connected. When true, only gaps smaller than fillLessThan are connected.
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.fillSpans?
optionalfillSpans?:boolean
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/BarChartPanel"; spec: { axes?: { isLogScale?: boolean; softMax?: number | null; softMin?: number | null; }; formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; thresholds?: object[] | null; visualization?: { fillSpans?: boolean; stackedBarChart?: boolean; timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/BarChartPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.axes?
optionalaxes?:object
spec.axes.isLogScale?
optionalisLogScale?:boolean
spec.axes.softMax?
optionalsoftMax?:number|null
spec.axes.softMin?
optionalsoftMin?:number|null
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.fillSpans?
optionalfillSpans?:boolean
spec.visualization.stackedBarChart?
optionalstackedBarChart?:boolean
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/NumberPanel"; spec: { formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; thresholds?: object[] | null; visualization?: { timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/NumberPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/PieChartPanel"; spec: { formatting?: { decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; unit?: string; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; visualization?: { timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/PieChartPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.formatting?
optionalformatting?:object
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.formatting.unit?
optionalunit?:string
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
spec.visualization?
optionalvisualization?:object
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/TablePanel"; spec: { formatting?: { columnUnits?: {[key: string]: string; } | null; decimalPrecision?: "0" | "1" | "2" | "3" | "4" | "full"; }; thresholds?: object[] | null; visualization?: { timePreference?: "global_time" | "last_5_min" | "last_15_min" | "last_30_min" | "last_1_hr" | "last_6_hr" | "last_1_day" | "last_3_days" | "last_1_week" | "last_1_month"; }; }; }
kind
kind:
"signoz/TablePanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.formatting?
optionalformatting?:object
spec.formatting.columnUnits?
optionalcolumnUnits?: {[key:string]:string; } |null
spec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
spec.thresholds?
optionalthresholds?:object[] |null
spec.visualization?
optionalvisualization?:object
spec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
Type Literal
{ kind: "signoz/HistogramPanel"; spec: { histogramBuckets?: { bucketCount?: number | null; bucketWidth?: number | null; mergeAllActiveQueries?: boolean; }; legend?: { customColors?: {[key: string]: string; } | null; mode?: "list"; position?: "bottom" | "right"; }; }; }
kind
kind:
"signoz/HistogramPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.histogramBuckets?
optionalhistogramBuckets?:object
spec.histogramBuckets.bucketCount?
optionalbucketCount?:number|null
spec.histogramBuckets.bucketWidth?
optionalbucketWidth?:number|null
spec.histogramBuckets.mergeAllActiveQueries?
optionalmergeAllActiveQueries?:boolean
spec.legend?
optionallegend?:object
spec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
spec.legend.mode?
optionalmode?:"list"
spec.legend.position?
optionalposition?:"bottom"|"right"
Type Literal
{ kind: "signoz/ListPanel"; spec: { selectFields?: object[] | null; }; }
kind
kind:
"signoz/ListPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.selectFields?
optionalselectFields?:object[] |null
Type Literal
{ kind: "signoz/TextPanel"; spec: { headerOptions?: { hide?: boolean; }; mode?: "markdown"; presentation?: { background?: string | null; textAlign?: "right" | "left" | "center"; verticalAlign?: "bottom" | "center" | "top"; }; text?: string; }; }
kind
kind:
"signoz/TextPanel"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.headerOptions?
optionalheaderOptions?:object
spec.headerOptions.hide?
optionalhide?:boolean
spec.mode?
optionalmode?:"markdown"
spec.presentation?
optionalpresentation?:object
spec.presentation.background?
optionalbackground?:string|null
spec.presentation.textAlign?
optionaltextAlign?:"right"|"left"|"center"
spec.presentation.verticalAlign?
optionalverticalAlign?:"bottom"|"center"|"top"
spec.text?
optionaltext?:string
DashboardtypesPanelSpec.queries
queries:
object[]
DashboardtypesPatchableDashboardV2
DashboardtypesPatchableDashboardV2:
object[] |null
DashboardtypesPatchOp
DashboardtypesPatchOp:
"add"|"remove"|"replace"|"move"|"copy"|"test"
DashboardtypesPieChartPanelSpec
DashboardtypesPieChartPanelSpec:
object
DashboardtypesPieChartPanelSpec.formatting?
optionalformatting?:object
DashboardtypesPieChartPanelSpec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesPieChartPanelSpec.formatting.unit?
optionalunit?:string
DashboardtypesPieChartPanelSpec.legend?
optionallegend?:object
DashboardtypesPieChartPanelSpec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
DashboardtypesPieChartPanelSpec.legend.mode?
optionalmode?:"list"
DashboardtypesPieChartPanelSpec.legend.position?
optionalposition?:"bottom"|"right"
DashboardtypesPieChartPanelSpec.visualization?
optionalvisualization?:object
DashboardtypesPieChartPanelSpec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesPostableDashboardV2
DashboardtypesPostableDashboardV2:
object
DashboardtypesPostableDashboardV2.generateName?
optionalgenerateName?:boolean
DashboardtypesPostableDashboardV2.image?
optionalimage?:string
DashboardtypesPostableDashboardV2.name?
optionalname?:string
DashboardtypesPostableDashboardV2.schemaVersion
schemaVersion:
string
DashboardtypesPostableDashboardV2.spec
spec:
object
DashboardtypesPostableDashboardV2.spec.display
display:
object
DashboardtypesPostableDashboardV2.spec.display.description?
optionaldescription?:string
DashboardtypesPostableDashboardV2.spec.display.name
name:
string
DashboardtypesPostableDashboardV2.spec.duration?
optionalduration?:string
DashboardtypesPostableDashboardV2.spec.layouts
layouts:
object[]
DashboardtypesPostableDashboardV2.spec.links?
optionallinks?:object[] |null
DashboardtypesPostableDashboardV2.spec.panels
panels:
object
Index Signature
[key: string]: object
DashboardtypesPostableDashboardV2.spec.refreshInterval?
optionalrefreshInterval?:string
DashboardtypesPostableDashboardV2.spec.variables
variables: ({
kind:"ListVariable";spec: {allowAllValue?:boolean;allowMultiple?:boolean;capturingRegexp?:string;customAllValue?:string;defaultValue?:string|string[];display: {description?:string;name:string; };name:string;plugin?: {kind:"signoz/DynamicVariable";spec: {name:string;signal: ... | ... | ... | ...; }; } | {kind:"signoz/QueryVariable";spec: {queryValue:string; }; } | {kind:"signoz/CustomVariable";spec: {customValue:string; }; };sort?:"none"|"alphabetical-asc"|"alphabetical-desc"|"numerical-asc"|"numerical-desc"|"alphabetical-ci-asc"|"alphabetical-ci-desc"; }; } | {kind:"TextVariable";spec: {constant?:boolean;display: {description?:string;name:string; };name:string;value:string; }; })[]
DashboardtypesPostableDashboardV2.tags
tags:
object[] |null
DashboardtypesPostableDashboardView
DashboardtypesPostableDashboardView:
object
DashboardtypesPostableDashboardView.data
data:
object
DashboardtypesPostableDashboardView.data.order?
optionalorder?:"asc"|"desc"
DashboardtypesPostableDashboardView.data.query?
optionalquery?:string
DashboardtypesPostableDashboardView.data.sort?
optionalsort?:"updated_at"|"created_at"|"name"
DashboardtypesPostableDashboardView.data.version
version:
string
DashboardtypesPostableDashboardView.name
name:
string
DashboardtypesPostablePublicDashboard
DashboardtypesPostablePublicDashboard:
object
DashboardtypesPostablePublicDashboard.defaultTimeRange?
optionaldefaultTimeRange?:string
DashboardtypesPostablePublicDashboard.timeRangeEnabled?
optionaltimeRangeEnabled?:boolean
DashboardtypesPrecisionOption
DashboardtypesPrecisionOption:
"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesQuery
DashboardtypesQuery:
object
DashboardtypesQuery.kind
kind:
"trace"|"raw"|"scalar"|"time_series"|"raw_stream"|"heatmap"
DashboardtypesQuery.spec
spec:
object
DashboardtypesQuery.spec.name?
optionalname?:string
DashboardtypesQuery.spec.plugin
plugin: {
kind:"signoz/BuilderQuery";spec: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?: ...[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?: ...[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?: ...[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; }; } | {kind:"signoz/CompositeQuery";spec: {queries?: ({spec?: ... | ... | ... | ...;type:"builder_query"; } | {spec?: ... | ...;type:"builder_ai_query"; } | {spec?: ... | ...;type:"builder_formula"; } | {spec?: ... | ...;type:"builder_trace_operator"; } | {spec?: ... | ...;type:"promql"; } | {spec?: ... | ...;type:"clickhouse_sql"; })[] |null; }; } | {kind:"signoz/Formula";spec: {bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };disabled?:boolean;expression?:string;functions?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;name?:string;order?:object[] |null; }; } | {kind:"signoz/PromQLQuery";spec: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; }; } | {kind:"signoz/ClickHouseSQL";spec: {disabled?:boolean;legend?:string;name?:string;query?:string; }; } | {kind:"signoz/TraceOperator";spec: {aggregations?:object[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;name?:string;offset?:number;order?:object[] |null;returnSpansFrom?:string;selectFields?:object[] |null;stepInterval?:string|number; }; }
Union Members
Type Literal
{ kind: "signoz/BuilderQuery"; spec: { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: ... | ...; }; } | { kind: "log"; spec: { scale?: ... | ... | ...; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: ...[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; } | { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: ... | ...; }; } | { kind: "log"; spec: { scale?: ... | ... | ...; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: ...[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; } | { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: ... | ...; }; } | { kind: "log"; spec: { scale?: ... | ... | ...; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: ...[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }; }
kind
kind:
"signoz/BuilderQuery"
Description
discriminator enum property added by openapi-typescript
spec
spec: {
aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?: ...[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?: ...[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?: ...[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; }
Union Members
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: ... | ...; }; } | { kind: "log"; spec: { scale?: ... | ... | ...; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: ...[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: ... | ...; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?: ... | ...
Type Literal
{ kind: "log"; spec: { scale?: ... | ... | ...; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?: ... | ... | ...
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?: ...[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"logs"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: ... | ...; }; } | { kind: "log"; spec: { scale?: ... | ... | ...; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: ...[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: ... | ...; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?: ... | ...
Type Literal
{ kind: "log"; spec: { scale?: ... | ... | ...; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?: ... | ... | ...
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?: ...[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"metrics"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: ... | ...; }; } | { kind: "log"; spec: { scale?: ... | ... | ...; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: ...[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: ... | ...; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?: ... | ...
Type Literal
{ kind: "log"; spec: { scale?: ... | ... | ...; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?: ... | ... | ...
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?: ...[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"traces"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ kind: "signoz/CompositeQuery"; spec: { queries?: ({ spec?: ... | ... | ... | ...; type: "builder_query"; } | { spec?: ... | ...; type: "builder_ai_query"; } | { spec?: ... | ...; type: "builder_formula"; } | { spec?: ... | ...; type: "builder_trace_operator"; } | { spec?: ... | ...; type: "promql"; } | { spec?: ... | ...; type: "clickhouse_sql"; })[] | null; }; }
kind
kind:
"signoz/CompositeQuery"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.queries?
optionalqueries?: ({spec?: ... | ... | ... | ...;type:"builder_query"; } | {spec?: ... | ...;type:"builder_ai_query"; } | {spec?: ... | ...;type:"builder_formula"; } | {spec?: ... | ...;type:"builder_trace_operator"; } | {spec?: ... | ...;type:"promql"; } | {spec?: ... | ...;type:"clickhouse_sql"; })[] |null
Type Literal
{ kind: "signoz/Formula"; spec: { bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; disabled?: boolean; expression?: string; functions?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; name?: string; order?: object[] | null; }; }
kind
kind:
"signoz/Formula"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
spec.disabled?
optionaldisabled?:boolean
spec.expression?
optionalexpression?:string
spec.functions?
optionalfunctions?:object[] |null
spec.having?
optionalhaving?:object
spec.having.expression?
optionalexpression?:string
spec.legend?
optionallegend?:string
spec.limit?
optionallimit?:number
spec.name?
optionalname?:string
spec.order?
optionalorder?:object[] |null
Type Literal
{ kind: "signoz/PromQLQuery"; spec: { disabled?: boolean; legend?: string; name?: string; query?: string; stats?: boolean; step?: string | number; }; }
kind
kind:
"signoz/PromQLQuery"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.disabled?
optionaldisabled?:boolean
spec.legend?
optionallegend?:string
spec.name?
optionalname?:string
spec.query?
optionalquery?:string
spec.stats?
optionalstats?:boolean
spec.step?
optionalstep?:string|number
Type Literal
{ kind: "signoz/ClickHouseSQL"; spec: { disabled?: boolean; legend?: string; name?: string; query?: string; }; }
kind
kind:
"signoz/ClickHouseSQL"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.disabled?
optionaldisabled?:boolean
spec.legend?
optionallegend?:string
spec.name?
optionalname?:string
spec.query?
optionalquery?:string
Type Literal
{ kind: "signoz/TraceOperator"; spec: { aggregations?: object[] | null; cursor?: string; disabled?: boolean; expression?: string; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; name?: string; offset?: number; order?: object[] | null; returnSpansFrom?: string; selectFields?: object[] | null; stepInterval?: string | number; }; }
kind
kind:
"signoz/TraceOperator"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.aggregations?
optionalaggregations?:object[] |null
spec.cursor?
optionalcursor?:string
spec.disabled?
optionaldisabled?:boolean
spec.expression?
optionalexpression?:string
spec.filter?
optionalfilter?:object
spec.filter.expression?
optionalexpression?:string
spec.functions?
optionalfunctions?:object[] |null
spec.groupBy?
optionalgroupBy?:object[] |null
spec.having?
optionalhaving?:object
spec.having.expression?
optionalexpression?:string
spec.legend?
optionallegend?:string
spec.limit?
optionallimit?:number
spec.name?
optionalname?:string
spec.offset?
optionaloffset?:number
spec.order?
optionalorder?:object[] |null
spec.returnSpansFrom?
optionalreturnSpansFrom?:string
spec.selectFields?
optionalselectFields?:object[] |null
spec.stepInterval?
optionalstepInterval?:string|number
DashboardtypesQueryPlugin
DashboardtypesQueryPlugin: {
kind:"signoz/BuilderQuery";spec: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; }; } | {kind:"signoz/CompositeQuery";spec: {queries?: ({spec?: {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"logs";source?: ... | ... | ...;stepInterval?: ... | ... | ...; } | {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"metrics";source?: ... | ... | ...;stepInterval?: ... | ... | ...; } | {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"traces";source?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_query"; } | {spec?: {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"traces";source?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: ... | ... | ...;disabled?: ... | ... | ...;expression?: ... | ...;functions?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;name?: ... | ...;order?: ... | ... | ...; };type:"builder_formula"; } | {spec?: {aggregations?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;expression?: ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;returnSpansFrom?: ... | ...;selectFields?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_trace_operator"; } | {spec?: {disabled?: ... | ... | ...;legend?: ... | ...;name?: ... | ...;query?: ... | ...;stats?: ... | ... | ...;step?: ... | ... | ...; };type:"promql"; } | {spec?: {disabled?: ... | ... | ...;legend?: ... | ...;name?: ... | ...;query?: ... | ...; };type:"clickhouse_sql"; })[] |null; }; } | {kind:"signoz/Formula";spec: {bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };disabled?:boolean;expression?:string;functions?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;name?:string;order?:object[] |null; }; } | {kind:"signoz/PromQLQuery";spec: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; }; } | {kind:"signoz/ClickHouseSQL";spec: {disabled?:boolean;legend?:string;name?:string;query?:string; }; } | {kind:"signoz/TraceOperator";spec: {aggregations?:object[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;name?:string;offset?:number;order?:object[] |null;returnSpansFrom?:string;selectFields?:object[] |null;stepInterval?:string|number; }; }
Union Members
Type Literal
{ kind: "signoz/BuilderQuery"; spec: { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; } | { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; } | { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }; }
kind
kind:
"signoz/BuilderQuery"
Description
discriminator enum property added by openapi-typescript
spec
spec: {
aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; }
Union Members
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"logs"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"metrics"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"traces"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ kind: "signoz/CompositeQuery"; spec: { queries?: ({ spec?: { aggregations?: ... | ... | ...; bucketOptions?: ... | ... | ...; cursor?: ... | ...; disabled?: ... | ... | ...; filter?: ... | ...; functions?: ... | ... | ...; groupBy?: ... | ... | ...; having?: ... | ...; legend?: ... | ...; limit?: ... | ...; limitBy?: ... | ...; name?: ... | ...; offset?: ... | ...; order?: ... | ... | ...; secondaryAggregations?: ... | ... | ...; selectFields?: ... | ... | ...; signal: "logs"; source?: ... | ... | ...; stepInterval?: ... | ... | ...; } | { aggregations?: ... | ... | ...; bucketOptions?: ... | ... | ...; cursor?: ... | ...; disabled?: ... | ... | ...; filter?: ... | ...; functions?: ... | ... | ...; groupBy?: ... | ... | ...; having?: ... | ...; legend?: ... | ...; limit?: ... | ...; limitBy?: ... | ...; name?: ... | ...; offset?: ... | ...; order?: ... | ... | ...; secondaryAggregations?: ... | ... | ...; selectFields?: ... | ... | ...; signal: "metrics"; source?: ... | ... | ...; stepInterval?: ... | ... | ...; } | { aggregations?: ... | ... | ...; bucketOptions?: ... | ... | ...; cursor?: ... | ...; disabled?: ... | ... | ...; filter?: ... | ...; functions?: ... | ... | ...; groupBy?: ... | ... | ...; having?: ... | ...; legend?: ... | ...; limit?: ... | ...; limitBy?: ... | ...; name?: ... | ...; offset?: ... | ...; order?: ... | ... | ...; secondaryAggregations?: ... | ... | ...; selectFields?: ... | ... | ...; signal: "traces"; source?: ... | ... | ...; stepInterval?: ... | ... | ...; }; type: "builder_query"; } | { spec?: { aggregations?: ... | ... | ...; bucketOptions?: ... | ... | ...; cursor?: ... | ...; disabled?: ... | ... | ...; filter?: ... | ...; functions?: ... | ... | ...; groupBy?: ... | ... | ...; having?: ... | ...; legend?: ... | ...; limit?: ... | ...; limitBy?: ... | ...; name?: ... | ...; offset?: ... | ...; order?: ... | ... | ...; secondaryAggregations?: ... | ... | ...; selectFields?: ... | ... | ...; signal: "traces"; source?: ... | ... | ...; stepInterval?: ... | ... | ...; }; type: "builder_ai_query"; } | { spec?: { bucketOptions?: ... | ... | ...; disabled?: ... | ... | ...; expression?: ... | ...; functions?: ... | ... | ...; having?: ... | ...; legend?: ... | ...; limit?: ... | ...; name?: ... | ...; order?: ... | ... | ...; }; type: "builder_formula"; } | { spec?: { aggregations?: ... | ... | ...; cursor?: ... | ...; disabled?: ... | ... | ...; expression?: ... | ...; filter?: ... | ...; functions?: ... | ... | ...; groupBy?: ... | ... | ...; having?: ... | ...; legend?: ... | ...; limit?: ... | ...; name?: ... | ...; offset?: ... | ...; order?: ... | ... | ...; returnSpansFrom?: ... | ...; selectFields?: ... | ... | ...; stepInterval?: ... | ... | ...; }; type: "builder_trace_operator"; } | { spec?: { disabled?: ... | ... | ...; legend?: ... | ...; name?: ... | ...; query?: ... | ...; stats?: ... | ... | ...; step?: ... | ... | ...; }; type: "promql"; } | { spec?: { disabled?: ... | ... | ...; legend?: ... | ...; name?: ... | ...; query?: ... | ...; }; type: "clickhouse_sql"; })[] | null; }; }
kind
kind:
"signoz/CompositeQuery"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.queries?
optionalqueries?: ({spec?: {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"logs";source?: ... | ... | ...;stepInterval?: ... | ... | ...; } | {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"metrics";source?: ... | ... | ...;stepInterval?: ... | ... | ...; } | {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"traces";source?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_query"; } | {spec?: {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"traces";source?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: ... | ... | ...;disabled?: ... | ... | ...;expression?: ... | ...;functions?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;name?: ... | ...;order?: ... | ... | ...; };type:"builder_formula"; } | {spec?: {aggregations?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;expression?: ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;returnSpansFrom?: ... | ...;selectFields?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_trace_operator"; } | {spec?: {disabled?: ... | ... | ...;legend?: ... | ...;name?: ... | ...;query?: ... | ...;stats?: ... | ... | ...;step?: ... | ... | ...; };type:"promql"; } | {spec?: {disabled?: ... | ... | ...;legend?: ... | ...;name?: ... | ...;query?: ... | ...; };type:"clickhouse_sql"; })[] |null
Type Literal
{ kind: "signoz/Formula"; spec: { bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; disabled?: boolean; expression?: string; functions?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; name?: string; order?: object[] | null; }; }
kind
kind:
"signoz/Formula"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
spec.disabled?
optionaldisabled?:boolean
spec.expression?
optionalexpression?:string
spec.functions?
optionalfunctions?:object[] |null
spec.having?
optionalhaving?:object
spec.having.expression?
optionalexpression?:string
spec.legend?
optionallegend?:string
spec.limit?
optionallimit?:number
spec.name?
optionalname?:string
spec.order?
optionalorder?:object[] |null
Type Literal
{ kind: "signoz/PromQLQuery"; spec: { disabled?: boolean; legend?: string; name?: string; query?: string; stats?: boolean; step?: string | number; }; }
kind
kind:
"signoz/PromQLQuery"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.disabled?
optionaldisabled?:boolean
spec.legend?
optionallegend?:string
spec.name?
optionalname?:string
spec.query?
optionalquery?:string
spec.stats?
optionalstats?:boolean
spec.step?
optionalstep?:string|number
Type Literal
{ kind: "signoz/ClickHouseSQL"; spec: { disabled?: boolean; legend?: string; name?: string; query?: string; }; }
kind
kind:
"signoz/ClickHouseSQL"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.disabled?
optionaldisabled?:boolean
spec.legend?
optionallegend?:string
spec.name?
optionalname?:string
spec.query?
optionalquery?:string
Type Literal
{ kind: "signoz/TraceOperator"; spec: { aggregations?: object[] | null; cursor?: string; disabled?: boolean; expression?: string; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; name?: string; offset?: number; order?: object[] | null; returnSpansFrom?: string; selectFields?: object[] | null; stepInterval?: string | number; }; }
kind
kind:
"signoz/TraceOperator"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.aggregations?
optionalaggregations?:object[] |null
spec.cursor?
optionalcursor?:string
spec.disabled?
optionaldisabled?:boolean
spec.expression?
optionalexpression?:string
spec.filter?
optionalfilter?:object
spec.filter.expression?
optionalexpression?:string
spec.functions?
optionalfunctions?:object[] |null
spec.groupBy?
optionalgroupBy?:object[] |null
spec.having?
optionalhaving?:object
spec.having.expression?
optionalexpression?:string
spec.legend?
optionallegend?:string
spec.limit?
optionallimit?:number
spec.name?
optionalname?:string
spec.offset?
optionaloffset?:number
spec.order?
optionalorder?:object[] |null
spec.returnSpansFrom?
optionalreturnSpansFrom?:string
spec.selectFields?
optionalselectFields?:object[] |null
spec.stepInterval?
optionalstepInterval?:string|number
DashboardtypesQueryPluginKind
DashboardtypesQueryPluginKind:
"signoz/BuilderQuery"|"signoz/CompositeQuery"|"signoz/Formula"|"signoz/PromQLQuery"|"signoz/ClickHouseSQL"|"signoz/TraceOperator"
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBuilderQuerySpec
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBuilderQuerySpec:
object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBuilderQuerySpec.kind
kind:
"signoz/BuilderQuery"
Description
discriminator enum property added by openapi-typescript
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesDashboardtypesBuilderQuerySpec.spec
spec: {
aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; }
Union Members
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"logs"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"metrics"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"traces"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5ClickHouseQuery
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5ClickHouseQuery:
object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5ClickHouseQuery.kind
kind:
"signoz/ClickHouseSQL"
Description
discriminator enum property added by openapi-typescript
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5ClickHouseQuery.spec
spec:
object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5ClickHouseQuery.spec.disabled?
optionaldisabled?:boolean
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5ClickHouseQuery.spec.legend?
optionallegend?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5ClickHouseQuery.spec.name?
optionalname?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5ClickHouseQuery.spec.query?
optionalquery?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5CompositeQuery
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5CompositeQuery:
object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5CompositeQuery.kind
kind:
"signoz/CompositeQuery"
Description
discriminator enum property added by openapi-typescript
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5CompositeQuery.spec
spec:
object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5CompositeQuery.spec.queries?
optionalqueries?: ({spec?: {aggregations?: ...[] |null;bucketOptions?: {kind: ...;spec: ...; } | {kind: ...;spec: ...; };cursor?:string;disabled?:boolean;filter?: {expression?: ...; };functions?: ...[] |null;groupBy?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;limitBy?: {keys?: ...;value?: ...; };name?:string;offset?:number;order?: ...[] |null;secondaryAggregations?: ...[] |null;selectFields?: ...[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?: ...[] |null;bucketOptions?: {kind: ...;spec: ...; } | {kind: ...;spec: ...; };cursor?:string;disabled?:boolean;filter?: {expression?: ...; };functions?: ...[] |null;groupBy?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;limitBy?: {keys?: ...;value?: ...; };name?:string;offset?:number;order?: ...[] |null;secondaryAggregations?: ...[] |null;selectFields?: ...[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?: ...[] |null;bucketOptions?: {kind: ...;spec: ...; } | {kind: ...;spec: ...; };cursor?:string;disabled?:boolean;filter?: {expression?: ...; };functions?: ...[] |null;groupBy?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;limitBy?: {keys?: ...;value?: ...; };name?:string;offset?:number;order?: ...[] |null;secondaryAggregations?: ...[] |null;selectFields?: ...[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_query"; } | {spec?: {aggregations?: ...[] |null;bucketOptions?: {kind: ...;spec: ...; } | {kind: ...;spec: ...; };cursor?:string;disabled?:boolean;filter?: {expression?: ...; };functions?: ...[] |null;groupBy?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;limitBy?: {keys?: ...;value?: ...; };name?:string;offset?:number;order?: ...[] |null;secondaryAggregations?: ...[] |null;selectFields?: ...[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: {kind: ...;spec: ...; } | {kind: ...;spec: ...; };disabled?:boolean;expression?:string;functions?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;name?:string;order?: ...[] |null; };type:"builder_formula"; } | {spec?: {aggregations?: ...[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?: ...; };functions?: ...[] |null;groupBy?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;name?:string;offset?:number;order?: ...[] |null;returnSpansFrom?:string;selectFields?: ...[] |null;stepInterval?:string|number; };type:"builder_trace_operator"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; };type:"promql"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string; };type:"clickhouse_sql"; })[] |null
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5PromQuery
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5PromQuery:
object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5PromQuery.kind
kind:
"signoz/PromQLQuery"
Description
discriminator enum property added by openapi-typescript
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5PromQuery.spec
spec:
object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5PromQuery.spec.disabled?
optionaldisabled?:boolean
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5PromQuery.spec.legend?
optionallegend?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5PromQuery.spec.name?
optionalname?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5PromQuery.spec.query?
optionalquery?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5PromQuery.spec.stats?
optionalstats?:boolean
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5PromQuery.spec.step?
optionalstep?:string|number
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula:
object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.kind
kind:
"signoz/Formula"
Description
discriminator enum property added by openapi-typescript
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.spec
spec:
object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.spec.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.spec.disabled?
optionaldisabled?:boolean
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.spec.expression?
optionalexpression?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.spec.functions?
optionalfunctions?:object[] |null
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.spec.having?
optionalhaving?:object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.spec.having.expression?
optionalexpression?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.spec.legend?
optionallegend?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.spec.limit?
optionallimit?:number
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.spec.name?
optionalname?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderFormula.spec.order?
optionalorder?:object[] |null
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator:
object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.kind
kind:
"signoz/TraceOperator"
Description
discriminator enum property added by openapi-typescript
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec
spec:
object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.aggregations?
optionalaggregations?:object[] |null
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.cursor?
optionalcursor?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.disabled?
optionaldisabled?:boolean
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.expression?
optionalexpression?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.filter?
optionalfilter?:object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.filter.expression?
optionalexpression?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.functions?
optionalfunctions?:object[] |null
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.groupBy?
optionalgroupBy?:object[] |null
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.having?
optionalhaving?:object
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.having.expression?
optionalexpression?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.legend?
optionallegend?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.limit?
optionallimit?:number
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.name?
optionalname?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.offset?
optionaloffset?:number
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.order?
optionalorder?:object[] |null
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.returnSpansFrom?
optionalreturnSpansFrom?:string
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.selectFields?
optionalselectFields?:object[] |null
DashboardtypesQueryPluginVariantGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5QueryBuilderTraceOperator.spec.stepInterval?
optionalstepInterval?:string|number
DashboardtypesQuerySpec
DashboardtypesQuerySpec:
object
DashboardtypesQuerySpec.name?
optionalname?:string
DashboardtypesQuerySpec.plugin
plugin: {
kind:"signoz/BuilderQuery";spec: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; }; } | {kind:"signoz/CompositeQuery";spec: {queries?: ({spec?: {aggregations?: ...;bucketOptions?: ...;cursor?: ...;disabled?: ...;filter?: ...;functions?: ...;groupBy?: ...;having?: ...;legend?: ...;limit?: ...;limitBy?: ...;name?: ...;offset?: ...;order?: ...;secondaryAggregations?: ...;selectFields?: ...;signal: ...;source?: ...;stepInterval?: ...; } | {aggregations?: ...;bucketOptions?: ...;cursor?: ...;disabled?: ...;filter?: ...;functions?: ...;groupBy?: ...;having?: ...;legend?: ...;limit?: ...;limitBy?: ...;name?: ...;offset?: ...;order?: ...;secondaryAggregations?: ...;selectFields?: ...;signal: ...;source?: ...;stepInterval?: ...; } | {aggregations?: ...;bucketOptions?: ...;cursor?: ...;disabled?: ...;filter?: ...;functions?: ...;groupBy?: ...;having?: ...;legend?: ...;limit?: ...;limitBy?: ...;name?: ...;offset?: ...;order?: ...;secondaryAggregations?: ...;selectFields?: ...;signal: ...;source?: ...;stepInterval?: ...; };type:"builder_query"; } | {spec?: {aggregations?: ...;bucketOptions?: ...;cursor?: ...;disabled?: ...;filter?: ...;functions?: ...;groupBy?: ...;having?: ...;legend?: ...;limit?: ...;limitBy?: ...;name?: ...;offset?: ...;order?: ...;secondaryAggregations?: ...;selectFields?: ...;signal: ...;source?: ...;stepInterval?: ...; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: ...;disabled?: ...;expression?: ...;functions?: ...;having?: ...;legend?: ...;limit?: ...;name?: ...;order?: ...; };type:"builder_formula"; } | {spec?: {aggregations?: ...;cursor?: ...;disabled?: ...;expression?: ...;filter?: ...;functions?: ...;groupBy?: ...;having?: ...;legend?: ...;limit?: ...;name?: ...;offset?: ...;order?: ...;returnSpansFrom?: ...;selectFields?: ...;stepInterval?: ...; };type:"builder_trace_operator"; } | {spec?: {disabled?: ...;legend?: ...;name?: ...;query?: ...;stats?: ...;step?: ...; };type:"promql"; } | {spec?: {disabled?: ...;legend?: ...;name?: ...;query?: ...; };type:"clickhouse_sql"; })[] |null; }; } | {kind:"signoz/Formula";spec: {bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };disabled?:boolean;expression?:string;functions?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;name?:string;order?:object[] |null; }; } | {kind:"signoz/PromQLQuery";spec: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; }; } | {kind:"signoz/ClickHouseSQL";spec: {disabled?:boolean;legend?:string;name?:string;query?:string; }; } | {kind:"signoz/TraceOperator";spec: {aggregations?:object[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;name?:string;offset?:number;order?:object[] |null;returnSpansFrom?:string;selectFields?:object[] |null;stepInterval?:string|number; }; }
Union Members
Type Literal
{ kind: "signoz/BuilderQuery"; spec: { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; } | { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; } | { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }; }
kind
kind:
"signoz/BuilderQuery"
Description
discriminator enum property added by openapi-typescript
spec
spec: {
aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; }
Union Members
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"logs"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"metrics"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"traces"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ kind: "signoz/CompositeQuery"; spec: { queries?: ({ spec?: { aggregations?: ...; bucketOptions?: ...; cursor?: ...; disabled?: ...; filter?: ...; functions?: ...; groupBy?: ...; having?: ...; legend?: ...; limit?: ...; limitBy?: ...; name?: ...; offset?: ...; order?: ...; secondaryAggregations?: ...; selectFields?: ...; signal: ...; source?: ...; stepInterval?: ...; } | { aggregations?: ...; bucketOptions?: ...; cursor?: ...; disabled?: ...; filter?: ...; functions?: ...; groupBy?: ...; having?: ...; legend?: ...; limit?: ...; limitBy?: ...; name?: ...; offset?: ...; order?: ...; secondaryAggregations?: ...; selectFields?: ...; signal: ...; source?: ...; stepInterval?: ...; } | { aggregations?: ...; bucketOptions?: ...; cursor?: ...; disabled?: ...; filter?: ...; functions?: ...; groupBy?: ...; having?: ...; legend?: ...; limit?: ...; limitBy?: ...; name?: ...; offset?: ...; order?: ...; secondaryAggregations?: ...; selectFields?: ...; signal: ...; source?: ...; stepInterval?: ...; }; type: "builder_query"; } | { spec?: { aggregations?: ...; bucketOptions?: ...; cursor?: ...; disabled?: ...; filter?: ...; functions?: ...; groupBy?: ...; having?: ...; legend?: ...; limit?: ...; limitBy?: ...; name?: ...; offset?: ...; order?: ...; secondaryAggregations?: ...; selectFields?: ...; signal: ...; source?: ...; stepInterval?: ...; }; type: "builder_ai_query"; } | { spec?: { bucketOptions?: ...; disabled?: ...; expression?: ...; functions?: ...; having?: ...; legend?: ...; limit?: ...; name?: ...; order?: ...; }; type: "builder_formula"; } | { spec?: { aggregations?: ...; cursor?: ...; disabled?: ...; expression?: ...; filter?: ...; functions?: ...; groupBy?: ...; having?: ...; legend?: ...; limit?: ...; name?: ...; offset?: ...; order?: ...; returnSpansFrom?: ...; selectFields?: ...; stepInterval?: ...; }; type: "builder_trace_operator"; } | { spec?: { disabled?: ...; legend?: ...; name?: ...; query?: ...; stats?: ...; step?: ...; }; type: "promql"; } | { spec?: { disabled?: ...; legend?: ...; name?: ...; query?: ...; }; type: "clickhouse_sql"; })[] | null; }; }
kind
kind:
"signoz/CompositeQuery"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.queries?
optionalqueries?: ({spec?: {aggregations?: ...;bucketOptions?: ...;cursor?: ...;disabled?: ...;filter?: ...;functions?: ...;groupBy?: ...;having?: ...;legend?: ...;limit?: ...;limitBy?: ...;name?: ...;offset?: ...;order?: ...;secondaryAggregations?: ...;selectFields?: ...;signal: ...;source?: ...;stepInterval?: ...; } | {aggregations?: ...;bucketOptions?: ...;cursor?: ...;disabled?: ...;filter?: ...;functions?: ...;groupBy?: ...;having?: ...;legend?: ...;limit?: ...;limitBy?: ...;name?: ...;offset?: ...;order?: ...;secondaryAggregations?: ...;selectFields?: ...;signal: ...;source?: ...;stepInterval?: ...; } | {aggregations?: ...;bucketOptions?: ...;cursor?: ...;disabled?: ...;filter?: ...;functions?: ...;groupBy?: ...;having?: ...;legend?: ...;limit?: ...;limitBy?: ...;name?: ...;offset?: ...;order?: ...;secondaryAggregations?: ...;selectFields?: ...;signal: ...;source?: ...;stepInterval?: ...; };type:"builder_query"; } | {spec?: {aggregations?: ...;bucketOptions?: ...;cursor?: ...;disabled?: ...;filter?: ...;functions?: ...;groupBy?: ...;having?: ...;legend?: ...;limit?: ...;limitBy?: ...;name?: ...;offset?: ...;order?: ...;secondaryAggregations?: ...;selectFields?: ...;signal: ...;source?: ...;stepInterval?: ...; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: ...;disabled?: ...;expression?: ...;functions?: ...;having?: ...;legend?: ...;limit?: ...;name?: ...;order?: ...; };type:"builder_formula"; } | {spec?: {aggregations?: ...;cursor?: ...;disabled?: ...;expression?: ...;filter?: ...;functions?: ...;groupBy?: ...;having?: ...;legend?: ...;limit?: ...;name?: ...;offset?: ...;order?: ...;returnSpansFrom?: ...;selectFields?: ...;stepInterval?: ...; };type:"builder_trace_operator"; } | {spec?: {disabled?: ...;legend?: ...;name?: ...;query?: ...;stats?: ...;step?: ...; };type:"promql"; } | {spec?: {disabled?: ...;legend?: ...;name?: ...;query?: ...; };type:"clickhouse_sql"; })[] |null
Type Literal
{ kind: "signoz/Formula"; spec: { bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; disabled?: boolean; expression?: string; functions?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; name?: string; order?: object[] | null; }; }
kind
kind:
"signoz/Formula"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
spec.disabled?
optionaldisabled?:boolean
spec.expression?
optionalexpression?:string
spec.functions?
optionalfunctions?:object[] |null
spec.having?
optionalhaving?:object
spec.having.expression?
optionalexpression?:string
spec.legend?
optionallegend?:string
spec.limit?
optionallimit?:number
spec.name?
optionalname?:string
spec.order?
optionalorder?:object[] |null
Type Literal
{ kind: "signoz/PromQLQuery"; spec: { disabled?: boolean; legend?: string; name?: string; query?: string; stats?: boolean; step?: string | number; }; }
kind
kind:
"signoz/PromQLQuery"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.disabled?
optionaldisabled?:boolean
spec.legend?
optionallegend?:string
spec.name?
optionalname?:string
spec.query?
optionalquery?:string
spec.stats?
optionalstats?:boolean
spec.step?
optionalstep?:string|number
Type Literal
{ kind: "signoz/ClickHouseSQL"; spec: { disabled?: boolean; legend?: string; name?: string; query?: string; }; }
kind
kind:
"signoz/ClickHouseSQL"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.disabled?
optionaldisabled?:boolean
spec.legend?
optionallegend?:string
spec.name?
optionalname?:string
spec.query?
optionalquery?:string
Type Literal
{ kind: "signoz/TraceOperator"; spec: { aggregations?: object[] | null; cursor?: string; disabled?: boolean; expression?: string; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; name?: string; offset?: number; order?: object[] | null; returnSpansFrom?: string; selectFields?: object[] | null; stepInterval?: string | number; }; }
kind
kind:
"signoz/TraceOperator"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.aggregations?
optionalaggregations?:object[] |null
spec.cursor?
optionalcursor?:string
spec.disabled?
optionaldisabled?:boolean
spec.expression?
optionalexpression?:string
spec.filter?
optionalfilter?:object
spec.filter.expression?
optionalexpression?:string
spec.functions?
optionalfunctions?:object[] |null
spec.groupBy?
optionalgroupBy?:object[] |null
spec.having?
optionalhaving?:object
spec.having.expression?
optionalexpression?:string
spec.legend?
optionallegend?:string
spec.limit?
optionallimit?:number
spec.name?
optionalname?:string
spec.offset?
optionaloffset?:number
spec.order?
optionalorder?:object[] |null
spec.returnSpansFrom?
optionalreturnSpansFrom?:string
spec.selectFields?
optionalselectFields?:object[] |null
spec.stepInterval?
optionalstepInterval?:string|number
DashboardtypesQueryVariableSpec
DashboardtypesQueryVariableSpec:
object
DashboardtypesQueryVariableSpec.queryValue
queryValue:
string
DashboardtypesSource
DashboardtypesSource:
"user"|"integration"|"system"
DashboardtypesSpanGaps
DashboardtypesSpanGaps:
object
DashboardtypesSpanGaps.fillLessThan?
optionalfillLessThan?:string
Description
The maximum gap size to connect when fillOnlyBelow is true. Gaps larger than this duration are left disconnected.
DashboardtypesSpanGaps.fillOnlyBelow?
optionalfillOnlyBelow?:boolean
Description
Controls whether lines connect across null values. When false (default), all gaps are connected. When true, only gaps smaller than fillLessThan are connected.
DashboardtypesStorableDashboardData
DashboardtypesStorableDashboardData:
object
Index Signature
[key: string]: unknown
DashboardtypesTableFormatting
DashboardtypesTableFormatting:
object
DashboardtypesTableFormatting.columnUnits?
optionalcolumnUnits?: {[key:string]:string; } |null
DashboardtypesTableFormatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesTablePanelSpec
DashboardtypesTablePanelSpec:
object
DashboardtypesTablePanelSpec.formatting?
optionalformatting?:object
DashboardtypesTablePanelSpec.formatting.columnUnits?
optionalcolumnUnits?: {[key:string]:string; } |null
DashboardtypesTablePanelSpec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesTablePanelSpec.thresholds?
optionalthresholds?:object[] |null
DashboardtypesTablePanelSpec.visualization?
optionalvisualization?:object
DashboardtypesTablePanelSpec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesTableThreshold
DashboardtypesTableThreshold:
object
DashboardtypesTableThreshold.color
color:
string
DashboardtypesTableThreshold.columnName
columnName:
string
DashboardtypesTableThreshold.format?
optionalformat?:"text"|"background"
DashboardtypesTableThreshold.operator?
optionaloperator?:"above"|"below"|"above_or_equal"|"below_or_equal"|"equal"|"not_equal"
DashboardtypesTableThreshold.unit?
optionalunit?:string
DashboardtypesTableThreshold.value
value:
number
Format: double
DashboardtypesTextAlign
DashboardtypesTextAlign:
"right"|"left"|"center"
DashboardtypesTextMode
DashboardtypesTextMode:
"markdown"
DashboardtypesTextPanelSpec
DashboardtypesTextPanelSpec:
object
DashboardtypesTextPanelSpec.headerOptions?
optionalheaderOptions?:object
DashboardtypesTextPanelSpec.headerOptions.hide?
optionalhide?:boolean
DashboardtypesTextPanelSpec.mode?
optionalmode?:"markdown"
DashboardtypesTextPanelSpec.presentation?
optionalpresentation?:object
DashboardtypesTextPanelSpec.presentation.background?
optionalbackground?:string|null
DashboardtypesTextPanelSpec.presentation.textAlign?
optionaltextAlign?:"right"|"left"|"center"
DashboardtypesTextPanelSpec.presentation.verticalAlign?
optionalverticalAlign?:"bottom"|"center"|"top"
DashboardtypesTextPanelSpec.text?
optionaltext?:string
DashboardtypesTextPresentation
DashboardtypesTextPresentation:
object
DashboardtypesTextPresentation.background?
optionalbackground?:string|null
DashboardtypesTextPresentation.textAlign?
optionaltextAlign?:"right"|"left"|"center"
DashboardtypesTextPresentation.verticalAlign?
optionalverticalAlign?:"bottom"|"center"|"top"
DashboardtypesTextVariableSpec
DashboardtypesTextVariableSpec:
object
DashboardtypesTextVariableSpec.constant?
optionalconstant?:boolean
DashboardtypesTextVariableSpec.display
display:
object
DashboardtypesTextVariableSpec.display.description?
optionaldescription?:string
DashboardtypesTextVariableSpec.display.name
name:
string
DashboardtypesTextVariableSpec.name
name:
string
DashboardtypesTextVariableSpec.value
value:
string
DashboardtypesThresholdFormat
DashboardtypesThresholdFormat:
"text"|"background"
DashboardtypesThresholdWithLabel
DashboardtypesThresholdWithLabel:
object
DashboardtypesThresholdWithLabel.color
color:
string
DashboardtypesThresholdWithLabel.label?
optionallabel?:string
DashboardtypesThresholdWithLabel.unit?
optionalunit?:string
DashboardtypesThresholdWithLabel.value
value:
number
Format: double
DashboardtypesTimePreference
DashboardtypesTimePreference:
"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesTimeSeriesChartAppearance
DashboardtypesTimeSeriesChartAppearance:
object
DashboardtypesTimeSeriesChartAppearance.fillMode?
optionalfillMode?:"solid"|"gradient"|"none"
DashboardtypesTimeSeriesChartAppearance.lineInterpolation?
optionallineInterpolation?:"linear"|"spline"|"step_after"|"step_before"
DashboardtypesTimeSeriesChartAppearance.lineStyle?
optionallineStyle?:"solid"|"dashed"
DashboardtypesTimeSeriesChartAppearance.showPoints?
optionalshowPoints?:boolean
DashboardtypesTimeSeriesChartAppearance.spanGaps?
optionalspanGaps?:object
DashboardtypesTimeSeriesChartAppearance.spanGaps.fillLessThan?
optionalfillLessThan?:string
Description
The maximum gap size to connect when fillOnlyBelow is true. Gaps larger than this duration are left disconnected.
DashboardtypesTimeSeriesChartAppearance.spanGaps.fillOnlyBelow?
optionalfillOnlyBelow?:boolean
Description
Controls whether lines connect across null values. When false (default), all gaps are connected. When true, only gaps smaller than fillLessThan are connected.
DashboardtypesTimeSeriesPanelSpec
DashboardtypesTimeSeriesPanelSpec:
object
DashboardtypesTimeSeriesPanelSpec.axes?
optionalaxes?:object
DashboardtypesTimeSeriesPanelSpec.axes.isLogScale?
optionalisLogScale?:boolean
DashboardtypesTimeSeriesPanelSpec.axes.softMax?
optionalsoftMax?:number|null
DashboardtypesTimeSeriesPanelSpec.axes.softMin?
optionalsoftMin?:number|null
DashboardtypesTimeSeriesPanelSpec.chartAppearance?
optionalchartAppearance?:object
DashboardtypesTimeSeriesPanelSpec.chartAppearance.fillMode?
optionalfillMode?:"solid"|"gradient"|"none"
DashboardtypesTimeSeriesPanelSpec.chartAppearance.lineInterpolation?
optionallineInterpolation?:"linear"|"spline"|"step_after"|"step_before"
DashboardtypesTimeSeriesPanelSpec.chartAppearance.lineStyle?
optionallineStyle?:"solid"|"dashed"
DashboardtypesTimeSeriesPanelSpec.chartAppearance.showPoints?
optionalshowPoints?:boolean
DashboardtypesTimeSeriesPanelSpec.chartAppearance.spanGaps?
optionalspanGaps?:object
DashboardtypesTimeSeriesPanelSpec.chartAppearance.spanGaps.fillLessThan?
optionalfillLessThan?:string
Description
The maximum gap size to connect when fillOnlyBelow is true. Gaps larger than this duration are left disconnected.
DashboardtypesTimeSeriesPanelSpec.chartAppearance.spanGaps.fillOnlyBelow?
optionalfillOnlyBelow?:boolean
Description
Controls whether lines connect across null values. When false (default), all gaps are connected. When true, only gaps smaller than fillLessThan are connected.
DashboardtypesTimeSeriesPanelSpec.formatting?
optionalformatting?:object
DashboardtypesTimeSeriesPanelSpec.formatting.decimalPrecision?
optionaldecimalPrecision?:"0"|"1"|"2"|"3"|"4"|"full"
DashboardtypesTimeSeriesPanelSpec.formatting.unit?
optionalunit?:string
DashboardtypesTimeSeriesPanelSpec.legend?
optionallegend?:object
DashboardtypesTimeSeriesPanelSpec.legend.customColors?
optionalcustomColors?: {[key:string]:string; } |null
DashboardtypesTimeSeriesPanelSpec.legend.mode?
optionalmode?:"list"
DashboardtypesTimeSeriesPanelSpec.legend.position?
optionalposition?:"bottom"|"right"
DashboardtypesTimeSeriesPanelSpec.thresholds?
optionalthresholds?:object[] |null
DashboardtypesTimeSeriesPanelSpec.visualization?
optionalvisualization?:object
DashboardtypesTimeSeriesPanelSpec.visualization.fillSpans?
optionalfillSpans?:boolean
DashboardtypesTimeSeriesPanelSpec.visualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesTimeSeriesVisualization
DashboardtypesTimeSeriesVisualization:
object
DashboardtypesTimeSeriesVisualization.fillSpans?
optionalfillSpans?:boolean
DashboardtypesTimeSeriesVisualization.timePreference?
optionaltimePreference?:"global_time"|"last_5_min"|"last_15_min"|"last_30_min"|"last_1_hr"|"last_6_hr"|"last_1_day"|"last_3_days"|"last_1_week"|"last_1_month"
DashboardtypesUpdatableDashboardV2
DashboardtypesUpdatableDashboardV2:
object
DashboardtypesUpdatableDashboardV2.image?
optionalimage?:string
DashboardtypesUpdatableDashboardV2.name
name:
string
DashboardtypesUpdatableDashboardV2.schemaVersion
schemaVersion:
string
DashboardtypesUpdatableDashboardV2.spec
spec:
object
DashboardtypesUpdatableDashboardV2.spec.display
display:
object
DashboardtypesUpdatableDashboardV2.spec.display.description?
optionaldescription?:string
DashboardtypesUpdatableDashboardV2.spec.display.name
name:
string
DashboardtypesUpdatableDashboardV2.spec.duration?
optionalduration?:string
DashboardtypesUpdatableDashboardV2.spec.layouts
layouts:
object[]
DashboardtypesUpdatableDashboardV2.spec.links?
optionallinks?:object[] |null
DashboardtypesUpdatableDashboardV2.spec.panels
panels:
object
Index Signature
[key: string]: object
DashboardtypesUpdatableDashboardV2.spec.refreshInterval?
optionalrefreshInterval?:string
DashboardtypesUpdatableDashboardV2.spec.variables
variables: ({
kind:"ListVariable";spec: {allowAllValue?:boolean;allowMultiple?:boolean;capturingRegexp?:string;customAllValue?:string;defaultValue?:string|string[];display: {description?:string;name:string; };name:string;plugin?: {kind:"signoz/DynamicVariable";spec: {name:string;signal: ... | ... | ... | ...; }; } | {kind:"signoz/QueryVariable";spec: {queryValue:string; }; } | {kind:"signoz/CustomVariable";spec: {customValue:string; }; };sort?:"none"|"alphabetical-asc"|"alphabetical-desc"|"numerical-asc"|"numerical-desc"|"alphabetical-ci-asc"|"alphabetical-ci-desc"; }; } | {kind:"TextVariable";spec: {constant?:boolean;display: {description?:string;name:string; };name:string;value:string; }; })[]
DashboardtypesUpdatableDashboardV2.tags
tags:
object[] |null
DashboardtypesUpdatablePublicDashboard
DashboardtypesUpdatablePublicDashboard:
object
DashboardtypesUpdatablePublicDashboard.defaultTimeRange?
optionaldefaultTimeRange?:string
DashboardtypesUpdatablePublicDashboard.timeRangeEnabled?
optionaltimeRangeEnabled?:boolean
DashboardtypesVariable
DashboardtypesVariable: {
kind:"ListVariable";spec: {allowAllValue?:boolean;allowMultiple?:boolean;capturingRegexp?:string;customAllValue?:string;defaultValue?:string|string[];display: {description?:string;name:string; };name:string;plugin?: {kind:"signoz/DynamicVariable";spec: {name:string;signal:"logs"|"traces"|"metrics"|"all"; }; } | {kind:"signoz/QueryVariable";spec: {queryValue:string; }; } | {kind:"signoz/CustomVariable";spec: {customValue:string; }; };sort?:"none"|"alphabetical-asc"|"alphabetical-desc"|"numerical-asc"|"numerical-desc"|"alphabetical-ci-asc"|"alphabetical-ci-desc"; }; } | {kind:"TextVariable";spec: {constant?:boolean;display: {description?:string;name:string; };name:string;value:string; }; }
Union Members
Type Literal
{ kind: "ListVariable"; spec: { allowAllValue?: boolean; allowMultiple?: boolean; capturingRegexp?: string; customAllValue?: string; defaultValue?: string | string[]; display: { description?: string; name: string; }; name: string; plugin?: { kind: "signoz/DynamicVariable"; spec: { name: string; signal: "logs" | "traces" | "metrics" | "all"; }; } | { kind: "signoz/QueryVariable"; spec: { queryValue: string; }; } | { kind: "signoz/CustomVariable"; spec: { customValue: string; }; }; sort?: "none" | "alphabetical-asc" | "alphabetical-desc" | "numerical-asc" | "numerical-desc" | "alphabetical-ci-asc" | "alphabetical-ci-desc"; }; }
kind
kind:
"ListVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.allowAllValue?
optionalallowAllValue?:boolean
spec.allowMultiple?
optionalallowMultiple?:boolean
spec.capturingRegexp?
optionalcapturingRegexp?:string
spec.customAllValue?
optionalcustomAllValue?:string
spec.defaultValue?
optionaldefaultValue?:string|string[]
spec.display
display:
object
spec.display.description?
optionaldescription?:string
spec.display.name
name:
string
spec.name
name:
string
spec.plugin?
optionalplugin?: {kind:"signoz/DynamicVariable";spec: {name:string;signal:"logs"|"traces"|"metrics"|"all"; }; } | {kind:"signoz/QueryVariable";spec: {queryValue:string; }; } | {kind:"signoz/CustomVariable";spec: {customValue:string; }; }
Union Members
Type Literal
{ kind: "signoz/DynamicVariable"; spec: { name: string; signal: "logs" | "traces" | "metrics" | "all"; }; }
kind
kind:
"signoz/DynamicVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.name
name:
string
spec.signal
signal:
"logs"|"traces"|"metrics"|"all"
Type Literal
{ kind: "signoz/QueryVariable"; spec: { queryValue: string; }; }
kind
kind:
"signoz/QueryVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.queryValue
queryValue:
string
Type Literal
{ kind: "signoz/CustomVariable"; spec: { customValue: string; }; }
kind
kind:
"signoz/CustomVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.customValue
customValue:
string
spec.sort?
optionalsort?:"none"|"alphabetical-asc"|"alphabetical-desc"|"numerical-asc"|"numerical-desc"|"alphabetical-ci-asc"|"alphabetical-ci-desc"
Type Literal
{ kind: "TextVariable"; spec: { constant?: boolean; display: { description?: string; name: string; }; name: string; value: string; }; }
kind
kind:
"TextVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.constant?
optionalconstant?:boolean
spec.display
display:
object
spec.display.description?
optionaldescription?:string
spec.display.name
name:
string
spec.name
name:
string
spec.value
value:
string
DashboardtypesVariableDefaultValue
DashboardtypesVariableDefaultValue:
string|string[]
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec:
object
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.kind
kind:
"ListVariable"
Description
discriminator enum property added by openapi-typescript
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec
spec:
object
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec.allowAllValue?
optionalallowAllValue?:boolean
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec.allowMultiple?
optionalallowMultiple?:boolean
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec.capturingRegexp?
optionalcapturingRegexp?:string
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec.customAllValue?
optionalcustomAllValue?:string
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec.defaultValue?
optionaldefaultValue?:string|string[]
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec.display
display:
object
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec.display.description?
optionaldescription?:string
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec.display.name
name:
string
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec.name
name:
string
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec.plugin?
optionalplugin?: {kind:"signoz/DynamicVariable";spec: {name:string;signal:"logs"|"traces"|"metrics"|"all"; }; } | {kind:"signoz/QueryVariable";spec: {queryValue:string; }; } | {kind:"signoz/CustomVariable";spec: {customValue:string; }; }
Union Members
Type Literal
{ kind: "signoz/DynamicVariable"; spec: { name: string; signal: "logs" | "traces" | "metrics" | "all"; }; }
kind
kind:
"signoz/DynamicVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.name
name:
string
spec.signal
signal:
"logs"|"traces"|"metrics"|"all"
Type Literal
{ kind: "signoz/QueryVariable"; spec: { queryValue: string; }; }
kind
kind:
"signoz/QueryVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.queryValue
queryValue:
string
Type Literal
{ kind: "signoz/CustomVariable"; spec: { customValue: string; }; }
kind
kind:
"signoz/CustomVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.customValue
customValue:
string
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesListVariableSpec.spec.sort?
optionalsort?:"none"|"alphabetical-asc"|"alphabetical-desc"|"numerical-asc"|"numerical-desc"|"alphabetical-ci-asc"|"alphabetical-ci-desc"
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesTextVariableSpec
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesTextVariableSpec:
object
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesTextVariableSpec.kind
kind:
"TextVariable"
Description
discriminator enum property added by openapi-typescript
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesTextVariableSpec.spec
spec:
object
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesTextVariableSpec.spec.constant?
optionalconstant?:boolean
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesTextVariableSpec.spec.display
display:
object
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesTextVariableSpec.spec.display.description?
optionaldescription?:string
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesTextVariableSpec.spec.display.name
name:
string
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesTextVariableSpec.spec.name
name:
string
DashboardtypesVariableEnvelopeGithubComSigNozSignozPkgTypesDashboardtypesTextVariableSpec.spec.value
value:
string
DashboardtypesVariablePlugin
DashboardtypesVariablePlugin: {
kind:"signoz/DynamicVariable";spec: {name:string;signal:"logs"|"traces"|"metrics"|"all"; }; } | {kind:"signoz/QueryVariable";spec: {queryValue:string; }; } | {kind:"signoz/CustomVariable";spec: {customValue:string; }; }
Union Members
Type Literal
{ kind: "signoz/DynamicVariable"; spec: { name: string; signal: "logs" | "traces" | "metrics" | "all"; }; }
kind
kind:
"signoz/DynamicVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.name
name:
string
spec.signal
signal:
"logs"|"traces"|"metrics"|"all"
Type Literal
{ kind: "signoz/QueryVariable"; spec: { queryValue: string; }; }
kind
kind:
"signoz/QueryVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.queryValue
queryValue:
string
Type Literal
{ kind: "signoz/CustomVariable"; spec: { customValue: string; }; }
kind
kind:
"signoz/CustomVariable"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.customValue
customValue:
string
DashboardtypesVariablePluginKind
DashboardtypesVariablePluginKind:
"signoz/DynamicVariable"|"signoz/QueryVariable"|"signoz/CustomVariable"
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesCustomVariableSpec
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesCustomVariableSpec:
object
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesCustomVariableSpec.kind
kind:
"signoz/CustomVariable"
Description
discriminator enum property added by openapi-typescript
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesCustomVariableSpec.spec
spec:
object
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesCustomVariableSpec.spec.customValue
customValue:
string
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesDynamicVariableSpec
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesDynamicVariableSpec:
object
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesDynamicVariableSpec.kind
kind:
"signoz/DynamicVariable"
Description
discriminator enum property added by openapi-typescript
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesDynamicVariableSpec.spec
spec:
object
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesDynamicVariableSpec.spec.name
name:
string
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesDynamicVariableSpec.spec.signal
signal:
"logs"|"traces"|"metrics"|"all"
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesQueryVariableSpec
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesQueryVariableSpec:
object
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesQueryVariableSpec.kind
kind:
"signoz/QueryVariable"
Description
discriminator enum property added by openapi-typescript
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesQueryVariableSpec.spec
spec:
object
DashboardtypesVariablePluginVariantGithubComSigNozSignozPkgTypesDashboardtypesQueryVariableSpec.spec.queryValue
queryValue:
string
DashboardtypesVerticalAlign
DashboardtypesVerticalAlign:
"bottom"|"center"|"top"
ErrorsJSON
ErrorsJSON:
object
ErrorsJSON.code
code:
string
ErrorsJSON.errors
errors:
object[]
ErrorsJSON.message
message:
string
ErrorsJSON.retry?
optionalretry?:object
ErrorsJSON.retry.delay
delay:
number
ErrorsJSON.suggestions
suggestions:
string[]
ErrorsJSON.type
type:
string
ErrorsJSON.url?
optionalurl?:string
ErrorsResponseerroradditional
ErrorsResponseerroradditional:
object
ErrorsResponseerroradditional.message
message:
string
ErrorsResponseerroradditional.suggestions
suggestions:
string[]
ErrorsResponseretryjson
ErrorsResponseretryjson:
object
ErrorsResponseretryjson.delay
delay:
number
FactoryResponse
FactoryResponse:
object
FactoryResponse.healthy?
optionalhealthy?:boolean
FactoryResponse.services?
optionalservices?: {[key:string]:string[]; } |null
FeaturetypesGettableFeature
FeaturetypesGettableFeature:
object
FeaturetypesGettableFeature.defaultVariant?
optionaldefaultVariant?:string
FeaturetypesGettableFeature.description?
optionaldescription?:string
FeaturetypesGettableFeature.kind?
optionalkind?:string
FeaturetypesGettableFeature.name?
optionalname?:string
FeaturetypesGettableFeature.resolvedValue?
optionalresolvedValue?:unknown
FeaturetypesGettableFeature.stage?
optionalstage?:string
FeaturetypesGettableFeature.variants?
optionalvariants?: {[key:string]:unknown; } |null
GatewaytypesDeprecatedPostableIngestionKeyLimit
GatewaytypesDeprecatedPostableIngestionKeyLimit:
object
GatewaytypesDeprecatedPostableIngestionKeyLimit.config?
optionalconfig?:object
GatewaytypesDeprecatedPostableIngestionKeyLimit.config.day?
optionalday?:object
GatewaytypesDeprecatedPostableIngestionKeyLimit.config.day.count?
optionalcount?:number|null
GatewaytypesDeprecatedPostableIngestionKeyLimit.config.day.size?
optionalsize?:number|null
GatewaytypesDeprecatedPostableIngestionKeyLimit.config.second?
optionalsecond?:object
GatewaytypesDeprecatedPostableIngestionKeyLimit.config.second.count?
optionalcount?:number|null
GatewaytypesDeprecatedPostableIngestionKeyLimit.config.second.size?
optionalsize?:number|null
GatewaytypesDeprecatedPostableIngestionKeyLimit.signal?
optionalsignal?:string
GatewaytypesDeprecatedPostableIngestionKeyLimit.tags?
optionaltags?:string[] |null
GatewaytypesGettableCreatedIngestionKey
GatewaytypesGettableCreatedIngestionKey:
object
GatewaytypesGettableCreatedIngestionKey.id
id:
string
GatewaytypesGettableCreatedIngestionKey.value
value:
string
GatewaytypesGettableCreatedIngestionKeyLimit
GatewaytypesGettableCreatedIngestionKeyLimit:
object
GatewaytypesGettableCreatedIngestionKeyLimit.id
id:
string
GatewaytypesGettableIngestionKeys
GatewaytypesGettableIngestionKeys:
object
GatewaytypesGettableIngestionKeys._pagination?
optional_pagination?:object
GatewaytypesGettableIngestionKeys._pagination.page?
optionalpage?:number
GatewaytypesGettableIngestionKeys._pagination.pages?
optionalpages?:number
GatewaytypesGettableIngestionKeys._pagination.per_page?
optionalper_page?:number
GatewaytypesGettableIngestionKeys._pagination.total?
optionaltotal?:number
GatewaytypesGettableIngestionKeys.keys?
optionalkeys?:object[] |null
GatewaytypesIngestionKey
GatewaytypesIngestionKey:
object
GatewaytypesIngestionKey.created_at?
optionalcreated_at?:string
Format: date-time
GatewaytypesIngestionKey.expires_at?
optionalexpires_at?:string
Format: date-time
GatewaytypesIngestionKey.id?
optionalid?:string
GatewaytypesIngestionKey.limits?
optionallimits?:object[] |null
GatewaytypesIngestionKey.name?
optionalname?:string
GatewaytypesIngestionKey.tags?
optionaltags?:string[] |null
GatewaytypesIngestionKey.updated_at?
optionalupdated_at?:string
Format: date-time
GatewaytypesIngestionKey.value?
optionalvalue?:string
GatewaytypesIngestionKey.workspace_id?
optionalworkspace_id?:string
GatewaytypesLimit
GatewaytypesLimit:
object
GatewaytypesLimit.config?
optionalconfig?:object
GatewaytypesLimit.config.day?
optionalday?:object
GatewaytypesLimit.config.day.count?
optionalcount?:number|null
GatewaytypesLimit.config.day.size?
optionalsize?:number|null
GatewaytypesLimit.config.second?
optionalsecond?:object
GatewaytypesLimit.config.second.count?
optionalcount?:number|null
GatewaytypesLimit.config.second.size?
optionalsize?:number|null
GatewaytypesLimit.created_at?
optionalcreated_at?:string
Format: date-time
GatewaytypesLimit.id?
optionalid?:string
GatewaytypesLimit.key_id?
optionalkey_id?:string
GatewaytypesLimit.metric?
optionalmetric?:object
GatewaytypesLimit.metric.day?
optionalday?:object
GatewaytypesLimit.metric.day.count?
optionalcount?:number
Format: int64
GatewaytypesLimit.metric.day.size?
optionalsize?:number
Format: int64
GatewaytypesLimit.metric.second?
optionalsecond?:object
GatewaytypesLimit.metric.second.count?
optionalcount?:number
Format: int64
GatewaytypesLimit.metric.second.size?
optionalsize?:number
Format: int64
GatewaytypesLimit.signal?
optionalsignal?:string
GatewaytypesLimit.tags?
optionaltags?:string[] |null
GatewaytypesLimit.updated_at?
optionalupdated_at?:string
Format: date-time
GatewaytypesLimitConfig
GatewaytypesLimitConfig:
object
GatewaytypesLimitConfig.day?
optionalday?:object
GatewaytypesLimitConfig.day.count?
optionalcount?:number|null
GatewaytypesLimitConfig.day.size?
optionalsize?:number|null
GatewaytypesLimitConfig.second?
optionalsecond?:object
GatewaytypesLimitConfig.second.count?
optionalcount?:number|null
GatewaytypesLimitConfig.second.size?
optionalsize?:number|null
GatewaytypesLimitMetric
GatewaytypesLimitMetric:
object
GatewaytypesLimitMetric.day?
optionalday?:object
GatewaytypesLimitMetric.day.count?
optionalcount?:number
Format: int64
GatewaytypesLimitMetric.day.size?
optionalsize?:number
Format: int64
GatewaytypesLimitMetric.second?
optionalsecond?:object
GatewaytypesLimitMetric.second.count?
optionalcount?:number
Format: int64
GatewaytypesLimitMetric.second.size?
optionalsize?:number
Format: int64
GatewaytypesLimitMetricValue
GatewaytypesLimitMetricValue:
object
GatewaytypesLimitMetricValue.count?
optionalcount?:number
Format: int64
GatewaytypesLimitMetricValue.size?
optionalsize?:number
Format: int64
GatewaytypesLimitValue
GatewaytypesLimitValue:
object
GatewaytypesLimitValue.count?
optionalcount?:number|null
GatewaytypesLimitValue.size?
optionalsize?:number|null
GatewaytypesPagination
GatewaytypesPagination:
object
GatewaytypesPagination.page?
optionalpage?:number
GatewaytypesPagination.pages?
optionalpages?:number
GatewaytypesPagination.per_page?
optionalper_page?:number
GatewaytypesPagination.total?
optionaltotal?:number
GatewaytypesPostableIngestionKey
GatewaytypesPostableIngestionKey:
object
GatewaytypesPostableIngestionKey.expires_at?
optionalexpires_at?:string
Format: date-time
GatewaytypesPostableIngestionKey.name
name:
string
GatewaytypesPostableIngestionKey.tags?
optionaltags?:string[] |null
GatewaytypesPostableIngestionKeyLimit
GatewaytypesPostableIngestionKeyLimit:
object
GatewaytypesPostableIngestionKeyLimit.config?
optionalconfig?:object
GatewaytypesPostableIngestionKeyLimit.config.day?
optionalday?:object
GatewaytypesPostableIngestionKeyLimit.config.day.count?
optionalcount?:number|null
GatewaytypesPostableIngestionKeyLimit.config.day.size?
optionalsize?:number|null
GatewaytypesPostableIngestionKeyLimit.config.second?
optionalsecond?:object
GatewaytypesPostableIngestionKeyLimit.config.second.count?
optionalcount?:number|null
GatewaytypesPostableIngestionKeyLimit.config.second.size?
optionalsize?:number|null
GatewaytypesPostableIngestionKeyLimit.keyId
keyId:
string
GatewaytypesPostableIngestionKeyLimit.signal?
optionalsignal?:string
GatewaytypesPostableIngestionKeyLimit.tags?
optionaltags?:string[] |null
GatewaytypesUpdatableIngestionKeyLimit
GatewaytypesUpdatableIngestionKeyLimit:
object
GatewaytypesUpdatableIngestionKeyLimit.config
config:
object
GatewaytypesUpdatableIngestionKeyLimit.config.day?
optionalday?:object
GatewaytypesUpdatableIngestionKeyLimit.config.day.count?
optionalcount?:number|null
GatewaytypesUpdatableIngestionKeyLimit.config.day.size?
optionalsize?:number|null
GatewaytypesUpdatableIngestionKeyLimit.config.second?
optionalsecond?:object
GatewaytypesUpdatableIngestionKeyLimit.config.second.count?
optionalcount?:number|null
GatewaytypesUpdatableIngestionKeyLimit.config.second.size?
optionalsize?:number|null
GatewaytypesUpdatableIngestionKeyLimit.tags?
optionaltags?:string[] |null
GlobaltypesAPIKeyConfig
GlobaltypesAPIKeyConfig:
object
GlobaltypesAPIKeyConfig.enabled?
optionalenabled?:boolean
GlobaltypesConfig
GlobaltypesConfig:
object
GlobaltypesConfig.ai_assistant_url
ai_assistant_url:
string|null
GlobaltypesConfig.external_url
external_url:
string
GlobaltypesConfig.identN?
optionalidentN?:object
GlobaltypesConfig.identN.apikey?
optionalapikey?:object
GlobaltypesConfig.identN.apikey.enabled?
optionalenabled?:boolean
GlobaltypesConfig.identN.impersonation?
optionalimpersonation?:object
GlobaltypesConfig.identN.impersonation.enabled?
optionalenabled?:boolean
GlobaltypesConfig.identN.tokenizer?
optionaltokenizer?:object
GlobaltypesConfig.identN.tokenizer.enabled?
optionalenabled?:boolean
GlobaltypesConfig.ingestion_url
ingestion_url:
string
GlobaltypesConfig.mcp_url
mcp_url:
string|null
GlobaltypesIdentNConfig
GlobaltypesIdentNConfig:
object
GlobaltypesIdentNConfig.apikey?
optionalapikey?:object
GlobaltypesIdentNConfig.apikey.enabled?
optionalenabled?:boolean
GlobaltypesIdentNConfig.impersonation?
optionalimpersonation?:object
GlobaltypesIdentNConfig.impersonation.enabled?
optionalenabled?:boolean
GlobaltypesIdentNConfig.tokenizer?
optionaltokenizer?:object
GlobaltypesIdentNConfig.tokenizer.enabled?
optionalenabled?:boolean
GlobaltypesImpersonationConfig
GlobaltypesImpersonationConfig:
object
GlobaltypesImpersonationConfig.enabled?
optionalenabled?:boolean
GlobaltypesTokenizerConfig
GlobaltypesTokenizerConfig:
object
GlobaltypesTokenizerConfig.enabled?
optionalenabled?:boolean
InframonitoringtypesAssociatedComponent
InframonitoringtypesAssociatedComponent:
object
InframonitoringtypesAssociatedComponent.name
name:
string
InframonitoringtypesAssociatedComponent.type
type:
"receiver"|"processor"
InframonitoringtypesAttributesComponentEntry
InframonitoringtypesAttributesComponentEntry:
object
InframonitoringtypesAttributesComponentEntry.associatedComponent
associatedComponent:
object
InframonitoringtypesAttributesComponentEntry.associatedComponent.name
name:
string
InframonitoringtypesAttributesComponentEntry.associatedComponent.type
type:
"receiver"|"processor"
InframonitoringtypesAttributesComponentEntry.attributes
attributes:
string[] |null
InframonitoringtypesCheckComponentType
InframonitoringtypesCheckComponentType:
"receiver"|"processor"
InframonitoringtypesChecks
InframonitoringtypesChecks:
object
InframonitoringtypesChecks.missingDefaultEnabledMetrics
missingDefaultEnabledMetrics:
object[] |null
InframonitoringtypesChecks.missingOptionalMetrics
missingOptionalMetrics:
object[] |null
InframonitoringtypesChecks.missingRequiredAttributes
missingRequiredAttributes:
object[] |null
InframonitoringtypesChecks.presentDefaultEnabledMetrics
presentDefaultEnabledMetrics:
object[] |null
InframonitoringtypesChecks.presentOptionalMetrics
presentOptionalMetrics:
object[] |null
InframonitoringtypesChecks.presentRequiredAttributes
presentRequiredAttributes:
object[] |null
InframonitoringtypesChecks.ready
ready:
boolean
InframonitoringtypesChecks.type
type:
"hosts"|"processes"|"pods"|"nodes"|"deployments"|"daemonsets"|"statefulsets"|"jobs"|"namespaces"|"clusters"|"volumes"|"kube_containers"
InframonitoringtypesCheckType
InframonitoringtypesCheckType:
"hosts"|"processes"|"pods"|"nodes"|"deployments"|"daemonsets"|"statefulsets"|"jobs"|"namespaces"|"clusters"|"volumes"|"kube_containers"
InframonitoringtypesClusterFilter
InframonitoringtypesClusterFilter:
object
InframonitoringtypesClusterFilter.expression?
optionalexpression?:string
InframonitoringtypesClusterFilter.filterByNodeReadiness?
optionalfilterByNodeReadiness?: ("ready"|"not_ready"|"no_data")[] |null
InframonitoringtypesClusterFilter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesClusterRecord
InframonitoringtypesClusterRecord:
object
InframonitoringtypesClusterRecord.clusterCPU
clusterCPU:
number
Format: double
InframonitoringtypesClusterRecord.clusterCPUAllocatable
clusterCPUAllocatable:
number
Format: double
InframonitoringtypesClusterRecord.clusterMemory
clusterMemory:
number
Format: double
InframonitoringtypesClusterRecord.clusterMemoryAllocatable
clusterMemoryAllocatable:
number
Format: double
InframonitoringtypesClusterRecord.clusterName
clusterName:
string
InframonitoringtypesClusterRecord.counts
counts:
object
InframonitoringtypesClusterRecord.counts.daemonSets
daemonSets:
number
Format: int64
InframonitoringtypesClusterRecord.counts.deployments
deployments:
number
Format: int64
InframonitoringtypesClusterRecord.counts.jobs
jobs:
number
Format: int64
InframonitoringtypesClusterRecord.counts.namespaces
namespaces:
number
Format: int64
InframonitoringtypesClusterRecord.counts.nodes
nodes:
number
Format: int64
InframonitoringtypesClusterRecord.counts.statefulSets
statefulSets:
number
Format: int64
InframonitoringtypesClusterRecord.meta
meta: {[
key:string]:string; } |null
InframonitoringtypesClusterRecord.nodeCountsByReadiness
nodeCountsByReadiness:
object
InframonitoringtypesClusterRecord.nodeCountsByReadiness.notReady
notReady:
number
InframonitoringtypesClusterRecord.nodeCountsByReadiness.ready
ready:
number
InframonitoringtypesClusterRecord.podCountsByStatus
podCountsByStatus:
object
InframonitoringtypesClusterRecord.podCountsByStatus.completed
completed:
number
InframonitoringtypesClusterRecord.podCountsByStatus.containerCannotRun
containerCannotRun:
number
InframonitoringtypesClusterRecord.podCountsByStatus.containerCreating
containerCreating:
number
InframonitoringtypesClusterRecord.podCountsByStatus.crashLoopBackOff
crashLoopBackOff:
number
InframonitoringtypesClusterRecord.podCountsByStatus.createContainerConfigError
createContainerConfigError:
number
InframonitoringtypesClusterRecord.podCountsByStatus.errImagePull
errImagePull:
number
InframonitoringtypesClusterRecord.podCountsByStatus.error
error:
number
InframonitoringtypesClusterRecord.podCountsByStatus.evicted
evicted:
number
InframonitoringtypesClusterRecord.podCountsByStatus.failed
failed:
number
InframonitoringtypesClusterRecord.podCountsByStatus.imagePullBackOff
imagePullBackOff:
number
InframonitoringtypesClusterRecord.podCountsByStatus.nodeAffinity
nodeAffinity:
number
InframonitoringtypesClusterRecord.podCountsByStatus.nodeLost
nodeLost:
number
InframonitoringtypesClusterRecord.podCountsByStatus.oomKilled
oomKilled:
number
InframonitoringtypesClusterRecord.podCountsByStatus.pending
pending:
number
InframonitoringtypesClusterRecord.podCountsByStatus.running
running:
number
InframonitoringtypesClusterRecord.podCountsByStatus.shutdown
shutdown:
number
InframonitoringtypesClusterRecord.podCountsByStatus.unexpectedAdmissionError
unexpectedAdmissionError:
number
InframonitoringtypesClusterRecord.podCountsByStatus.unknown
unknown:
number
InframonitoringtypesClusters
InframonitoringtypesClusters:
object
InframonitoringtypesClusters.endTimeBeforeRetention
endTimeBeforeRetention:
boolean
InframonitoringtypesClusters.records
records:
object[]
InframonitoringtypesClusters.total
total:
number
InframonitoringtypesClusters.type
type:
"list"|"grouped_list"
InframonitoringtypesClusters.warning?
optionalwarning?:object
InframonitoringtypesClusters.warning.message?
optionalmessage?:string
InframonitoringtypesClusters.warning.url?
optionalurl?:string
InframonitoringtypesClusters.warning.warnings?
optionalwarnings?:object[]
InframonitoringtypesContainerCountsByReady
InframonitoringtypesContainerCountsByReady:
object
InframonitoringtypesContainerCountsByReady.notReady
notReady:
number
InframonitoringtypesContainerCountsByReady.ready
ready:
number
InframonitoringtypesContainerCountsByStatus
InframonitoringtypesContainerCountsByStatus:
object
InframonitoringtypesContainerCountsByStatus.completed
completed:
number
InframonitoringtypesContainerCountsByStatus.containerCannotRun
containerCannotRun:
number
InframonitoringtypesContainerCountsByStatus.containerCreating
containerCreating:
number
InframonitoringtypesContainerCountsByStatus.crashLoopBackOff
crashLoopBackOff:
number
InframonitoringtypesContainerCountsByStatus.createContainerConfigError
createContainerConfigError:
number
InframonitoringtypesContainerCountsByStatus.errImagePull
errImagePull:
number
InframonitoringtypesContainerCountsByStatus.error
error:
number
InframonitoringtypesContainerCountsByStatus.imagePullBackOff
imagePullBackOff:
number
InframonitoringtypesContainerCountsByStatus.oomKilled
oomKilled:
number
InframonitoringtypesContainerCountsByStatus.running
running:
number
InframonitoringtypesContainerCountsByStatus.terminated
terminated:
number
InframonitoringtypesContainerCountsByStatus.unknown
unknown:
number
InframonitoringtypesContainerCountsByStatus.waiting
waiting:
number
InframonitoringtypesContainerFilter
InframonitoringtypesContainerFilter:
object
InframonitoringtypesContainerFilter.expression?
optionalexpression?:string
InframonitoringtypesContainerFilter.filterByContainerStatus?
optionalfilterByContainerStatus?: ("no_data"|"running"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"waiting"|"terminated")[] |null
InframonitoringtypesContainerReady
InframonitoringtypesContainerReady:
"ready"|"not_ready"|"no_data"
InframonitoringtypesContainerRecord
InframonitoringtypesContainerRecord:
object
InframonitoringtypesContainerRecord.containerCountsByReady
containerCountsByReady:
object
InframonitoringtypesContainerRecord.containerCountsByReady.notReady
notReady:
number
InframonitoringtypesContainerRecord.containerCountsByReady.ready
ready:
number
InframonitoringtypesContainerRecord.containerCountsByStatus
containerCountsByStatus:
object
InframonitoringtypesContainerRecord.containerCountsByStatus.completed
completed:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.containerCannotRun
containerCannotRun:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.containerCreating
containerCreating:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.crashLoopBackOff
crashLoopBackOff:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.createContainerConfigError
createContainerConfigError:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.errImagePull
errImagePull:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.error
error:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.imagePullBackOff
imagePullBackOff:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.oomKilled
oomKilled:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.running
running:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.terminated
terminated:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.unknown
unknown:
number
InframonitoringtypesContainerRecord.containerCountsByStatus.waiting
waiting:
number
InframonitoringtypesContainerRecord.containerName
containerName:
string
InframonitoringtypesContainerRecord.cpu
cpu:
number
Format: double
InframonitoringtypesContainerRecord.cpuLimitUtilization
cpuLimitUtilization:
number
Format: double
InframonitoringtypesContainerRecord.cpuRequestUtilization
cpuRequestUtilization:
number
Format: double
InframonitoringtypesContainerRecord.memory
memory:
number
Format: double
InframonitoringtypesContainerRecord.memoryLimitUtilization
memoryLimitUtilization:
number
Format: double
InframonitoringtypesContainerRecord.memoryRequestUtilization
memoryRequestUtilization:
number
Format: double
InframonitoringtypesContainerRecord.meta
meta: {[
key:string]:string; } |null
InframonitoringtypesContainerRecord.podUID
podUID:
string
InframonitoringtypesContainerRecord.ready
ready:
"ready"|"not_ready"|"no_data"
InframonitoringtypesContainerRecord.restarts
restarts:
number
Format: int64
InframonitoringtypesContainerRecord.status
status:
"no_data"|"running"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"waiting"|"terminated"
InframonitoringtypesContainers
InframonitoringtypesContainers:
object
InframonitoringtypesContainers.endTimeBeforeRetention
endTimeBeforeRetention:
boolean
InframonitoringtypesContainers.records
records:
object[]
InframonitoringtypesContainers.total
total:
number
InframonitoringtypesContainers.type
type:
"list"|"grouped_list"
InframonitoringtypesContainers.warning?
optionalwarning?:object
InframonitoringtypesContainers.warning.message?
optionalmessage?:string
InframonitoringtypesContainers.warning.url?
optionalurl?:string
InframonitoringtypesContainers.warning.warnings?
optionalwarnings?:object[]
InframonitoringtypesContainerStatus
InframonitoringtypesContainerStatus:
"no_data"|"running"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"waiting"|"terminated"
InframonitoringtypesDaemonSetFilter
InframonitoringtypesDaemonSetFilter:
object
InframonitoringtypesDaemonSetFilter.expression?
optionalexpression?:string
InframonitoringtypesDaemonSetFilter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesDaemonSetRecord
InframonitoringtypesDaemonSetRecord:
object
InframonitoringtypesDaemonSetRecord.currentNodes
currentNodes:
number
InframonitoringtypesDaemonSetRecord.daemonSetCPU
daemonSetCPU:
number
Format: double
InframonitoringtypesDaemonSetRecord.daemonSetCPULimit
daemonSetCPULimit:
number
Format: double
InframonitoringtypesDaemonSetRecord.daemonSetCPURequest
daemonSetCPURequest:
number
Format: double
InframonitoringtypesDaemonSetRecord.daemonSetMemory
daemonSetMemory:
number
Format: double
InframonitoringtypesDaemonSetRecord.daemonSetMemoryLimit
daemonSetMemoryLimit:
number
Format: double
InframonitoringtypesDaemonSetRecord.daemonSetMemoryRequest
daemonSetMemoryRequest:
number
Format: double
InframonitoringtypesDaemonSetRecord.daemonSetName
daemonSetName:
string
InframonitoringtypesDaemonSetRecord.desiredNodes
desiredNodes:
number
InframonitoringtypesDaemonSetRecord.meta
meta: {[
key:string]:string; } |null
InframonitoringtypesDaemonSetRecord.misscheduledNodes
misscheduledNodes:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus
podCountsByStatus:
object
InframonitoringtypesDaemonSetRecord.podCountsByStatus.completed
completed:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.containerCannotRun
containerCannotRun:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.containerCreating
containerCreating:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.crashLoopBackOff
crashLoopBackOff:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.createContainerConfigError
createContainerConfigError:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.errImagePull
errImagePull:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.error
error:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.evicted
evicted:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.failed
failed:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.imagePullBackOff
imagePullBackOff:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.nodeAffinity
nodeAffinity:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.nodeLost
nodeLost:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.oomKilled
oomKilled:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.pending
pending:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.running
running:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.shutdown
shutdown:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.unexpectedAdmissionError
unexpectedAdmissionError:
number
InframonitoringtypesDaemonSetRecord.podCountsByStatus.unknown
unknown:
number
InframonitoringtypesDaemonSetRecord.readyNodes
readyNodes:
number
InframonitoringtypesDaemonSets
InframonitoringtypesDaemonSets:
object
InframonitoringtypesDaemonSets.endTimeBeforeRetention
endTimeBeforeRetention:
boolean
InframonitoringtypesDaemonSets.records
records:
object[]
InframonitoringtypesDaemonSets.total
total:
number
InframonitoringtypesDaemonSets.type
type:
"list"|"grouped_list"
InframonitoringtypesDaemonSets.warning?
optionalwarning?:object
InframonitoringtypesDaemonSets.warning.message?
optionalmessage?:string
InframonitoringtypesDaemonSets.warning.url?
optionalurl?:string
InframonitoringtypesDaemonSets.warning.warnings?
optionalwarnings?:object[]
InframonitoringtypesDeploymentFilter
InframonitoringtypesDeploymentFilter:
object
InframonitoringtypesDeploymentFilter.expression?
optionalexpression?:string
InframonitoringtypesDeploymentFilter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesDeploymentRecord
InframonitoringtypesDeploymentRecord:
object
InframonitoringtypesDeploymentRecord.availablePods
availablePods:
number
InframonitoringtypesDeploymentRecord.deploymentCPU
deploymentCPU:
number
Format: double
InframonitoringtypesDeploymentRecord.deploymentCPULimit
deploymentCPULimit:
number
Format: double
InframonitoringtypesDeploymentRecord.deploymentCPURequest
deploymentCPURequest:
number
Format: double
InframonitoringtypesDeploymentRecord.deploymentMemory
deploymentMemory:
number
Format: double
InframonitoringtypesDeploymentRecord.deploymentMemoryLimit
deploymentMemoryLimit:
number
Format: double
InframonitoringtypesDeploymentRecord.deploymentMemoryRequest
deploymentMemoryRequest:
number
Format: double
InframonitoringtypesDeploymentRecord.deploymentName
deploymentName:
string
InframonitoringtypesDeploymentRecord.desiredPods
desiredPods:
number
InframonitoringtypesDeploymentRecord.meta
meta: {[
key:string]:string; } |null
InframonitoringtypesDeploymentRecord.podCountsByStatus
podCountsByStatus:
object
InframonitoringtypesDeploymentRecord.podCountsByStatus.completed
completed:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.containerCannotRun
containerCannotRun:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.containerCreating
containerCreating:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.crashLoopBackOff
crashLoopBackOff:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.createContainerConfigError
createContainerConfigError:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.errImagePull
errImagePull:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.error
error:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.evicted
evicted:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.failed
failed:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.imagePullBackOff
imagePullBackOff:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.nodeAffinity
nodeAffinity:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.nodeLost
nodeLost:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.oomKilled
oomKilled:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.pending
pending:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.running
running:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.shutdown
shutdown:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.unexpectedAdmissionError
unexpectedAdmissionError:
number
InframonitoringtypesDeploymentRecord.podCountsByStatus.unknown
unknown:
number
InframonitoringtypesDeployments
InframonitoringtypesDeployments:
object
InframonitoringtypesDeployments.endTimeBeforeRetention
endTimeBeforeRetention:
boolean
InframonitoringtypesDeployments.records
records:
object[]
InframonitoringtypesDeployments.total
total:
number
InframonitoringtypesDeployments.type
type:
"list"|"grouped_list"
InframonitoringtypesDeployments.warning?
optionalwarning?:object
InframonitoringtypesDeployments.warning.message?
optionalmessage?:string
InframonitoringtypesDeployments.warning.url?
optionalurl?:string
InframonitoringtypesDeployments.warning.warnings?
optionalwarnings?:object[]
InframonitoringtypesHostFilter
InframonitoringtypesHostFilter:
object
InframonitoringtypesHostFilter.expression?
optionalexpression?:string
InframonitoringtypesHostFilter.filterByStatus?
optionalfilterByStatus?:""|"active"|"inactive"
InframonitoringtypesHostRecord
InframonitoringtypesHostRecord:
object
InframonitoringtypesHostRecord.activeHostCount
activeHostCount:
number
InframonitoringtypesHostRecord.cpu
cpu:
number
Format: double
InframonitoringtypesHostRecord.diskUsage
diskUsage:
number
Format: double
InframonitoringtypesHostRecord.hostName
hostName:
string
InframonitoringtypesHostRecord.inactiveHostCount
inactiveHostCount:
number
InframonitoringtypesHostRecord.load15
load15:
number
Format: double
InframonitoringtypesHostRecord.memory
memory:
number
Format: double
InframonitoringtypesHostRecord.meta
meta: {[
key:string]:string; } |null
InframonitoringtypesHostRecord.status
status:
""|"active"|"inactive"
InframonitoringtypesHostRecord.wait
wait:
number
Format: double
InframonitoringtypesHosts
InframonitoringtypesHosts:
object
InframonitoringtypesHosts.endTimeBeforeRetention
endTimeBeforeRetention:
boolean
InframonitoringtypesHosts.records
records:
object[]
InframonitoringtypesHosts.total
total:
number
InframonitoringtypesHosts.type
type:
"list"|"grouped_list"
InframonitoringtypesHosts.warning?
optionalwarning?:object
InframonitoringtypesHosts.warning.message?
optionalmessage?:string
InframonitoringtypesHosts.warning.url?
optionalurl?:string
InframonitoringtypesHosts.warning.warnings?
optionalwarnings?:object[]
InframonitoringtypesHostStatus
InframonitoringtypesHostStatus:
""|"active"|"inactive"
InframonitoringtypesJobFilter
InframonitoringtypesJobFilter:
object
InframonitoringtypesJobFilter.expression?
optionalexpression?:string
InframonitoringtypesJobFilter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesJobRecord
InframonitoringtypesJobRecord:
object
InframonitoringtypesJobRecord.activePods
activePods:
number
InframonitoringtypesJobRecord.desiredSuccessfulPods
desiredSuccessfulPods:
number
InframonitoringtypesJobRecord.failedPods
failedPods:
number
InframonitoringtypesJobRecord.jobCPU
jobCPU:
number
Format: double
InframonitoringtypesJobRecord.jobCPULimit
jobCPULimit:
number
Format: double
InframonitoringtypesJobRecord.jobCPURequest
jobCPURequest:
number
Format: double
InframonitoringtypesJobRecord.jobMemory
jobMemory:
number
Format: double
InframonitoringtypesJobRecord.jobMemoryLimit
jobMemoryLimit:
number
Format: double
InframonitoringtypesJobRecord.jobMemoryRequest
jobMemoryRequest:
number
Format: double
InframonitoringtypesJobRecord.jobName
jobName:
string
InframonitoringtypesJobRecord.meta
meta: {[
key:string]:string; } |null
InframonitoringtypesJobRecord.podCountsByStatus
podCountsByStatus:
object
InframonitoringtypesJobRecord.podCountsByStatus.completed
completed:
number
InframonitoringtypesJobRecord.podCountsByStatus.containerCannotRun
containerCannotRun:
number
InframonitoringtypesJobRecord.podCountsByStatus.containerCreating
containerCreating:
number
InframonitoringtypesJobRecord.podCountsByStatus.crashLoopBackOff
crashLoopBackOff:
number
InframonitoringtypesJobRecord.podCountsByStatus.createContainerConfigError
createContainerConfigError:
number
InframonitoringtypesJobRecord.podCountsByStatus.errImagePull
errImagePull:
number
InframonitoringtypesJobRecord.podCountsByStatus.error
error:
number
InframonitoringtypesJobRecord.podCountsByStatus.evicted
evicted:
number
InframonitoringtypesJobRecord.podCountsByStatus.failed
failed:
number
InframonitoringtypesJobRecord.podCountsByStatus.imagePullBackOff
imagePullBackOff:
number
InframonitoringtypesJobRecord.podCountsByStatus.nodeAffinity
nodeAffinity:
number
InframonitoringtypesJobRecord.podCountsByStatus.nodeLost
nodeLost:
number
InframonitoringtypesJobRecord.podCountsByStatus.oomKilled
oomKilled:
number
InframonitoringtypesJobRecord.podCountsByStatus.pending
pending:
number
InframonitoringtypesJobRecord.podCountsByStatus.running
running:
number
InframonitoringtypesJobRecord.podCountsByStatus.shutdown
shutdown:
number
InframonitoringtypesJobRecord.podCountsByStatus.unexpectedAdmissionError
unexpectedAdmissionError:
number
InframonitoringtypesJobRecord.podCountsByStatus.unknown
unknown:
number
InframonitoringtypesJobRecord.successfulPods
successfulPods:
number
InframonitoringtypesJobs
InframonitoringtypesJobs:
object
InframonitoringtypesJobs.endTimeBeforeRetention
endTimeBeforeRetention:
boolean
InframonitoringtypesJobs.records
records:
object[]
InframonitoringtypesJobs.total
total:
number
InframonitoringtypesJobs.type
type:
"list"|"grouped_list"
InframonitoringtypesJobs.warning?
optionalwarning?:object
InframonitoringtypesJobs.warning.message?
optionalmessage?:string
InframonitoringtypesJobs.warning.url?
optionalurl?:string
InframonitoringtypesJobs.warning.warnings?
optionalwarnings?:object[]
InframonitoringtypesMetricsComponentEntry
InframonitoringtypesMetricsComponentEntry:
object
InframonitoringtypesMetricsComponentEntry.associatedComponent
associatedComponent:
object
InframonitoringtypesMetricsComponentEntry.associatedComponent.name
name:
string
InframonitoringtypesMetricsComponentEntry.associatedComponent.type
type:
"receiver"|"processor"
InframonitoringtypesMetricsComponentEntry.metrics
metrics:
string[] |null
InframonitoringtypesMissingAttributesComponentEntry
InframonitoringtypesMissingAttributesComponentEntry:
object
InframonitoringtypesMissingAttributesComponentEntry.associatedComponent
associatedComponent:
object
InframonitoringtypesMissingAttributesComponentEntry.associatedComponent.name
name:
string
InframonitoringtypesMissingAttributesComponentEntry.associatedComponent.type
type:
"receiver"|"processor"
InframonitoringtypesMissingAttributesComponentEntry.attributes
attributes:
string[] |null
InframonitoringtypesMissingAttributesComponentEntry.documentationLink
documentationLink:
string
InframonitoringtypesMissingAttributesComponentEntry.message
message:
string
InframonitoringtypesMissingMetricsComponentEntry
InframonitoringtypesMissingMetricsComponentEntry:
object
InframonitoringtypesMissingMetricsComponentEntry.associatedComponent
associatedComponent:
object
InframonitoringtypesMissingMetricsComponentEntry.associatedComponent.name
name:
string
InframonitoringtypesMissingMetricsComponentEntry.associatedComponent.type
type:
"receiver"|"processor"
InframonitoringtypesMissingMetricsComponentEntry.documentationLink
documentationLink:
string
InframonitoringtypesMissingMetricsComponentEntry.message
message:
string
InframonitoringtypesMissingMetricsComponentEntry.metrics
metrics:
string[] |null
InframonitoringtypesNamespaceFilter
InframonitoringtypesNamespaceFilter:
object
InframonitoringtypesNamespaceFilter.expression?
optionalexpression?:string
InframonitoringtypesNamespaceFilter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesNamespaceRecord
InframonitoringtypesNamespaceRecord:
object
InframonitoringtypesNamespaceRecord.counts
counts:
object
InframonitoringtypesNamespaceRecord.counts.daemonSets
daemonSets:
number
Format: int64
InframonitoringtypesNamespaceRecord.counts.deployments
deployments:
number
Format: int64
InframonitoringtypesNamespaceRecord.counts.jobs
jobs:
number
Format: int64
InframonitoringtypesNamespaceRecord.counts.statefulSets
statefulSets:
number
Format: int64
InframonitoringtypesNamespaceRecord.meta
meta: {[
key:string]:string; } |null
InframonitoringtypesNamespaceRecord.namespaceCPU
namespaceCPU:
number
Format: double
InframonitoringtypesNamespaceRecord.namespaceMemory
namespaceMemory:
number
Format: double
InframonitoringtypesNamespaceRecord.namespaceName
namespaceName:
string
InframonitoringtypesNamespaceRecord.podCountsByStatus
podCountsByStatus:
object
InframonitoringtypesNamespaceRecord.podCountsByStatus.completed
completed:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.containerCannotRun
containerCannotRun:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.containerCreating
containerCreating:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.crashLoopBackOff
crashLoopBackOff:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.createContainerConfigError
createContainerConfigError:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.errImagePull
errImagePull:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.error
error:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.evicted
evicted:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.failed
failed:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.imagePullBackOff
imagePullBackOff:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.nodeAffinity
nodeAffinity:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.nodeLost
nodeLost:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.oomKilled
oomKilled:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.pending
pending:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.running
running:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.shutdown
shutdown:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.unexpectedAdmissionError
unexpectedAdmissionError:
number
InframonitoringtypesNamespaceRecord.podCountsByStatus.unknown
unknown:
number
InframonitoringtypesNamespaces
InframonitoringtypesNamespaces:
object
InframonitoringtypesNamespaces.endTimeBeforeRetention
endTimeBeforeRetention:
boolean
InframonitoringtypesNamespaces.records
records:
object[]
InframonitoringtypesNamespaces.total
total:
number
InframonitoringtypesNamespaces.type
type:
"list"|"grouped_list"
InframonitoringtypesNamespaces.warning?
optionalwarning?:object
InframonitoringtypesNamespaces.warning.message?
optionalmessage?:string
InframonitoringtypesNamespaces.warning.url?
optionalurl?:string
InframonitoringtypesNamespaces.warning.warnings?
optionalwarnings?:object[]
InframonitoringtypesNodeCondition
InframonitoringtypesNodeCondition:
"ready"|"not_ready"|"no_data"
InframonitoringtypesNodeCountsByReadiness
InframonitoringtypesNodeCountsByReadiness:
object
InframonitoringtypesNodeCountsByReadiness.notReady
notReady:
number
InframonitoringtypesNodeCountsByReadiness.ready
ready:
number
InframonitoringtypesNodeFilter
InframonitoringtypesNodeFilter:
object
InframonitoringtypesNodeFilter.expression?
optionalexpression?:string
InframonitoringtypesNodeFilter.filterByNodeReadiness?
optionalfilterByNodeReadiness?: ("ready"|"not_ready"|"no_data")[] |null
InframonitoringtypesNodeFilter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesNodeRecord
InframonitoringtypesNodeRecord:
object
InframonitoringtypesNodeRecord.condition
condition:
"ready"|"not_ready"|"no_data"
InframonitoringtypesNodeRecord.meta
meta: {[
key:string]:string; } |null
InframonitoringtypesNodeRecord.nodeCountsByReadiness
nodeCountsByReadiness:
object
InframonitoringtypesNodeRecord.nodeCountsByReadiness.notReady
notReady:
number
InframonitoringtypesNodeRecord.nodeCountsByReadiness.ready
ready:
number
InframonitoringtypesNodeRecord.nodeCPU
nodeCPU:
number
Format: double
InframonitoringtypesNodeRecord.nodeCPUAllocatable
nodeCPUAllocatable:
number
Format: double
InframonitoringtypesNodeRecord.nodeMemory
nodeMemory:
number
Format: double
InframonitoringtypesNodeRecord.nodeMemoryAllocatable
nodeMemoryAllocatable:
number
Format: double
InframonitoringtypesNodeRecord.nodeName
nodeName:
string
InframonitoringtypesNodeRecord.podCountsByStatus
podCountsByStatus:
object
InframonitoringtypesNodeRecord.podCountsByStatus.completed
completed:
number
InframonitoringtypesNodeRecord.podCountsByStatus.containerCannotRun
containerCannotRun:
number
InframonitoringtypesNodeRecord.podCountsByStatus.containerCreating
containerCreating:
number
InframonitoringtypesNodeRecord.podCountsByStatus.crashLoopBackOff
crashLoopBackOff:
number
InframonitoringtypesNodeRecord.podCountsByStatus.createContainerConfigError
createContainerConfigError:
number
InframonitoringtypesNodeRecord.podCountsByStatus.errImagePull
errImagePull:
number
InframonitoringtypesNodeRecord.podCountsByStatus.error
error:
number
InframonitoringtypesNodeRecord.podCountsByStatus.evicted
evicted:
number
InframonitoringtypesNodeRecord.podCountsByStatus.failed
failed:
number
InframonitoringtypesNodeRecord.podCountsByStatus.imagePullBackOff
imagePullBackOff:
number
InframonitoringtypesNodeRecord.podCountsByStatus.nodeAffinity
nodeAffinity:
number
InframonitoringtypesNodeRecord.podCountsByStatus.nodeLost
nodeLost:
number
InframonitoringtypesNodeRecord.podCountsByStatus.oomKilled
oomKilled:
number
InframonitoringtypesNodeRecord.podCountsByStatus.pending
pending:
number
InframonitoringtypesNodeRecord.podCountsByStatus.running
running:
number
InframonitoringtypesNodeRecord.podCountsByStatus.shutdown
shutdown:
number
InframonitoringtypesNodeRecord.podCountsByStatus.unexpectedAdmissionError
unexpectedAdmissionError:
number
InframonitoringtypesNodeRecord.podCountsByStatus.unknown
unknown:
number
InframonitoringtypesNodes
InframonitoringtypesNodes:
object
InframonitoringtypesNodes.endTimeBeforeRetention
endTimeBeforeRetention:
boolean
InframonitoringtypesNodes.records
records:
object[]
InframonitoringtypesNodes.total
total:
number
InframonitoringtypesNodes.type
type:
"list"|"grouped_list"
InframonitoringtypesNodes.warning?
optionalwarning?:object
InframonitoringtypesNodes.warning.message?
optionalmessage?:string
InframonitoringtypesNodes.warning.url?
optionalurl?:string
InframonitoringtypesNodes.warning.warnings?
optionalwarnings?:object[]
InframonitoringtypesPodCountsByStatus
InframonitoringtypesPodCountsByStatus:
object
InframonitoringtypesPodCountsByStatus.completed
completed:
number
InframonitoringtypesPodCountsByStatus.containerCannotRun
containerCannotRun:
number
InframonitoringtypesPodCountsByStatus.containerCreating
containerCreating:
number
InframonitoringtypesPodCountsByStatus.crashLoopBackOff
crashLoopBackOff:
number
InframonitoringtypesPodCountsByStatus.createContainerConfigError
createContainerConfigError:
number
InframonitoringtypesPodCountsByStatus.errImagePull
errImagePull:
number
InframonitoringtypesPodCountsByStatus.error
error:
number
InframonitoringtypesPodCountsByStatus.evicted
evicted:
number
InframonitoringtypesPodCountsByStatus.failed
failed:
number
InframonitoringtypesPodCountsByStatus.imagePullBackOff
imagePullBackOff:
number
InframonitoringtypesPodCountsByStatus.nodeAffinity
nodeAffinity:
number
InframonitoringtypesPodCountsByStatus.nodeLost
nodeLost:
number
InframonitoringtypesPodCountsByStatus.oomKilled
oomKilled:
number
InframonitoringtypesPodCountsByStatus.pending
pending:
number
InframonitoringtypesPodCountsByStatus.running
running:
number
InframonitoringtypesPodCountsByStatus.shutdown
shutdown:
number
InframonitoringtypesPodCountsByStatus.unexpectedAdmissionError
unexpectedAdmissionError:
number
InframonitoringtypesPodCountsByStatus.unknown
unknown:
number
InframonitoringtypesPodFilter
InframonitoringtypesPodFilter:
object
InframonitoringtypesPodFilter.expression?
optionalexpression?:string
InframonitoringtypesPodFilter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesPodRecord
InframonitoringtypesPodRecord:
object
InframonitoringtypesPodRecord.meta
meta: {[
key:string]:string; } |null
InframonitoringtypesPodRecord.podAge
podAge:
number
Format: int64
InframonitoringtypesPodRecord.podCountsByStatus
podCountsByStatus:
object
InframonitoringtypesPodRecord.podCountsByStatus.completed
completed:
number
InframonitoringtypesPodRecord.podCountsByStatus.containerCannotRun
containerCannotRun:
number
InframonitoringtypesPodRecord.podCountsByStatus.containerCreating
containerCreating:
number
InframonitoringtypesPodRecord.podCountsByStatus.crashLoopBackOff
crashLoopBackOff:
number
InframonitoringtypesPodRecord.podCountsByStatus.createContainerConfigError
createContainerConfigError:
number
InframonitoringtypesPodRecord.podCountsByStatus.errImagePull
errImagePull:
number
InframonitoringtypesPodRecord.podCountsByStatus.error
error:
number
InframonitoringtypesPodRecord.podCountsByStatus.evicted
evicted:
number
InframonitoringtypesPodRecord.podCountsByStatus.failed
failed:
number
InframonitoringtypesPodRecord.podCountsByStatus.imagePullBackOff
imagePullBackOff:
number
InframonitoringtypesPodRecord.podCountsByStatus.nodeAffinity
nodeAffinity:
number
InframonitoringtypesPodRecord.podCountsByStatus.nodeLost
nodeLost:
number
InframonitoringtypesPodRecord.podCountsByStatus.oomKilled
oomKilled:
number
InframonitoringtypesPodRecord.podCountsByStatus.pending
pending:
number
InframonitoringtypesPodRecord.podCountsByStatus.running
running:
number
InframonitoringtypesPodRecord.podCountsByStatus.shutdown
shutdown:
number
InframonitoringtypesPodRecord.podCountsByStatus.unexpectedAdmissionError
unexpectedAdmissionError:
number
InframonitoringtypesPodRecord.podCountsByStatus.unknown
unknown:
number
InframonitoringtypesPodRecord.podCPU
podCPU:
number
Format: double
InframonitoringtypesPodRecord.podCPULimit
podCPULimit:
number
Format: double
InframonitoringtypesPodRecord.podCPURequest
podCPURequest:
number
Format: double
InframonitoringtypesPodRecord.podMemory
podMemory:
number
Format: double
InframonitoringtypesPodRecord.podMemoryLimit
podMemoryLimit:
number
Format: double
InframonitoringtypesPodRecord.podMemoryRequest
podMemoryRequest:
number
Format: double
InframonitoringtypesPodRecord.podRestarts
podRestarts:
number
Format: int64
InframonitoringtypesPodRecord.podStatus
podStatus:
"no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror"
InframonitoringtypesPodRecord.podUID
podUID:
string
InframonitoringtypesPods
InframonitoringtypesPods:
object
InframonitoringtypesPods.endTimeBeforeRetention
endTimeBeforeRetention:
boolean
InframonitoringtypesPods.records
records:
object[]
InframonitoringtypesPods.total
total:
number
InframonitoringtypesPods.type
type:
"list"|"grouped_list"
InframonitoringtypesPods.warning?
optionalwarning?:object
InframonitoringtypesPods.warning.message?
optionalmessage?:string
InframonitoringtypesPods.warning.url?
optionalurl?:string
InframonitoringtypesPods.warning.warnings?
optionalwarnings?:object[]
InframonitoringtypesPodStatus
InframonitoringtypesPodStatus:
"no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror"
InframonitoringtypesPostableClusters
InframonitoringtypesPostableClusters:
object
InframonitoringtypesPostableClusters.end
end:
number
Format: int64
InframonitoringtypesPostableClusters.filter?
optionalfilter?:object
InframonitoringtypesPostableClusters.filter.expression?
optionalexpression?:string
InframonitoringtypesPostableClusters.filter.filterByNodeReadiness?
optionalfilterByNodeReadiness?: ("ready"|"not_ready"|"no_data")[] |null
InframonitoringtypesPostableClusters.filter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesPostableClusters.groupBy?
optionalgroupBy?:object[] |null
InframonitoringtypesPostableClusters.limit
limit:
number
InframonitoringtypesPostableClusters.offset?
optionaloffset?:number
InframonitoringtypesPostableClusters.orderBy?
optionalorderBy?:object
InframonitoringtypesPostableClusters.orderBy.direction?
optionaldirection?:"asc"|"desc"
InframonitoringtypesPostableClusters.orderBy.key?
optionalkey?:object
InframonitoringtypesPostableClusters.orderBy.key.description?
optionaldescription?:string
InframonitoringtypesPostableClusters.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
InframonitoringtypesPostableClusters.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
InframonitoringtypesPostableClusters.orderBy.key.name
name:
string
InframonitoringtypesPostableClusters.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
InframonitoringtypesPostableClusters.orderBy.key.unit?
optionalunit?:string
InframonitoringtypesPostableClusters.start
start:
number
Format: int64
InframonitoringtypesPostableContainers
InframonitoringtypesPostableContainers:
object
InframonitoringtypesPostableContainers.end
end:
number
Format: int64
InframonitoringtypesPostableContainers.filter?
optionalfilter?:object
InframonitoringtypesPostableContainers.filter.expression?
optionalexpression?:string
InframonitoringtypesPostableContainers.filter.filterByContainerStatus?
optionalfilterByContainerStatus?: ("no_data"|"running"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"waiting"|"terminated")[] |null
InframonitoringtypesPostableContainers.groupBy?
optionalgroupBy?:object[] |null
InframonitoringtypesPostableContainers.limit
limit:
number
InframonitoringtypesPostableContainers.offset?
optionaloffset?:number
InframonitoringtypesPostableContainers.orderBy?
optionalorderBy?:object
InframonitoringtypesPostableContainers.orderBy.direction?
optionaldirection?:"asc"|"desc"
InframonitoringtypesPostableContainers.orderBy.key?
optionalkey?:object
InframonitoringtypesPostableContainers.orderBy.key.description?
optionaldescription?:string
InframonitoringtypesPostableContainers.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
InframonitoringtypesPostableContainers.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
InframonitoringtypesPostableContainers.orderBy.key.name
name:
string
InframonitoringtypesPostableContainers.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
InframonitoringtypesPostableContainers.orderBy.key.unit?
optionalunit?:string
InframonitoringtypesPostableContainers.start
start:
number
Format: int64
InframonitoringtypesPostableDaemonSets
InframonitoringtypesPostableDaemonSets:
object
InframonitoringtypesPostableDaemonSets.end
end:
number
Format: int64
InframonitoringtypesPostableDaemonSets.filter?
optionalfilter?:object
InframonitoringtypesPostableDaemonSets.filter.expression?
optionalexpression?:string
InframonitoringtypesPostableDaemonSets.filter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesPostableDaemonSets.groupBy?
optionalgroupBy?:object[] |null
InframonitoringtypesPostableDaemonSets.limit
limit:
number
InframonitoringtypesPostableDaemonSets.offset?
optionaloffset?:number
InframonitoringtypesPostableDaemonSets.orderBy?
optionalorderBy?:object
InframonitoringtypesPostableDaemonSets.orderBy.direction?
optionaldirection?:"asc"|"desc"
InframonitoringtypesPostableDaemonSets.orderBy.key?
optionalkey?:object
InframonitoringtypesPostableDaemonSets.orderBy.key.description?
optionaldescription?:string
InframonitoringtypesPostableDaemonSets.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
InframonitoringtypesPostableDaemonSets.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
InframonitoringtypesPostableDaemonSets.orderBy.key.name
name:
string
InframonitoringtypesPostableDaemonSets.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
InframonitoringtypesPostableDaemonSets.orderBy.key.unit?
optionalunit?:string
InframonitoringtypesPostableDaemonSets.start
start:
number
Format: int64
InframonitoringtypesPostableDeployments
InframonitoringtypesPostableDeployments:
object
InframonitoringtypesPostableDeployments.end
end:
number
Format: int64
InframonitoringtypesPostableDeployments.filter?
optionalfilter?:object
InframonitoringtypesPostableDeployments.filter.expression?
optionalexpression?:string
InframonitoringtypesPostableDeployments.filter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesPostableDeployments.groupBy?
optionalgroupBy?:object[] |null
InframonitoringtypesPostableDeployments.limit
limit:
number
InframonitoringtypesPostableDeployments.offset?
optionaloffset?:number
InframonitoringtypesPostableDeployments.orderBy?
optionalorderBy?:object
InframonitoringtypesPostableDeployments.orderBy.direction?
optionaldirection?:"asc"|"desc"
InframonitoringtypesPostableDeployments.orderBy.key?
optionalkey?:object
InframonitoringtypesPostableDeployments.orderBy.key.description?
optionaldescription?:string
InframonitoringtypesPostableDeployments.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
InframonitoringtypesPostableDeployments.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
InframonitoringtypesPostableDeployments.orderBy.key.name
name:
string
InframonitoringtypesPostableDeployments.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
InframonitoringtypesPostableDeployments.orderBy.key.unit?
optionalunit?:string
InframonitoringtypesPostableDeployments.start
start:
number
Format: int64
InframonitoringtypesPostableHosts
InframonitoringtypesPostableHosts:
object
InframonitoringtypesPostableHosts.end
end:
number
Format: int64
InframonitoringtypesPostableHosts.filter?
optionalfilter?:object
InframonitoringtypesPostableHosts.filter.expression?
optionalexpression?:string
InframonitoringtypesPostableHosts.filter.filterByStatus?
optionalfilterByStatus?:""|"active"|"inactive"
InframonitoringtypesPostableHosts.groupBy?
optionalgroupBy?:object[] |null
InframonitoringtypesPostableHosts.limit
limit:
number
InframonitoringtypesPostableHosts.offset?
optionaloffset?:number
InframonitoringtypesPostableHosts.orderBy?
optionalorderBy?:object
InframonitoringtypesPostableHosts.orderBy.direction?
optionaldirection?:"asc"|"desc"
InframonitoringtypesPostableHosts.orderBy.key?
optionalkey?:object
InframonitoringtypesPostableHosts.orderBy.key.description?
optionaldescription?:string
InframonitoringtypesPostableHosts.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
InframonitoringtypesPostableHosts.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
InframonitoringtypesPostableHosts.orderBy.key.name
name:
string
InframonitoringtypesPostableHosts.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
InframonitoringtypesPostableHosts.orderBy.key.unit?
optionalunit?:string
InframonitoringtypesPostableHosts.start
start:
number
Format: int64
InframonitoringtypesPostableJobs
InframonitoringtypesPostableJobs:
object
InframonitoringtypesPostableJobs.end
end:
number
Format: int64
InframonitoringtypesPostableJobs.filter?
optionalfilter?:object
InframonitoringtypesPostableJobs.filter.expression?
optionalexpression?:string
InframonitoringtypesPostableJobs.filter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesPostableJobs.groupBy?
optionalgroupBy?:object[] |null
InframonitoringtypesPostableJobs.limit
limit:
number
InframonitoringtypesPostableJobs.offset?
optionaloffset?:number
InframonitoringtypesPostableJobs.orderBy?
optionalorderBy?:object
InframonitoringtypesPostableJobs.orderBy.direction?
optionaldirection?:"asc"|"desc"
InframonitoringtypesPostableJobs.orderBy.key?
optionalkey?:object
InframonitoringtypesPostableJobs.orderBy.key.description?
optionaldescription?:string
InframonitoringtypesPostableJobs.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
InframonitoringtypesPostableJobs.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
InframonitoringtypesPostableJobs.orderBy.key.name
name:
string
InframonitoringtypesPostableJobs.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
InframonitoringtypesPostableJobs.orderBy.key.unit?
optionalunit?:string
InframonitoringtypesPostableJobs.start
start:
number
Format: int64
InframonitoringtypesPostableNamespaces
InframonitoringtypesPostableNamespaces:
object
InframonitoringtypesPostableNamespaces.end
end:
number
Format: int64
InframonitoringtypesPostableNamespaces.filter?
optionalfilter?:object
InframonitoringtypesPostableNamespaces.filter.expression?
optionalexpression?:string
InframonitoringtypesPostableNamespaces.filter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesPostableNamespaces.groupBy?
optionalgroupBy?:object[] |null
InframonitoringtypesPostableNamespaces.limit
limit:
number
InframonitoringtypesPostableNamespaces.offset?
optionaloffset?:number
InframonitoringtypesPostableNamespaces.orderBy?
optionalorderBy?:object
InframonitoringtypesPostableNamespaces.orderBy.direction?
optionaldirection?:"asc"|"desc"
InframonitoringtypesPostableNamespaces.orderBy.key?
optionalkey?:object
InframonitoringtypesPostableNamespaces.orderBy.key.description?
optionaldescription?:string
InframonitoringtypesPostableNamespaces.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
InframonitoringtypesPostableNamespaces.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
InframonitoringtypesPostableNamespaces.orderBy.key.name
name:
string
InframonitoringtypesPostableNamespaces.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
InframonitoringtypesPostableNamespaces.orderBy.key.unit?
optionalunit?:string
InframonitoringtypesPostableNamespaces.start
start:
number
Format: int64
InframonitoringtypesPostableNodes
InframonitoringtypesPostableNodes:
object
InframonitoringtypesPostableNodes.end
end:
number
Format: int64
InframonitoringtypesPostableNodes.filter?
optionalfilter?:object
InframonitoringtypesPostableNodes.filter.expression?
optionalexpression?:string
InframonitoringtypesPostableNodes.filter.filterByNodeReadiness?
optionalfilterByNodeReadiness?: ("ready"|"not_ready"|"no_data")[] |null
InframonitoringtypesPostableNodes.filter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesPostableNodes.groupBy?
optionalgroupBy?:object[] |null
InframonitoringtypesPostableNodes.limit
limit:
number
InframonitoringtypesPostableNodes.offset?
optionaloffset?:number
InframonitoringtypesPostableNodes.orderBy?
optionalorderBy?:object
InframonitoringtypesPostableNodes.orderBy.direction?
optionaldirection?:"asc"|"desc"
InframonitoringtypesPostableNodes.orderBy.key?
optionalkey?:object
InframonitoringtypesPostableNodes.orderBy.key.description?
optionaldescription?:string
InframonitoringtypesPostableNodes.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
InframonitoringtypesPostableNodes.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
InframonitoringtypesPostableNodes.orderBy.key.name
name:
string
InframonitoringtypesPostableNodes.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
InframonitoringtypesPostableNodes.orderBy.key.unit?
optionalunit?:string
InframonitoringtypesPostableNodes.start
start:
number
Format: int64
InframonitoringtypesPostablePods
InframonitoringtypesPostablePods:
object
InframonitoringtypesPostablePods.end
end:
number
Format: int64
InframonitoringtypesPostablePods.filter?
optionalfilter?:object
InframonitoringtypesPostablePods.filter.expression?
optionalexpression?:string
InframonitoringtypesPostablePods.filter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesPostablePods.groupBy?
optionalgroupBy?:object[] |null
InframonitoringtypesPostablePods.limit
limit:
number
InframonitoringtypesPostablePods.offset?
optionaloffset?:number
InframonitoringtypesPostablePods.orderBy?
optionalorderBy?:object
InframonitoringtypesPostablePods.orderBy.direction?
optionaldirection?:"asc"|"desc"
InframonitoringtypesPostablePods.orderBy.key?
optionalkey?:object
InframonitoringtypesPostablePods.orderBy.key.description?
optionaldescription?:string
InframonitoringtypesPostablePods.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
InframonitoringtypesPostablePods.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
InframonitoringtypesPostablePods.orderBy.key.name
name:
string
InframonitoringtypesPostablePods.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
InframonitoringtypesPostablePods.orderBy.key.unit?
optionalunit?:string
InframonitoringtypesPostablePods.start
start:
number
Format: int64
InframonitoringtypesPostableStatefulSets
InframonitoringtypesPostableStatefulSets:
object
InframonitoringtypesPostableStatefulSets.end
end:
number
Format: int64
InframonitoringtypesPostableStatefulSets.filter?
optionalfilter?:object
InframonitoringtypesPostableStatefulSets.filter.expression?
optionalexpression?:string
InframonitoringtypesPostableStatefulSets.filter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesPostableStatefulSets.groupBy?
optionalgroupBy?:object[] |null
InframonitoringtypesPostableStatefulSets.limit
limit:
number
InframonitoringtypesPostableStatefulSets.offset?
optionaloffset?:number
InframonitoringtypesPostableStatefulSets.orderBy?
optionalorderBy?:object
InframonitoringtypesPostableStatefulSets.orderBy.direction?
optionaldirection?:"asc"|"desc"
InframonitoringtypesPostableStatefulSets.orderBy.key?
optionalkey?:object
InframonitoringtypesPostableStatefulSets.orderBy.key.description?
optionaldescription?:string
InframonitoringtypesPostableStatefulSets.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
InframonitoringtypesPostableStatefulSets.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
InframonitoringtypesPostableStatefulSets.orderBy.key.name
name:
string
InframonitoringtypesPostableStatefulSets.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
InframonitoringtypesPostableStatefulSets.orderBy.key.unit?
optionalunit?:string
InframonitoringtypesPostableStatefulSets.start
start:
number
Format: int64
InframonitoringtypesPostableVolumes
InframonitoringtypesPostableVolumes:
object
InframonitoringtypesPostableVolumes.end
end:
number
Format: int64
InframonitoringtypesPostableVolumes.filter?
optionalfilter?:object
InframonitoringtypesPostableVolumes.filter.expression?
optionalexpression?:string
InframonitoringtypesPostableVolumes.groupBy?
optionalgroupBy?:object[] |null
InframonitoringtypesPostableVolumes.limit
limit:
number
InframonitoringtypesPostableVolumes.offset?
optionaloffset?:number
InframonitoringtypesPostableVolumes.orderBy?
optionalorderBy?:object
InframonitoringtypesPostableVolumes.orderBy.direction?
optionaldirection?:"asc"|"desc"
InframonitoringtypesPostableVolumes.orderBy.key?
optionalkey?:object
InframonitoringtypesPostableVolumes.orderBy.key.description?
optionaldescription?:string
InframonitoringtypesPostableVolumes.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
InframonitoringtypesPostableVolumes.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
InframonitoringtypesPostableVolumes.orderBy.key.name
name:
string
InframonitoringtypesPostableVolumes.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
InframonitoringtypesPostableVolumes.orderBy.key.unit?
optionalunit?:string
InframonitoringtypesPostableVolumes.start
start:
number
Format: int64
InframonitoringtypesResponseType
InframonitoringtypesResponseType:
"list"|"grouped_list"
InframonitoringtypesStatefulSetFilter
InframonitoringtypesStatefulSetFilter:
object
InframonitoringtypesStatefulSetFilter.expression?
optionalexpression?:string
InframonitoringtypesStatefulSetFilter.filterByPodStatus?
optionalfilterByPodStatus?: ("no_data"|"pending"|"running"|"failed"|"unknown"|"crashloopbackoff"|"imagepullbackoff"|"errimagepull"|"createcontainerconfigerror"|"containercreating"|"oomkilled"|"completed"|"error"|"containercannotrun"|"evicted"|"nodeaffinity"|"nodelost"|"shutdown"|"unexpectedadmissionerror")[] |null
InframonitoringtypesStatefulSetRecord
InframonitoringtypesStatefulSetRecord:
object
InframonitoringtypesStatefulSetRecord.currentPods
currentPods:
number
InframonitoringtypesStatefulSetRecord.desiredPods
desiredPods:
number
InframonitoringtypesStatefulSetRecord.meta
meta: {[
key:string]:string; } |null
InframonitoringtypesStatefulSetRecord.podCountsByStatus
podCountsByStatus:
object
InframonitoringtypesStatefulSetRecord.podCountsByStatus.completed
completed:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.containerCannotRun
containerCannotRun:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.containerCreating
containerCreating:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.crashLoopBackOff
crashLoopBackOff:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.createContainerConfigError
createContainerConfigError:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.errImagePull
errImagePull:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.error
error:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.evicted
evicted:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.failed
failed:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.imagePullBackOff
imagePullBackOff:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.nodeAffinity
nodeAffinity:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.nodeLost
nodeLost:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.oomKilled
oomKilled:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.pending
pending:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.running
running:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.shutdown
shutdown:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.unexpectedAdmissionError
unexpectedAdmissionError:
number
InframonitoringtypesStatefulSetRecord.podCountsByStatus.unknown
unknown:
number
InframonitoringtypesStatefulSetRecord.statefulSetCPU
statefulSetCPU:
number
Format: double
InframonitoringtypesStatefulSetRecord.statefulSetCPULimit
statefulSetCPULimit:
number
Format: double
InframonitoringtypesStatefulSetRecord.statefulSetCPURequest
statefulSetCPURequest:
number
Format: double
InframonitoringtypesStatefulSetRecord.statefulSetMemory
statefulSetMemory:
number
Format: double
InframonitoringtypesStatefulSetRecord.statefulSetMemoryLimit
statefulSetMemoryLimit:
number
Format: double
InframonitoringtypesStatefulSetRecord.statefulSetMemoryRequest
statefulSetMemoryRequest:
number
Format: double
InframonitoringtypesStatefulSetRecord.statefulSetName
statefulSetName:
string
InframonitoringtypesStatefulSets
InframonitoringtypesStatefulSets:
object
InframonitoringtypesStatefulSets.endTimeBeforeRetention
endTimeBeforeRetention:
boolean
InframonitoringtypesStatefulSets.records
records:
object[]
InframonitoringtypesStatefulSets.total
total:
number
InframonitoringtypesStatefulSets.type
type:
"list"|"grouped_list"
InframonitoringtypesStatefulSets.warning?
optionalwarning?:object
InframonitoringtypesStatefulSets.warning.message?
optionalmessage?:string
InframonitoringtypesStatefulSets.warning.url?
optionalurl?:string
InframonitoringtypesStatefulSets.warning.warnings?
optionalwarnings?:object[]
InframonitoringtypesVolumeRecord
InframonitoringtypesVolumeRecord:
object
InframonitoringtypesVolumeRecord.meta
meta: {[
key:string]:string; } |null
InframonitoringtypesVolumeRecord.persistentVolumeClaimName
persistentVolumeClaimName:
string
InframonitoringtypesVolumeRecord.volumeAvailable
volumeAvailable:
number
Format: double
InframonitoringtypesVolumeRecord.volumeCapacity
volumeCapacity:
number
Format: double
InframonitoringtypesVolumeRecord.volumeInodes
volumeInodes:
number
Format: double
InframonitoringtypesVolumeRecord.volumeInodesFree
volumeInodesFree:
number
Format: double
InframonitoringtypesVolumeRecord.volumeInodesUsed
volumeInodesUsed:
number
Format: double
InframonitoringtypesVolumeRecord.volumeUsage
volumeUsage:
number
Format: double
InframonitoringtypesVolumes
InframonitoringtypesVolumes:
object
InframonitoringtypesVolumes.endTimeBeforeRetention
endTimeBeforeRetention:
boolean
InframonitoringtypesVolumes.records
records:
object[]
InframonitoringtypesVolumes.total
total:
number
InframonitoringtypesVolumes.type
type:
"list"|"grouped_list"
InframonitoringtypesVolumes.warning?
optionalwarning?:object
InframonitoringtypesVolumes.warning.message?
optionalmessage?:string
InframonitoringtypesVolumes.warning.url?
optionalurl?:string
InframonitoringtypesVolumes.warning.warnings?
optionalwarnings?:object[]
LicensetypesFeature
LicensetypesFeature:
object
LicensetypesFeature.active?
optionalactive?:boolean
LicensetypesFeature.name?
optionalname?:string
LicensetypesFeature.route?
optionalroute?:string
LicensetypesFeature.usage?
optionalusage?:number
Format: int64
LicensetypesFeature.usage_limit?
optionalusage_limit?:number
Format: int64
LicensetypesGettableActiveLicense
LicensetypesGettableActiveLicense:
object
LicensetypesGettableActiveLicense.createdAt
createdAt:
string
Format: date-time
LicensetypesGettableActiveLicense.eventQueue
eventQueue:
object
LicensetypesGettableActiveLicense.eventQueue.createdAt
createdAt:
string
Format: date-time
LicensetypesGettableActiveLicense.eventQueue.event
event:
string
LicensetypesGettableActiveLicense.eventQueue.scheduledAt
scheduledAt:
string
Format: date-time
LicensetypesGettableActiveLicense.eventQueue.status
status:
string
LicensetypesGettableActiveLicense.eventQueue.updatedAt
updatedAt:
string
Format: date-time
LicensetypesGettableActiveLicense.features
features:
object[]
LicensetypesGettableActiveLicense.freeUntil
freeUntil:
string
Format: date-time
LicensetypesGettableActiveLicense.id
id:
string
LicensetypesGettableActiveLicense.plan
plan:
object
LicensetypesGettableActiveLicense.plan.createdAt
createdAt:
string
Format: date-time
LicensetypesGettableActiveLicense.plan.description
description:
string
LicensetypesGettableActiveLicense.plan.id
id:
string
LicensetypesGettableActiveLicense.plan.isActive
isActive:
boolean
LicensetypesGettableActiveLicense.plan.name
name:
string
LicensetypesGettableActiveLicense.plan.updatedAt
updatedAt:
string
Format: date-time
LicensetypesGettableActiveLicense.platform
platform:
string
LicensetypesGettableActiveLicense.state
state:
string
LicensetypesGettableActiveLicense.status
status:
string
LicensetypesGettableActiveLicense.updatedAt
updatedAt:
string
Format: date-time
LicensetypesGettableActiveLicense.validFrom
validFrom:
number
Format: int64
LicensetypesGettableActiveLicense.validUntil
validUntil:
number
Format: int64
LicensetypesGettableLicense
LicensetypesGettableLicense:
object
LicensetypesGettableLicense.createdAt
createdAt:
string
Format: date-time
LicensetypesGettableLicense.eventQueue
eventQueue:
object
LicensetypesGettableLicense.eventQueue.createdAt
createdAt:
string
Format: date-time
LicensetypesGettableLicense.eventQueue.event
event:
string
LicensetypesGettableLicense.eventQueue.scheduledAt
scheduledAt:
string
Format: date-time
LicensetypesGettableLicense.eventQueue.status
status:
string
LicensetypesGettableLicense.eventQueue.updatedAt
updatedAt:
string
Format: date-time
LicensetypesGettableLicense.features
features:
object[]
LicensetypesGettableLicense.freeUntil
freeUntil:
string
Format: date-time
LicensetypesGettableLicense.id
id:
string
LicensetypesGettableLicense.plan
plan:
object
LicensetypesGettableLicense.plan.createdAt
createdAt:
string
Format: date-time
LicensetypesGettableLicense.plan.description
description:
string
LicensetypesGettableLicense.plan.id
id:
string
LicensetypesGettableLicense.plan.isActive
isActive:
boolean
LicensetypesGettableLicense.plan.name
name:
string
LicensetypesGettableLicense.plan.updatedAt
updatedAt:
string
Format: date-time
LicensetypesGettableLicense.platform
platform:
string
LicensetypesGettableLicense.state
state:
string
LicensetypesGettableLicense.status
status:
string
LicensetypesGettableLicense.updatedAt
updatedAt:
string
Format: date-time
LicensetypesGettableLicense.validFrom
validFrom:
number
Format: int64
LicensetypesGettableLicense.validUntil
validUntil:
number
Format: int64
LicensetypesGettableLicenseWithKey
LicensetypesGettableLicenseWithKey:
object
LicensetypesGettableLicenseWithKey.createdAt
createdAt:
string
Format: date-time
LicensetypesGettableLicenseWithKey.eventQueue
eventQueue:
object
LicensetypesGettableLicenseWithKey.eventQueue.createdAt
createdAt:
string
Format: date-time
LicensetypesGettableLicenseWithKey.eventQueue.event
event:
string
LicensetypesGettableLicenseWithKey.eventQueue.scheduledAt
scheduledAt:
string
Format: date-time
LicensetypesGettableLicenseWithKey.eventQueue.status
status:
string
LicensetypesGettableLicenseWithKey.eventQueue.updatedAt
updatedAt:
string
Format: date-time
LicensetypesGettableLicenseWithKey.features
features:
object[]
LicensetypesGettableLicenseWithKey.freeUntil
freeUntil:
string
Format: date-time
LicensetypesGettableLicenseWithKey.id
id:
string
LicensetypesGettableLicenseWithKey.key
key:
string
Format: password
LicensetypesGettableLicenseWithKey.plan
plan:
object
LicensetypesGettableLicenseWithKey.plan.createdAt
createdAt:
string
Format: date-time
LicensetypesGettableLicenseWithKey.plan.description
description:
string
LicensetypesGettableLicenseWithKey.plan.id
id:
string
LicensetypesGettableLicenseWithKey.plan.isActive
isActive:
boolean
LicensetypesGettableLicenseWithKey.plan.name
name:
string
LicensetypesGettableLicenseWithKey.plan.updatedAt
updatedAt:
string
Format: date-time
LicensetypesGettableLicenseWithKey.platform
platform:
string
LicensetypesGettableLicenseWithKey.state
state:
string
LicensetypesGettableLicenseWithKey.status
status:
string
LicensetypesGettableLicenseWithKey.updatedAt
updatedAt:
string
Format: date-time
LicensetypesGettableLicenseWithKey.validFrom
validFrom:
number
Format: int64
LicensetypesGettableLicenseWithKey.validUntil
validUntil:
number
Format: int64
LicensetypesLicenseEventQueue
LicensetypesLicenseEventQueue:
object
LicensetypesLicenseEventQueue.createdAt
createdAt:
string
Format: date-time
LicensetypesLicenseEventQueue.event
event:
string
LicensetypesLicenseEventQueue.scheduledAt
scheduledAt:
string
Format: date-time
LicensetypesLicenseEventQueue.status
status:
string
LicensetypesLicenseEventQueue.updatedAt
updatedAt:
string
Format: date-time
LicensetypesLicensePlan
LicensetypesLicensePlan:
object
LicensetypesLicensePlan.createdAt
createdAt:
string
Format: date-time
LicensetypesLicensePlan.description
description:
string
LicensetypesLicensePlan.id
id:
string
LicensetypesLicensePlan.isActive
isActive:
boolean
LicensetypesLicensePlan.name
name:
string
LicensetypesLicensePlan.updatedAt
updatedAt:
string
Format: date-time
LicensetypesPostableLicense
LicensetypesPostableLicense:
object
LicensetypesPostableLicense.key?
optionalkey?:string
Format: password
LlmpricingruletypesGettablePricingRules
LlmpricingruletypesGettablePricingRules:
object
LlmpricingruletypesGettablePricingRules.items
items:
object[] |null
LlmpricingruletypesGettablePricingRules.limit
limit:
number
LlmpricingruletypesGettablePricingRules.offset
offset:
number
LlmpricingruletypesGettablePricingRules.total
total:
number
LlmpricingruletypesGettableUnmappedModels
LlmpricingruletypesGettableUnmappedModels:
object
LlmpricingruletypesGettableUnmappedModels.items
items:
object[] |null
LlmpricingruletypesLLMPricingCacheCosts
LlmpricingruletypesLLMPricingCacheCosts:
object
LlmpricingruletypesLLMPricingCacheCosts.mode
mode:
"unknown"|"subtract"|"additive"
LlmpricingruletypesLLMPricingCacheCosts.read?
optionalread?:number
Format: double
LlmpricingruletypesLLMPricingCacheCosts.write?
optionalwrite?:number
Format: double
LlmpricingruletypesLLMPricingRule
LlmpricingruletypesLLMPricingRule:
object
LlmpricingruletypesLLMPricingRule.createdAt?
optionalcreatedAt?:string
Format: date-time
LlmpricingruletypesLLMPricingRule.createdBy?
optionalcreatedBy?:string
LlmpricingruletypesLLMPricingRule.enabled
enabled:
boolean
LlmpricingruletypesLLMPricingRule.id
id:
string
LlmpricingruletypesLLMPricingRule.isOverride
isOverride:
boolean
LlmpricingruletypesLLMPricingRule.modelName
modelName:
string
LlmpricingruletypesLLMPricingRule.modelPattern
modelPattern:
string[] |null
LlmpricingruletypesLLMPricingRule.orgId
orgId:
string
LlmpricingruletypesLLMPricingRule.pricing
pricing:
object
LlmpricingruletypesLLMPricingRule.pricing.cache?
optionalcache?:object
LlmpricingruletypesLLMPricingRule.pricing.cache.mode
mode:
"unknown"|"subtract"|"additive"
LlmpricingruletypesLLMPricingRule.pricing.cache.read?
optionalread?:number
Format: double
LlmpricingruletypesLLMPricingRule.pricing.cache.write?
optionalwrite?:number
Format: double
LlmpricingruletypesLLMPricingRule.pricing.input
input:
number
Format: double
LlmpricingruletypesLLMPricingRule.pricing.output
output:
number
Format: double
LlmpricingruletypesLLMPricingRule.provider
provider:
string
LlmpricingruletypesLLMPricingRule.sourceId?
optionalsourceId?:string
LlmpricingruletypesLLMPricingRule.syncedAt?
optionalsyncedAt?:string|null
Format: date-time
LlmpricingruletypesLLMPricingRule.unit
unit:
"per_million_tokens"
LlmpricingruletypesLLMPricingRule.updatedAt?
optionalupdatedAt?:string
Format: date-time
LlmpricingruletypesLLMPricingRule.updatedBy?
optionalupdatedBy?:string
LlmpricingruletypesLLMPricingRuleCacheMode
LlmpricingruletypesLLMPricingRuleCacheMode:
"unknown"|"subtract"|"additive"
LlmpricingruletypesLLMPricingRuleUnit
LlmpricingruletypesLLMPricingRuleUnit:
"per_million_tokens"
LlmpricingruletypesLLMRulePricing
LlmpricingruletypesLLMRulePricing:
object
LlmpricingruletypesLLMRulePricing.cache?
optionalcache?:object
LlmpricingruletypesLLMRulePricing.cache.mode
mode:
"unknown"|"subtract"|"additive"
LlmpricingruletypesLLMRulePricing.cache.read?
optionalread?:number
Format: double
LlmpricingruletypesLLMRulePricing.cache.write?
optionalwrite?:number
Format: double
LlmpricingruletypesLLMRulePricing.input
input:
number
Format: double
LlmpricingruletypesLLMRulePricing.output
output:
number
Format: double
LlmpricingruletypesStringSlice
LlmpricingruletypesStringSlice:
string[] |null
LlmpricingruletypesUnmappedModel
LlmpricingruletypesUnmappedModel:
object
LlmpricingruletypesUnmappedModel.modelName
modelName:
string
LlmpricingruletypesUnmappedModel.provider?
optionalprovider?:string
LlmpricingruletypesUnmappedModel.spanCount
spanCount:
number
LlmpricingruletypesUpdatableLLMPricingRule
LlmpricingruletypesUpdatableLLMPricingRule:
object
LlmpricingruletypesUpdatableLLMPricingRule.enabled
enabled:
boolean
LlmpricingruletypesUpdatableLLMPricingRule.id?
optionalid?:string|null
LlmpricingruletypesUpdatableLLMPricingRule.isOverride?
optionalisOverride?:boolean|null
LlmpricingruletypesUpdatableLLMPricingRule.modelName
modelName:
string
LlmpricingruletypesUpdatableLLMPricingRule.modelPattern
modelPattern:
string[] |null
LlmpricingruletypesUpdatableLLMPricingRule.pricing
pricing:
object
LlmpricingruletypesUpdatableLLMPricingRule.pricing.cache?
optionalcache?:object
LlmpricingruletypesUpdatableLLMPricingRule.pricing.cache.mode
mode:
"unknown"|"subtract"|"additive"
LlmpricingruletypesUpdatableLLMPricingRule.pricing.cache.read?
optionalread?:number
Format: double
LlmpricingruletypesUpdatableLLMPricingRule.pricing.cache.write?
optionalwrite?:number
Format: double
LlmpricingruletypesUpdatableLLMPricingRule.pricing.input
input:
number
Format: double
LlmpricingruletypesUpdatableLLMPricingRule.pricing.output
output:
number
Format: double
LlmpricingruletypesUpdatableLLMPricingRule.provider
provider:
string
LlmpricingruletypesUpdatableLLMPricingRule.sourceId?
optionalsourceId?:string|null
LlmpricingruletypesUpdatableLLMPricingRule.unit
unit:
"per_million_tokens"
LlmpricingruletypesUpdatableLLMPricingRules
LlmpricingruletypesUpdatableLLMPricingRules:
object
LlmpricingruletypesUpdatableLLMPricingRules.rules
rules:
object[] |null
MetricreductionruletypesAffectedAsset
MetricreductionruletypesAffectedAsset:
object
MetricreductionruletypesAffectedAsset.id
id:
string
MetricreductionruletypesAffectedAsset.impactedLabels
impactedLabels:
string[] |null
MetricreductionruletypesAffectedAsset.name
name:
string
MetricreductionruletypesAffectedAsset.type
type:
"dashboard"|"alert_rule"
MetricreductionruletypesAffectedAsset.widget?
optionalwidget?:object
MetricreductionruletypesAffectedAsset.widget.id
id:
string
MetricreductionruletypesAffectedAsset.widget.name
name:
string
MetricreductionruletypesAffectedWidget
MetricreductionruletypesAffectedWidget:
object
MetricreductionruletypesAffectedWidget.id
id:
string
MetricreductionruletypesAffectedWidget.name
name:
string
MetricreductionruletypesAssetType
MetricreductionruletypesAssetType:
"dashboard"|"alert_rule"
MetricreductionruletypesGettableReductionRule
MetricreductionruletypesGettableReductionRule:
object
MetricreductionruletypesGettableReductionRule.active
active:
boolean
MetricreductionruletypesGettableReductionRule.createdAt?
optionalcreatedAt?:string
Format: date-time
MetricreductionruletypesGettableReductionRule.createdBy?
optionalcreatedBy?:string
MetricreductionruletypesGettableReductionRule.effectiveFrom
effectiveFrom:
string
Format: date-time
MetricreductionruletypesGettableReductionRule.id
id:
string
MetricreductionruletypesGettableReductionRule.ingestedSamples
ingestedSamples:
number
MetricreductionruletypesGettableReductionRule.ingestedSeries
ingestedSeries:
number
MetricreductionruletypesGettableReductionRule.labels
labels:
string[] |null
MetricreductionruletypesGettableReductionRule.matchType
matchType:
"drop"|"keep"
MetricreductionruletypesGettableReductionRule.metricName
metricName:
string
MetricreductionruletypesGettableReductionRule.retainedSamples
retainedSamples:
number
MetricreductionruletypesGettableReductionRule.retainedSeries
retainedSeries:
number
MetricreductionruletypesGettableReductionRule.updatedAt?
optionalupdatedAt?:string
Format: date-time
MetricreductionruletypesGettableReductionRule.updatedBy?
optionalupdatedBy?:string
MetricreductionruletypesGettableReductionRulePreview
MetricreductionruletypesGettableReductionRulePreview:
object
MetricreductionruletypesGettableReductionRulePreview.affectedAssets
affectedAssets:
object[] |null
MetricreductionruletypesGettableReductionRulePreview.currentRetainedSeries
currentRetainedSeries:
number
MetricreductionruletypesGettableReductionRulePreview.droppedLabels
droppedLabels:
string[] |null
MetricreductionruletypesGettableReductionRulePreview.effectiveFrom
effectiveFrom:
string
Format: date-time
MetricreductionruletypesGettableReductionRulePreview.ingestedSeries
ingestedSeries:
number
MetricreductionruletypesGettableReductionRulePreview.reductionPercent
reductionPercent:
number
Format: double
MetricreductionruletypesGettableReductionRulePreview.retainedSeries
retainedSeries:
number
MetricreductionruletypesGettableReductionRules
MetricreductionruletypesGettableReductionRules:
object
MetricreductionruletypesGettableReductionRules.rules
rules:
object[] |null
MetricreductionruletypesGettableReductionRules.total
total:
number
MetricreductionruletypesGettableReductionRuleStats
MetricreductionruletypesGettableReductionRuleStats:
object
MetricreductionruletypesGettableReductionRuleStats.estimatedMonthlySavingsUsd
estimatedMonthlySavingsUsd:
number
Format: double
MetricreductionruletypesGettableReductionRuleStats.ingestedSamples
ingestedSamples:
number
MetricreductionruletypesGettableReductionRuleStats.ingestedSeries
ingestedSeries:
number
MetricreductionruletypesGettableReductionRuleStats.retainedSamples
retainedSamples:
number
MetricreductionruletypesGettableReductionRuleStats.retainedSeries
retainedSeries:
number
MetricreductionruletypesMatchType
MetricreductionruletypesMatchType:
"drop"|"keep"
MetricreductionruletypesOrder
MetricreductionruletypesOrder:
"asc"|"desc"
MetricreductionruletypesPostableReductionRule
MetricreductionruletypesPostableReductionRule:
object
MetricreductionruletypesPostableReductionRule.labels
labels:
string[] |null
MetricreductionruletypesPostableReductionRule.matchType
matchType:
"drop"|"keep"
MetricreductionruletypesPostableReductionRule.metricName
metricName:
string
MetricreductionruletypesPostableReductionRulePreview
MetricreductionruletypesPostableReductionRulePreview:
object
MetricreductionruletypesPostableReductionRulePreview.labels
labels:
string[] |null
MetricreductionruletypesPostableReductionRulePreview.lookbackMs?
optionallookbackMs?:number
Format: int64
MetricreductionruletypesPostableReductionRulePreview.matchType
matchType:
"drop"|"keep"
MetricreductionruletypesPostableReductionRulePreview.metricName
metricName:
string
MetricreductionruletypesReductionRuleOrderBy
MetricreductionruletypesReductionRuleOrderBy:
"metric"|"ingested_volume"|"reduced_volume"|"last_updated"
MetricreductionruletypesUpdatableReductionRule
MetricreductionruletypesUpdatableReductionRule:
object
MetricreductionruletypesUpdatableReductionRule.labels
labels:
string[] |null
MetricreductionruletypesUpdatableReductionRule.matchType
matchType:
"drop"|"keep"
MetricsexplorertypesInspectMetricsRequest
MetricsexplorertypesInspectMetricsRequest:
object
MetricsexplorertypesInspectMetricsRequest.end
end:
number
Format: int64
MetricsexplorertypesInspectMetricsRequest.filter?
optionalfilter?:object
MetricsexplorertypesInspectMetricsRequest.filter.expression?
optionalexpression?:string
MetricsexplorertypesInspectMetricsRequest.metricName
metricName:
string
MetricsexplorertypesInspectMetricsRequest.start
start:
number
Format: int64
MetricsexplorertypesInspectMetricsResponse
MetricsexplorertypesInspectMetricsResponse:
object
MetricsexplorertypesInspectMetricsResponse.series
series:
object[] |null
MetricsexplorertypesListMetric
MetricsexplorertypesListMetric:
object
MetricsexplorertypesListMetric.description
description:
string
MetricsexplorertypesListMetric.isMonotonic
isMonotonic:
boolean
MetricsexplorertypesListMetric.metricName
metricName:
string
MetricsexplorertypesListMetric.temporality
temporality:
""|"delta"|"cumulative"|"unspecified"
MetricsexplorertypesListMetric.type
type:
"sum"|"gauge"|"histogram"|"summary"|"exponentialhistogram"
MetricsexplorertypesListMetric.unit
unit:
string
MetricsexplorertypesListMetricsResponse
MetricsexplorertypesListMetricsResponse:
object
MetricsexplorertypesListMetricsResponse.metrics
metrics:
object[] |null
MetricsexplorertypesMetricAlert
MetricsexplorertypesMetricAlert:
object
MetricsexplorertypesMetricAlert.alertId
alertId:
string
MetricsexplorertypesMetricAlert.alertName
alertName:
string
MetricsexplorertypesMetricAlertsResponse
MetricsexplorertypesMetricAlertsResponse:
object
MetricsexplorertypesMetricAlertsResponse.alerts
alerts:
object[] |null
MetricsexplorertypesMetricAttribute
MetricsexplorertypesMetricAttribute:
object
MetricsexplorertypesMetricAttribute.key
key:
string
MetricsexplorertypesMetricAttribute.valueCount
valueCount:
number
MetricsexplorertypesMetricAttribute.values
values:
string[] |null
MetricsexplorertypesMetricAttributesResponse
MetricsexplorertypesMetricAttributesResponse:
object
MetricsexplorertypesMetricAttributesResponse.attributes
attributes:
object[] |null
MetricsexplorertypesMetricAttributesResponse.totalKeys
totalKeys:
number
Format: int64
MetricsexplorertypesMetricDashboard
MetricsexplorertypesMetricDashboard:
object
MetricsexplorertypesMetricDashboard.dashboardId
dashboardId:
string
MetricsexplorertypesMetricDashboard.dashboardName
dashboardName:
string
MetricsexplorertypesMetricDashboard.widgetId
widgetId:
string
MetricsexplorertypesMetricDashboard.widgetName
widgetName:
string
MetricsexplorertypesMetricDashboardPanelsResponse
MetricsexplorertypesMetricDashboardPanelsResponse:
object
MetricsexplorertypesMetricDashboardPanelsResponse.dashboards
dashboards:
object[] |null
MetricsexplorertypesMetricDashboardsResponse
MetricsexplorertypesMetricDashboardsResponse:
object
MetricsexplorertypesMetricDashboardsResponse.dashboards
dashboards:
object[] |null
MetricsexplorertypesMetricHighlightsResponse
MetricsexplorertypesMetricHighlightsResponse:
object
MetricsexplorertypesMetricHighlightsResponse.activeTimeSeries
activeTimeSeries:
number
MetricsexplorertypesMetricHighlightsResponse.dataPoints
dataPoints:
number
MetricsexplorertypesMetricHighlightsResponse.lastReceived
lastReceived:
number
MetricsexplorertypesMetricHighlightsResponse.totalTimeSeries
totalTimeSeries:
number
MetricsexplorertypesMetricMetadata
MetricsexplorertypesMetricMetadata:
object
MetricsexplorertypesMetricMetadata.description
description:
string
MetricsexplorertypesMetricMetadata.isMonotonic
isMonotonic:
boolean
MetricsexplorertypesMetricMetadata.temporality
temporality:
""|"delta"|"cumulative"|"unspecified"
MetricsexplorertypesMetricMetadata.type
type:
"sum"|"gauge"|"histogram"|"summary"|"exponentialhistogram"
MetricsexplorertypesMetricMetadata.unit
unit:
string
MetricsexplorertypesMetricsOnboardingResponse
MetricsexplorertypesMetricsOnboardingResponse:
object
MetricsexplorertypesMetricsOnboardingResponse.hasMetrics
hasMetrics:
boolean
MetricsexplorertypesStat
MetricsexplorertypesStat:
object
MetricsexplorertypesStat.description
description:
string
MetricsexplorertypesStat.metricName
metricName:
string
MetricsexplorertypesStat.samples
samples:
number
MetricsexplorertypesStat.timeseries
timeseries:
number
MetricsexplorertypesStat.type
type:
"sum"|"gauge"|"histogram"|"summary"|"exponentialhistogram"
MetricsexplorertypesStat.unit
unit:
string
MetricsexplorertypesStatsRequest
MetricsexplorertypesStatsRequest:
object
MetricsexplorertypesStatsRequest.end
end:
number
Format: int64
MetricsexplorertypesStatsRequest.filter?
optionalfilter?:object
MetricsexplorertypesStatsRequest.filter.expression?
optionalexpression?:string
MetricsexplorertypesStatsRequest.limit
limit:
number
MetricsexplorertypesStatsRequest.offset?
optionaloffset?:number
MetricsexplorertypesStatsRequest.orderBy?
optionalorderBy?:object
MetricsexplorertypesStatsRequest.orderBy.direction?
optionaldirection?:"asc"|"desc"
MetricsexplorertypesStatsRequest.orderBy.key?
optionalkey?:object
MetricsexplorertypesStatsRequest.orderBy.key.description?
optionaldescription?:string
MetricsexplorertypesStatsRequest.orderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
MetricsexplorertypesStatsRequest.orderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
MetricsexplorertypesStatsRequest.orderBy.key.name
name:
string
MetricsexplorertypesStatsRequest.orderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
MetricsexplorertypesStatsRequest.orderBy.key.unit?
optionalunit?:string
MetricsexplorertypesStatsRequest.start
start:
number
Format: int64
MetricsexplorertypesStatsResponse
MetricsexplorertypesStatsResponse:
object
MetricsexplorertypesStatsResponse.metrics
metrics:
object[] |null
MetricsexplorertypesStatsResponse.total
total:
number
MetricsexplorertypesTreemapEntry
MetricsexplorertypesTreemapEntry:
object
MetricsexplorertypesTreemapEntry.metricName
metricName:
string
MetricsexplorertypesTreemapEntry.percentage
percentage:
number
Format: double
MetricsexplorertypesTreemapEntry.totalValue
totalValue:
number
MetricsexplorertypesTreemapMode
MetricsexplorertypesTreemapMode:
"timeseries"|"samples"
MetricsexplorertypesTreemapRequest
MetricsexplorertypesTreemapRequest:
object
MetricsexplorertypesTreemapRequest.end
end:
number
Format: int64
MetricsexplorertypesTreemapRequest.filter?
optionalfilter?:object
MetricsexplorertypesTreemapRequest.filter.expression?
optionalexpression?:string
MetricsexplorertypesTreemapRequest.limit
limit:
number
MetricsexplorertypesTreemapRequest.mode
mode:
"timeseries"|"samples"
MetricsexplorertypesTreemapRequest.start
start:
number
Format: int64
MetricsexplorertypesTreemapResponse
MetricsexplorertypesTreemapResponse:
object
MetricsexplorertypesTreemapResponse.samples
samples:
object[] |null
MetricsexplorertypesTreemapResponse.timeseries
timeseries:
object[] |null
MetricsexplorertypesUpdateMetricMetadataRequest
MetricsexplorertypesUpdateMetricMetadataRequest:
object
MetricsexplorertypesUpdateMetricMetadataRequest.description
description:
string
MetricsexplorertypesUpdateMetricMetadataRequest.isMonotonic
isMonotonic:
boolean
MetricsexplorertypesUpdateMetricMetadataRequest.metricName
metricName:
string
MetricsexplorertypesUpdateMetricMetadataRequest.temporality
temporality:
""|"delta"|"cumulative"|"unspecified"
MetricsexplorertypesUpdateMetricMetadataRequest.type
type:
"sum"|"gauge"|"histogram"|"summary"|"exponentialhistogram"
MetricsexplorertypesUpdateMetricMetadataRequest.unit
unit:
string
MetrictypesComparisonSpaceAggregationParam
MetrictypesComparisonSpaceAggregationParam:
object
MetrictypesComparisonSpaceAggregationParam.operator
operator:
string
MetrictypesComparisonSpaceAggregationParam.threshold
threshold:
number
Format: double
MetrictypesSpaceAggregation
MetrictypesSpaceAggregation:
"sum"|"count"|"avg"|"min"|"max"|"p50"|"p75"|"p90"|"p95"|"p99"
MetrictypesTemporality
MetrictypesTemporality:
""|"delta"|"cumulative"|"unspecified"
MetrictypesTimeAggregation
MetrictypesTimeAggregation:
""|"sum"|"count"|"avg"|"min"|"max"|"latest"|"count_distinct"|"rate"|"increase"
MetrictypesType
MetrictypesType:
"sum"|"gauge"|"histogram"|"summary"|"exponentialhistogram"
ModelDuration
ModelDuration:
number
Format: int64
ModelLabelSet
ModelLabelSet:
object
Index Signature
[key: string]: string
PreferencetypesPreference
PreferencetypesPreference:
object
PreferencetypesPreference.allowedScopes?
optionalallowedScopes?:string[] |null
PreferencetypesPreference.allowedValues?
optionalallowedValues?:string[] |null
PreferencetypesPreference.defaultValue?
optionaldefaultValue?:Record<string,never>
PreferencetypesPreference.description?
optionaldescription?:string
PreferencetypesPreference.name?
optionalname?:string
PreferencetypesPreference.value?
optionalvalue?:Record<string,never>
PreferencetypesPreference.valueType?
optionalvalueType?:string
PreferencetypesUpdatablePreference
PreferencetypesUpdatablePreference:
object
PreferencetypesUpdatablePreference.value?
optionalvalue?:unknown
PreferencetypesValue
PreferencetypesValue:
Record<string,never>
PrometheusErrorResponseSchema
PrometheusErrorResponseSchema:
object
PrometheusErrorResponseSchema.error
error:
string
PrometheusErrorResponseSchema.errorType
errorType:
"bad_data"|"execution"|"canceled"|"timeout"|"internal"
PrometheusErrorResponseSchema.status
status:
"error"
PrometheusMatrixDataSchema
PrometheusMatrixDataSchema:
object
PrometheusMatrixDataSchema.result
result:
object[] |null
PrometheusMatrixDataSchema.resultType
resultType:
"matrix"
PrometheusMatrixSeriesSchema
PrometheusMatrixSeriesSchema:
object
PrometheusMatrixSeriesSchema.metric
metric: {[
key:string]:string; } |null
PrometheusMatrixSeriesSchema.values
values: ((
string|number)[] |null)[] |null
PrometheusQueryDataSchema
PrometheusQueryDataSchema: {
result:object[] |null;resultType:"matrix"; } | {result:object[] |null;resultType:"vector"; } | {result: (string|number)[] |null;resultType:"scalar"; } | {result: (string|number)[] |null;resultType:"string"; }
PrometheusSamplePairSchema
PrometheusSamplePairSchema: (
string|number)[] |null
Description
A [timestamp, value] pair: float unix seconds, then the string-encoded sample value ("NaN", "+Inf", "-Inf" included).
PrometheusScalarDataSchema
PrometheusScalarDataSchema:
object
PrometheusScalarDataSchema.result
result: (
string|number)[] |null
PrometheusScalarDataSchema.resultType
resultType:
"scalar"
PrometheusStringDataSchema
PrometheusStringDataSchema:
object
PrometheusStringDataSchema.result
result: (
string|number)[] |null
PrometheusStringDataSchema.resultType
resultType:
"string"
PrometheusSuccessResponseSchema
PrometheusSuccessResponseSchema:
object
PrometheusSuccessResponseSchema.data
data: {
result:object[] |null;resultType:"matrix"; } | {result:object[] |null;resultType:"vector"; } | {result: (string|number)[] |null;resultType:"scalar"; } | {result: (string|number)[] |null;resultType:"string"; }
PrometheusSuccessResponseSchema.infos?
optionalinfos?:string[]
PrometheusSuccessResponseSchema.status
status:
"success"
PrometheusSuccessResponseSchema.warnings?
optionalwarnings?:string[]
PrometheusVectorDataSchema
PrometheusVectorDataSchema:
object
PrometheusVectorDataSchema.result
result:
object[] |null
PrometheusVectorDataSchema.resultType
resultType:
"vector"
PrometheusVectorSampleSchema
PrometheusVectorSampleSchema:
object
PrometheusVectorSampleSchema.metric
metric: {[
key:string]:string; } |null
PrometheusVectorSampleSchema.value
value: (
string|number)[] |null
PromotetypesPromotePath
PromotetypesPromotePath:
object
PromotetypesPromotePath.indexes?
optionalindexes?:object[]
PromotetypesPromotePath.path?
optionalpath?:string
PromotetypesPromotePath.promote?
optionalpromote?:boolean
PromotetypesWrappedIndex
PromotetypesWrappedIndex:
object
PromotetypesWrappedIndex.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
PromotetypesWrappedIndex.granularity?
optionalgranularity?:number
PromotetypesWrappedIndex.type?
optionaltype?:string
Querybuildertypesv5AggregationBucket
Querybuildertypesv5AggregationBucket:
object
Querybuildertypesv5AggregationBucket.alias?
optionalalias?:string
Querybuildertypesv5AggregationBucket.anomalyScores?
optionalanomalyScores?:object[]
Querybuildertypesv5AggregationBucket.index?
optionalindex?:number
Querybuildertypesv5AggregationBucket.lowerBoundSeries?
optionallowerBoundSeries?:object[]
Querybuildertypesv5AggregationBucket.meta?
optionalmeta?:object
Querybuildertypesv5AggregationBucket.meta.buckets?
optionalbuckets?:number[]
Querybuildertypesv5AggregationBucket.meta.unit?
optionalunit?:string
Querybuildertypesv5AggregationBucket.predictedSeries?
optionalpredictedSeries?:object[]
Querybuildertypesv5AggregationBucket.series?
optionalseries?:object[] |null
Querybuildertypesv5AggregationBucket.upperBoundSeries?
optionalupperBoundSeries?:object[]
Querybuildertypesv5AggregationMeta
Querybuildertypesv5AggregationMeta:
object
Querybuildertypesv5AggregationMeta.buckets?
optionalbuckets?:number[]
Querybuildertypesv5AggregationMeta.unit?
optionalunit?:string
Querybuildertypesv5BucketOptions
Querybuildertypesv5BucketOptions: {
kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
Querybuildertypesv5BucketOptionsLinear
Querybuildertypesv5BucketOptionsLinear:
object
Querybuildertypesv5BucketOptionsLinear.kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5BucketOptionsLinear.spec
spec:
object
Querybuildertypesv5BucketOptionsLinear.spec.maxValue
maxValue:
number
Format: double
Querybuildertypesv5BucketOptionsLinear.spec.numBuckets?
optionalnumBuckets?:number
Querybuildertypesv5BucketOptionsLog
Querybuildertypesv5BucketOptionsLog:
object
Querybuildertypesv5BucketOptionsLog.kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5BucketOptionsLog.spec
spec:
object
Querybuildertypesv5BucketOptionsLog.spec.scale?
optionalscale?:number|null
Querybuildertypesv5BucketsKind
Querybuildertypesv5BucketsKind:
"log"|"linear"
Querybuildertypesv5BuilderQuerySpec
Querybuildertypesv5BuilderQuerySpec: {
aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; }
Union Members
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"logs"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"metrics"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"traces"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Querybuildertypesv5ClickHouseQuery
Querybuildertypesv5ClickHouseQuery:
object
Querybuildertypesv5ClickHouseQuery.disabled?
optionaldisabled?:boolean
Querybuildertypesv5ClickHouseQuery.legend?
optionallegend?:string
Querybuildertypesv5ClickHouseQuery.name?
optionalname?:string
Querybuildertypesv5ClickHouseQuery.query?
optionalquery?:string
Querybuildertypesv5ColumnDescriptor
Querybuildertypesv5ColumnDescriptor:
object
Querybuildertypesv5ColumnDescriptor.aggregationIndex?
optionalaggregationIndex?:number
Format: int64
Querybuildertypesv5ColumnDescriptor.columnType?
optionalcolumnType?:"group"|"aggregation"
Querybuildertypesv5ColumnDescriptor.description?
optionaldescription?:string
Querybuildertypesv5ColumnDescriptor.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
Querybuildertypesv5ColumnDescriptor.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
Querybuildertypesv5ColumnDescriptor.meta?
optionalmeta?:object
Querybuildertypesv5ColumnDescriptor.meta.unit?
optionalunit?:string
Querybuildertypesv5ColumnDescriptor.name
name:
string
Querybuildertypesv5ColumnDescriptor.queryName?
optionalqueryName?:string
Querybuildertypesv5ColumnDescriptor.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
Querybuildertypesv5ColumnDescriptor.unit?
optionalunit?:string
Querybuildertypesv5ColumnType
Querybuildertypesv5ColumnType:
"group"|"aggregation"
Querybuildertypesv5CompositeQuery
Querybuildertypesv5CompositeQuery:
object
Description
Composite query containing one or more query envelopes. Each query envelope specifies its type and corresponding spec.
Querybuildertypesv5CompositeQuery.queries?
optionalqueries?: ({spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_query"; } | {spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };disabled?:boolean;expression?:string;functions?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;name?:string;order?:object[] |null; };type:"builder_formula"; } | {spec?: {aggregations?:object[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;name?:string;offset?:number;order?:object[] |null;returnSpansFrom?:string;selectFields?:object[] |null;stepInterval?:string|number; };type:"builder_trace_operator"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; };type:"promql"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string; };type:"clickhouse_sql"; })[] |null
Querybuildertypesv5ExecStats
Querybuildertypesv5ExecStats:
object
Description
Execution statistics for the query, including rows scanned, bytes scanned, and duration.
Querybuildertypesv5ExecStats.bytesScanned?
optionalbytesScanned?:number
Querybuildertypesv5ExecStats.durationMs?
optionaldurationMs?:number
Querybuildertypesv5ExecStats.rowsScanned?
optionalrowsScanned?:number
Querybuildertypesv5ExecStats.stepIntervals?
optionalstepIntervals?:object
Index Signature
[key: string]: number
Querybuildertypesv5Filter
Querybuildertypesv5Filter:
object
Querybuildertypesv5Filter.expression?
optionalexpression?:string
Querybuildertypesv5FormatOptions
Querybuildertypesv5FormatOptions:
object
Querybuildertypesv5FormatOptions.fillGaps?
optionalfillGaps?:boolean
Querybuildertypesv5FormatOptions.formatTableResultForUI?
optionalformatTableResultForUI?:boolean
Querybuildertypesv5Function
Querybuildertypesv5Function:
object
Querybuildertypesv5Function.args?
optionalargs?:object[] |null
Querybuildertypesv5Function.name?
optionalname?:"cutoffmin"|"cutoffmax"|"clampmin"|"clampmax"|"absolute"|"runningdiff"|"log2"|"log10"|"cumulativesum"|"ewma3"|"ewma5"|"ewma7"|"median3"|"median5"|"median7"|"timeshift"|"anomaly"|"fillzero"
Querybuildertypesv5FunctionArg
Querybuildertypesv5FunctionArg:
object
Querybuildertypesv5FunctionArg.name?
optionalname?:string
Querybuildertypesv5FunctionArg.value?
optionalvalue?:string|number
Querybuildertypesv5FunctionName
Querybuildertypesv5FunctionName:
"cutoffmin"|"cutoffmax"|"clampmin"|"clampmax"|"absolute"|"runningdiff"|"log2"|"log10"|"cumulativesum"|"ewma3"|"ewma5"|"ewma7"|"median3"|"median5"|"median7"|"timeshift"|"anomaly"|"fillzero"
Querybuildertypesv5GroupByKey
Querybuildertypesv5GroupByKey:
object
Querybuildertypesv5GroupByKey.description?
optionaldescription?:string
Querybuildertypesv5GroupByKey.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
Querybuildertypesv5GroupByKey.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
Querybuildertypesv5GroupByKey.name
name:
string
Querybuildertypesv5GroupByKey.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
Querybuildertypesv5GroupByKey.unit?
optionalunit?:string
Querybuildertypesv5Having
Querybuildertypesv5Having:
object
Querybuildertypesv5Having.expression?
optionalexpression?:string
Querybuildertypesv5Label
Querybuildertypesv5Label:
object
Querybuildertypesv5Label.key?
optionalkey?:object
Querybuildertypesv5Label.key.description?
optionaldescription?:string
Querybuildertypesv5Label.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
Querybuildertypesv5Label.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
Querybuildertypesv5Label.key.name
name:
string
Querybuildertypesv5Label.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
Querybuildertypesv5Label.key.unit?
optionalunit?:string
Querybuildertypesv5Label.value?
optionalvalue?:string|number|boolean
Querybuildertypesv5LimitBy
Querybuildertypesv5LimitBy:
object
Querybuildertypesv5LimitBy.keys?
optionalkeys?:string[] |null
Querybuildertypesv5LimitBy.value?
optionalvalue?:string
Querybuildertypesv5LinearBucketsSpec
Querybuildertypesv5LinearBucketsSpec:
object
Querybuildertypesv5LinearBucketsSpec.maxValue
maxValue:
number
Format: double
Querybuildertypesv5LinearBucketsSpec.numBuckets?
optionalnumBuckets?:number
Querybuildertypesv5LogAggregation
Querybuildertypesv5LogAggregation:
object
Querybuildertypesv5LogAggregation.alias?
optionalalias?:string
Querybuildertypesv5LogAggregation.expression?
optionalexpression?:string
Querybuildertypesv5LogBucketsSpec
Querybuildertypesv5LogBucketsSpec:
object
Querybuildertypesv5LogBucketsSpec.scale?
optionalscale?:number|null
Querybuildertypesv5MetricAggregation
Querybuildertypesv5MetricAggregation:
object
Querybuildertypesv5MetricAggregation.comparisonSpaceAggregationParam?
optionalcomparisonSpaceAggregationParam?:object
Querybuildertypesv5MetricAggregation.comparisonSpaceAggregationParam.operator
operator:
string
Querybuildertypesv5MetricAggregation.comparisonSpaceAggregationParam.threshold
threshold:
number
Format: double
Querybuildertypesv5MetricAggregation.metricName?
optionalmetricName?:string
Querybuildertypesv5MetricAggregation.reduceTo?
optionalreduceTo?:"sum"|"count"|"avg"|"min"|"max"|"last"|"median"
Querybuildertypesv5MetricAggregation.spaceAggregation?
optionalspaceAggregation?:"sum"|"count"|"avg"|"min"|"max"|"p50"|"p75"|"p90"|"p95"|"p99"
Querybuildertypesv5MetricAggregation.temporality?
optionaltemporality?:""|"delta"|"cumulative"|"unspecified"
Querybuildertypesv5MetricAggregation.timeAggregation?
optionaltimeAggregation?:""|"sum"|"count"|"avg"|"min"|"max"|"latest"|"count_distinct"|"rate"|"increase"
Querybuildertypesv5OrderBy
Querybuildertypesv5OrderBy:
object
Querybuildertypesv5OrderBy.direction?
optionaldirection?:"asc"|"desc"
Querybuildertypesv5OrderBy.key?
optionalkey?:object
Querybuildertypesv5OrderBy.key.description?
optionaldescription?:string
Querybuildertypesv5OrderBy.key.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
Querybuildertypesv5OrderBy.key.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
Querybuildertypesv5OrderBy.key.name
name:
string
Querybuildertypesv5OrderBy.key.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
Querybuildertypesv5OrderBy.key.unit?
optionalunit?:string
Querybuildertypesv5OrderByKey
Querybuildertypesv5OrderByKey:
object
Querybuildertypesv5OrderByKey.description?
optionaldescription?:string
Querybuildertypesv5OrderByKey.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
Querybuildertypesv5OrderByKey.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
Querybuildertypesv5OrderByKey.name
name:
string
Querybuildertypesv5OrderByKey.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
Querybuildertypesv5OrderByKey.unit?
optionalunit?:string
Querybuildertypesv5OrderDirection
Querybuildertypesv5OrderDirection:
"asc"|"desc"
Querybuildertypesv5PreviewStatement
Querybuildertypesv5PreviewStatement:
object
Querybuildertypesv5PreviewStatement.db.statement.args
db.statement.args:
unknown[]
Querybuildertypesv5PreviewStatement.db.statement.query
db.statement.query:
string
Querybuildertypesv5PreviewStatement.estimate
estimate:
object[]
Querybuildertypesv5PreviewStatement.granules
granules: {
initial:number;reads:object[];selected:number;skipped:number; } |null
Union Members
Type Literal
{ initial: number; reads: object[]; selected: number; skipped: number; }
initial
initial:
number
Format: int64
reads
reads:
object[]
selected
selected:
number
Format: int64
skipped
skipped:
number
Format: int64
null
Querybuildertypesv5PromQuery
Querybuildertypesv5PromQuery:
object
Querybuildertypesv5PromQuery.disabled?
optionaldisabled?:boolean
Querybuildertypesv5PromQuery.legend?
optionallegend?:string
Querybuildertypesv5PromQuery.name?
optionalname?:string
Querybuildertypesv5PromQuery.query?
optionalquery?:string
Querybuildertypesv5PromQuery.stats?
optionalstats?:boolean
Querybuildertypesv5PromQuery.step?
optionalstep?:string|number
Querybuildertypesv5QueryBuilderFormula
Querybuildertypesv5QueryBuilderFormula:
object
Querybuildertypesv5QueryBuilderFormula.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
Querybuildertypesv5QueryBuilderFormula.disabled?
optionaldisabled?:boolean
Querybuildertypesv5QueryBuilderFormula.expression?
optionalexpression?:string
Querybuildertypesv5QueryBuilderFormula.functions?
optionalfunctions?:object[] |null
Querybuildertypesv5QueryBuilderFormula.having?
optionalhaving?:object
Querybuildertypesv5QueryBuilderFormula.having.expression?
optionalexpression?:string
Querybuildertypesv5QueryBuilderFormula.legend?
optionallegend?:string
Querybuildertypesv5QueryBuilderFormula.limit?
optionallimit?:number
Querybuildertypesv5QueryBuilderFormula.name?
optionalname?:string
Querybuildertypesv5QueryBuilderFormula.order?
optionalorder?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation:
object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.aggregations?
optionalaggregations?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.cursor?
optionalcursor?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.disabled?
optionaldisabled?:boolean
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.filter?
optionalfilter?:object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.filter.expression?
optionalexpression?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.functions?
optionalfunctions?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.groupBy?
optionalgroupBy?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.having?
optionalhaving?:object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.having.expression?
optionalexpression?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.legend?
optionallegend?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.limit?
optionallimit?:number
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.limitBy?
optionallimitBy?:object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.limitBy.keys?
optionalkeys?:string[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.limitBy.value?
optionalvalue?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.name?
optionalname?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.offset?
optionaloffset?:number
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.order?
optionalorder?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.selectFields?
optionalselectFields?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.signal
signal:
"logs"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.source?
optionalsource?:""|"meter"
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation.stepInterval?
optionalstepInterval?:string|number
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation:
object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.aggregations?
optionalaggregations?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.cursor?
optionalcursor?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.disabled?
optionaldisabled?:boolean
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.filter?
optionalfilter?:object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.filter.expression?
optionalexpression?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.functions?
optionalfunctions?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.groupBy?
optionalgroupBy?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.having?
optionalhaving?:object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.having.expression?
optionalexpression?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.legend?
optionallegend?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.limit?
optionallimit?:number
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.limitBy?
optionallimitBy?:object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.limitBy.keys?
optionalkeys?:string[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.limitBy.value?
optionalvalue?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.name?
optionalname?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.offset?
optionaloffset?:number
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.order?
optionalorder?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.selectFields?
optionalselectFields?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.signal
signal:
"metrics"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.source?
optionalsource?:""|"meter"
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation.stepInterval?
optionalstepInterval?:string|number
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation:
object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.aggregations?
optionalaggregations?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.cursor?
optionalcursor?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.disabled?
optionaldisabled?:boolean
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.filter?
optionalfilter?:object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.filter.expression?
optionalexpression?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.functions?
optionalfunctions?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.groupBy?
optionalgroupBy?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.having?
optionalhaving?:object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.having.expression?
optionalexpression?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.legend?
optionallegend?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.limit?
optionallimit?:number
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.limitBy?
optionallimitBy?:object
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.limitBy.keys?
optionalkeys?:string[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.limitBy.value?
optionalvalue?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.name?
optionalname?:string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.offset?
optionaloffset?:number
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.order?
optionalorder?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.selectFields?
optionalselectFields?:object[] |null
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.signal
signal:
"traces"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.source?
optionalsource?:""|"meter"
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation.stepInterval?
optionalstepInterval?:string|number
Querybuildertypesv5QueryBuilderTraceOperator
Querybuildertypesv5QueryBuilderTraceOperator:
object
Querybuildertypesv5QueryBuilderTraceOperator.aggregations?
optionalaggregations?:object[] |null
Querybuildertypesv5QueryBuilderTraceOperator.cursor?
optionalcursor?:string
Querybuildertypesv5QueryBuilderTraceOperator.disabled?
optionaldisabled?:boolean
Querybuildertypesv5QueryBuilderTraceOperator.expression?
optionalexpression?:string
Querybuildertypesv5QueryBuilderTraceOperator.filter?
optionalfilter?:object
Querybuildertypesv5QueryBuilderTraceOperator.filter.expression?
optionalexpression?:string
Querybuildertypesv5QueryBuilderTraceOperator.functions?
optionalfunctions?:object[] |null
Querybuildertypesv5QueryBuilderTraceOperator.groupBy?
optionalgroupBy?:object[] |null
Querybuildertypesv5QueryBuilderTraceOperator.having?
optionalhaving?:object
Querybuildertypesv5QueryBuilderTraceOperator.having.expression?
optionalexpression?:string
Querybuildertypesv5QueryBuilderTraceOperator.legend?
optionallegend?:string
Querybuildertypesv5QueryBuilderTraceOperator.limit?
optionallimit?:number
Querybuildertypesv5QueryBuilderTraceOperator.name?
optionalname?:string
Querybuildertypesv5QueryBuilderTraceOperator.offset?
optionaloffset?:number
Querybuildertypesv5QueryBuilderTraceOperator.order?
optionalorder?:object[] |null
Querybuildertypesv5QueryBuilderTraceOperator.returnSpansFrom?
optionalreturnSpansFrom?:string
Querybuildertypesv5QueryBuilderTraceOperator.selectFields?
optionalselectFields?:object[] |null
Querybuildertypesv5QueryBuilderTraceOperator.stepInterval?
optionalstepInterval?:string|number
Querybuildertypesv5QueryData
Querybuildertypesv5QueryData:
object& {aggregations?:object[] |null;queryName?:string; } | {columns?:object[] |null;data?:unknown[][] |null;queryName?:string; } | {nextCursor?:string;queryName?:string;rows?:object[] |null; }
Type Declaration
results?
optionalresults?:unknown[] |null
Querybuildertypesv5QueryEnvelope
Querybuildertypesv5QueryEnvelope: {
spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_query"; } | {spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };disabled?:boolean;expression?:string;functions?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;name?:string;order?:object[] |null; };type:"builder_formula"; } | {spec?: {aggregations?:object[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;name?:string;offset?:number;order?:object[] |null;returnSpansFrom?:string;selectFields?:object[] |null;stepInterval?:string|number; };type:"builder_trace_operator"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; };type:"promql"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string; };type:"clickhouse_sql"; }
Union Members
Type Literal
{ spec?: { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; } | { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; } | { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }; type: "builder_query"; }
spec?
optionalspec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; }
Union Members
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"logs"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"metrics"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"traces"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
type
type:
"builder_query"
Description
discriminator enum property added by openapi-typescript
Type Literal
{ spec?: { aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }; type: "builder_ai_query"; }
spec?
optionalspec?:object
spec.aggregations?
optionalaggregations?:object[] |null
spec.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
spec.cursor?
optionalcursor?:string
spec.disabled?
optionaldisabled?:boolean
spec.filter?
optionalfilter?:object
spec.filter.expression?
optionalexpression?:string
spec.functions?
optionalfunctions?:object[] |null
spec.groupBy?
optionalgroupBy?:object[] |null
spec.having?
optionalhaving?:object
spec.having.expression?
optionalexpression?:string
spec.legend?
optionallegend?:string
spec.limit?
optionallimit?:number
spec.limitBy?
optionallimitBy?:object
spec.limitBy.keys?
optionalkeys?:string[] |null
spec.limitBy.value?
optionalvalue?:string
spec.name?
optionalname?:string
spec.offset?
optionaloffset?:number
spec.order?
optionalorder?:object[] |null
spec.secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
spec.selectFields?
optionalselectFields?:object[] |null
spec.signal
signal:
"traces"
Description
discriminator enum property added by openapi-typescript
spec.source?
optionalsource?:""|"meter"
spec.stepInterval?
optionalstepInterval?:string|number
type
type:
"builder_ai_query"
Description
discriminator enum property added by openapi-typescript
Type Literal
{ spec?: { bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; disabled?: boolean; expression?: string; functions?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; name?: string; order?: object[] | null; }; type: "builder_formula"; }
spec?
optionalspec?:object
spec.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
spec.disabled?
optionaldisabled?:boolean
spec.expression?
optionalexpression?:string
spec.functions?
optionalfunctions?:object[] |null
spec.having?
optionalhaving?:object
spec.having.expression?
optionalexpression?:string
spec.legend?
optionallegend?:string
spec.limit?
optionallimit?:number
spec.name?
optionalname?:string
spec.order?
optionalorder?:object[] |null
type
type:
"builder_formula"
Description
discriminator enum property added by openapi-typescript
Type Literal
{ spec?: { aggregations?: object[] | null; cursor?: string; disabled?: boolean; expression?: string; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; name?: string; offset?: number; order?: object[] | null; returnSpansFrom?: string; selectFields?: object[] | null; stepInterval?: string | number; }; type: "builder_trace_operator"; }
spec?
optionalspec?:object
spec.aggregations?
optionalaggregations?:object[] |null
spec.cursor?
optionalcursor?:string
spec.disabled?
optionaldisabled?:boolean
spec.expression?
optionalexpression?:string
spec.filter?
optionalfilter?:object
spec.filter.expression?
optionalexpression?:string
spec.functions?
optionalfunctions?:object[] |null
spec.groupBy?
optionalgroupBy?:object[] |null
spec.having?
optionalhaving?:object
spec.having.expression?
optionalexpression?:string
spec.legend?
optionallegend?:string
spec.limit?
optionallimit?:number
spec.name?
optionalname?:string
spec.offset?
optionaloffset?:number
spec.order?
optionalorder?:object[] |null
spec.returnSpansFrom?
optionalreturnSpansFrom?:string
spec.selectFields?
optionalselectFields?:object[] |null
spec.stepInterval?
optionalstepInterval?:string|number
type
type:
"builder_trace_operator"
Description
discriminator enum property added by openapi-typescript
Type Literal
{ spec?: { disabled?: boolean; legend?: string; name?: string; query?: string; stats?: boolean; step?: string | number; }; type: "promql"; }
spec?
optionalspec?:object
spec.disabled?
optionaldisabled?:boolean
spec.legend?
optionallegend?:string
spec.name?
optionalname?:string
spec.query?
optionalquery?:string
spec.stats?
optionalstats?:boolean
spec.step?
optionalstep?:string|number
type
type:
"promql"
Description
discriminator enum property added by openapi-typescript
Type Literal
{ spec?: { disabled?: boolean; legend?: string; name?: string; query?: string; }; type: "clickhouse_sql"; }
spec?
optionalspec?:object
spec.disabled?
optionaldisabled?:boolean
spec.legend?
optionallegend?:string
spec.name?
optionalname?:string
spec.query?
optionalquery?:string
type
type:
"clickhouse_sql"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5QueryEnvelopeBuilder
Querybuildertypesv5QueryEnvelopeBuilder:
object
Querybuildertypesv5QueryEnvelopeBuilder.spec?
optionalspec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?:string[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; }
Union Members
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "logs"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"logs"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "metrics"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"metrics"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Type Literal
{ aggregations?: object[] | null; bucketOptions?: { kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; } | { kind: "log"; spec: { scale?: number | null; }; }; cursor?: string; disabled?: boolean; filter?: { expression?: string; }; functions?: object[] | null; groupBy?: object[] | null; having?: { expression?: string; }; legend?: string; limit?: number; limitBy?: { keys?: string[] | null; value?: string; }; name?: string; offset?: number; order?: object[] | null; secondaryAggregations?: object[] | null; selectFields?: object[] | null; signal: "traces"; source?: "" | "meter"; stepInterval?: string | number; }
aggregations?
optionalaggregations?:object[] |null
bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
cursor?
optionalcursor?:string
disabled?
optionaldisabled?:boolean
filter?
optionalfilter?:object
filter.expression?
optionalexpression?:string
functions?
optionalfunctions?:object[] |null
groupBy?
optionalgroupBy?:object[] |null
having?
optionalhaving?:object
having.expression?
optionalexpression?:string
legend?
optionallegend?:string
limit?
optionallimit?:number
limitBy?
optionallimitBy?:object
limitBy.keys?
optionalkeys?:string[] |null
limitBy.value?
optionalvalue?:string
name?
optionalname?:string
offset?
optionaloffset?:number
order?
optionalorder?:object[] |null
secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
selectFields?
optionalselectFields?:object[] |null
signal
signal:
"traces"
Description
discriminator enum property added by openapi-typescript
source?
optionalsource?:""|"meter"
stepInterval?
optionalstepInterval?:string|number
Querybuildertypesv5QueryEnvelopeBuilder.type
type:
"builder_query"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5QueryEnvelopeBuilderAI
Querybuildertypesv5QueryEnvelopeBuilderAI:
object
Querybuildertypesv5QueryEnvelopeBuilderAI.spec?
optionalspec?:object
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.aggregations?
optionalaggregations?:object[] |null
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.cursor?
optionalcursor?:string
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.disabled?
optionaldisabled?:boolean
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.filter?
optionalfilter?:object
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.filter.expression?
optionalexpression?:string
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.functions?
optionalfunctions?:object[] |null
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.groupBy?
optionalgroupBy?:object[] |null
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.having?
optionalhaving?:object
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.having.expression?
optionalexpression?:string
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.legend?
optionallegend?:string
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.limit?
optionallimit?:number
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.limitBy?
optionallimitBy?:object
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.limitBy.keys?
optionalkeys?:string[] |null
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.limitBy.value?
optionalvalue?:string
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.name?
optionalname?:string
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.offset?
optionaloffset?:number
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.order?
optionalorder?:object[] |null
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.secondaryAggregations?
optionalsecondaryAggregations?:object[] |null
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.selectFields?
optionalselectFields?:object[] |null
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.signal
signal:
"traces"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.source?
optionalsource?:""|"meter"
Querybuildertypesv5QueryEnvelopeBuilderAI.spec.stepInterval?
optionalstepInterval?:string|number
Querybuildertypesv5QueryEnvelopeBuilderAI.type
type:
"builder_ai_query"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5QueryEnvelopeClickHouseSQL
Querybuildertypesv5QueryEnvelopeClickHouseSQL:
object
Querybuildertypesv5QueryEnvelopeClickHouseSQL.spec?
optionalspec?:object
Querybuildertypesv5QueryEnvelopeClickHouseSQL.spec.disabled?
optionaldisabled?:boolean
Querybuildertypesv5QueryEnvelopeClickHouseSQL.spec.legend?
optionallegend?:string
Querybuildertypesv5QueryEnvelopeClickHouseSQL.spec.name?
optionalname?:string
Querybuildertypesv5QueryEnvelopeClickHouseSQL.spec.query?
optionalquery?:string
Querybuildertypesv5QueryEnvelopeClickHouseSQL.type
type:
"clickhouse_sql"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5QueryEnvelopeFormula
Querybuildertypesv5QueryEnvelopeFormula:
object
Querybuildertypesv5QueryEnvelopeFormula.spec?
optionalspec?:object
Querybuildertypesv5QueryEnvelopeFormula.spec.bucketOptions?
optionalbucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?:number; }; } | {kind:"log";spec: {scale?:number|null; }; }
Union Members
Type Literal
{ kind: "linear"; spec: { maxValue: number; numBuckets?: number; }; }
kind
kind:
"linear"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.maxValue
maxValue:
number
Format: double
spec.numBuckets?
optionalnumBuckets?:number
Type Literal
{ kind: "log"; spec: { scale?: number | null; }; }
kind
kind:
"log"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.scale?
optionalscale?:number|null
Querybuildertypesv5QueryEnvelopeFormula.spec.disabled?
optionaldisabled?:boolean
Querybuildertypesv5QueryEnvelopeFormula.spec.expression?
optionalexpression?:string
Querybuildertypesv5QueryEnvelopeFormula.spec.functions?
optionalfunctions?:object[] |null
Querybuildertypesv5QueryEnvelopeFormula.spec.having?
optionalhaving?:object
Querybuildertypesv5QueryEnvelopeFormula.spec.having.expression?
optionalexpression?:string
Querybuildertypesv5QueryEnvelopeFormula.spec.legend?
optionallegend?:string
Querybuildertypesv5QueryEnvelopeFormula.spec.limit?
optionallimit?:number
Querybuildertypesv5QueryEnvelopeFormula.spec.name?
optionalname?:string
Querybuildertypesv5QueryEnvelopeFormula.spec.order?
optionalorder?:object[] |null
Querybuildertypesv5QueryEnvelopeFormula.type
type:
"builder_formula"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5QueryEnvelopePromQL
Querybuildertypesv5QueryEnvelopePromQL:
object
Querybuildertypesv5QueryEnvelopePromQL.spec?
optionalspec?:object
Querybuildertypesv5QueryEnvelopePromQL.spec.disabled?
optionaldisabled?:boolean
Querybuildertypesv5QueryEnvelopePromQL.spec.legend?
optionallegend?:string
Querybuildertypesv5QueryEnvelopePromQL.spec.name?
optionalname?:string
Querybuildertypesv5QueryEnvelopePromQL.spec.query?
optionalquery?:string
Querybuildertypesv5QueryEnvelopePromQL.spec.stats?
optionalstats?:boolean
Querybuildertypesv5QueryEnvelopePromQL.spec.step?
optionalstep?:string|number
Querybuildertypesv5QueryEnvelopePromQL.type
type:
"promql"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5QueryEnvelopeTraceOperator
Querybuildertypesv5QueryEnvelopeTraceOperator:
object
Querybuildertypesv5QueryEnvelopeTraceOperator.spec?
optionalspec?:object
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.aggregations?
optionalaggregations?:object[] |null
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.cursor?
optionalcursor?:string
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.disabled?
optionaldisabled?:boolean
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.expression?
optionalexpression?:string
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.filter?
optionalfilter?:object
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.filter.expression?
optionalexpression?:string
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.functions?
optionalfunctions?:object[] |null
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.groupBy?
optionalgroupBy?:object[] |null
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.having?
optionalhaving?:object
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.having.expression?
optionalexpression?:string
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.legend?
optionallegend?:string
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.limit?
optionallimit?:number
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.name?
optionalname?:string
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.offset?
optionaloffset?:number
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.order?
optionalorder?:object[] |null
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.returnSpansFrom?
optionalreturnSpansFrom?:string
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.selectFields?
optionalselectFields?:object[] |null
Querybuildertypesv5QueryEnvelopeTraceOperator.spec.stepInterval?
optionalstepInterval?:string|number
Querybuildertypesv5QueryEnvelopeTraceOperator.type
type:
"builder_trace_operator"
Description
discriminator enum property added by openapi-typescript
Querybuildertypesv5QueryPreview
Querybuildertypesv5QueryPreview:
object
Querybuildertypesv5QueryPreview.error
error:
unknown
Querybuildertypesv5QueryPreview.statements
statements:
object[]
Querybuildertypesv5QueryPreview.valid
valid:
boolean
Querybuildertypesv5QueryPreview.warnings
warnings:
string[]
Querybuildertypesv5QueryRangePreviewResponse
Querybuildertypesv5QueryRangePreviewResponse:
object
Description
Response from the v5 query range preview (dry-run) endpoint. For each query in the composite query, returns the underlying ClickHouse statement(s) it renders to without executing them (one per PromQL metric selector; exactly one for builder/ClickHouse/trace-operator queries), with the optional EXPLAIN ESTIMATE and granule analysis attached per statement when requested.
Querybuildertypesv5QueryRangePreviewResponse.compositeQuery
compositeQuery: {[
key:string]:object; } |null
Querybuildertypesv5QueryRangeRequest
Querybuildertypesv5QueryRangeRequest:
object
Description
Request body for the v5 query range endpoint. Supports builder queries (traces, logs, metrics), formulas, joins, trace operators, PromQL, and ClickHouse SQL queries.
Querybuildertypesv5QueryRangeRequest.compositeQuery?
optionalcompositeQuery?:object
Querybuildertypesv5QueryRangeRequest.compositeQuery.queries?
optionalqueries?: ({spec?: {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"logs";source?: ... | ... | ...;stepInterval?: ... | ... | ...; } | {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"metrics";source?: ... | ... | ...;stepInterval?: ... | ... | ...; } | {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"traces";source?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_query"; } | {spec?: {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"traces";source?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: ... | ... | ...;disabled?: ... | ... | ...;expression?: ... | ...;functions?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;name?: ... | ...;order?: ... | ... | ...; };type:"builder_formula"; } | {spec?: {aggregations?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;expression?: ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;returnSpansFrom?: ... | ...;selectFields?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_trace_operator"; } | {spec?: {disabled?: ... | ... | ...;legend?: ... | ...;name?: ... | ...;query?: ... | ...;stats?: ... | ... | ...;step?: ... | ... | ...; };type:"promql"; } | {spec?: {disabled?: ... | ... | ...;legend?: ... | ...;name?: ... | ...;query?: ... | ...; };type:"clickhouse_sql"; })[] |null
Querybuildertypesv5QueryRangeRequest.end?
optionalend?:number
Querybuildertypesv5QueryRangeRequest.formatOptions?
optionalformatOptions?:object
Querybuildertypesv5QueryRangeRequest.formatOptions.fillGaps?
optionalfillGaps?:boolean
Querybuildertypesv5QueryRangeRequest.formatOptions.formatTableResultForUI?
optionalformatTableResultForUI?:boolean
Querybuildertypesv5QueryRangeRequest.noCache?
optionalnoCache?:boolean
Querybuildertypesv5QueryRangeRequest.requestType?
optionalrequestType?:"trace"|"raw"|"scalar"|"time_series"|"raw_stream"|"heatmap"
Querybuildertypesv5QueryRangeRequest.schemaVersion?
optionalschemaVersion?:string
Querybuildertypesv5QueryRangeRequest.start?
optionalstart?:number
Querybuildertypesv5QueryRangeRequest.variables?
optionalvariables?:object
Index Signature
[key: string]: object
Querybuildertypesv5QueryRangeResponse
Querybuildertypesv5QueryRangeResponse:
object
Description
Response from the v5 query range endpoint. The data.results array contains typed results depending on the requestType: TimeSeriesData for time_series, ScalarData for scalar, or RawData for raw requests.
Querybuildertypesv5QueryRangeResponse.data?
optionaldata?: { results?: unknown[] | null | undefined; } & ({ aggregations?: { alias?: string | undefined; anomalyScores?: { labels?: { key?: { description?: string | undefined; fieldContext?: "" | "metric" | ... 7 more ... | undefined; fieldDataType?: "" | ... 5 more ... | undefined; name: string; signal?: "" | ... 3 more ... |...
Querybuildertypesv5QueryRangeResponse.meta?
optionalmeta?:object
Querybuildertypesv5QueryRangeResponse.meta.bytesScanned?
optionalbytesScanned?:number
Querybuildertypesv5QueryRangeResponse.meta.durationMs?
optionaldurationMs?:number
Querybuildertypesv5QueryRangeResponse.meta.rowsScanned?
optionalrowsScanned?:number
Querybuildertypesv5QueryRangeResponse.meta.stepIntervals?
optionalstepIntervals?:object
Index Signature
[key: string]: number
Querybuildertypesv5QueryRangeResponse.type?
optionaltype?:"trace"|"raw"|"scalar"|"time_series"|"raw_stream"|"heatmap"
Querybuildertypesv5QueryRangeResponse.warning?
optionalwarning?:object
Querybuildertypesv5QueryRangeResponse.warning.message?
optionalmessage?:string
Querybuildertypesv5QueryRangeResponse.warning.url?
optionalurl?:string
Querybuildertypesv5QueryRangeResponse.warning.warnings?
optionalwarnings?:object[]
Querybuildertypesv5QueryType
Querybuildertypesv5QueryType:
"builder_query"|"builder_ai_query"|"builder_formula"|"builder_trace_operator"|"promql"|"clickhouse_sql"
Querybuildertypesv5QueryWarnData
Querybuildertypesv5QueryWarnData:
object
Querybuildertypesv5QueryWarnData.message?
optionalmessage?:string
Querybuildertypesv5QueryWarnData.url?
optionalurl?:string
Querybuildertypesv5QueryWarnData.warnings?
optionalwarnings?:object[]
Querybuildertypesv5QueryWarnDataAdditional
Querybuildertypesv5QueryWarnDataAdditional:
object
Querybuildertypesv5QueryWarnDataAdditional.message?
optionalmessage?:string
Querybuildertypesv5RawData
Querybuildertypesv5RawData:
object
Querybuildertypesv5RawData.nextCursor?
optionalnextCursor?:string
Querybuildertypesv5RawData.queryName?
optionalqueryName?:string
Querybuildertypesv5RawData.rows?
optionalrows?:object[] |null
Querybuildertypesv5RawRow
Querybuildertypesv5RawRow:
object
Querybuildertypesv5RawRow.data?
optionaldata?: {[key:string]:unknown; } |null
Querybuildertypesv5RawRow.timestamp?
optionaltimestamp?:string
Format: date-time
Querybuildertypesv5ReduceTo
Querybuildertypesv5ReduceTo:
"sum"|"count"|"avg"|"min"|"max"|"last"|"median"
Querybuildertypesv5RequestType
Querybuildertypesv5RequestType:
"trace"|"raw"|"scalar"|"time_series"|"raw_stream"|"heatmap"
Querybuildertypesv5ScalarData
Querybuildertypesv5ScalarData:
object
Querybuildertypesv5ScalarData.columns?
optionalcolumns?:object[] |null
Querybuildertypesv5ScalarData.data?
optionaldata?:unknown[][] |null
Querybuildertypesv5ScalarData.queryName?
optionalqueryName?:string
Querybuildertypesv5SecondaryAggregation
Querybuildertypesv5SecondaryAggregation:
object
Querybuildertypesv5SecondaryAggregation.alias?
optionalalias?:string
Querybuildertypesv5SecondaryAggregation.expression?
optionalexpression?:string
Querybuildertypesv5SecondaryAggregation.groupBy?
optionalgroupBy?:object[] |null
Querybuildertypesv5SecondaryAggregation.limit?
optionallimit?:number
Querybuildertypesv5SecondaryAggregation.limitBy?
optionallimitBy?:object
Querybuildertypesv5SecondaryAggregation.limitBy.keys?
optionalkeys?:string[] |null
Querybuildertypesv5SecondaryAggregation.limitBy.value?
optionalvalue?:string
Querybuildertypesv5SecondaryAggregation.order?
optionalorder?:object[] |null
Querybuildertypesv5SecondaryAggregation.stepInterval?
optionalstepInterval?:string|number
Querybuildertypesv5Step
Querybuildertypesv5Step:
string|number
Description
Step interval. Accepts a Go duration string (e.g., "60s", "1m", "1h") or a number representing seconds (e.g., 60).
Querybuildertypesv5TimeSeries
Querybuildertypesv5TimeSeries:
object
Querybuildertypesv5TimeSeries.labels?
optionallabels?:object[]
Querybuildertypesv5TimeSeries.values?
optionalvalues?:object[] |null
Querybuildertypesv5TimeSeriesData
Querybuildertypesv5TimeSeriesData:
object
Querybuildertypesv5TimeSeriesData.aggregations?
optionalaggregations?:object[] |null
Querybuildertypesv5TimeSeriesData.queryName?
optionalqueryName?:string
Querybuildertypesv5TimeSeriesValue
Querybuildertypesv5TimeSeriesValue:
object
Querybuildertypesv5TimeSeriesValue.partial?
optionalpartial?:boolean
Querybuildertypesv5TimeSeriesValue.timestamp?
optionaltimestamp?:number
Format: int64
Querybuildertypesv5TimeSeriesValue.value?
optionalvalue?:number
Format: double
Querybuildertypesv5TimeSeriesValue.values?
optionalvalues?:number[]
Querybuildertypesv5TraceAggregation
Querybuildertypesv5TraceAggregation:
object
Querybuildertypesv5TraceAggregation.alias?
optionalalias?:string
Querybuildertypesv5TraceAggregation.expression?
optionalexpression?:string
Querybuildertypesv5VariableItem
Querybuildertypesv5VariableItem:
object
Querybuildertypesv5VariableItem.type?
optionaltype?:"query"|"text"|"dynamic"|"custom"
Querybuildertypesv5VariableItem.value?
optionalvalue?:string|number|boolean| (string|number|boolean)[]
Querybuildertypesv5VariableType
Querybuildertypesv5VariableType:
"query"|"text"|"dynamic"|"custom"
QuickfiltertypesSource
QuickfiltertypesSource:
"logs"|"traces"|"meter"|"api_monitoring"|"exceptions"|"ai_observability"
QuickfiltertypesSourceFilters
QuickfiltertypesSourceFilters:
object
QuickfiltertypesSourceFilters.createdAt?
optionalcreatedAt?:string
Format: date-time
QuickfiltertypesSourceFilters.filters
filters:
object[]
QuickfiltertypesSourceFilters.id
id:
string
QuickfiltertypesSourceFilters.orgId
orgId:
string
QuickfiltertypesSourceFilters.source
source:
"logs"|"traces"|"meter"|"api_monitoring"|"exceptions"|"ai_observability"
QuickfiltertypesSourceFilters.updatedAt?
optionalupdatedAt?:string
Format: date-time
QuickfiltertypesUpdatableQuickFilters
QuickfiltertypesUpdatableQuickFilters:
object
QuickfiltertypesUpdatableQuickFilters.filters
filters:
object[]
RenderErrorResponse
RenderErrorResponse:
object
RenderErrorResponse.error
error:
object
RenderErrorResponse.error.code
code:
string
RenderErrorResponse.error.errors
errors:
object[]
RenderErrorResponse.error.message
message:
string
RenderErrorResponse.error.retry?
optionalretry?:object
RenderErrorResponse.error.retry.delay
delay:
number
RenderErrorResponse.error.suggestions
suggestions:
string[]
RenderErrorResponse.error.type
type:
string
RenderErrorResponse.error.url?
optionalurl?:string
RenderErrorResponse.status
status:
string
RulestatehistorytypesGettableRuleStateHistory
RulestatehistorytypesGettableRuleStateHistory:
object
RulestatehistorytypesGettableRuleStateHistory.fingerprint
fingerprint:
number
RulestatehistorytypesGettableRuleStateHistory.labels
labels:
object[] |null
RulestatehistorytypesGettableRuleStateHistory.overallState
overallState:
"pending"|"inactive"|"recovering"|"firing"|"nodata"|"disabled"
RulestatehistorytypesGettableRuleStateHistory.overallStateChanged
overallStateChanged:
boolean
RulestatehistorytypesGettableRuleStateHistory.relatedAITracesLink?
optionalrelatedAITracesLink?:string
RulestatehistorytypesGettableRuleStateHistory.relatedLogsLink?
optionalrelatedLogsLink?:string
RulestatehistorytypesGettableRuleStateHistory.relatedTracesLink?
optionalrelatedTracesLink?:string
RulestatehistorytypesGettableRuleStateHistory.ruleId
ruleId:
string
RulestatehistorytypesGettableRuleStateHistory.ruleName
ruleName:
string
RulestatehistorytypesGettableRuleStateHistory.state
state:
"pending"|"inactive"|"recovering"|"firing"|"nodata"|"disabled"
RulestatehistorytypesGettableRuleStateHistory.stateChanged
stateChanged:
boolean
RulestatehistorytypesGettableRuleStateHistory.unixMilli
unixMilli:
number
Format: int64
RulestatehistorytypesGettableRuleStateHistory.value
value:
number
Format: double
RulestatehistorytypesGettableRuleStateHistoryContributor
RulestatehistorytypesGettableRuleStateHistoryContributor:
object
RulestatehistorytypesGettableRuleStateHistoryContributor.count
count:
number
RulestatehistorytypesGettableRuleStateHistoryContributor.fingerprint
fingerprint:
number
RulestatehistorytypesGettableRuleStateHistoryContributor.labels
labels:
object[] |null
RulestatehistorytypesGettableRuleStateHistoryContributor.relatedAITracesLink?
optionalrelatedAITracesLink?:string
RulestatehistorytypesGettableRuleStateHistoryContributor.relatedLogsLink?
optionalrelatedLogsLink?:string
RulestatehistorytypesGettableRuleStateHistoryContributor.relatedTracesLink?
optionalrelatedTracesLink?:string
RulestatehistorytypesGettableRuleStateHistoryStats
RulestatehistorytypesGettableRuleStateHistoryStats:
object
RulestatehistorytypesGettableRuleStateHistoryStats.currentAvgResolutionTime
currentAvgResolutionTime:
number
Format: double
RulestatehistorytypesGettableRuleStateHistoryStats.currentAvgResolutionTimeSeries
currentAvgResolutionTimeSeries:
object
RulestatehistorytypesGettableRuleStateHistoryStats.currentAvgResolutionTimeSeries.labels?
optionallabels?:object[]
RulestatehistorytypesGettableRuleStateHistoryStats.currentAvgResolutionTimeSeries.values?
optionalvalues?:object[] |null
RulestatehistorytypesGettableRuleStateHistoryStats.currentTriggersSeries
currentTriggersSeries:
object
RulestatehistorytypesGettableRuleStateHistoryStats.currentTriggersSeries.labels?
optionallabels?:object[]
RulestatehistorytypesGettableRuleStateHistoryStats.currentTriggersSeries.values?
optionalvalues?:object[] |null
RulestatehistorytypesGettableRuleStateHistoryStats.pastAvgResolutionTime
pastAvgResolutionTime:
number
Format: double
RulestatehistorytypesGettableRuleStateHistoryStats.pastAvgResolutionTimeSeries
pastAvgResolutionTimeSeries:
object
RulestatehistorytypesGettableRuleStateHistoryStats.pastAvgResolutionTimeSeries.labels?
optionallabels?:object[]
RulestatehistorytypesGettableRuleStateHistoryStats.pastAvgResolutionTimeSeries.values?
optionalvalues?:object[] |null
RulestatehistorytypesGettableRuleStateHistoryStats.pastTriggersSeries
pastTriggersSeries:
object
RulestatehistorytypesGettableRuleStateHistoryStats.pastTriggersSeries.labels?
optionallabels?:object[]
RulestatehistorytypesGettableRuleStateHistoryStats.pastTriggersSeries.values?
optionalvalues?:object[] |null
RulestatehistorytypesGettableRuleStateHistoryStats.totalCurrentTriggers
totalCurrentTriggers:
number
RulestatehistorytypesGettableRuleStateHistoryStats.totalPastTriggers
totalPastTriggers:
number
RulestatehistorytypesGettableRuleStateTimeline
RulestatehistorytypesGettableRuleStateTimeline:
object
RulestatehistorytypesGettableRuleStateTimeline.items
items:
object[] |null
RulestatehistorytypesGettableRuleStateTimeline.nextCursor?
optionalnextCursor?:string
RulestatehistorytypesGettableRuleStateTimeline.total
total:
number
RulestatehistorytypesGettableRuleStateWindow
RulestatehistorytypesGettableRuleStateWindow:
object
RulestatehistorytypesGettableRuleStateWindow.end
end:
number
Format: int64
RulestatehistorytypesGettableRuleStateWindow.start
start:
number
Format: int64
RulestatehistorytypesGettableRuleStateWindow.state
state:
"pending"|"inactive"|"recovering"|"firing"|"nodata"|"disabled"
RuletypesAlertCompositeQuery
RuletypesAlertCompositeQuery:
object
RuletypesAlertCompositeQuery.panelType
panelType:
"value"|"table"|"graph"
RuletypesAlertCompositeQuery.queries
queries: ({
spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_query"; } | {spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };disabled?:boolean;expression?:string;functions?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;name?:string;order?:object[] |null; };type:"builder_formula"; } | {spec?: {aggregations?:object[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;name?:string;offset?:number;order?:object[] |null;returnSpansFrom?:string;selectFields?:object[] |null;stepInterval?:string|number; };type:"builder_trace_operator"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; };type:"promql"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string; };type:"clickhouse_sql"; })[] |null
RuletypesAlertCompositeQuery.queryType
queryType:
"promql"|"clickhouse_sql"|"builder"
RuletypesAlertCompositeQuery.unit?
optionalunit?:string
RuletypesAlertState
RuletypesAlertState:
"pending"|"inactive"|"recovering"|"firing"|"nodata"|"disabled"
RuletypesAlertType
RuletypesAlertType:
"METRIC_BASED_ALERT"|"TRACES_BASED_ALERT"|"LOGS_BASED_ALERT"|"EXCEPTIONS_BASED_ALERT"|"AI_TRACES_BASED_ALERT"
RuletypesBasicRuleThreshold
RuletypesBasicRuleThreshold:
object
RuletypesBasicRuleThreshold.channels?
optionalchannels?:string[] |null
RuletypesBasicRuleThreshold.matchType
matchType:
"last"|"at_least_once"|"all_the_times"|"on_average"|"in_total"
RuletypesBasicRuleThreshold.name
name:
string
RuletypesBasicRuleThreshold.op
op:
"above"|"below"|"above_or_equal"|"below_or_equal"|"equal"|"not_equal"|"outside_bounds"
RuletypesBasicRuleThreshold.recoveryTarget?
optionalrecoveryTarget?:number|null
Format: double
RuletypesBasicRuleThreshold.target
target:
number|null
Format: double
RuletypesBasicRuleThreshold.targetUnit?
optionaltargetUnit?:string
RuletypesBasicRuleThresholds
RuletypesBasicRuleThresholds:
object[] |null
RuletypesCompareOperator
RuletypesCompareOperator:
"above"|"below"|"above_or_equal"|"below_or_equal"|"equal"|"not_equal"|"outside_bounds"
RuletypesCumulativeSchedule
RuletypesCumulativeSchedule:
object
RuletypesCumulativeSchedule.day?
optionalday?:number|null
RuletypesCumulativeSchedule.hour?
optionalhour?:number|null
RuletypesCumulativeSchedule.minute?
optionalminute?:number|null
RuletypesCumulativeSchedule.type
type:
"daily"|"weekly"|"monthly"|"hourly"
RuletypesCumulativeSchedule.weekday?
optionalweekday?:number|null
RuletypesCumulativeWindow
RuletypesCumulativeWindow:
object
RuletypesCumulativeWindow.frequency
frequency:
string
RuletypesCumulativeWindow.schedule
schedule:
object
RuletypesCumulativeWindow.schedule.day?
optionalday?:number|null
RuletypesCumulativeWindow.schedule.hour?
optionalhour?:number|null
RuletypesCumulativeWindow.schedule.minute?
optionalminute?:number|null
RuletypesCumulativeWindow.schedule.type
type:
"daily"|"weekly"|"monthly"|"hourly"
RuletypesCumulativeWindow.schedule.weekday?
optionalweekday?:number|null
RuletypesCumulativeWindow.timezone
timezone:
string
RuletypesEvaluationCumulative
RuletypesEvaluationCumulative:
object
RuletypesEvaluationCumulative.kind
kind:
"cumulative"
Description
discriminator enum property added by openapi-typescript
RuletypesEvaluationCumulative.spec
spec:
object
RuletypesEvaluationCumulative.spec.frequency
frequency:
string
RuletypesEvaluationCumulative.spec.schedule
schedule:
object
RuletypesEvaluationCumulative.spec.schedule.day?
optionalday?:number|null
RuletypesEvaluationCumulative.spec.schedule.hour?
optionalhour?:number|null
RuletypesEvaluationCumulative.spec.schedule.minute?
optionalminute?:number|null
RuletypesEvaluationCumulative.spec.schedule.type
type:
"daily"|"weekly"|"monthly"|"hourly"
RuletypesEvaluationCumulative.spec.schedule.weekday?
optionalweekday?:number|null
RuletypesEvaluationCumulative.spec.timezone
timezone:
string
RuletypesEvaluationEnvelope
RuletypesEvaluationEnvelope: {
kind:"cumulative";spec: {frequency:string;schedule: {day?:number|null;hour?:number|null;minute?:number|null;type:"daily"|"weekly"|"monthly"|"hourly";weekday?:number|null; };timezone:string; }; } | {kind:"rolling";spec: {evalWindow:string;frequency:string; }; }
Union Members
Type Literal
{ kind: "cumulative"; spec: { frequency: string; schedule: { day?: number | null; hour?: number | null; minute?: number | null; type: "daily" | "weekly" | "monthly" | "hourly"; weekday?: number | null; }; timezone: string; }; }
kind
kind:
"cumulative"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.frequency
frequency:
string
spec.schedule
schedule:
object
spec.schedule.day?
optionalday?:number|null
spec.schedule.hour?
optionalhour?:number|null
spec.schedule.minute?
optionalminute?:number|null
spec.schedule.type
type:
"daily"|"weekly"|"monthly"|"hourly"
spec.schedule.weekday?
optionalweekday?:number|null
spec.timezone
timezone:
string
Type Literal
{ kind: "rolling"; spec: { evalWindow: string; frequency: string; }; }
kind
kind:
"rolling"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.evalWindow
evalWindow:
string
spec.frequency
frequency:
string
RuletypesEvaluationKind
RuletypesEvaluationKind:
"cumulative"|"rolling"
RuletypesEvaluationRolling
RuletypesEvaluationRolling:
object
RuletypesEvaluationRolling.kind
kind:
"rolling"
Description
discriminator enum property added by openapi-typescript
RuletypesEvaluationRolling.spec
spec:
object
RuletypesEvaluationRolling.spec.evalWindow
evalWindow:
string
RuletypesEvaluationRolling.spec.frequency
frequency:
string
RuletypesGettableTestRule
RuletypesGettableTestRule:
object
RuletypesGettableTestRule.alertCount?
optionalalertCount?:number
RuletypesGettableTestRule.message?
optionalmessage?:string
RuletypesMatchType
RuletypesMatchType:
"last"|"at_least_once"|"all_the_times"|"on_average"|"in_total"
RuletypesNotificationSettings
RuletypesNotificationSettings:
object
RuletypesNotificationSettings.groupBy?
optionalgroupBy?:string[] |null
RuletypesNotificationSettings.newGroupEvalDelay?
optionalnewGroupEvalDelay?:string
RuletypesNotificationSettings.renotify?
optionalrenotify?:object
RuletypesNotificationSettings.renotify.alertStates?
optionalalertStates?: ("pending"|"inactive"|"recovering"|"firing"|"nodata"|"disabled")[] |null
RuletypesNotificationSettings.renotify.enabled?
optionalenabled?:boolean
RuletypesNotificationSettings.renotify.interval?
optionalinterval?:string
RuletypesNotificationSettings.usePolicy?
optionalusePolicy?:boolean
RuletypesPanelType
RuletypesPanelType:
"value"|"table"|"graph"
RuletypesPostableRule
RuletypesPostableRule:
object
RuletypesPostableRule.alert
alert:
string
RuletypesPostableRule.alertType
alertType:
"METRIC_BASED_ALERT"|"TRACES_BASED_ALERT"|"LOGS_BASED_ALERT"|"EXCEPTIONS_BASED_ALERT"|"AI_TRACES_BASED_ALERT"
RuletypesPostableRule.annotations?
optionalannotations?:object
Index Signature
[key: string]: string
RuletypesPostableRule.condition
condition:
object
RuletypesPostableRule.condition.absentFor?
optionalabsentFor?:number
RuletypesPostableRule.condition.alertOnAbsent?
optionalalertOnAbsent?:boolean
RuletypesPostableRule.condition.algorithm?
optionalalgorithm?:string
RuletypesPostableRule.condition.compositeQuery
compositeQuery:
object
RuletypesPostableRule.condition.compositeQuery.panelType
panelType:
"value"|"table"|"graph"
RuletypesPostableRule.condition.compositeQuery.queries
queries: ({
spec?: {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"logs";source?: ... | ... | ...;stepInterval?: ... | ... | ...; } | {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"metrics";source?: ... | ... | ...;stepInterval?: ... | ... | ...; } | {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"traces";source?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_query"; } | {spec?: {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"traces";source?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: ... | ... | ...;disabled?: ... | ... | ...;expression?: ... | ...;functions?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;name?: ... | ...;order?: ... | ... | ...; };type:"builder_formula"; } | {spec?: {aggregations?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;expression?: ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;returnSpansFrom?: ... | ...;selectFields?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_trace_operator"; } | {spec?: {disabled?: ... | ... | ...;legend?: ... | ...;name?: ... | ...;query?: ... | ...;stats?: ... | ... | ...;step?: ... | ... | ...; };type:"promql"; } | {spec?: {disabled?: ... | ... | ...;legend?: ... | ...;name?: ... | ...;query?: ... | ...; };type:"clickhouse_sql"; })[] |null
RuletypesPostableRule.condition.compositeQuery.queryType
queryType:
"promql"|"clickhouse_sql"|"builder"
RuletypesPostableRule.condition.compositeQuery.unit?
optionalunit?:string
RuletypesPostableRule.condition.matchType?
optionalmatchType?:"last"|"at_least_once"|"all_the_times"|"on_average"|"in_total"
RuletypesPostableRule.condition.op?
optionalop?:"above"|"below"|"above_or_equal"|"below_or_equal"|"equal"|"not_equal"|"outside_bounds"
RuletypesPostableRule.condition.requiredNumPoints?
optionalrequiredNumPoints?:number
RuletypesPostableRule.condition.requireMinPoints?
optionalrequireMinPoints?:boolean
RuletypesPostableRule.condition.seasonality?
optionalseasonality?:"daily"|"weekly"|"hourly"
RuletypesPostableRule.condition.selectedQueryName?
optionalselectedQueryName?:string
RuletypesPostableRule.condition.target?
optionaltarget?:number|null
Format: double
RuletypesPostableRule.condition.targetUnit?
optionaltargetUnit?:string
RuletypesPostableRule.condition.thresholds?
optionalthresholds?:object
RuletypesPostableRule.condition.thresholds.kind
kind:
"basic"
Description
discriminator enum property added by openapi-typescript
RuletypesPostableRule.condition.thresholds.spec
spec:
object[] |null
RuletypesPostableRule.description?
optionaldescription?:string
RuletypesPostableRule.disabled?
optionaldisabled?:boolean
RuletypesPostableRule.evaluation?
optionalevaluation?: {kind:"cumulative";spec: {frequency:string;schedule: {day?:number|null;hour?:number|null;minute?:number|null;type:"daily"|"weekly"|"monthly"|"hourly";weekday?:number|null; };timezone:string; }; } | {kind:"rolling";spec: {evalWindow:string;frequency:string; }; }
Union Members
Type Literal
{ kind: "cumulative"; spec: { frequency: string; schedule: { day?: number | null; hour?: number | null; minute?: number | null; type: "daily" | "weekly" | "monthly" | "hourly"; weekday?: number | null; }; timezone: string; }; }
kind
kind:
"cumulative"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.frequency
frequency:
string
spec.schedule
schedule:
object
spec.schedule.day?
optionalday?:number|null
spec.schedule.hour?
optionalhour?:number|null
spec.schedule.minute?
optionalminute?:number|null
spec.schedule.type
type:
"daily"|"weekly"|"monthly"|"hourly"
spec.schedule.weekday?
optionalweekday?:number|null
spec.timezone
timezone:
string
Type Literal
{ kind: "rolling"; spec: { evalWindow: string; frequency: string; }; }
kind
kind:
"rolling"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.evalWindow
evalWindow:
string
spec.frequency
frequency:
string
RuletypesPostableRule.evalWindow?
optionalevalWindow?:string
RuletypesPostableRule.frequency?
optionalfrequency?:string
RuletypesPostableRule.labels?
optionallabels?:object
Index Signature
[key: string]: string
RuletypesPostableRule.notificationSettings?
optionalnotificationSettings?:object
RuletypesPostableRule.notificationSettings.groupBy?
optionalgroupBy?:string[] |null
RuletypesPostableRule.notificationSettings.newGroupEvalDelay?
optionalnewGroupEvalDelay?:string
RuletypesPostableRule.notificationSettings.renotify?
optionalrenotify?:object
RuletypesPostableRule.notificationSettings.renotify.alertStates?
optionalalertStates?: ("pending"|"inactive"|"recovering"|"firing"|"nodata"|"disabled")[] |null
RuletypesPostableRule.notificationSettings.renotify.enabled?
optionalenabled?:boolean
RuletypesPostableRule.notificationSettings.renotify.interval?
optionalinterval?:string
RuletypesPostableRule.notificationSettings.usePolicy?
optionalusePolicy?:boolean
RuletypesPostableRule.preferredChannels?
optionalpreferredChannels?:string[]
RuletypesPostableRule.ruleType
ruleType:
"threshold_rule"|"promql_rule"|"anomaly_rule"
RuletypesPostableRule.schemaVersion?
optionalschemaVersion?:string
RuletypesPostableRule.source?
optionalsource?:string
RuletypesPostableRule.version?
optionalversion?:string
RuletypesQueryType
RuletypesQueryType:
"promql"|"clickhouse_sql"|"builder"
RuletypesRenotify
RuletypesRenotify:
object
RuletypesRenotify.alertStates?
optionalalertStates?: ("pending"|"inactive"|"recovering"|"firing"|"nodata"|"disabled")[] |null
RuletypesRenotify.enabled?
optionalenabled?:boolean
RuletypesRenotify.interval?
optionalinterval?:string
RuletypesRollingWindow
RuletypesRollingWindow:
object
RuletypesRollingWindow.evalWindow
evalWindow:
string
RuletypesRollingWindow.frequency
frequency:
string
RuletypesRule
RuletypesRule:
object
RuletypesRule.alert
alert:
string
RuletypesRule.alertType
alertType:
"METRIC_BASED_ALERT"|"TRACES_BASED_ALERT"|"LOGS_BASED_ALERT"|"EXCEPTIONS_BASED_ALERT"|"AI_TRACES_BASED_ALERT"
RuletypesRule.annotations?
optionalannotations?:object
Index Signature
[key: string]: string
RuletypesRule.condition
condition:
object
RuletypesRule.condition.absentFor?
optionalabsentFor?:number
RuletypesRule.condition.alertOnAbsent?
optionalalertOnAbsent?:boolean
RuletypesRule.condition.algorithm?
optionalalgorithm?:string
RuletypesRule.condition.compositeQuery
compositeQuery:
object
RuletypesRule.condition.compositeQuery.panelType
panelType:
"value"|"table"|"graph"
RuletypesRule.condition.compositeQuery.queries
queries: ({
spec?: {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"logs";source?: ... | ... | ...;stepInterval?: ... | ... | ...; } | {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"metrics";source?: ... | ... | ...;stepInterval?: ... | ... | ...; } | {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"traces";source?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_query"; } | {spec?: {aggregations?: ... | ... | ...;bucketOptions?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;limitBy?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;secondaryAggregations?: ... | ... | ...;selectFields?: ... | ... | ...;signal:"traces";source?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: ... | ... | ...;disabled?: ... | ... | ...;expression?: ... | ...;functions?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;name?: ... | ...;order?: ... | ... | ...; };type:"builder_formula"; } | {spec?: {aggregations?: ... | ... | ...;cursor?: ... | ...;disabled?: ... | ... | ...;expression?: ... | ...;filter?: ... | ...;functions?: ... | ... | ...;groupBy?: ... | ... | ...;having?: ... | ...;legend?: ... | ...;limit?: ... | ...;name?: ... | ...;offset?: ... | ...;order?: ... | ... | ...;returnSpansFrom?: ... | ...;selectFields?: ... | ... | ...;stepInterval?: ... | ... | ...; };type:"builder_trace_operator"; } | {spec?: {disabled?: ... | ... | ...;legend?: ... | ...;name?: ... | ...;query?: ... | ...;stats?: ... | ... | ...;step?: ... | ... | ...; };type:"promql"; } | {spec?: {disabled?: ... | ... | ...;legend?: ... | ...;name?: ... | ...;query?: ... | ...; };type:"clickhouse_sql"; })[] |null
RuletypesRule.condition.compositeQuery.queryType
queryType:
"promql"|"clickhouse_sql"|"builder"
RuletypesRule.condition.compositeQuery.unit?
optionalunit?:string
RuletypesRule.condition.matchType?
optionalmatchType?:"last"|"at_least_once"|"all_the_times"|"on_average"|"in_total"
RuletypesRule.condition.op?
optionalop?:"above"|"below"|"above_or_equal"|"below_or_equal"|"equal"|"not_equal"|"outside_bounds"
RuletypesRule.condition.requiredNumPoints?
optionalrequiredNumPoints?:number
RuletypesRule.condition.requireMinPoints?
optionalrequireMinPoints?:boolean
RuletypesRule.condition.seasonality?
optionalseasonality?:"daily"|"weekly"|"hourly"
RuletypesRule.condition.selectedQueryName?
optionalselectedQueryName?:string
RuletypesRule.condition.target?
optionaltarget?:number|null
Format: double
RuletypesRule.condition.targetUnit?
optionaltargetUnit?:string
RuletypesRule.condition.thresholds?
optionalthresholds?:object
RuletypesRule.condition.thresholds.kind
kind:
"basic"
Description
discriminator enum property added by openapi-typescript
RuletypesRule.condition.thresholds.spec
spec:
object[] |null
RuletypesRule.createdAt?
optionalcreatedAt?:string
Format: date-time
RuletypesRule.createdBy?
optionalcreatedBy?:string
RuletypesRule.description?
optionaldescription?:string
RuletypesRule.disabled?
optionaldisabled?:boolean
RuletypesRule.evaluation?
optionalevaluation?: {kind:"cumulative";spec: {frequency:string;schedule: {day?:number|null;hour?:number|null;minute?:number|null;type:"daily"|"weekly"|"monthly"|"hourly";weekday?:number|null; };timezone:string; }; } | {kind:"rolling";spec: {evalWindow:string;frequency:string; }; }
Union Members
Type Literal
{ kind: "cumulative"; spec: { frequency: string; schedule: { day?: number | null; hour?: number | null; minute?: number | null; type: "daily" | "weekly" | "monthly" | "hourly"; weekday?: number | null; }; timezone: string; }; }
kind
kind:
"cumulative"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.frequency
frequency:
string
spec.schedule
schedule:
object
spec.schedule.day?
optionalday?:number|null
spec.schedule.hour?
optionalhour?:number|null
spec.schedule.minute?
optionalminute?:number|null
spec.schedule.type
type:
"daily"|"weekly"|"monthly"|"hourly"
spec.schedule.weekday?
optionalweekday?:number|null
spec.timezone
timezone:
string
Type Literal
{ kind: "rolling"; spec: { evalWindow: string; frequency: string; }; }
kind
kind:
"rolling"
Description
discriminator enum property added by openapi-typescript
spec
spec:
object
spec.evalWindow
evalWindow:
string
spec.frequency
frequency:
string
RuletypesRule.evalWindow?
optionalevalWindow?:string
RuletypesRule.frequency?
optionalfrequency?:string
RuletypesRule.id
id:
string
RuletypesRule.labels?
optionallabels?:object
Index Signature
[key: string]: string
RuletypesRule.notificationSettings?
optionalnotificationSettings?:object
RuletypesRule.notificationSettings.groupBy?
optionalgroupBy?:string[] |null
RuletypesRule.notificationSettings.newGroupEvalDelay?
optionalnewGroupEvalDelay?:string
RuletypesRule.notificationSettings.renotify?
optionalrenotify?:object
RuletypesRule.notificationSettings.renotify.alertStates?
optionalalertStates?: ("pending"|"inactive"|"recovering"|"firing"|"nodata"|"disabled")[] |null
RuletypesRule.notificationSettings.renotify.enabled?
optionalenabled?:boolean
RuletypesRule.notificationSettings.renotify.interval?
optionalinterval?:string
RuletypesRule.notificationSettings.usePolicy?
optionalusePolicy?:boolean
RuletypesRule.preferredChannels?
optionalpreferredChannels?:string[]
RuletypesRule.ruleType
ruleType:
"threshold_rule"|"promql_rule"|"anomaly_rule"
RuletypesRule.schemaVersion?
optionalschemaVersion?:string
RuletypesRule.source?
optionalsource?:string
RuletypesRule.state
state:
"pending"|"inactive"|"recovering"|"firing"|"nodata"|"disabled"
RuletypesRule.updatedAt?
optionalupdatedAt?:string
Format: date-time
RuletypesRule.updatedBy?
optionalupdatedBy?:string
RuletypesRule.version?
optionalversion?:string
RuletypesRuleCondition
RuletypesRuleCondition:
object
RuletypesRuleCondition.absentFor?
optionalabsentFor?:number
RuletypesRuleCondition.alertOnAbsent?
optionalalertOnAbsent?:boolean
RuletypesRuleCondition.algorithm?
optionalalgorithm?:string
RuletypesRuleCondition.compositeQuery
compositeQuery:
object
RuletypesRuleCondition.compositeQuery.panelType
panelType:
"value"|"table"|"graph"
RuletypesRuleCondition.compositeQuery.queries
queries: ({
spec?: {aggregations?: ...[] |null;bucketOptions?: {kind: ...;spec: ...; } | {kind: ...;spec: ...; };cursor?:string;disabled?:boolean;filter?: {expression?: ...; };functions?: ...[] |null;groupBy?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;limitBy?: {keys?: ...;value?: ...; };name?:string;offset?:number;order?: ...[] |null;secondaryAggregations?: ...[] |null;selectFields?: ...[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?: ...[] |null;bucketOptions?: {kind: ...;spec: ...; } | {kind: ...;spec: ...; };cursor?:string;disabled?:boolean;filter?: {expression?: ...; };functions?: ...[] |null;groupBy?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;limitBy?: {keys?: ...;value?: ...; };name?:string;offset?:number;order?: ...[] |null;secondaryAggregations?: ...[] |null;selectFields?: ...[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?: ...[] |null;bucketOptions?: {kind: ...;spec: ...; } | {kind: ...;spec: ...; };cursor?:string;disabled?:boolean;filter?: {expression?: ...; };functions?: ...[] |null;groupBy?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;limitBy?: {keys?: ...;value?: ...; };name?:string;offset?:number;order?: ...[] |null;secondaryAggregations?: ...[] |null;selectFields?: ...[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_query"; } | {spec?: {aggregations?: ...[] |null;bucketOptions?: {kind: ...;spec: ...; } | {kind: ...;spec: ...; };cursor?:string;disabled?:boolean;filter?: {expression?: ...; };functions?: ...[] |null;groupBy?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;limitBy?: {keys?: ...;value?: ...; };name?:string;offset?:number;order?: ...[] |null;secondaryAggregations?: ...[] |null;selectFields?: ...[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: {kind: ...;spec: ...; } | {kind: ...;spec: ...; };disabled?:boolean;expression?:string;functions?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;name?:string;order?: ...[] |null; };type:"builder_formula"; } | {spec?: {aggregations?: ...[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?: ...; };functions?: ...[] |null;groupBy?: ...[] |null;having?: {expression?: ...; };legend?:string;limit?:number;name?:string;offset?:number;order?: ...[] |null;returnSpansFrom?:string;selectFields?: ...[] |null;stepInterval?:string|number; };type:"builder_trace_operator"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; };type:"promql"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string; };type:"clickhouse_sql"; })[] |null
RuletypesRuleCondition.compositeQuery.queryType
queryType:
"promql"|"clickhouse_sql"|"builder"
RuletypesRuleCondition.compositeQuery.unit?
optionalunit?:string
RuletypesRuleCondition.matchType?
optionalmatchType?:"last"|"at_least_once"|"all_the_times"|"on_average"|"in_total"
RuletypesRuleCondition.op?
optionalop?:"above"|"below"|"above_or_equal"|"below_or_equal"|"equal"|"not_equal"|"outside_bounds"
RuletypesRuleCondition.requiredNumPoints?
optionalrequiredNumPoints?:number
RuletypesRuleCondition.requireMinPoints?
optionalrequireMinPoints?:boolean
RuletypesRuleCondition.seasonality?
optionalseasonality?:"daily"|"weekly"|"hourly"
RuletypesRuleCondition.selectedQueryName?
optionalselectedQueryName?:string
RuletypesRuleCondition.target?
optionaltarget?:number|null
Format: double
RuletypesRuleCondition.targetUnit?
optionaltargetUnit?:string
RuletypesRuleCondition.thresholds?
optionalthresholds?:object
RuletypesRuleCondition.thresholds.kind
kind:
"basic"
Description
discriminator enum property added by openapi-typescript
RuletypesRuleCondition.thresholds.spec
spec:
object[] |null
RuletypesRuleThresholdData
RuletypesRuleThresholdData:
object
RuletypesRuleThresholdData.kind
kind:
"basic"
Description
discriminator enum property added by openapi-typescript
RuletypesRuleThresholdData.spec
spec:
object[] |null
RuletypesRuleType
RuletypesRuleType:
"threshold_rule"|"promql_rule"|"anomaly_rule"
RuletypesScheduleType
RuletypesScheduleType:
"daily"|"weekly"|"monthly"|"hourly"
RuletypesSeasonality
RuletypesSeasonality:
"daily"|"weekly"|"hourly"
RuletypesThresholdBasic
RuletypesThresholdBasic:
object
RuletypesThresholdBasic.kind
kind:
"basic"
Description
discriminator enum property added by openapi-typescript
RuletypesThresholdBasic.spec
spec:
object[] |null
RuletypesThresholdKind
RuletypesThresholdKind:
"basic"
SavedviewtypesDisplay
SavedviewtypesDisplay:
object
SavedviewtypesDisplay.color?
optionalcolor?:string
SavedviewtypesDisplay.fontSize?
optionalfontSize?:string
SavedviewtypesDisplay.format?
optionalformat?:string
SavedviewtypesDisplay.maxLines?
optionalmaxLines?:number
SavedviewtypesPanelType
SavedviewtypesPanelType:
"trace"|"list"|"value"|"table"|"graph"
SavedviewtypesPostableSavedView
SavedviewtypesPostableSavedView:
object
SavedviewtypesPostableSavedView.generateName?
optionalgenerateName?:boolean
SavedviewtypesPostableSavedView.name?
optionalname?:string
SavedviewtypesPostableSavedView.schemaVersion
schemaVersion:
"v2"
SavedviewtypesPostableSavedView.source
source:
"logs"|"traces"|"metrics"|"meter"|"ai_observability"
SavedviewtypesPostableSavedView.spec
spec:
object
SavedviewtypesPostableSavedView.spec.display?
optionaldisplay?:object
SavedviewtypesPostableSavedView.spec.display.color?
optionalcolor?:string
SavedviewtypesPostableSavedView.spec.display.fontSize?
optionalfontSize?:string
SavedviewtypesPostableSavedView.spec.display.format?
optionalformat?:string
SavedviewtypesPostableSavedView.spec.display.maxLines?
optionalmaxLines?:number
SavedviewtypesPostableSavedView.spec.displayName
displayName:
string
SavedviewtypesPostableSavedView.spec.panelType
panelType:
"trace"|"list"|"value"|"table"|"graph"
SavedviewtypesPostableSavedView.spec.queries
queries: ({
spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_query"; } | {spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };disabled?:boolean;expression?:string;functions?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;name?:string;order?:object[] |null; };type:"builder_formula"; } | {spec?: {aggregations?:object[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;name?:string;offset?:number;order?:object[] |null;returnSpansFrom?:string;selectFields?:object[] |null;stepInterval?:string|number; };type:"builder_trace_operator"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; };type:"promql"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string; };type:"clickhouse_sql"; })[]
SavedviewtypesPostableSavedView.spec.requestType
requestType:
"trace"|"raw"|"scalar"|"time_series"|"raw_stream"|"heatmap"
SavedviewtypesPostableSavedView.spec.selectedFields?
optionalselectedFields?:object[]
SavedviewtypesSavedView
SavedviewtypesSavedView:
object
SavedviewtypesSavedView.createdAt?
optionalcreatedAt?:string
Format: date-time
SavedviewtypesSavedView.createdBy?
optionalcreatedBy?:string
SavedviewtypesSavedView.id
id:
string
SavedviewtypesSavedView.name?
optionalname?:string
SavedviewtypesSavedView.schemaVersion
schemaVersion:
"v2"
SavedviewtypesSavedView.source?
optionalsource?:"logs"|"traces"|"metrics"|"meter"|"ai_observability"
SavedviewtypesSavedView.spec
spec:
object
SavedviewtypesSavedView.spec.display?
optionaldisplay?:object
SavedviewtypesSavedView.spec.display.color?
optionalcolor?:string
SavedviewtypesSavedView.spec.display.fontSize?
optionalfontSize?:string
SavedviewtypesSavedView.spec.display.format?
optionalformat?:string
SavedviewtypesSavedView.spec.display.maxLines?
optionalmaxLines?:number
SavedviewtypesSavedView.spec.displayName
displayName:
string
SavedviewtypesSavedView.spec.panelType
panelType:
"trace"|"list"|"value"|"table"|"graph"
SavedviewtypesSavedView.spec.queries
queries: ({
spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_query"; } | {spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };disabled?:boolean;expression?:string;functions?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;name?:string;order?:object[] |null; };type:"builder_formula"; } | {spec?: {aggregations?:object[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;name?:string;offset?:number;order?:object[] |null;returnSpansFrom?:string;selectFields?:object[] |null;stepInterval?:string|number; };type:"builder_trace_operator"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; };type:"promql"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string; };type:"clickhouse_sql"; })[]
SavedviewtypesSavedView.spec.requestType
requestType:
"trace"|"raw"|"scalar"|"time_series"|"raw_stream"|"heatmap"
SavedviewtypesSavedView.spec.selectedFields?
optionalselectedFields?:object[]
SavedviewtypesSavedView.updatedAt?
optionalupdatedAt?:string
Format: date-time
SavedviewtypesSavedView.updatedBy?
optionalupdatedBy?:string
SavedviewtypesSavedViewSpec
SavedviewtypesSavedViewSpec:
object
SavedviewtypesSavedViewSpec.display?
optionaldisplay?:object
SavedviewtypesSavedViewSpec.display.color?
optionalcolor?:string
SavedviewtypesSavedViewSpec.display.fontSize?
optionalfontSize?:string
SavedviewtypesSavedViewSpec.display.format?
optionalformat?:string
SavedviewtypesSavedViewSpec.display.maxLines?
optionalmaxLines?:number
SavedviewtypesSavedViewSpec.displayName
displayName:
string
SavedviewtypesSavedViewSpec.panelType
panelType:
"trace"|"list"|"value"|"table"|"graph"
SavedviewtypesSavedViewSpec.queries
queries: ({
spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?: ...[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?: ...[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?: ...[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_query"; } | {spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;limitBy?: {keys?: ...[] |null;value?:string; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: {kind:"linear";spec: {maxValue:number;numBuckets?: ... | ...; }; } | {kind:"log";spec: {scale?: ... | ... | ...; }; };disabled?:boolean;expression?:string;functions?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;name?:string;order?:object[] |null; };type:"builder_formula"; } | {spec?: {aggregations?:object[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?:string; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?:string; };legend?:string;limit?:number;name?:string;offset?:number;order?:object[] |null;returnSpansFrom?:string;selectFields?:object[] |null;stepInterval?:string|number; };type:"builder_trace_operator"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; };type:"promql"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string; };type:"clickhouse_sql"; })[]
SavedviewtypesSavedViewSpec.requestType
requestType:
"trace"|"raw"|"scalar"|"time_series"|"raw_stream"|"heatmap"
SavedviewtypesSavedViewSpec.selectedFields?
optionalselectedFields?:object[]
SavedviewtypesSchemaVersion
SavedviewtypesSchemaVersion:
"v2"
SavedviewtypesSource
SavedviewtypesSource:
"logs"|"traces"|"metrics"|"meter"|"ai_observability"
SavedviewtypesUpdatableSavedView
SavedviewtypesUpdatableSavedView:
object
SavedviewtypesUpdatableSavedView.schemaVersion
schemaVersion:
"v2"
SavedviewtypesUpdatableSavedView.source
source:
"logs"|"traces"|"metrics"|"meter"|"ai_observability"
SavedviewtypesUpdatableSavedView.spec
spec:
object
SavedviewtypesUpdatableSavedView.spec.display?
optionaldisplay?:object
SavedviewtypesUpdatableSavedView.spec.display.color?
optionalcolor?:string
SavedviewtypesUpdatableSavedView.spec.display.fontSize?
optionalfontSize?:string
SavedviewtypesUpdatableSavedView.spec.display.format?
optionalformat?:string
SavedviewtypesUpdatableSavedView.spec.display.maxLines?
optionalmaxLines?:number
SavedviewtypesUpdatableSavedView.spec.displayName
displayName:
string
SavedviewtypesUpdatableSavedView.spec.panelType
panelType:
"trace"|"list"|"value"|"table"|"graph"
SavedviewtypesUpdatableSavedView.spec.queries
queries: ({
spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"logs";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"metrics";source?:""|"meter";stepInterval?:string|number; } | {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_query"; } | {spec?: {aggregations?:object[] |null;bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };cursor?:string;disabled?:boolean;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;limitBy?: {keys?: ... | ... | ...;value?: ... | ...; };name?:string;offset?:number;order?:object[] |null;secondaryAggregations?:object[] |null;selectFields?:object[] |null;signal:"traces";source?:""|"meter";stepInterval?:string|number; };type:"builder_ai_query"; } | {spec?: {bucketOptions?: {kind:"linear";spec: {maxValue: ...;numBuckets?: ...; }; } | {kind:"log";spec: {scale?: ...; }; };disabled?:boolean;expression?:string;functions?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;name?:string;order?:object[] |null; };type:"builder_formula"; } | {spec?: {aggregations?:object[] |null;cursor?:string;disabled?:boolean;expression?:string;filter?: {expression?: ... | ...; };functions?:object[] |null;groupBy?:object[] |null;having?: {expression?: ... | ...; };legend?:string;limit?:number;name?:string;offset?:number;order?:object[] |null;returnSpansFrom?:string;selectFields?:object[] |null;stepInterval?:string|number; };type:"builder_trace_operator"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string;stats?:boolean;step?:string|number; };type:"promql"; } | {spec?: {disabled?:boolean;legend?:string;name?:string;query?:string; };type:"clickhouse_sql"; })[]
SavedviewtypesUpdatableSavedView.spec.requestType
requestType:
"trace"|"raw"|"scalar"|"time_series"|"raw_stream"|"heatmap"
SavedviewtypesUpdatableSavedView.spec.selectedFields?
optionalselectedFields?:object[]
ServiceaccounttypesGettableFactorAPIKey
ServiceaccounttypesGettableFactorAPIKey:
object
ServiceaccounttypesGettableFactorAPIKey.createdAt?
optionalcreatedAt?:string
Format: date-time
ServiceaccounttypesGettableFactorAPIKey.expiresAt
expiresAt:
number
ServiceaccounttypesGettableFactorAPIKey.id
id:
string
ServiceaccounttypesGettableFactorAPIKey.lastObservedAt
lastObservedAt:
string
Format: date-time
ServiceaccounttypesGettableFactorAPIKey.name?
optionalname?:string
ServiceaccounttypesGettableFactorAPIKey.serviceAccountId
serviceAccountId:
string
ServiceaccounttypesGettableFactorAPIKey.updatedAt?
optionalupdatedAt?:string
Format: date-time
ServiceaccounttypesGettableFactorAPIKeyWithKey
ServiceaccounttypesGettableFactorAPIKeyWithKey:
object
ServiceaccounttypesGettableFactorAPIKeyWithKey.id
id:
string
ServiceaccounttypesGettableFactorAPIKeyWithKey.key
key:
string
ServiceaccounttypesPostableFactorAPIKey
ServiceaccounttypesPostableFactorAPIKey:
object
ServiceaccounttypesPostableFactorAPIKey.expiresAt
expiresAt:
number
ServiceaccounttypesPostableFactorAPIKey.name
name:
string
ServiceaccounttypesPostableServiceAccount
ServiceaccounttypesPostableServiceAccount:
object
ServiceaccounttypesPostableServiceAccount.name
name:
string
ServiceaccounttypesPostableServiceAccountRole
ServiceaccounttypesPostableServiceAccountRole:
object
ServiceaccounttypesPostableServiceAccountRole.roleId
roleId:
string
ServiceaccounttypesPostableServiceAccountRole.serviceAccountId
serviceAccountId:
string
ServiceaccounttypesServiceAccount
ServiceaccounttypesServiceAccount:
object
ServiceaccounttypesServiceAccount.createdAt?
optionalcreatedAt?:string
Format: date-time
ServiceaccounttypesServiceAccount.email
email:
string
ServiceaccounttypesServiceAccount.id
id:
string
ServiceaccounttypesServiceAccount.name
name:
string
ServiceaccounttypesServiceAccount.orgId
orgId:
string
ServiceaccounttypesServiceAccount.status
status:
string
ServiceaccounttypesServiceAccount.updatedAt?
optionalupdatedAt?:string
Format: date-time
ServiceaccounttypesServiceAccountRole
ServiceaccounttypesServiceAccountRole:
object
ServiceaccounttypesServiceAccountRole.createdAt?
optionalcreatedAt?:string
Format: date-time
ServiceaccounttypesServiceAccountRole.id
id:
string
ServiceaccounttypesServiceAccountRole.role
role:
object
ServiceaccounttypesServiceAccountRole.role.createdAt?
optionalcreatedAt?:string
Format: date-time
ServiceaccounttypesServiceAccountRole.role.description
description:
string
ServiceaccounttypesServiceAccountRole.role.id
id:
string
ServiceaccounttypesServiceAccountRole.role.name
name:
string
ServiceaccounttypesServiceAccountRole.role.orgId
orgId:
string
ServiceaccounttypesServiceAccountRole.role.transactionGroups
transactionGroups:
object[]
ServiceaccounttypesServiceAccountRole.role.type
type:
string
ServiceaccounttypesServiceAccountRole.role.updatedAt?
optionalupdatedAt?:string
Format: date-time
ServiceaccounttypesServiceAccountRole.roleId
roleId:
string
ServiceaccounttypesServiceAccountRole.serviceAccountId
serviceAccountId:
string
ServiceaccounttypesServiceAccountRole.updatedAt?
optionalupdatedAt?:string
Format: date-time
ServiceaccounttypesServiceAccountWithRoles
ServiceaccounttypesServiceAccountWithRoles:
object
ServiceaccounttypesServiceAccountWithRoles.createdAt?
optionalcreatedAt?:string
Format: date-time
ServiceaccounttypesServiceAccountWithRoles.email
email:
string
ServiceaccounttypesServiceAccountWithRoles.id
id:
string
ServiceaccounttypesServiceAccountWithRoles.name
name:
string
ServiceaccounttypesServiceAccountWithRoles.orgId
orgId:
string
ServiceaccounttypesServiceAccountWithRoles.serviceAccountRoles
serviceAccountRoles:
object[] |null
ServiceaccounttypesServiceAccountWithRoles.status
status:
string
ServiceaccounttypesServiceAccountWithRoles.updatedAt?
optionalupdatedAt?:string
Format: date-time
ServiceaccounttypesUpdatableFactorAPIKey
ServiceaccounttypesUpdatableFactorAPIKey:
object
ServiceaccounttypesUpdatableFactorAPIKey.expiresAt
expiresAt:
number
ServiceaccounttypesUpdatableFactorAPIKey.name
name:
string
Sigv4SigV4Config
Sigv4SigV4Config:
Record<string,never>
SpantypesEvent
SpantypesEvent:
object
SpantypesEvent.attributeMap?
optionalattributeMap?:object
Index Signature
[key: string]: unknown
SpantypesEvent.isError?
optionalisError?:boolean
SpantypesEvent.name?
optionalname?:string
SpantypesEvent.timeUnixNano?
optionaltimeUnixNano?:number
SpantypesFieldContext
SpantypesFieldContext:
"resource"|"attribute"
SpantypesFlamegraphSpan
SpantypesFlamegraphSpan:
object
SpantypesFlamegraphSpan.attributes
attributes:
object
Index Signature
[key: string]: unknown
SpantypesFlamegraphSpan.durationNano
durationNano:
number
SpantypesFlamegraphSpan.event
event:
object[]
SpantypesFlamegraphSpan.hasError
hasError:
boolean
SpantypesFlamegraphSpan.level
level:
number
Format: int64
SpantypesFlamegraphSpan.name
name:
string
SpantypesFlamegraphSpan.parentSpanId
parentSpanId:
string
SpantypesFlamegraphSpan.resource
resource:
object
Index Signature
[key: string]: string
SpantypesFlamegraphSpan.spanId
spanId:
string
SpantypesFlamegraphSpan.timestamp
timestamp:
number
SpantypesGettableFlamegraphTrace
SpantypesGettableFlamegraphTrace:
object
SpantypesGettableFlamegraphTrace.endTimestampMillis
endTimestampMillis:
number
Format: int64
SpantypesGettableFlamegraphTrace.hasMore
hasMore:
boolean
SpantypesGettableFlamegraphTrace.spans
spans:
object[][]
SpantypesGettableFlamegraphTrace.startTimestampMillis
startTimestampMillis:
number
Format: int64
SpantypesGettableSpanMapperGroups
SpantypesGettableSpanMapperGroups:
object
SpantypesGettableSpanMapperGroups.items
items:
object[]
SpantypesGettableSpanMappers
SpantypesGettableSpanMappers:
object
SpantypesGettableSpanMappers.items
items:
object[]
SpantypesGettableSpanMapperTest
SpantypesGettableSpanMapperTest:
object
SpantypesGettableSpanMapperTest.collectorLogs?
optionalcollectorLogs?:string[] |null
SpantypesGettableSpanMapperTest.spans?
optionalspans?:object[] |null
SpantypesGettableTraceAggregations
SpantypesGettableTraceAggregations:
object
SpantypesGettableTraceAggregations.aggregations
aggregations:
object[]
SpantypesGettableWaterfallTrace
SpantypesGettableWaterfallTrace:
object
SpantypesGettableWaterfallTrace.endTimestampMillis?
optionalendTimestampMillis?:number
SpantypesGettableWaterfallTrace.hasMissingSpans?
optionalhasMissingSpans?:boolean
SpantypesGettableWaterfallTrace.hasMore?
optionalhasMore?:boolean
SpantypesGettableWaterfallTrace.rootServiceEntryPoint?
optionalrootServiceEntryPoint?:string
SpantypesGettableWaterfallTrace.rootServiceName?
optionalrootServiceName?:string
SpantypesGettableWaterfallTrace.spans?
optionalspans?:object[] |null
SpantypesGettableWaterfallTrace.startTimestampMillis?
optionalstartTimestampMillis?:number
SpantypesGettableWaterfallTrace.totalErrorSpansCount?
optionaltotalErrorSpansCount?:number
SpantypesGettableWaterfallTrace.totalSpansCount?
optionaltotalSpansCount?:number
SpantypesGettableWaterfallTrace.uncollapsedSpans?
optionaluncollapsedSpans?:string[] |null
SpantypesOtelSpanRef
SpantypesOtelSpanRef:
object
SpantypesOtelSpanRef.refType?
optionalrefType?:string
SpantypesOtelSpanRef.spanId?
optionalspanId?:string
SpantypesOtelSpanRef.traceId?
optionaltraceId?:string
SpantypesPostableFlamegraph
SpantypesPostableFlamegraph:
object
SpantypesPostableFlamegraph.selectedSpanId?
optionalselectedSpanId?:string
SpantypesPostableFlamegraph.selectFields?
optionalselectFields?:object[]
SpantypesPostableSpanMapper
SpantypesPostableSpanMapper:
object
SpantypesPostableSpanMapper.config
config:
object
SpantypesPostableSpanMapper.config.sources
sources:
object[] |null
SpantypesPostableSpanMapper.enabled?
optionalenabled?:boolean
SpantypesPostableSpanMapper.fieldContext
fieldContext:
"resource"|"attribute"
SpantypesPostableSpanMapper.name
name:
string
SpantypesPostableSpanMapperGroup
SpantypesPostableSpanMapperGroup:
object
SpantypesPostableSpanMapperGroup.condition
condition: {
attributes:string[] |null;resource:string[] |null; } |null
SpantypesPostableSpanMapperGroup.enabled?
optionalenabled?:boolean
SpantypesPostableSpanMapperGroup.name
name:
string
SpantypesPostableSpanMapperTest
SpantypesPostableSpanMapperTest:
object
SpantypesPostableSpanMapperTest.groups
groups:
object[] |null
SpantypesPostableSpanMapperTest.spans
spans:
object[] |null
SpantypesPostableSpanMapperTestGroup
SpantypesPostableSpanMapperTestGroup:
object
SpantypesPostableSpanMapperTestGroup.condition
condition: {
attributes:string[] |null;resource:string[] |null; } |null
SpantypesPostableSpanMapperTestGroup.enabled?
optionalenabled?:boolean
SpantypesPostableSpanMapperTestGroup.mappers?
optionalmappers?:object[] |null
SpantypesPostableSpanMapperTestGroup.name
name:
string
SpantypesPostableTraceAggregations
SpantypesPostableTraceAggregations:
object
SpantypesPostableTraceAggregations.aggregations
aggregations:
object[]
SpantypesPostableWaterfall
SpantypesPostableWaterfall:
object
SpantypesPostableWaterfall.selectedSpanId?
optionalselectedSpanId?:string
SpantypesPostableWaterfall.uncollapsedSpans?
optionaluncollapsedSpans?:string[] |null
SpantypesSpanAggregation
SpantypesSpanAggregation:
object
SpantypesSpanAggregation.aggregation
aggregation:
"span_count"|"execution_time_percentage"|"duration"
SpantypesSpanAggregation.field
field:
object
SpantypesSpanAggregation.field.description?
optionaldescription?:string
SpantypesSpanAggregation.field.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
SpantypesSpanAggregation.field.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
SpantypesSpanAggregation.field.name
name:
string
SpantypesSpanAggregation.field.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
SpantypesSpanAggregation.field.unit?
optionalunit?:string
SpantypesSpanAggregationResult
SpantypesSpanAggregationResult:
object
SpantypesSpanAggregationResult.aggregation
aggregation:
"span_count"|"execution_time_percentage"|"duration"
SpantypesSpanAggregationResult.field
field:
object
SpantypesSpanAggregationResult.field.description?
optionaldescription?:string
SpantypesSpanAggregationResult.field.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
SpantypesSpanAggregationResult.field.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
SpantypesSpanAggregationResult.field.name
name:
string
SpantypesSpanAggregationResult.field.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
SpantypesSpanAggregationResult.field.unit?
optionalunit?:string
SpantypesSpanAggregationResult.value
value: {[
key:string]:number; } |null
SpantypesSpanAggregationType
SpantypesSpanAggregationType:
"span_count"|"execution_time_percentage"|"duration"
SpantypesSpanMapper
SpantypesSpanMapper:
object
SpantypesSpanMapper.config
config:
object
SpantypesSpanMapper.config.sources
sources:
object[] |null
SpantypesSpanMapper.createdAt?
optionalcreatedAt?:string
Format: date-time
SpantypesSpanMapper.createdBy?
optionalcreatedBy?:string
SpantypesSpanMapper.enabled
enabled:
boolean
SpantypesSpanMapper.fieldContext
fieldContext:
"resource"|"attribute"
SpantypesSpanMapper.groupId
groupId:
string
SpantypesSpanMapper.id
id:
string
SpantypesSpanMapper.name
name:
string
SpantypesSpanMapper.updatedAt?
optionalupdatedAt?:string
Format: date-time
SpantypesSpanMapper.updatedBy?
optionalupdatedBy?:string
SpantypesSpanMapperConfig
SpantypesSpanMapperConfig:
object
SpantypesSpanMapperConfig.sources
sources:
object[] |null
SpantypesSpanMapperGroup
SpantypesSpanMapperGroup:
object
SpantypesSpanMapperGroup.condition
condition: {
attributes:string[] |null;resource:string[] |null; } |null
SpantypesSpanMapperGroup.createdAt?
optionalcreatedAt?:string
Format: date-time
SpantypesSpanMapperGroup.createdBy?
optionalcreatedBy?:string
SpantypesSpanMapperGroup.enabled
enabled:
boolean
SpantypesSpanMapperGroup.id
id:
string
SpantypesSpanMapperGroup.name
name:
string
SpantypesSpanMapperGroup.orgId
orgId:
string
SpantypesSpanMapperGroup.updatedAt?
optionalupdatedAt?:string
Format: date-time
SpantypesSpanMapperGroup.updatedBy?
optionalupdatedBy?:string
SpantypesSpanMapperGroupCondition
SpantypesSpanMapperGroupCondition: {
attributes:string[] |null;resource:string[] |null; } |null
SpantypesSpanMapperOperation
SpantypesSpanMapperOperation:
"move"|"copy"
SpantypesSpanMapperSource
SpantypesSpanMapperSource:
object
SpantypesSpanMapperSource.context
context:
"resource"|"attribute"
SpantypesSpanMapperSource.key
key:
string
SpantypesSpanMapperSource.operation
operation:
"move"|"copy"
SpantypesSpanMapperSource.priority
priority:
number
SpantypesSpanMapperTestSpan
SpantypesSpanMapperTestSpan:
object
SpantypesSpanMapperTestSpan.attributes?
optionalattributes?: {[key:string]:unknown; } |null
SpantypesSpanMapperTestSpan.resource?
optionalresource?: {[key:string]:unknown; } |null
SpantypesUpdatableSpanMapper
SpantypesUpdatableSpanMapper:
object
SpantypesUpdatableSpanMapper.config?
optionalconfig?:object
SpantypesUpdatableSpanMapper.config.sources
sources:
object[] |null
SpantypesUpdatableSpanMapper.enabled?
optionalenabled?:boolean|null
SpantypesUpdatableSpanMapper.fieldContext?
optionalfieldContext?:"resource"|"attribute"
SpantypesUpdatableSpanMapperGroup
SpantypesUpdatableSpanMapperGroup:
object
SpantypesUpdatableSpanMapperGroup.condition?
optionalcondition?: {attributes:string[] |null;resource:string[] |null; } |null
SpantypesUpdatableSpanMapperGroup.enabled?
optionalenabled?:boolean|null
SpantypesUpdatableSpanMapperGroup.name?
optionalname?:string|null
SpantypesWaterfallSpan
SpantypesWaterfallSpan:
object
SpantypesWaterfallSpan.attributes?
optionalattributes?: {[key:string]:unknown; } |null
SpantypesWaterfallSpan.db_name?
optionaldb_name?:string
SpantypesWaterfallSpan.db_operation?
optionaldb_operation?:string
SpantypesWaterfallSpan.duration_nano?
optionalduration_nano?:number
SpantypesWaterfallSpan.events?
optionalevents?:object[] |null
SpantypesWaterfallSpan.external_http_method?
optionalexternal_http_method?:string
SpantypesWaterfallSpan.external_http_url?
optionalexternal_http_url?:string
SpantypesWaterfallSpan.flags?
optionalflags?:number
SpantypesWaterfallSpan.has_children?
optionalhas_children?:boolean
SpantypesWaterfallSpan.has_error?
optionalhas_error?:boolean
SpantypesWaterfallSpan.http_host?
optionalhttp_host?:string
SpantypesWaterfallSpan.http_method?
optionalhttp_method?:string
SpantypesWaterfallSpan.http_url?
optionalhttp_url?:string
SpantypesWaterfallSpan.is_remote?
optionalis_remote?:string
SpantypesWaterfallSpan.kind_string?
optionalkind_string?:string
SpantypesWaterfallSpan.level?
optionallevel?:number
SpantypesWaterfallSpan.name?
optionalname?:string
SpantypesWaterfallSpan.parent_span_id?
optionalparent_span_id?:string
SpantypesWaterfallSpan.references
references:
object[]
SpantypesWaterfallSpan.resource?
optionalresource?: {[key:string]:string; } |null
SpantypesWaterfallSpan.response_status_code?
optionalresponse_status_code?:string
SpantypesWaterfallSpan.span_id?
optionalspan_id?:string
SpantypesWaterfallSpan.status_code?
optionalstatus_code?:number
SpantypesWaterfallSpan.status_code_string?
optionalstatus_code_string?:string
SpantypesWaterfallSpan.status_message?
optionalstatus_message?:string
SpantypesWaterfallSpan.sub_tree_node_count?
optionalsub_tree_node_count?:number
SpantypesWaterfallSpan.time_unix?
optionaltime_unix?:number
SpantypesWaterfallSpan.trace_id?
optionaltrace_id?:string
SpantypesWaterfallSpan.trace_state?
optionaltrace_state?:string
SubscriptiontypesGettableSubscription
SubscriptiontypesGettableSubscription:
object
SubscriptiontypesGettableSubscription.redirectURL
redirectURL:
string
SubscriptiontypesGettableSubscriptionUsage
SubscriptiontypesGettableSubscriptionUsage:
object
SubscriptiontypesGettableSubscriptionUsage.billingPeriodEnd?
optionalbillingPeriodEnd?:number
Format: int64
SubscriptiontypesGettableSubscriptionUsage.billingPeriodStart?
optionalbillingPeriodStart?:number
Format: int64
SubscriptiontypesGettableSubscriptionUsage.details?
optionaldetails?:object
SubscriptiontypesGettableSubscriptionUsage.details.baseFee?
optionalbaseFee?:number
Format: double
SubscriptiontypesGettableSubscriptionUsage.details.billTotal?
optionalbillTotal?:number
Format: double
SubscriptiontypesGettableSubscriptionUsage.details.breakdown?
optionalbreakdown?:object[] |null
SubscriptiontypesGettableSubscriptionUsage.details.total?
optionaltotal?:number
Format: double
SubscriptiontypesGettableSubscriptionUsage.discount?
optionaldiscount?:number
Format: double
SubscriptiontypesGettableSubscriptionUsage.subscriptionStatus?
optionalsubscriptionStatus?:string
SubscriptiontypesPostableSubscription
SubscriptiontypesPostableSubscription:
object
SubscriptiontypesPostableSubscription.url
url:
string
SubscriptiontypesSubscriptionUsageBreakdown
SubscriptiontypesSubscriptionUsageBreakdown:
object
SubscriptiontypesSubscriptionUsageBreakdown.dayWiseBreakdown?
optionaldayWiseBreakdown?:object
SubscriptiontypesSubscriptionUsageBreakdown.dayWiseBreakdown.breakdown?
optionalbreakdown?:object[] |null
SubscriptiontypesSubscriptionUsageBreakdown.dayWiseBreakdown.type?
optionaltype?:string
SubscriptiontypesSubscriptionUsageBreakdown.tiers?
optionaltiers?:object[] |null
SubscriptiontypesSubscriptionUsageBreakdown.type?
optionaltype?:string
SubscriptiontypesSubscriptionUsageBreakdown.unit?
optionalunit?:string
SubscriptiontypesSubscriptionUsageDayWiseBreakdown
SubscriptiontypesSubscriptionUsageDayWiseBreakdown:
object
SubscriptiontypesSubscriptionUsageDayWiseBreakdown.breakdown?
optionalbreakdown?:object[] |null
SubscriptiontypesSubscriptionUsageDayWiseBreakdown.type?
optionaltype?:string
SubscriptiontypesSubscriptionUsageDayWiseData
SubscriptiontypesSubscriptionUsageDayWiseData:
object
SubscriptiontypesSubscriptionUsageDayWiseData.count?
optionalcount?:number
Format: double
SubscriptiontypesSubscriptionUsageDayWiseData.quantity?
optionalquantity?:number
Format: double
SubscriptiontypesSubscriptionUsageDayWiseData.size?
optionalsize?:number
Format: double
SubscriptiontypesSubscriptionUsageDayWiseData.timestamp?
optionaltimestamp?:number
Format: int64
SubscriptiontypesSubscriptionUsageDayWiseData.total?
optionaltotal?:number
Format: double
SubscriptiontypesSubscriptionUsageDayWiseData.unitPrice?
optionalunitPrice?:number
Format: double
SubscriptiontypesSubscriptionUsageDetails
SubscriptiontypesSubscriptionUsageDetails:
object
SubscriptiontypesSubscriptionUsageDetails.baseFee?
optionalbaseFee?:number
Format: double
SubscriptiontypesSubscriptionUsageDetails.billTotal?
optionalbillTotal?:number
Format: double
SubscriptiontypesSubscriptionUsageDetails.breakdown?
optionalbreakdown?:object[] |null
SubscriptiontypesSubscriptionUsageDetails.total?
optionaltotal?:number
Format: double
SubscriptiontypesSubscriptionUsageTier
SubscriptiontypesSubscriptionUsageTier:
object
SubscriptiontypesSubscriptionUsageTier.quantity?
optionalquantity?:number
Format: double
SubscriptiontypesSubscriptionUsageTier.tierCost?
optionaltierCost?:number
Format: double
SubscriptiontypesSubscriptionUsageTier.tierEnd?
optionaltierEnd?:number
Format: int64
SubscriptiontypesSubscriptionUsageTier.tierStart?
optionaltierStart?:number
Format: int64
SubscriptiontypesSubscriptionUsageTier.unitPrice?
optionalunitPrice?:number
Format: double
TagtypesGettableTag
TagtypesGettableTag:
object
TagtypesGettableTag.key
key:
string
TagtypesGettableTag.value
value:
string
TagtypesPostableTag
TagtypesPostableTag:
object
TagtypesPostableTag.key
key:
string
TagtypesPostableTag.value
value:
string
TelemetrystoretypesEstimateEntry
TelemetrystoretypesEstimateEntry:
object
TelemetrystoretypesEstimateEntry.database
database:
string
TelemetrystoretypesEstimateEntry.marks
marks:
number
Format: int64
TelemetrystoretypesEstimateEntry.parts
parts:
number
Format: int64
TelemetrystoretypesEstimateEntry.rows
rows:
number
Format: int64
TelemetrystoretypesEstimateEntry.table
table:
string
TelemetrystoretypesGranules
TelemetrystoretypesGranules: {
initial:number;reads:object[];selected:number;skipped:number; } |null
Union Members
Type Literal
{ initial: number; reads: object[]; selected: number; skipped: number; }
initial
initial:
number
Format: int64
reads
reads:
object[]
selected
selected:
number
Format: int64
skipped
skipped:
number
Format: int64
null
TelemetrystoretypesIndexStep
TelemetrystoretypesIndexStep:
object
TelemetrystoretypesIndexStep.condition
condition:
string
TelemetrystoretypesIndexStep.initialGranules
initialGranules:
number
Format: int64
TelemetrystoretypesIndexStep.initialParts
initialParts:
number
Format: int64
TelemetrystoretypesIndexStep.keys
keys:
string[]
TelemetrystoretypesIndexStep.name
name:
string
TelemetrystoretypesIndexStep.selectedGranules
selectedGranules:
number
Format: int64
TelemetrystoretypesIndexStep.selectedParts
selectedParts:
number
Format: int64
TelemetrystoretypesIndexStep.type
type:
string
TelemetrystoretypesMergeTreeRead
TelemetrystoretypesMergeTreeRead:
object
TelemetrystoretypesMergeTreeRead.steps
steps:
object[]
TelemetrystoretypesMergeTreeRead.table
table:
string
TelemetrytypesFieldContext
TelemetrytypesFieldContext:
""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
TelemetrytypesFieldDataType
TelemetrytypesFieldDataType:
""|"string"|"number"|"bool"|"float64"|"int64"
TelemetrytypesGettableFieldKeys
TelemetrytypesGettableFieldKeys:
object
TelemetrytypesGettableFieldKeys.complete
complete:
boolean
TelemetrytypesGettableFieldKeys.keys
keys: {[
key:string]:object[]; } |null
TelemetrytypesGettableFieldValues
TelemetrytypesGettableFieldValues:
object
TelemetrytypesGettableFieldValues.complete
complete:
boolean
TelemetrytypesGettableFieldValues.values
values:
object
TelemetrytypesGettableFieldValues.values.boolValues?
optionalboolValues?:boolean[]
TelemetrytypesGettableFieldValues.values.numberValues?
optionalnumberValues?:number[]
TelemetrytypesGettableFieldValues.values.relatedValues?
optionalrelatedValues?:string[]
TelemetrytypesGettableFieldValues.values.stringValues?
optionalstringValues?:string[]
TelemetrytypesSignal
TelemetrytypesSignal:
""|"logs"|"traces"|"metrics"
TelemetrytypesSource
TelemetrytypesSource:
""|"meter"
TelemetrytypesTelemetryFieldKey
TelemetrytypesTelemetryFieldKey:
object
TelemetrytypesTelemetryFieldKey.description?
optionaldescription?:string
TelemetrytypesTelemetryFieldKey.fieldContext?
optionalfieldContext?:""|"metric"|"log"|"span"|"trace"|"resource"|"scope"|"attribute"|"body"
TelemetrytypesTelemetryFieldKey.fieldDataType?
optionalfieldDataType?:""|"string"|"number"|"bool"|"float64"|"int64"
TelemetrytypesTelemetryFieldKey.name
name:
string
TelemetrytypesTelemetryFieldKey.signal?
optionalsignal?:""|"logs"|"traces"|"metrics"
TelemetrytypesTelemetryFieldKey.unit?
optionalunit?:string
TelemetrytypesTelemetryFieldValues
TelemetrytypesTelemetryFieldValues:
object
TelemetrytypesTelemetryFieldValues.boolValues?
optionalboolValues?:boolean[]
TelemetrytypesTelemetryFieldValues.numberValues?
optionalnumberValues?:number[]
TelemetrytypesTelemetryFieldValues.relatedValues?
optionalrelatedValues?:string[]
TelemetrytypesTelemetryFieldValues.stringValues?
optionalstringValues?:string[]
TimeDuration
TimeDuration:
number
Format: int64
TypesAlertStatus
TypesAlertStatus:
object
TypesAlertStatus.inhibitedBy?
optionalinhibitedBy?:string[] |null
TypesAlertStatus.silencedBy?
optionalsilencedBy?:string[] |null
TypesAlertStatus.state?
optionalstate?:string
TypesChangePasswordRequest
TypesChangePasswordRequest:
object
TypesChangePasswordRequest.newPassword?
optionalnewPassword?:string
TypesChangePasswordRequest.oldPassword?
optionaloldPassword?:string
TypesIdentifiable
TypesIdentifiable:
object
TypesIdentifiable.id
id:
string
TypesOrganization
TypesOrganization:
object
TypesOrganization.alias?
optionalalias?:string
TypesOrganization.createdAt?
optionalcreatedAt?:string
Format: date-time
TypesOrganization.displayName?
optionaldisplayName?:string
TypesOrganization.id
id:
string
TypesOrganization.key?
optionalkey?:number
TypesOrganization.name?
optionalname?:string
TypesOrganization.updatedAt?
optionalupdatedAt?:string
Format: date-time
TypesPostableForgotPassword
TypesPostableForgotPassword:
object
TypesPostableForgotPassword.email
email:
string
TypesPostableForgotPassword.frontendBaseURL?
optionalfrontendBaseURL?:string
TypesPostableForgotPassword.orgId
orgId:
string
TypesPostableResetPassword
TypesPostableResetPassword:
object
TypesPostableResetPassword.password?
optionalpassword?:string
TypesPostableResetPassword.token?
optionaltoken?:string
TypesPostableVerifyResetPasswordToken
TypesPostableVerifyResetPasswordToken:
object
TypesPostableVerifyResetPasswordToken.token
token:
string
TypesResetPasswordToken
TypesResetPasswordToken:
object
TypesResetPasswordToken.expiresAt?
optionalexpiresAt?:string
Format: date-time
TypesResetPasswordToken.id
id:
string
TypesResetPasswordToken.passwordId?
optionalpasswordId?:string
TypesResetPasswordToken.token?
optionaltoken?:string
TypesUpdatableUser
TypesUpdatableUser:
object
TypesUpdatableUser.displayName
displayName:
string
TypesUser
TypesUser:
object
TypesUser.createdAt?
optionalcreatedAt?:string
Format: date-time
TypesUser.displayName?
optionaldisplayName?:string
TypesUser.email?
optionalemail?:string
TypesUser.id
id:
string
TypesUser.isRoot?
optionalisRoot?:boolean
TypesUser.orgId?
optionalorgId?:string
TypesUser.status?
optionalstatus?:string
TypesUser.updatedAt?
optionalupdatedAt?:string
Format: date-time
ZeustypesGettableHost
ZeustypesGettableHost:
object
ZeustypesGettableHost.hosts
hosts:
object[] |null
ZeustypesGettableHost.name
name:
string
ZeustypesGettableHost.state
state:
string
ZeustypesGettableHost.tier
tier:
string
ZeustypesHost
ZeustypesHost:
object
ZeustypesHost.is_default
is_default:
boolean
ZeustypesHost.name
name:
string
ZeustypesHost.url
url:
string
ZeustypesPostableHost
ZeustypesPostableHost:
object
ZeustypesPostableHost.name
name:
string
ZeustypesPostableProfile
ZeustypesPostableProfile:
object
ZeustypesPostableProfile.existing_observability_tool
existing_observability_tool:
string
ZeustypesPostableProfile.has_existing_observability_tool
has_existing_observability_tool:
boolean
ZeustypesPostableProfile.logs_scale_per_day_in_gb
logs_scale_per_day_in_gb:
number
Format: int64
ZeustypesPostableProfile.number_of_hosts
number_of_hosts:
number
Format: int64
ZeustypesPostableProfile.number_of_services
number_of_services:
number
Format: int64
ZeustypesPostableProfile.reasons_for_interest_in_signoz
reasons_for_interest_in_signoz:
string[] |null
ZeustypesPostableProfile.timeline_for_migrating_to_signoz
timeline_for_migrating_to_signoz:
string
ZeustypesPostableProfile.uses_otel
uses_otel:
boolean
ZeustypesPostableProfile.where_did_you_discover_signoz
where_did_you_discover_signoz:
string