ゾーン¶

ゾーンオブジェクト¶

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 36,
      "maxLength": 36
    },
    "name": {
      "type": "string",
      "minLength": 4,
      "maxLength": 255
    },
    "deletion_protection": {
      "type": "boolean"
    },
    "current_version_id": {
      "type": "string",
      "minLength": 36,
      "maxLength": 36
    }
  }
}

ゾーンオブジェクトプロパティ¶
プロパティ	型	編集可否	説明
.id	string	読み取り専用	ゾーンを一意に識別する ID
.name	string	読み取り専用	4文字以上255文字以下のドメイン名
.deletion_protection	boolean	編集可	削除保護機能の設定状況
.current_version_id	string	読み取り専用	現在アクティブなバージョンの ID

作成¶

Gehirn DNS に新しいゾーンを作成します。

ドメイン名は事前に認証されている必要があります。

HTTP リクエスト¶

POST /dns/v1/zones HTTP/1.1
Host: api.gis.gehirn.jp
Content-Type: application/json

{
  "name": "example.net",
  "deletion_protection": true
}

リクエストボディ¶

作成したいゾーンオブジェクトをリクエストしてください。

HTTP レスポンス¶

作成されたゾーンオブジェクトが返ります。

一覧¶

Gehirn DNS に存在するすべてのゾーンを取得します。

HTTP リクエスト¶

GET /dns/v1/zones HTTP/1.1
Host: api.gis.gehirn.jp

リクエストボディ¶

リクエストボディは必要ありません。

HTTP レスポンス¶

すべてのゾーンオブジェクトを要素とする JSON array がレスポンスされます。

[
  {
    "id": "ZONE-ID-1",
    "name": "example.net",
    "deletion_protection": true,
    "current_version_id": "VERSION-ID-1"
  },
  {
    "id": "ZONE-ID-2",
    "name": "example.org",
    "deletion_protection": true,
    "current_version_id": "VERSION-ID-2"
  }
[

取得¶

Gehirn DNS に存在する個別のゾーンを取得します。

HTTP リクエスト¶

GET /dns/v1/zones/:zone_id HTTP/1.1
Host: api.gis.gehirn.jp

パスパラメーター¶
パラメーター	値
zone_id	取得するゾーンの ID

リクエストボディ¶

リクエストボディは必要ありません。

HTTP レスポンス¶

指定したゾーンオブジェクトが返ります。

編集¶

Gehirn DNS に存在する個別のゾーンを編集します。

HTTP リクエスト¶

PUT /dns/v1/zones/:zone_id HTTP/1.1
Host: api.gis.gehirn.jp
Content-Type: application/json

{
  "name": "example.net",
  "deletion_protection": true
}

パスパラメーター¶
パラメーター	値
zone_id	編集するゾーンの ID

リクエストボディ¶

編集を加えたゾーンオブジェクトをリクエストしてください。

HTTP レスポンス¶

編集されたゾーンオブジェクトが返ります。

削除¶

Gehirn DNS から個別のゾーンを削除します。

HTTP リクエスト¶

DELETE /dns/v1/zones/:zone_id HTTP/1.1
Host: api.gis.gehirn.jp

パスパラメーター¶
パラメーター	値
zone_id	削除するゾーンの ID

リクエストボディ¶

リクエストボディは必要ありません。

HTTP レスポンス¶

削除されたゾーンオブジェクトが返ります。