Skip to main content
Use this endpoint to fetch the DNS records you need to configure in your domain registrar in order to connect a custom domain to your application. The response includes CNAME and TXT records along with their current validation status, so you can track whether your DNS changes have propagated and been verified by Virtus Cloud.
A Standard plan or higher is required to use custom domains and this endpoint.

​
Endpoint

GET https://api.virtuscloud.app/v2/apps/{app_id}/network/dns

​
Authorization

Include your API key in the request header: 
Authorization: <api_key>

​
Path Parameters

​
app_id
string
required
The unique identifier of your application. You can find this in the URL of your application’s dashboard.

​
Response

​
status
string
Indicates the outcome of the request. Returns "success" when the operation completes without errors.
​
response
array
An array of DNS record objects that must be added to your domain registrar’s DNS settings.

​
Examples

curl --request GET \
  --url "https://api.virtuscloud.app/v2/apps/{app_id}/network/dns" \
  --header "Authorization: <api_key>"

​
Response Example

{
  "status": "success",
  "response": [
    {
      "type": "txt",
      "name": "_acme-challenge.yourdomain.dev",
      "value": "hmo-jMx_KCWQU5CWG6xmrkI4AOZOJXlQtjEtc7zI1PA",
      "status": "pending_validation"
    },
    {
      "type": "cname",
      "name": "yourdomain.dev",
      "value": "custom.virtuscloud.app",
      "status": "pending"
    }
  ]
}
DNS propagation can take up to 48 hours depending on your domain registrar and TTL settings. Poll this endpoint periodically to check when all records reach "active" status.