API一覧

API一覧

CAC-APIでは以下のAPIが利用できます。

HTTPメソッドAPI名目的
GETcontract契約情報一覧取得
GEToriginオリジンサーバー情報取得
PUToriginオリジンサーバー情報変更
GETcache_settingキャッシュ設定情報取得
PUTcache_settingキャッシュ設定
GETpurgejobキャッシュ削除ジョブステータス取得(一覧)
GETpurgejobキャッシュ削除ジョブステータス取得(JobID指定)
POSTpurgejobキャッシュ削除ジョブ登録
POSTaccesslog_keyアクセスログダウンロード用URL発行
GETrange_purgejob(一覧)範囲指定キャッシュ削除ジョブステータス取得(一覧)
GETrange_purgejob (JobID指定)範囲指定キャッシュ削除ジョブステータス取得(JobID指定)
POSTrange_purgejob範囲指定キャッシュ削除ジョブ登録
GETacls_settingACL設定情報取得
PUTacls_settingACL設定情報変更
GETbypass_settingキャッシュバイパス設定情報取得
PUTbypass_settingキャッシュバイパス設定情報変更
GETipv6_settingIPv6設定情報取得
PUTipv6_settingIPv6設定情報変更

APIバージョン

CAC-APIで提供するAPI群にはバージョンが設定されています。バージョンによって一部のパラメータや、挙動が変化する場合があります

APIをリクエストする際に、APIVersionパラメータを指定することで、どのバージョンのAPIを実行するかを指定することができます。

現在指定可能なAPIVersionは以下の通りです。

APIVersion利用開始日利用終了日備考
201406022014年6月3日未定初期リリース版

API詳細における凡例 (レスポンス)

各API一覧ページでは、レスポンスの説明に以下のような表記を使用します。

JSON表記

{
    "SampleApiResponse": {
        "Param1": "abcdefg",
        "Param2": {
            "ParamA": "pqr",
            "ParamB": "xyz"
        },
        "Param3": [
            {
                "ParamC": "123"
            },
            {
                "ParamC": "987"
            }
        ]
    }
}
フィールドタイプ意味

SampleApiResponse.Param1

String

単純な値

SampleApiResponse.Param2

Object

内部に複数の値を含む連想配列

SampleApiResponse.Param2.ParamA

String

構造体に含まれる単純な値

SampleApiResponse.Param2.ParamB

String

構造体に含まれる単純な値

SampleApiResponse.Param3

Array

内部に複数の値を含む単純配列

SampleApiResponse.Param3.ParamC

String

配列に含まれる単純な値

  • 構造化されたフィールドのキーは、表中ではそれぞれのキーを"."(ドット)で連結して現します
  • CAC-APIでは値に型はありません。すべて文字列として取り扱います。