Class CreateStatusPageRequestDataAttributes

The supported attributes for creating a status page.

Hierarchy

  • CreateStatusPageRequestDataAttributes

Constructors

constructor

Properties

additionalProperties? companyLogo? components? domainPrefix emailHeaderImage? emailNotificationsEnabled? favicon? msTeamsSubscriptionsEnabled? name 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

The base64-encoded image data displayed on the status page.

Optional components

components?: CreateStatusPageRequestDataAttributesComponentsItems[]

The components displayed on the status page.

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 favicon

favicon?: string

Base64-encoded image data displayed in the browser tab.

Optional msTeamsSubscriptionsEnabled

msTeamsSubscriptionsEnabled?: boolean

Whether Microsoft Teams subscriptions are enabled for the status page.

name

name: string

The name of the status page.

Optional rssFeedEnabled

rssFeedEnabled?: boolean

Whether the RSS feed is enabled for the status page.

Optional slackAppIcon

slackAppIcon?: string

The base64-encoded image data used as the Slack app icon.

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.

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.

visualizationType

visualizationType: CreateStatusPageRequestDataAttributesVisualizationType

The visualization type of the status page.

Settings

Member Visibility

Theme

Generated using TypeDoc