Class StatusPageDataAttributes

The attributes of a status page.

Hierarchy

  • StatusPageDataAttributes

Constructors

constructor

Properties

additionalProperties? companyLogo? components? createdAt? customDomain? customDomainEnabled? domainPrefix? emailHeaderImage? emailNotificationsEnabled? enabled? favicon? modifiedAt? msTeamsSubscriptionsEnabled? name? pageUrl? rssFeedEnabled? slackAppIcon? slackSubscriptionsEnabled? subscriptionsEnabled? type? visualizationLayout? visualizationType?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional companyLogo

companyLogo?: string

Base64-encoded image data displayed on the status page.

Optional components

components?: StatusPageDataAttributesComponentsItems[]

Components displayed on the status page.

Optional createdAt

createdAt?: Date

Timestamp of when the status page was created.

Optional customDomain

customDomain?: string

If configured, the url that the status page is accessible at.

Optional customDomainEnabled

customDomainEnabled?: boolean

Whether the custom domain is configured.

Optional domainPrefix

domainPrefix?: string

The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.

Optional emailHeaderImage

emailHeaderImage?: string

Base64-encoded image data included in email notifications sent to status page subscribers.

Optional emailNotificationsEnabled

emailNotificationsEnabled?: boolean

Whether email notifications are enabled for the status page. Must be enabled when subscriptions_enabled is true.

Optional enabled

enabled?: boolean

Whether the status page is enabled.

Optional favicon

favicon?: string

Base64-encoded image data displayed in the browser tab.

Optional modifiedAt

modifiedAt?: Date

Timestamp of when the status page was last modified.

Optional msTeamsSubscriptionsEnabled

msTeamsSubscriptionsEnabled?: boolean

Whether Microsoft Teams subscriptions are enabled for the status page.

Optional name

name?: string

The name of the status page.

Optional pageUrl

pageUrl?: string

The url that the status page is accessible at.

Optional rssFeedEnabled

rssFeedEnabled?: boolean

Whether the RSS feed is enabled for the status page.

Optional slackAppIcon

slackAppIcon?: string

The Slack app icon URL for the status page.

Optional slackSubscriptionsEnabled

slackSubscriptionsEnabled?: boolean

Whether Slack subscriptions are enabled for the status page.

Optional subscriptionsEnabled

subscriptionsEnabled?: boolean

Whether users can subscribe to the status page.

Optional type

type?: CreateStatusPageRequestDataAttributesType

The type of the status page controlling how the status page is accessed.

Optional visualizationLayout

visualizationLayout?: CreateStatusPageRequestDataAttributesVisualizationLayout

The layout of components on the status page. Defaults to list. grid requires visualization_type to be component_name_only; changing visualization_type to any other value resets the layout to list.

Optional visualizationType

visualizationType?: CreateStatusPageRequestDataAttributesVisualizationType

The visualization type of the status page.

Settings

Member Visibility

Theme

Generated using TypeDoc