List components
https://api.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.us3.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.us5.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.datadoghq.eu/api/v2/statuspages/{page_id}/componentshttps://api.ap1.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.ap2.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.uk1.datadoghq.com/api/v2/statuspages/{page_id}/componentshttps://api.ddog-gov.com/api/v2/statuspages/{page_id}/componentshttps://api.us2.ddog-gov.com/api/v2/statuspages/{page_id}/componentsOverview
Lists all components for a status page.
OAuth apps require the status_pages_settings_read authorization scope to access this endpoint.
Arguments
Path Parameters
page_id [required]The ID of the status page.
Query Strings
includeComma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group.
Response
OK
Response object for a list of components.
data [required]A list of component data objects.
attributesThe attributes of a component.
componentsIf the component is of type group, the components within the group.
idThe ID of the component within the group.
nameThe name of the component within the group.
positionThe zero-indexed position of the component within the group.
statusThe status of the component.
operational, degraded, partial_outage, major_outage, maintenancetypeThe type of the component.
componentcreated_atTimestamp of when the component was created.
modified_atTimestamp of when the component was last modified.
nameThe name of the component.
positionThe zero-indexed position of the component.
statusThe status of the component.
operational, degraded, partial_outage, major_outage, maintenancetype [required]The type of the component.
component, groupidThe ID of the component.
relationshipsThe relationships of a component.
created_by_userThe Datadog user who created the component.
data [required]The data object identifying the Datadog user who created the component.
id [required]The ID of the Datadog user who created the component.
type [required]Users resource type.
usersusersgroupThe group the component belongs to.
data [required]The data object identifying the group the component belongs to.
id [required]The ID of the group the component belongs to.
type [required]Components resource type.
componentscomponentslast_modified_by_userThe Datadog user who last modified the component.
data [required]The data object identifying the Datadog user who last modified the component.
id [required]The ID of the Datadog user who last modified the component.
type [required]Users resource type.
usersusersstatus_pageThe status page the component belongs to.
data [required]The data object identifying the status page the component belongs to.
id [required]The ID of the status page the component belongs to.
type [required]Status pages resource type.
status_pagesstatus_pagestype [required]Components resource type.
componentscomponentsincludedThe included related resources of a component. Client must explicitly request these resources by name in the include query parameter.
<type=users>The included Datadog user resource.
attributesAttributes of the Datadog user.
emailThe email of the Datadog user.
handleThe handle of the Datadog user.
iconThe icon of the Datadog user.
nameThe name of the Datadog user.
uuidThe UUID of the Datadog user.
idThe ID of the Datadog user.
type [required]Users resource type.
usersusers<type=status_pages>The included status page resource.
attributesThe attributes of a status page.
company_logoThe base64-encoded image data displayed in the company logo.
componentsComponents displayed on the status page.
componentsIf the component is of type group, the components within the group.
idThe ID of the grouped component.
nameThe name of the grouped component.
positionThe zero-indexed position of the grouped component. Relative to the other components in the group.
statusThe status of the component.
operational, degraded, partial_outage, major_outage, maintenancetypeThe type of the component.
componentidThe ID of the component.
nameThe name of the component.
positionThe zero-indexed position of the component.
statusThe status of the component.
operational, degraded, partial_outage, major_outage, maintenancetypeThe type of the component.
component, groupcreated_atTimestamp of when the status page was created.
custom_domainIf configured, the url that the status page is accessible at.
custom_domain_enabledWhether the custom domain is configured.
domain_prefixThe subdomain of the status page's url taking the form https://{domain_prefix}.statuspage.datadoghq.com. Globally unique across Datadog Status Pages.
email_header_imageBase64-encoded image data included in email notifications sent to status page subscribers.
enabledWhether the status page is enabled.
faviconBase64-encoded image data displayed in the browser tab.
modified_atTimestamp of when the status page was last modified.
nameThe name of the status page.
page_urlThe url that the status page is accessible at.
slack_app_iconThe Slack app icon URL for the status page.
slack_subscriptions_enabledWhether Slack subscriptions are enabled for the status page.
subscriptions_enabledWhether users can subscribe to the status page.
typeThe type of the status page controlling how the status page is accessed.
public, internalvisualization_typeThe visualization type of the status page.
bars_and_uptime_percentage, bars_only, component_name_onlyidThe ID of the status page.
relationshipsThe relationships of a status page.
created_by_userThe Datadog user who created the status page.
data [required]The data object identifying the Datadog user who created the status page.
id [required]The ID of the Datadog user who created the status page.
type [required]Users resource type.
usersuserslast_modified_by_userThe Datadog user who last modified the status page.
data [required]The data object identifying the Datadog user who last modified the status page.
id [required]The ID of the Datadog user who last modified the status page.
type [required]Users resource type.
usersuserstype [required]Status pages resource type.
status_pagesstatus_pages<type=components>The included component group resource.
attributesThe attributes of a component group.
componentsIf the component is of type group, the components within the group.
idThe ID of the grouped component.
nameThe name of the grouped component.
positionThe zero-indexed position of the grouped component. Relative to the other components in the group.
statusThe status of the component.
operational, degraded, partial_outage, major_outage, maintenancetypeThe type of the component.
componentcreated_atTimestamp of when the component was created.
modified_atTimestamp of when the component was last modified.
nameThe name of the component.
positionThe zero-indexed position of the component.
statusThe status of the component.
operational, degraded, partial_outage, major_outage, maintenancetype [required]The type of the component.
component, groupidThe ID of the component.
relationshipsThe relationships of a component group.
created_by_userThe Datadog user who created the component group.
data [required]The data object identifying the Datadog user who created the component group.
id [required]The ID of the Datadog user who created the component group.
type [required]Users resource type.
usersusersgroupThe group the component group belongs to.
data [required]The data object identifying the parent group of a component group.
id [required]The ID of the parent group.
type [required]Components resource type.
componentscomponentslast_modified_by_userThe Datadog user who last modified the component group.
data [required]The data object identifying the Datadog user who last modified the component group.
id [required]The ID of the Datadog user who last modified the component group.
type [required]Users resource type.
usersusersstatus_pageThe status page the component group belongs to.
data [required]The data object identifying the status page the component group belongs to.
id [required]The ID of the status page.
type [required]Status pages resource type.
status_pagesstatus_pagestype [required]Components resource type.
componentscomponents{
"data": [
{
"attributes": {
"components": [
{
"id": "string",
"name": "string",
"position": "integer",
"status": "string",
"type": "component"
}
],
"created_at": "2019-09-19T10:00:00.000Z",
"modified_at": "2019-09-19T10:00:00.000Z",
"name": "string",
"position": "integer",
"status": "operational",
"type": "component"
},
"id": "string",
"relationships": {
"created_by_user": {
"data": {
"id": "",
"type": "users"
}
},
"group": {
"data": {
"id": "1234abcd-12ab-34cd-56ef-123456abcdef",
"type": "components"
}
},
"last_modified_by_user": {
"data": {
"id": "",
"type": "users"
}
},
"status_page": {
"data": {
"id": "1234abcd-12ab-34cd-56ef-123456abcdef",
"type": "status_pages"
}
}
},
"type": "components"
}
],
"included": [
{
"attributes": {
"email": "string",
"handle": "string",
"icon": "string",
"name": "string",
"uuid": "string"
},
"id": "string",
"type": "users"
}
]
}Too many requests
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/components" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/components" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/components" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/components" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/components" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/components" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/components" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/components" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export page_id="1234abcd-12ab-34cd-56ef-123456abcdef"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/statuspages/${page_id}/components" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"// List components 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() {
// there is a valid "status_page" in the system
StatusPageDataID := uuid.MustParse(os.Getenv("STATUS_PAGE_DATA_ID"))
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewStatusPagesApi(apiClient)
resp, r, err := api.ListComponents(ctx, StatusPageDataID, *datadogV2.NewListComponentsOptionalParameters())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `StatusPagesApi.ListComponents`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `StatusPagesApi.ListComponents`:\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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"// List components 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.StatusPagesComponentArray;
import java.util.UUID;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
StatusPagesApi apiInstance = new StatusPagesApi(defaultClient);
// there is a valid "status_page" in the system
UUID STATUS_PAGE_DATA_ID = null;
try {
STATUS_PAGE_DATA_ID = UUID.fromString(System.getenv("STATUS_PAGE_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}
try {
StatusPagesComponentArray result = apiInstance.listComponents(STATUS_PAGE_DATA_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling StatusPagesApi#listComponents");
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java""""
List components returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.status_pages_api import StatusPagesApi
# there is a valid "status_page" in the system
STATUS_PAGE_DATA_ID = environ["STATUS_PAGE_DATA_ID"]
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = StatusPagesApi(api_client)
response = api_instance.list_components(
page_id=STATUS_PAGE_DATA_ID,
)
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"# List components returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::StatusPagesAPI.new
# there is a valid "status_page" in the system
STATUS_PAGE_DATA_ID = ENV["STATUS_PAGE_DATA_ID"]
p api_instance.list_components(STATUS_PAGE_DATA_ID)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"// List components returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_status_pages::ListComponentsOptionalParams;
use datadog_api_client::datadogV2::api_status_pages::StatusPagesAPI;
#[tokio::main]
async fn main() {
// there is a valid "status_page" in the system
let status_page_data_id = uuid::Uuid::parse_str(&std::env::var("STATUS_PAGE_DATA_ID").unwrap())
.expect("Invalid UUID");
let configuration = datadog::Configuration::new();
let api = StatusPagesAPI::with_config(configuration);
let resp = api
.list_components(
status_page_data_id.clone(),
ListComponentsOptionalParams::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" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run/**
* List components returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
const apiInstance = new v2.StatusPagesApi(configuration);
// there is a valid "status_page" in the system
const STATUS_PAGE_DATA_ID = process.env.STATUS_PAGE_DATA_ID as string;
const params: v2.StatusPagesApiListComponentsRequest = {
pageId: STATUS_PAGE_DATA_ID,
};
apiInstance
.listComponents(params)
.then((data: v2.StatusPagesComponentArray) => {
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"