メインコンテンツまでスキップ

ゾーンAPIリファレンス

API docs by Redocly

Chip-in zone API (1.0.0)

Download OpenAPI specification:Download

E-mail: mitsuru@procube.jp License: Apache 2.0

これはChip-in のゾーンの dnsProvider のAPI仕様です。

rrset

Operations related to RRSet (Resource Record Set).

Get RRSets.

Authorizations:
bearerAuth
query Parameters
object (QueryParameter)

Query parameters for listing rrset. The parameters are used to filter the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update the existing RRSet.

Authorizations:
bearerAuth
Request Body schema: application/json
required

The RRSet to update. The name and type are used to identify the RRSet. The changetype is required and must be either REPLACE or DELETE. If changetype is REPLACE, the records and comments are updated. If changetype is DELETE, all records and comments are deleted.

name
required
string <hostname>

MUST be a valid DNS name, and MUST end with a dot. The name is case-insensitive. The suffix of the name must bearer the zone name, which is the name of the zone this RRSet belongs to.

type
required
string
Enum: "A" "AAAA" "CNAME" "MX" "NS" "PTR" "SOA" "SRV" "TXT"

Type of this record (e.g. “A”, “PTR”, “MX”)

ttl
required
integer

DNS TTL of the records, in seconds. MUST NOT be included when changetype is set to “DELETE”.

changetype
required
string
Enum: "REPLACE" "DELETE"

MUST be added when updating the RRSet. Must be REPLACE or DELETE. With DELETE, all existing RRs matching name and type will be deleted, including all comments. With REPLACE: when records is present, all existing RRs matching name and type will be deleted, and then new records given in records will be created. If no records are left, any existing comments will be deleted as well. When comments is present, all existing comments for the RRs matching name and type will be deleted, and then new comments given in comments will be created.

required
Array of objects (Record)

All records in this RRSet. When updating Records, this is the list of new records (replacing the old ones). Must be empty when changetype is set to DELETE. An empty list results in deletion of all records (and comments).

Array of objects (Comment)

List of Comment. Must be empty when changetype is set to DELETE. An empty list results in deletion of all comments. modified_at is optional and defaults to the current server time.

Responses

Request samples

Content type
application/json
{
  • "name": "example.com",
  • "type": "A",
  • "ttl": 0,
  • "changetype": "REPLACE",
  • "records": [
    ],
  • "comments": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]