Refresh domain certificate
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/domains/{id}/refresh \
--header 'api_access_token: <api-key>'const options = {method: 'POST', headers: {api_access_token: '<api-key>'}};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/domains/{id}/refresh', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/domains/{id}/refresh"
headers = {"api_access_token": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": 123,
"custom_domain": "<string>",
"certificate_status": "<string>",
"live": true,
"verification_errors": "<string>",
"dns_record": {
"type": "CNAME",
"name": "arriendos",
"value": "customers.yampi.ai"
},
"created_at": 123
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{}Domains
Refresh domain certificate
Ask Cloudflare for the current certificate status now, register the hostname again when it is missing, and restart the status polling.
POST
/
api
/
v1
/
accounts
/
{account_id}
/
domains
/
{id}
/
refresh
Refresh domain certificate
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/domains/{id}/refresh \
--header 'api_access_token: <api-key>'const options = {method: 'POST', headers: {api_access_token: '<api-key>'}};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/domains/{id}/refresh', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/domains/{id}/refresh"
headers = {"api_access_token": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": 123,
"custom_domain": "<string>",
"certificate_status": "<string>",
"live": true,
"verification_errors": "<string>",
"dns_record": {
"type": "CNAME",
"name": "arriendos",
"value": "customers.yampi.ai"
},
"created_at": 123
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{}Authorizations
Path Parameters
ID of the domain
The numeric ID of the account
Response
Success
Certificate status reported by Cloudflare (e.g. pending_validation, active).
Whether the certificate has settled and the domain serves the portal.
The record the domain owner creates at their DNS provider. A zone apex gets an ALIAS (CNAME flattening) on @, since it cannot hold a CNAME next to its MX records.
Show child attributes
Show child attributes