Domains
Custom domains with automatic HTTPS, across the team's apps and functions.
/v1/domainsEvery custom domain of the team#
- Credential
- An API key or a dashboard session
- Roles
- Any role
Parameters
projectstringqueryonly this project's
Response
200object
domainsDomain[]requirednamestringrequiredlowercase ASCII (an international name in its xn-- form)
apexstringrequiredthe registrable domain
typestringrequiredone of
apex,subdomainprojectobjectrequirednamestringkindstringone 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
statestringrequiredone of
pending,verifying,valid,misconfigured,errorreasonstring | nullwhat is missing or wrong, for people
verifiedbooleanrequiredownership proven by the TXT record
recordsDomainRecord[]requiredthe records to set at the DNS provider
typestringrequiredone of
A,CNAME,TXTnamestringrequiredrelative to the registrable domain; @ is the domain itself
hoststringrequiredthe full name
valuestringrequiredpurposestringrequiredone of
routing,ownershipokbooleanrequiredfound as it should be at the last check
checksobject[]what the last lookup found
typestringhoststringokbooleanfoundstring[]
certificateobjectrequiredstatestringrequiredone of
none,issuing,valid,renewing,expirednot_beforestring (date-time)not_afterstring (date-time)issued_atstring (date-time)renew_errorstringnext_attempt_atstring (date-time)
urlstringrequiredchecked_atstring (date-time) | nullnext_check_atstring (date-time)created_atstring (date-time)alsoDomain[]add only: the www pair added with it
Errors
| Status | Description |
|---|---|
| 401 | unauthorized: missing, invalid, expired or revoked credential |
| 500 | internal: an unexpected failure |
Example
curl "https://api.ibel.ai/v1/domains" \
-H "Authorization: Bearer $KEY"/v1/domains/ibel.aiOne custom domain#
- Credential
- An API key or a dashboard session
- Roles
- Any role
Parameters
domainstringpathrequiredthe domain, e.g. shop.example.ir
Response
200Domain
namestringrequiredlowercase ASCII (an international name in its xn-- form)
apexstringrequiredthe registrable domain
typestringrequiredone of
apex,subdomainprojectobjectrequirednamestringkindstringone 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
statestringrequiredone of
pending,verifying,valid,misconfigured,errorreasonstring | nullwhat is missing or wrong, for people
verifiedbooleanrequiredownership proven by the TXT record
recordsDomainRecord[]requiredthe records to set at the DNS provider
typestringrequiredone of
A,CNAME,TXTnamestringrequiredrelative to the registrable domain; @ is the domain itself
hoststringrequiredthe full name
valuestringrequiredpurposestringrequiredone of
routing,ownershipokbooleanrequiredfound as it should be at the last check
checksobject[]what the last lookup found
typestringhoststringokbooleanfoundstring[]
certificateobjectrequiredstatestringrequiredone of
none,issuing,valid,renewing,expirednot_beforestring (date-time)not_afterstring (date-time)issued_atstring (date-time)renew_errorstringnext_attempt_atstring (date-time)
urlstringrequiredchecked_atstring (date-time) | nullnext_check_atstring (date-time)created_atstring (date-time)alsoDomain[]add only: the www pair added with it
Errors
| Status | Description |
|---|---|
| 401 | unauthorized: missing, invalid, expired or revoked credential |
| 404 | Not found: not_found |
| 500 | internal: an unexpected failure |
Example
curl "https://api.ibel.ai/v1/domains/domain" \
-H "Authorization: Bearer $KEY"/v1/domains/ibel.aiRemove a custom domain#
- Credential
- An API key or a dashboard session
- Roles
- owner, admin, developer
Parameters
domainstringpathrequiredthe domain, e.g. shop.example.ir
Response
200object
namestringremovedboolean
Errors
| Status | Description |
|---|---|
| 401 | unauthorized: missing, invalid, expired or revoked credential |
| 403 | Not allowed: forbidden |
| 404 | Not found: not_found |
| 500 | internal: an unexpected failure |
Example
curl -X DELETE "https://api.ibel.ai/v1/domains/domain" \
-H "Authorization: Bearer $KEY"/v1/domains/ibel.aiChange a domain's redirect or branch#
- Credential
- An API key or a dashboard session
- Roles
- owner, admin, developer
Parameters
domainstringpathrequiredthe domain, e.g. shop.example.ir
Request bodyapplication/json
redirect_tostring | nullredirect_statusintegerone of
301,302,307,308branchstring | null
Response
200Domain
namestringrequiredlowercase ASCII (an international name in its xn-- form)
apexstringrequiredthe registrable domain
typestringrequiredone of
apex,subdomainprojectobjectrequirednamestringkindstringone 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
statestringrequiredone of
pending,verifying,valid,misconfigured,errorreasonstring | nullwhat is missing or wrong, for people
verifiedbooleanrequiredownership proven by the TXT record
recordsDomainRecord[]requiredthe records to set at the DNS provider
typestringrequiredone of
A,CNAME,TXTnamestringrequiredrelative to the registrable domain; @ is the domain itself
hoststringrequiredthe full name
valuestringrequiredpurposestringrequiredone of
routing,ownershipokbooleanrequiredfound as it should be at the last check
checksobject[]what the last lookup found
typestringhoststringokbooleanfoundstring[]
certificateobjectrequiredstatestringrequiredone of
none,issuing,valid,renewing,expirednot_beforestring (date-time)not_afterstring (date-time)issued_atstring (date-time)renew_errorstringnext_attempt_atstring (date-time)
urlstringrequiredchecked_atstring (date-time) | nullnext_check_atstring (date-time)created_atstring (date-time)alsoDomain[]add only: the www pair added with it
Errors
| Status | Description |
|---|---|
| 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 |
Example
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#
- Credential
- An API key or a dashboard session
- Roles
- owner, admin, developer
Parameters
domainstringpathrequiredthe domain, e.g. shop.example.ir
Response
200Domain
namestringrequiredlowercase ASCII (an international name in its xn-- form)
apexstringrequiredthe registrable domain
typestringrequiredone of
apex,subdomainprojectobjectrequirednamestringkindstringone 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
statestringrequiredone of
pending,verifying,valid,misconfigured,errorreasonstring | nullwhat is missing or wrong, for people
verifiedbooleanrequiredownership proven by the TXT record
recordsDomainRecord[]requiredthe records to set at the DNS provider
typestringrequiredone of
A,CNAME,TXTnamestringrequiredrelative to the registrable domain; @ is the domain itself
hoststringrequiredthe full name
valuestringrequiredpurposestringrequiredone of
routing,ownershipokbooleanrequiredfound as it should be at the last check
checksobject[]what the last lookup found
typestringhoststringokbooleanfoundstring[]
certificateobjectrequiredstatestringrequiredone of
none,issuing,valid,renewing,expirednot_beforestring (date-time)not_afterstring (date-time)issued_atstring (date-time)renew_errorstringnext_attempt_atstring (date-time)
urlstringrequiredchecked_atstring (date-time) | nullnext_check_atstring (date-time)created_atstring (date-time)alsoDomain[]add only: the www pair added with it
Errors
| Status | Description |
|---|---|
| 401 | unauthorized: missing, invalid, expired or revoked credential |
| 403 | Not allowed: forbidden |
| 404 | Not found: not_found |
| 500 | internal: an unexpected failure |
Example
curl -X POST "https://api.ibel.ai/v1/domains/domain/verify" \
-H "Authorization: Bearer $KEY"