Домэйн

Өөрийн домэйн, DNS бичлэг, баталгаажуулалт.

GET/v1/workspaces/{workspaceId}/domains

Domains of the workspace plus the shared platform domains.

Шаардлагатай API түлхүүрийн хамрах хүрээ: domains.read

Параметр (6)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`page`	path	integer (int32)	тийм
`pageSize`	path	integer (int32)	тийм
`search`	path	string	тийм	Matches the punycode and the Unicode name, case-insensitively.
`archived`	path	boolean	тийм	`true` lists only archived domains; default `false` hides them.
`status`	path	string	тийм	Lifecycle filter: pending, verified, active, degraded.

Хариу: 200 Domain[]

POST/v1/workspaces/{workspaceId}/domains

Add a custom domain: returns the DNS records to create. The first custom domain becomes primary.

Шаардлагатай API түлхүүрийн хамрах хүрээ: domains.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (CreateDomain)

Нэр	Төрөл	Заавал	Тайлбар
`slug`	string	тийм
`expiredUrl`	string
`notFoundUrl`	string
`archived`	boolean
`placeholder`	string
`logo`	string		URL or base64 data URI; only PNG, JPEG and WebP data URIs are accepted in v1.
`assetLinks`	string
`appleAppSiteAssociation`	string

Хариу: 201 Domain

POST/v1/workspaces/{workspaceId}/domains/register

Domain registration is not in v1.

Шаардлагатай API түлхүүрийн хамрах хүрээ: domains.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хариу: 2xx

GET/v1/workspaces/{workspaceId}/domains/status

Availability checks are not in v1.

Шаардлагатай API түлхүүрийн хамрах хүрээ: domains.read

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хариу: 2xx

GET/v1/workspaces/{workspaceId}/domains/{slug}

One domain by punycode or Unicode name.

Шаардлагатай API түлхүүрийн хамрах хүрээ: domains.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`slug`	path	string	тийм

Хариу: 200 Domain

PATCH/v1/workspaces/{workspaceId}/domains/{slug}

Update settings, set primary, archive or unarchive; If-Match carries the version.

Шаардлагатай API түлхүүрийн хамрах хүрээ: domains.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`slug`	path	string	тийм

Хүсэлтийн бие (PatchDomain)

Нэр	Төрөл	Тайлбар
`slug`	string	Rename; only while the domain is pending.
`primary`	boolean
`archived`	boolean
`placeholder`	string
`expiredUrl`	string
`notFoundUrl`	string
`logo`	string	Data URI, or `null` to remove.
`assetLinks`	string
`appleAppSiteAssociation`	string

Хариу: 200 Domain

DELETE/v1/workspaces/{workspaceId}/domains/{slug}

Delete a domain and every link on it. With links, ?confirm=<slug> is required.

Шаардлагатай API түлхүүрийн хамрах хүрээ: domains.write

Параметр (3)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`slug`	path	string	тийм
`confirm`	path	string	тийм	The domain name; required when links exist on it.

Хариу: 200

POST/v1/workspaces/{workspaceId}/domains/{slug}/forward

Email the DNS records to whoever manages DNS (5 per workspace per day).

Шаардлагатай API түлхүүрийн хамрах хүрээ: domains.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`slug`	path	string	тийм

Хүсэлтийн бие (ForwardBody)

Нэр	Төрөл	Заавал	Тайлбар
`email`	string	тийм

Хариу: 202

POST/v1/workspaces/{workspaceId}/domains/{slug}/transfer

Move a domain and all its links to another workspace (owner/admin in both).

Шаардлагатай API түлхүүрийн хамрах хүрээ: domains.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`slug`	path	string	тийм

Хүсэлтийн бие (TransferBody)

Нэр	Төрөл	Заавал	Тайлбар
`workspaceId`	string	тийм	Target workspace: `ws_` id or slug. The caller must be able to manage links there.

Хариу: 200 Domain

GET/v1/workspaces/{workspaceId}/domains/{slug}/verification

DNS records to create and the live verification, routing and certificate status.

Шаардлагатай API түлхүүрийн хамрах хүрээ: domains.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`slug`	path	string	тийм

Хариу: 200 VerificationView

POST/v1/workspaces/{workspaceId}/domains/{slug}/verification

Check again now (1 per minute, 30 per day) or retry the certificate.

Шаардлагатай API түлхүүрийн хамрах хүрээ: domains.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`slug`	path	string	тийм

Хүсэлтийн бие (RecheckBody)

Нэр	Төрөл	Заавал	Тайлбар
`retryCertificate`	boolean		Restart the certificate retries of a domain whose certificate failed.

Хариу: 202 VerificationView