GET https://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/maintenance_templates https://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/maintenance_templates https://api.datadoghq.eu/api/v2/statuspages/{page_id}/maintenance_templates https://api.ddog-gov.com/api/v2/statuspages/{page_id}/maintenance_templates https://api.us2.ddog-gov.com/api/v2/statuspages/{page_id}/maintenance_templates https://api.uk1.datadoghq.com/api/v2/statuspages/{page_id}/maintenance_templates https://api.datadoghq.com/api/v2/statuspages/{page_id}/maintenance_templates https://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/maintenance_templates https://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/maintenance_templates
Overview Lists all maintenance templates for a status page.
OAuth apps require the status_pages_settings_read authorization scope to access this endpoint.
Arguments Path Parameters The ID of the status page.
Query Strings Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.
Response OK
Response object for a list of maintenance templates.
Expand All
A list of maintenance template data objects.
The attributes of a maintenance template.
The description shown when a maintenance created from this template is completed.
The IDs of the components affected by a maintenance created from this template.
Timestamp of when the maintenance template was created.
The description shown while a maintenance created from this template is in progress.
The title used for a maintenance created from this template.
Timestamp of when the maintenance template was last modified.
The name of the maintenance template.
The description shown when a maintenance created from this template is scheduled.
The ID of the maintenance template.
The relationships of a maintenance template.
The Datadog user who created the maintenance template.
The data object identifying the Datadog user who created the maintenance template.
The ID of the Datadog user who created the maintenance template.
Users resource type.
Allowed enum values: users
default: users
The Datadog user who last modified the maintenance template.
The data object identifying the Datadog user who last modified the maintenance template.
The ID of the Datadog user who last modified the maintenance template.
Users resource type.
Allowed enum values: users
default: users
The status page the maintenance template belongs to.
The data object identifying the status page associated with a maintenance template.
The ID of the status page.
Status pages resource type.
Allowed enum values: status_pages
default: status_pages
Maintenance templates resource type.
Allowed enum values: maintenance_templates
default: maintenance_templates
The included related resources of a maintenance template. Client must explicitly request these resources by name in the include query parameter.
The included Datadog user resource.
Attributes of the Datadog user.
The email of the Datadog user.
The handle of the Datadog user.
The icon of the Datadog user.
The name of the Datadog user.
The UUID of the Datadog user.
The ID of the Datadog user.
Users resource type.
Allowed enum values: users
default: users
The included status page resource.
The attributes of a status page.
The base64-encoded image data displayed in the company logo.
Components displayed on the status page.
If the component is of type group, the components within the group.
The ID of the grouped component.
The name of the grouped component.
The zero-indexed position of the grouped component. Relative to the other components in the group.
The status of the component.
Allowed enum values: operational,degraded,partial_outage,major_outage,maintenance
The type of the component.
Allowed enum values: component
The name of the component.
The zero-indexed position of the component.
The status of the component.
Allowed enum values: operational,degraded,partial_outage,major_outage,maintenance
The type of the component.
Allowed enum values: component,group
Timestamp of when the status page was created.
If configured, the url that the status page is accessible at.
Whether the custom domain is configured.
The subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
Base64-encoded image data included in email notifications sent to status page subscribers.
Whether the status page is enabled.
Base64-encoded image data displayed in the browser tab.
Timestamp of when the status page was last modified.
The name of the status page.
The url that the status page is accessible at.
The Slack app icon URL for the status page.
slack_subscriptions_enabled
Whether Slack subscriptions are enabled for the status page.
Whether users can subscribe to the status page.
The type of the status page controlling how the status page is accessed.
Allowed enum values: public,internal
The visualization type of the status page.
Allowed enum values: bars_and_uptime_percentage,bars_only,component_name_only
The ID of the status page.
The relationships of a status page.
The Datadog user who created the status page.
The data object identifying the Datadog user who created the status page.
The ID of the Datadog user who created the status page.
Users resource type.
Allowed enum values: users
default: users
The Datadog user who last modified the status page.
The data object identifying the Datadog user who last modified the status page.
The ID of the Datadog user who last modified the status page.
Users resource type.
Allowed enum values: users
default: users
Status pages resource type.
Allowed enum values: status_pages
default: status_pages
{
"data" : [
{
"attributes" : {
"completed_description" : "string" ,
"component_ids" : [],
"created_at" : "2019-09-19T10:00:00.000Z" ,
"in_progress_description" : "string" ,
"maintenance_title" : "string" ,
"modified_at" : "2019-09-19T10:00:00.000Z" ,
"name" : "string" ,
"scheduled_description" : "string"
},
"id" : "string" ,
"relationships" : {
"created_by_user" : {
"data" : {
"id" : "" ,
"type" : "users"
}
},
"last_modified_by_user" : {
"data" : {
"id" : "" ,
"type" : "users"
}
},
"status_page" : {
"data" : {
"id" : "" ,
"type" : "status_pages"
}
}
},
"type" : "maintenance_templates"
}
],
"included" : [
{
"attributes" : {
"email" : "string" ,
"handle" : "string" ,
"icon" : "string" ,
"name" : "string" ,
"uuid" : "string"
},
"id" : "string" ,
"type" : "users"
}
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Path parameters export page_id = "CHANGE_ME" # Curl command curl -X GET "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.uk1.datadoghq.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/statuspages/${page_id}/maintenance_templates " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
List maintenance templates returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi
from uuid import UUID
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = StatusPagesApi ( api_client )
response = api_instance . list_maintenance_templates (
page_id = UUID ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ),
)
print ( response )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# List maintenance templates returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V2 :: StatusPagesAPI . new
p api_instance . list_maintenance_templates ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" )
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// List maintenance templates returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
"github.com/google/uuid"
)
func main () {
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewStatusPagesApi ( apiClient )
resp , r , err := api . ListMaintenanceTemplates ( ctx , uuid . MustParse ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ), * datadogV2 . NewListMaintenanceTemplatesOptionalParameters ())
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `StatusPagesApi.ListMaintenanceTemplates`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `StatusPagesApi.ListMaintenanceTemplates`:\n%s\n" , responseContent )
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// List maintenance templates returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.StatusPagesApi ;
import com.datadog.api.client.v2.model.MaintenanceTemplateArray ;
import java.util.UUID ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
StatusPagesApi apiInstance = new StatusPagesApi ( defaultClient );
try {
MaintenanceTemplateArray result =
apiInstance . listMaintenanceTemplates (
UUID . fromString ( "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ));
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling StatusPagesApi#listMaintenanceTemplates" );
System . err . println ( "Status code: " + e . getCode ());
System . err . println ( "Reason: " + e . getResponseBody ());
System . err . println ( "Response headers: " + e . getResponseHeaders ());
e . printStackTrace ();
}
}
}
Instructions First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// List maintenance templates returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_status_pages ::ListMaintenanceTemplatesOptionalParams ;
use datadog_api_client ::datadogV2 ::api_status_pages ::StatusPagesAPI ;
use uuid ::Uuid ;
#[tokio::main]
async fn main () {
let configuration = datadog ::Configuration ::new ();
let api = StatusPagesAPI ::with_config ( configuration );
let resp = api
. list_maintenance_templates (
Uuid ::parse_str ( "00000000-0000-0000-0000-000000000000" ). expect ( "invalid UUID" ),
ListMaintenanceTemplatesOptionalParams ::default (),
)
. await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* List maintenance templates returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v2 . StatusPagesApi ( configuration );
const params : v2.StatusPagesApiListMaintenanceTemplatesRequest = {
pageId : "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" ,
};
apiInstance
. listMaintenanceTemplates ( params )
. then (( data : v2.MaintenanceTemplateArray ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"