モニタリングと自動化 · DomScan製品

非同期 API バッチ APIリファレンス

対応する多数の API リクエストをキューに追加し、クライアント接続を開いたままにせず結果を取得できます。

得られるもの

対応する多数の API リクエストをキューに追加し、クライアント接続を開いたままにせず結果を取得できます。

非同期RESTMCPSDK

この製品を選ぶ場面

対象ユーザー

同じ意思決定を時間をまたいで、リスト全体で、または複数製品にわたって実行する必要があるときに自動化を使います。

この製品を選ぶ場面

対応GETリクエストを最大100件キューに入れ、24時間の保持期間内にJSONまたはCSV結果を取得するときに選びます。

得られるもの

対応する多数の API リクエストをキューに追加し、クライアント接続を開いたままにせず結果を取得できます。

エンドポイント

統合する前に、各エンドポイントが受け付ける内容、返す内容、モード、制限を確認できます。

GET /v1/batches/:job_id APIリファレンスを見る
GET /v1/batches/:job_id/results APIリファレンスを見る
DELETE /v1/batches/:job_id APIリファレンスを見る
GET /v1/jobs/:job_id APIリファレンスを見る
GET /v1/jobs/:job_id/results APIリファレンスを見る
POST /v1/jobs/:job_id/cancel APIリファレンスを見る
POST /v1/estimate APIリファレンスを見る
POST /v1/feedback APIリファレンスを見る

クレジットと認証

無料 認証が必要。個別の項目ごとの料金を含む正確な費用は、APIリファレンスをご覧ください。

操作例

文書化された操作を使って、公開証拠を収集、評価、補足、検証、比較、保護、監視します。

POST /v1/batches クレジット: 0

ボディパラメータ

パラメータ タイプ 必須
notify_webhook unknown オプション
requests object[] 必須
webhook object オプション

レスポンスフィールド

フィールド タイプ
job object
job.id string
job.status string
job.total integer
job.counts object
job.counts.pending integer
job.counts.processing integer
job.counts.succeeded integer
job.counts.failed integer
job.counts.cancelled integer
job.billing object
job.billing.credits_charged integer
job.billing.credits_refunded integer
job.billing.credits_net integer
job.webhook object
job.webhook.configured boolean
job.webhook.status string
job.webhook.attempts integer
job.status_url string
job.results_url string
job.results_csv_url string
job.poll_after_ms integer | null
job.created_at string
job.started_at string | null
job.completed_at string | null
job.cancelled_at string | null
job.updated_at string
job.processing_deadline_at string
job.results_expires_at string

リクエスト例

curl -X POST "https://domscan.net/v1/batches" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "requests": [
    {
      "path": "/v1/status",
      "query": {
        "domain": "example.com"
      },
      "reference": "customer-42"
    },
    {
      "path": "/v1/dns",
      "query": {
        "domain": "example.org",
        "type": "MX"
      }
    }
  ],
  "webhook": {
    "url": "https://example.com/hooks/domscan",
    "secret": "replace-with-a-private-secret"
  }
}'
const response = await fetch("https://domscan.net/v1/batches", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "requests": [
      {
        "path": "/v1/status",
        "query": {
          "domain": "example.com"
        },
        "reference": "customer-42"
      },
      {
        "path": "/v1/dns",
        "query": {
          "domain": "example.org",
          "type": "MX"
        }
      }
    ],
    "webhook": {
      "url": "https://example.com/hooks/domscan",
      "secret": "replace-with-a-private-secret"
    }
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/batches",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "requests": [
            {
                "path": "/v1/status",
                "query": {
                    "domain": "example.com",
                },
                "reference": "customer-42",
            },
            {
                "path": "/v1/dns",
                "query": {
                    "domain": "example.org",
                    "type": "MX",
                },
            },
        ],
        "webhook": {
            "url": "https://example.com/hooks/domscan",
            "secret": "replace-with-a-private-secret",
        },
    },
)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "requests": [
	    {
	      "path": "/v1/status",
	      "query": {
	        "domain": "example.com"
	      },
	      "reference": "customer-42"
	    },
	    {
	      "path": "/v1/dns",
	      "query": {
	        "domain": "example.org",
	        "type": "MX"
	      }
	    }
	  ],
	  "webhook": {
	    "url": "https://example.com/hooks/domscan",
	    "secret": "replace-with-a-private-secret"
	  }
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/batches", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(resp.Status, string(data))
}
require "json"
require "net/http"

uri = URI("https://domscan.net/v1/batches")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "requests" => [
    {
      "path" => "/v1/status",
      "query" => {
        "domain" => "example.com"
      },
      "reference" => "customer-42"
    },
    {
      "path" => "/v1/dns",
      "query" => {
        "domain" => "example.org",
        "type" => "MX"
      }
    }
  ],
  "webhook" => {
    "url" => "https://example.com/hooks/domscan",
    "secret" => "replace-with-a-private-secret"
  }
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))

レスポンス例

{
  "job": {
    "id": "example-id",
    "status": "queued",
    "total": 1,
    "counts": {
      "pending": 1,
      "processing": 1,
      "succeeded": 1,
      "failed": 1,
      "cancelled": 1
    },
    "billing": {
      "credits_charged": 1,
      "credits_refunded": 1,
      "credits_net": 1
    },
    "webhook": {
      "configured": false,
      "status": "not_configured",
      "attempts": 1
    },
    "status_url": "https://example.com",
    "results_url": "https://example.com",
    "results_csv_url": "https://example.com",
    "created_at": "2026-08-27T12:00:00Z",
    "updated_at": "2026-08-27T12:00:00Z",
    "processing_deadline_at": "2026-08-27T12:00:00Z",
    "results_expires_at": "2026-08-27T12:00:00Z",
    "poll_after_ms": 1,
    "started_at": "2026-08-27T12:00:00Z",
    "completed_at": "2026-08-27T12:00:00Z",
    "cancelled_at": "2026-08-27T12:00:00Z"
  }
}

HTTP ステータスコード

  • 200 成功
  • 202 受理済み
  • 400 不正なリクエスト
  • 401 未認証
  • 402 支払いが必要
  • 409 HTTP 409
  • 429 リクエスト過多

よくある質問

非同期 API バッチのリクエストとレスポンスのリファレンスはどこで確認できますか?

非同期 API バッチのAPIリファレンスで、パラメーター、レスポンスフィールド、例、ステータスコード、サポートされる操作モードを確認できます。

非同期 API バッチの不明または不完全な結果はどのように解釈すべきですか?

「不明」または「一部」は、結果を完全には確認できなかったことを意味します。結果をもとに対応する際は、ステータス、信頼度、鮮度、制限事項を考慮してください。

非同期 API バッチの料金はどのように決まりますか?

料金は、チェックの種類と選択したモードによって異なります。現在のクレジット消費量、APIキーの要否、項目ごとの料金は、APIリファレンスで確認できます。

これらの企業の担当者に使われています

InstantOutseerMongoDBRespondentSage Expense ManagementInstantlyD.R. HortonWhatConvertsAdobeLLM Pulse