Sakura Cloud DNS
Sakura Cloud API key setup: create a project-scoped Sakura Cloud resource API key and choose the Japanese access level for preview, record changes, or billable zone creation.
On this page
Sakura Cloud API key permissions
- Credential type
- Resource API key
- Preview access
- リソース閲覧 (Resource view)
- Apply access
- 設定編集 (Settings edit); 作成・削除 (Create/delete) only to create zones
- API endpoint
- DNSMigrator uses the provider's fixed API endpoint.
Additional access
DNSControl id
{
"TYPE": "SAKURACLOUD"
}Create credentials
Create a project-scoped Sakura Cloud resource API key and choose the Japanese access level for preview, record changes, or billable zone creation.
Access you'll grant
リソース閲覧 (Resource view)
設定編集 (Settings edit); 作成・削除 (Create/delete) only to create zones
Before you start
- A Sakura Cloud account and the project that contains, or will contain, the DNS appliances.
- A membership-ID administrator or a project user with 作成・削除 access, which Sakura requires to create API keys.
Setup steps
0 of 6 done
Open the project's API keys
Sign in to the Sakura Cloud control panel, select the project that owns the DNS appliances, and choose APIキー (API keys) in the left menu. The labels below are the Japanese labels in Sakura's current manual.
Start a resource API key
Select APIキーの作成 (Create API key). For APIキーの種類, choose リソース操作APIキー, then enter a recognizable 名前 and optional 説明.
API key typeリソース操作APIキーChoose the access level
Under アクセスレベル, choose リソース閲覧 for preview, 設定編集 to change records in existing zones, or 作成・削除 only when DNSMigrator should create DNS zones.
Previewリソース閲覧Apply to existing zones設定編集Create zones作成・削除Create the key
Leave サービスへのアクセス権 unchecked; Sakura Cloud DNS needs no separate service permission. Select 作成 at the bottom of the form.
Copy both token values
Copy アクセストークン and アクセストークンシークレット from the completion page. The secret appears only on this page; create another API key if you leave without saving it.
Paste the tokens and choose an endpoint
Paste the two values into Access token and Access token secret. API zone only chooses the API endpoint; DNS appliances are global. Leave it empty for Ishikari 1 (is1a) unless you need another endpoint.
Default API zoneis1a
Troubleshooting
Sakura Cloud rejects the API key
Use the access token and access token secret from the same active リソース操作APIキー. Replace the key if its one-time secret was not saved.
Preview works but record changes return 403
Edit the key's アクセスレベル to 設定編集. Use 作成・削除 only if DNSMigrator must create a DNS appliance.
No zones appear
Confirm the API key was created in the project that owns the DNS appliances. Changing API zone does not move or scope DNS data.
Official documentation
- Sakura Cloud API keys (Japanese)
- Sakura Cloud access levels (Japanese)
- Sakura Cloud DNS appliance (Japanese)
Guide checked against the official documentation on .
Credential fields
| Field | Requirement | Where to find it |
|---|---|---|
| Access tokenaccessToken | Required | The アクセストークン displayed after the resource API key is created. |
| Access token secretaccessTokenSecret | Required | The アクセストークンシークレット shown once on the same completion page as the access token. |
| API zonezone | Optional | The API endpoint zone: is1a (Ishikari 1), is1b (Ishikari 2), tk1a (Tokyo 1), or tk1b (Tokyo 2). DNS data is global; the default is is1a. |
Capabilities
- Create zones
- Yes
- List zones
- Yes
- DNSSEC
- Not available through this connection
- Minimum TTL
- 10 seconds
- Apex CNAME
- No
- Read only
- No
Record types
- A
- AAAA
- CNAME
- MX
- TXT
- NS
- SRV
- CAA
- ALIAS
- HTTPS
- SVCB
- PTR
Caveats
- Every record with the same name must share one TTL, and a zone can hold at most 2,000 records.
- TXT values are limited to 500 characters of letters, digits, spaces and _ = : ; ~ , - . + / (no quotes or backslashes), and CAA records to 64 characters.
- DNSSEC isn't supported, and each write replaces the zone's whole record list, so changes are applied in one request.
Troubleshooting
- Sakura Cloud rejects the API key
- Use the access token and access token secret from the same active リソース操作APIキー. Replace the key if its one-time secret was not saved.
- Preview works but record changes return 403
- Edit the key's アクセスレベル to 設定編集. Use 作成・削除 only if DNSMigrator must create a DNS appliance.
- No zones appear
- Confirm the API key was created in the project that owns the DNS appliances. Changing API zone does not move or scope DNS data.