دامنه‌ها
دامنهٔ خودتان روی برنامه یا فانکشن، با HTTPS خودکار، ریدایرکت و پیش‌نمایش شاخه.
/v1/domainsEvery custom domain of the team#
- دسترسی
- کلید API یا نشست داشبورد
- نقش‌ها
- همهٔ نقش‌ها
پارامترها
projectstringکوئریonly this project's
پاسخ
200object
domainsDomain[]الزامیnamestringالزامیlowercase ASCII (an international name in its xn-- form)
apexstringالزامیthe registrable domain
typestringالزامیone of
apex,subdomainprojectobjectالزامیnamestringkindstringone of
function,appproductstringone of
functions,apps
branchstring | nulla git branch: the domain serves its preview
servesstring | nullthe platform address it serves; null for a redirect
redirectobject | nulltostringstatusintegerone of
301,302,307,308
statestringالزامیone of
pending,verifying,valid,misconfigured,errorreasonstring | nullwhat is missing or wrong, for people
verifiedbooleanالزامیownership proven by the TXT record
recordsDomainRecord[]الزامیthe records to set at the DNS provider
typestringالزامیone of
A,CNAME,TXTnamestringالزامیrelative to the registrable domain; @ is the domain itself
hoststringالزامیthe full name
valuestringالزامیpurposestringالزامیone of
routing,ownershipokbooleanالزامیfound as it should be at the last check
checksobject[]what the last lookup found
typestringhoststringokbooleanfoundstring[]
certificateobjectالزامیstatestringالزامیone of
none,issuing,valid,renewing,expirednot_beforestring (date-time)not_afterstring (date-time)issued_atstring (date-time)renew_errorstringnext_attempt_atstring (date-time)
urlstringالزامیchecked_atstring (date-time) | nullnext_check_atstring (date-time)created_atstring (date-time)alsoDomain[]add only: the www pair added with it
خطاها
| وضعیت | توضیح |
|---|---|
| 401 | unauthorized: missing, invalid, expired or revoked credential |
| 500 | internal: an unexpected failure |
نمونه
curl "https://api.ibel.ai/v1/domains" \
-H "Authorization: Bearer $KEY"/v1/domains/ibel.aiOne custom domain#
- دسترسی
- کلید API یا نشست داشبورد
- نقش‌ها
- همهٔ نقش‌ها
پارامترها
domainstringمسیرالزامیthe domain, e.g. shop.example.ir
پاسخ
200Domain
namestringالزامیlowercase ASCII (an international name in its xn-- form)
apexstringالزامیthe registrable domain
typestringالزامیone of
apex,subdomainprojectobjectالزامیnamestringkindstringone of
function,appproductstringone of
functions,apps
branchstring | nulla git branch: the domain serves its preview
servesstring | nullthe platform address it serves; null for a redirect
redirectobject | nulltostringstatusintegerone of
301,302,307,308
statestringالزامیone of
pending,verifying,valid,misconfigured,errorreasonstring | nullwhat is missing or wrong, for people
verifiedbooleanالزامیownership proven by the TXT record
recordsDomainRecord[]الزامیthe records to set at the DNS provider
typestringالزامیone of
A,CNAME,TXTnamestringالزامیrelative to the registrable domain; @ is the domain itself
hoststringالزامیthe full name
valuestringالزامیpurposestringالزامیone of
routing,ownershipokbooleanالزامیfound as it should be at the last check
checksobject[]what the last lookup found
typestringhoststringokbooleanfoundstring[]
certificateobjectالزامیstatestringالزامیone of
none,issuing,valid,renewing,expirednot_beforestring (date-time)not_afterstring (date-time)issued_atstring (date-time)renew_errorstringnext_attempt_atstring (date-time)
urlstringالزامیchecked_atstring (date-time) | nullnext_check_atstring (date-time)created_atstring (date-time)alsoDomain[]add only: the www pair added with it
خطاها
| وضعیت | توضیح |
|---|---|
| 401 | unauthorized: missing, invalid, expired or revoked credential |
| 404 | Not found: not_found |
| 500 | internal: an unexpected failure |
نمونه
curl "https://api.ibel.ai/v1/domains/domain" \
-H "Authorization: Bearer $KEY"/v1/domains/ibel.aiRemove a custom domain#
- دسترسی
- کلید API یا نشست داشبورد
- نقش‌ها
- مالک، ادمین، توسعه‌دهنده
پارامترها
domainstringمسیرالزامیthe domain, e.g. shop.example.ir
پاسخ
200object
namestringremovedboolean
خطاها
| وضعیت | توضیح |
|---|---|
| 401 | unauthorized: missing, invalid, expired or revoked credential |
| 403 | Not allowed: forbidden |
| 404 | Not found: not_found |
| 500 | internal: an unexpected failure |
نمونه
curl -X DELETE "https://api.ibel.ai/v1/domains/domain" \
-H "Authorization: Bearer $KEY"/v1/domains/ibel.aiChange a domain's redirect or branch#
- دسترسی
- کلید API یا نشست داشبورد
- نقش‌ها
- مالک، ادمین، توسعه‌دهنده
پارامترها
domainstringمسیرالزامیthe domain, e.g. shop.example.ir
بدنهٔ درخواستapplication/json
redirect_tostring | nullredirect_statusintegerone of
301,302,307,308branchstring | null
پاسخ
200Domain
namestringالزامیlowercase ASCII (an international name in its xn-- form)
apexstringالزامیthe registrable domain
typestringالزامیone of
apex,subdomainprojectobjectالزامیnamestringkindstringone of
function,appproductstringone of
functions,apps
branchstring | nulla git branch: the domain serves its preview
servesstring | nullthe platform address it serves; null for a redirect
redirectobject | nulltostringstatusintegerone of
301,302,307,308
statestringالزامیone of
pending,verifying,valid,misconfigured,errorreasonstring | nullwhat is missing or wrong, for people
verifiedbooleanالزامیownership proven by the TXT record
recordsDomainRecord[]الزامیthe records to set at the DNS provider
typestringالزامیone of
A,CNAME,TXTnamestringالزامیrelative to the registrable domain; @ is the domain itself
hoststringالزامیthe full name
valuestringالزامیpurposestringالزامیone of
routing,ownershipokbooleanالزامیfound as it should be at the last check
checksobject[]what the last lookup found
typestringhoststringokbooleanfoundstring[]
certificateobjectالزامیstatestringالزامیone of
none,issuing,valid,renewing,expirednot_beforestring (date-time)not_afterstring (date-time)issued_atstring (date-time)renew_errorstringnext_attempt_atstring (date-time)
urlstringالزامیchecked_atstring (date-time) | nullnext_check_atstring (date-time)created_atstring (date-time)alsoDomain[]add only: the www pair added with it
خطاها
| وضعیت | توضیح |
|---|---|
| 400 | Bad request: bad_redirect, bad_branch, nothing_to_change, bad_json |
| 401 | unauthorized: missing, invalid, expired or revoked credential |
| 403 | Not allowed: forbidden |
| 404 | Not found: not_found |
| 500 | internal: an unexpected failure |
نمونه
curl -X PATCH "https://api.ibel.ai/v1/domains/domain" \
-H "Authorization: Bearer $KEY" \
-d '{"redirect_to":"…","redirect_status":301,"branch":"dev"}'/v1/domains/ibel.ai/verifyCheck a domain's DNS now#
- دسترسی
- کلید API یا نشست داشبورد
- نقش‌ها
- مالک، ادمین، توسعه‌دهنده
پارامترها
domainstringمسیرالزامیthe domain, e.g. shop.example.ir
پاسخ
200Domain
namestringالزامیlowercase ASCII (an international name in its xn-- form)
apexstringالزامیthe registrable domain
typestringالزامیone of
apex,subdomainprojectobjectالزامیnamestringkindstringone of
function,appproductstringone of
functions,apps
branchstring | nulla git branch: the domain serves its preview
servesstring | nullthe platform address it serves; null for a redirect
redirectobject | nulltostringstatusintegerone of
301,302,307,308
statestringالزامیone of
pending,verifying,valid,misconfigured,errorreasonstring | nullwhat is missing or wrong, for people
verifiedbooleanالزامیownership proven by the TXT record
recordsDomainRecord[]الزامیthe records to set at the DNS provider
typestringالزامیone of
A,CNAME,TXTnamestringالزامیrelative to the registrable domain; @ is the domain itself
hoststringالزامیthe full name
valuestringالزامیpurposestringالزامیone of
routing,ownershipokbooleanالزامیfound as it should be at the last check
checksobject[]what the last lookup found
typestringhoststringokbooleanfoundstring[]
certificateobjectالزامیstatestringالزامیone of
none,issuing,valid,renewing,expirednot_beforestring (date-time)not_afterstring (date-time)issued_atstring (date-time)renew_errorstringnext_attempt_atstring (date-time)
urlstringالزامیchecked_atstring (date-time) | nullnext_check_atstring (date-time)created_atstring (date-time)alsoDomain[]add only: the www pair added with it
خطاها
| وضعیت | توضیح |
|---|---|
| 401 | unauthorized: missing, invalid, expired or revoked credential |
| 403 | Not allowed: forbidden |
| 404 | Not found: not_found |
| 500 | internal: an unexpected failure |
نمونه
curl -X POST "https://api.ibel.ai/v1/domains/domain/verify" \
-H "Authorization: Bearer $KEY"