宛先サーバー設定の削除

最終更新日: 2023-10-31
  • トピック:
  • Destinations
    このトピックの詳細を表示
  • 作成対象:
  • Developer
    User
    Admin
    Leader

このページでは、/authoring/destination-servers API エンドポイントを使用して、既存の宛先サーバー設定を削除するために使用できる API リクエストおよびペイロードの例を示します。

このエンドポイントを通じて削除できる機能について詳しくは、以下の記事を参照してください。

重要

Destination SDK でサポートされているすべてのパラメーター名および値は、大文字と小文字が区別​されます。大文字と小文字を区別することに関するエラーを避けるために、ドキュメントに示すように、パラメーター名および値を正確に使用してください。

宛先サーバー API 操作の概要

続行する前に、「はじめる前に」を参照し、API の呼び出しを正常に行うために必要となる重要な情報(必要な宛先オーサリング権限および必要なヘッダーの取得方法など)を確認してください。

宛先サーバー設定の削除

削除したい宛先サーバー設定の {INSTANCE_ID}/authoring/destination-servers エンドポイントに DELETE リクエストを行うことで、既存の宛先サーバー設定を削除できます。

ヒント

API エンドポイントplatform.adobe.io/data/core/activation/authoring/destination-servers

既存の宛先サーバー設定およびその関連する {INSTANCE_ID} を取得するには、宛先サーバー設定の取得に関する記事を参照してください。

API 形式

DELETE /authoring/destination-servers/{INSTANCE_ID}
パラメーター 説明
{INSTANCE_ID} 削除する宛先サーバー設定の ID です。
 リクエスト
curl -X DELETE https://platform.adobe.io/data/core/activation/authoring/destination-servers/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 応答

応答が成功すると、HTTP ステータス 200 が、空の HTTP 応答と共に返されます。

API エラー処理

Destination SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。

次の手順

このドキュメントでは、Destination SDK /authoring/destination-servers API エンドポイントを使用した、既存の宛先サーバーの削除方法を確認しました。

このエンドポイントでできることについて詳しくは、以下の記事を参照してください。

このページ