Update a Statuspage URL setting

v2 (latest)

PATCH https://api.ap1.datadoghq.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.ap2.datadoghq.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.datadoghq.eu/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.ddog-gov.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.us2.ddog-gov.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.uk1.datadoghq.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.datadoghq.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.us3.datadoghq.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.us5.datadoghq.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}

개요

조직에서 단일 Statuspage URL 설정을 업데이트합니다. This endpoint requires the manage_integrations permission.

인수

경로 파라미터

이름

유형

설명

statuspage_url_setting_id [required]

string

The UUID of the Statuspage URL setting.

요청

Body Data (required)

Statuspage URL 설정 페이로드입니다.

Expand All

항목

유형

설명

data [required]

object

Statuspage URL setting data for an update request.

{
  "data": {
    "attributes": {
      "custom_tags": "team:collaboration-integrations,env:prod",
      "url": "https://example.statuspage.io"
    },
    "id": "596da4af-0563-4097-90ff-07230c3f9db3",
    "type": "statuspage-url-setting"
  }
}

응답

Response containing a Statuspage URL setting.

Expand All

항목

유형

설명

data [required]

object

Statuspage URL setting data from a response.

{
  "data": {
    "attributes": {
      "custom_tags": "team:collaboration-integrations,env:prod",
      "url": "https://example.statuspage.io"
    },
    "id": "596da4af-0563-4097-90ff-07230c3f9db3",
    "type": "statuspage-url-setting"
  }
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Conflict

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 예시

                  ## default
# 

# Path parameters
export statuspage_url_setting_id="CHANGE_ME"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X PATCH "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/integration/statuspage/url_settings/${statuspage_url_setting_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "custom_tags": "team:collaboration-integrations",
      "url": "https://example.statuspage.io"
    },
    "id": "596da4af-0563-4097-90ff-07230c3f9db3",
    "type": "statuspage-url-setting"
  }
}
EOF

                

"""
Update a Statuspage URL setting returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.statuspage_integration_api import StatuspageIntegrationApi
from datadog_api_client.v2.model.statuspage_url_setting_type import StatuspageUrlSettingType
from datadog_api_client.v2.model.statuspage_url_setting_update_attributes import StatuspageUrlSettingUpdateAttributes
from datadog_api_client.v2.model.statuspage_url_setting_update_data import StatuspageUrlSettingUpdateData
from datadog_api_client.v2.model.statuspage_url_setting_update_request import StatuspageUrlSettingUpdateRequest

body = StatuspageUrlSettingUpdateRequest(
    data=StatuspageUrlSettingUpdateData(
        attributes=StatuspageUrlSettingUpdateAttributes(
            custom_tags="team:collaboration-integrations,env:prod",
            url="https://example.statuspage.io",
        ),
        id="596da4af-0563-4097-90ff-07230c3f9db3",
        type=StatuspageUrlSettingType.STATUSPAGE_URL_SETTING,
    ),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
    api_instance = StatuspageIntegrationApi(api_client)
    response = api_instance.update_statuspage_url_setting(
        statuspage_url_setting_id="statuspage_url_setting_id", body=body
    )

    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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"

# Update a Statuspage URL setting returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::StatuspageIntegrationAPI.new

body = DatadogAPIClient::V2::StatuspageUrlSettingUpdateRequest.new({
  data: DatadogAPIClient::V2::StatuspageUrlSettingUpdateData.new({
    attributes: DatadogAPIClient::V2::StatuspageUrlSettingUpdateAttributes.new({
      custom_tags: "team:collaboration-integrations,env:prod",
      url: "https://example.statuspage.io",
    }),
    id: "596da4af-0563-4097-90ff-07230c3f9db3",
    type: DatadogAPIClient::V2::StatuspageUrlSettingType::STATUSPAGE_URL_SETTING,
  }),
})
p api_instance.update_statuspage_url_setting("statuspage_url_setting_id", body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"

// Update a Statuspage URL setting 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"
)

func main() {
	body := datadogV2.StatuspageUrlSettingUpdateRequest{
		Data: datadogV2.StatuspageUrlSettingUpdateData{
			Attributes: datadogV2.StatuspageUrlSettingUpdateAttributes{
				CustomTags: datadog.PtrString("team:collaboration-integrations,env:prod"),
				Url:        datadog.PtrString("https://example.statuspage.io"),
			},
			Id:   "596da4af-0563-4097-90ff-07230c3f9db3",
			Type: datadogV2.STATUSPAGEURLSETTINGTYPE_STATUSPAGE_URL_SETTING,
		},
	}
	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.NewStatuspageIntegrationApi(apiClient)
	resp, r, err := api.UpdateStatuspageUrlSetting(ctx, "statuspage_url_setting_id", body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StatuspageIntegrationApi.UpdateStatuspageUrlSetting`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `StatuspageIntegrationApi.UpdateStatuspageUrlSetting`:\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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"

// Update a Statuspage URL setting returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.StatuspageIntegrationApi;
import com.datadog.api.client.v2.model.StatuspageUrlSettingResponse;
import com.datadog.api.client.v2.model.StatuspageUrlSettingType;
import com.datadog.api.client.v2.model.StatuspageUrlSettingUpdateAttributes;
import com.datadog.api.client.v2.model.StatuspageUrlSettingUpdateData;
import com.datadog.api.client.v2.model.StatuspageUrlSettingUpdateRequest;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    StatuspageIntegrationApi apiInstance = new StatuspageIntegrationApi(defaultClient);

    StatuspageUrlSettingUpdateRequest body =
        new StatuspageUrlSettingUpdateRequest()
            .data(
                new StatuspageUrlSettingUpdateData()
                    .attributes(
                        new StatuspageUrlSettingUpdateAttributes()
                            .customTags("team:collaboration-integrations,env:prod")
                            .url("https://example.statuspage.io"))
                    .id("596da4af-0563-4097-90ff-07230c3f9db3")
                    .type(StatuspageUrlSettingType.STATUSPAGE_URL_SETTING));

    try {
      StatuspageUrlSettingResponse result =
          apiInstance.updateStatuspageUrlSetting("statuspage_url_setting_id", body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling StatuspageIntegrationApi#updateStatuspageUrlSetting");
      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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"

// Update a Statuspage URL setting returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_statuspage_integration::StatuspageIntegrationAPI;
use datadog_api_client::datadogV2::model::StatuspageUrlSettingType;
use datadog_api_client::datadogV2::model::StatuspageUrlSettingUpdateAttributes;
use datadog_api_client::datadogV2::model::StatuspageUrlSettingUpdateData;
use datadog_api_client::datadogV2::model::StatuspageUrlSettingUpdateRequest;

#[tokio::main]
async fn main() {
    let body = StatuspageUrlSettingUpdateRequest::new(StatuspageUrlSettingUpdateData::new(
        StatuspageUrlSettingUpdateAttributes::new()
            .custom_tags("team:collaboration-integrations,env:prod".to_string())
            .url("https://example.statuspage.io".to_string()),
        "596da4af-0563-4097-90ff-07230c3f9db3".to_string(),
        StatuspageUrlSettingType::STATUSPAGE_URL_SETTING,
    ));
    let configuration = datadog::Configuration::new();
    let api = StatuspageIntegrationAPI::with_config(configuration);
    let resp = api
        .update_statuspage_url_setting("statuspage_url_setting_id".to_string(), body)
        .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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run

/**
 * Update a Statuspage URL setting 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.StatuspageIntegrationApi(configuration);

const params: v2.StatuspageIntegrationApiUpdateStatuspageUrlSettingRequest = {
  body: {
    data: {
      attributes: {
        customTags: "team:collaboration-integrations,env:prod",
        url: "https://example.statuspage.io",
      },
      id: "596da4af-0563-4097-90ff-07230c3f9db3",
      type: "statuspage-url-setting",
    },
  },
  statuspageUrlSettingId: "statuspage_url_setting_id",
};

apiInstance
  .updateStatuspageUrlSetting(params)
  .then((data: v2.StatuspageUrlSettingResponse) => {
    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.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"

Update a Statuspage URL setting

개요

인수

경로 파라미터

요청

Body Data (required)

응답

코드 예시

Update a Statuspage URL setting

Update a Statuspage URL setting

Instructions

Update a Statuspage URL setting

Instructions

Update a Statuspage URL setting

Instructions

Update a Statuspage URL setting

Instructions

Update a Statuspage URL setting

Instructions

Update a Statuspage URL setting

Instructions

How can I help you today?