Recent searches

in
Developer ReferenceAPI

Base Domains

On this page

Get base domain

GET/api/v0/base-domains/{base_domain_uuid}
Path parameters:
base_domain_uuidUUID | integerRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid} \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "base_domain": "string",
  "uses_dns": true,
  "auto_generate_ssl_failures": 0,
  "auto_generate_ssl_max_failures": 0,
  "next_ssl_generate_attempt_at": "2024-01-01T00:00:00Z",
  "ssl_generation_failing_email_sent_at": "2024-01-01T00:00:00Z",
  "in_cloudflare_beta": true,
  "cloudflare_dns_migrated": true,
  "cloudflare_zone_id": "string",
  "cloudflare_zone_create_error": "string",
  "cloudflare_zone_create_error_from_cloudflare": true,
  "mx_record": "string",
  "spf_record": "string",
  "minimum_tls_version": "string",
  "site_count": 0,
  "subdomain_count": 0,
  "fallback_domain": "string",
  "organisation_uuid": "00000000-0000-0000-0000-000000000000",
  "name_server_checks": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "base_domain": "string",
      "base_domain_uuid": "string"
    }
  ]
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Update base domain

PUT/api/v0/base-domains/{base_domain_uuid}
Path parameters:
base_domain_uuidUUID | integerRequired#
Request body:
minimum_tls_versionenum#

Allowed values: 1.2 1.3

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid} \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "minimum_tls_version": "1.2"
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "base_domain": "string",
  "uses_dns": true,
  "auto_generate_ssl_failures": 0,
  "auto_generate_ssl_max_failures": 0,
  "next_ssl_generate_attempt_at": "2024-01-01T00:00:00Z",
  "ssl_generation_failing_email_sent_at": "2024-01-01T00:00:00Z",
  "in_cloudflare_beta": true,
  "cloudflare_dns_migrated": true,
  "cloudflare_zone_id": "string",
  "cloudflare_zone_create_error": "string",
  "cloudflare_zone_create_error_from_cloudflare": true,
  "mx_record": "string",
  "spf_record": "string",
  "minimum_tls_version": "string",
  "cloudflare_name_servers": [
    "string"
  ],
  "name_servers": [
    "string"
  ],
  "cloudflare_dns_migration": [
    {}
  ],
  "a_record": [
    {
      "subdomain": "string",
      "target": "string"
    }
  ],
  "cname_record": [
    {
      "subdomain": "string",
      "target": "string"
    }
  ],
  "txt_record": [
    {
      "subdomain": "string",
      "target": "string"
    }
  ]
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Delete base domain

DELETE/api/v0/base-domains/{base_domain_uuid}
Path parameters:
base_domain_uuidUUID | integerRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid} \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
204Deleted
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Status of base domain dns

GET/api/v0/base-domains/{base_domain_uuid}/dns
Path parameters:
base_domain_uuidUUID | integerRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid}/dns \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "success": true,
  "status": 0,
  "answers": [
    "string"
  ],
  "error_message": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Create a base domain dns

POST/api/v0/base-domains/{base_domain_uuid}/dns
Path parameters:
base_domain_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid}/dns \
  -X POST \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
201Created
JSON
Copied to clipboard
{
  "base_domain": "string",
  "uses_dns": true,
  "auto_generate_ssl_failures": 0,
  "auto_generate_ssl_max_failures": 0,
  "next_ssl_generate_attempt_at": "2024-01-01T00:00:00Z",
  "ssl_generation_failing_email_sent_at": "2024-01-01T00:00:00Z",
  "in_cloudflare_beta": true,
  "cloudflare_dns_migrated": true,
  "cloudflare_zone_id": "string",
  "cloudflare_zone_create_error": "string",
  "cloudflare_zone_create_error_from_cloudflare": true,
  "mx_record": "string",
  "spf_record": "string",
  "minimum_tls_version": "string",
  "site_count": 0,
  "subdomain_count": 0,
  "fallback_domain": "string",
  "organisation_uuid": "00000000-0000-0000-0000-000000000000",
  "name_server_checks": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "base_domain": "string",
      "base_domain_uuid": "string"
    }
  ]
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Delete base domain dns

DELETE/api/v0/base-domains/{base_domain_uuid}/dns
Path parameters:
base_domain_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid}/dns \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200Removed
JSON
Copied to clipboard
{
  "base_domain": "string",
  "uses_dns": true,
  "auto_generate_ssl_failures": 0,
  "auto_generate_ssl_max_failures": 0,
  "next_ssl_generate_attempt_at": "2024-01-01T00:00:00Z",
  "ssl_generation_failing_email_sent_at": "2024-01-01T00:00:00Z",
  "in_cloudflare_beta": true,
  "cloudflare_dns_migrated": true,
  "cloudflare_zone_id": "string",
  "cloudflare_zone_create_error": "string",
  "cloudflare_zone_create_error_from_cloudflare": true,
  "mx_record": "string",
  "spf_record": "string",
  "minimum_tls_version": "string",
  "site_count": 0,
  "subdomain_count": 0,
  "fallback_domain": "string",
  "organisation_uuid": "00000000-0000-0000-0000-000000000000",
  "name_server_checks": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "base_domain": "string",
      "base_domain_uuid": "string"
    }
  ]
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

List of base domain dns records

GET/api/v0/base-domains/{base_domain_uuid}/dns/records
Path parameters:
base_domain_uuidUUID | integerRequired#
Filters:
searchstring#
Pagination:
pageinteger#

Page number to fetch (1-indexed)

itemsinteger#

Number of items per page

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid}/dns/records \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "content": "string",
    "created_on": "2024-01-01T00:00:00Z",
    "id": "string",
    "locked": true,
    "meta": {},
    "modified_on": "2024-01-01T00:00:00Z",
    "name": "string",
    "proxiable": true,
    "proxied": true,
    "ttl": 0,
    "type": "string",
    "zone_id": "string",
    "zone_name": "string"
  }
]
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Create a base domain dns record

POST/api/v0/base-domains/{base_domain_uuid}/dns/records
Path parameters:
base_domain_uuidUUIDRequired#
Request body:
typestring#
namestring#
ttlinteger#
dataobject#
commentstring#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid}/dns/records \
  -X POST \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "name": "string",
    "ttl": 0,
    "data": {
      "comment": "string"
    }
  }'
Terminal
Responses:
201Created
JSON
Copied to clipboard
{
  "content": "string",
  "created_on": "2024-01-01T00:00:00Z",
  "id": "string",
  "locked": true,
  "meta": {},
  "modified_on": "2024-01-01T00:00:00Z",
  "name": "string",
  "proxiable": true,
  "proxied": true,
  "ttl": 0,
  "type": "string",
  "zone_id": "string",
  "zone_name": "string"
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Update a base domain dns record

PUT/api/v0/base-domains/{base_domain_uuid}/dns/records/{record_id}
Path parameters:
base_domain_uuidUUIDRequired#
record_idstringRequired#
Request body:
typestring#
namestring#
ttlinteger#
dataobject#
commentstring#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid}/dns/records/{record_id} \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "name": "string",
    "ttl": 0,
    "data": {
      "comment": "string"
    }
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "content": "string",
  "created_on": "2024-01-01T00:00:00Z",
  "id": "string",
  "locked": true,
  "meta": {},
  "modified_on": "2024-01-01T00:00:00Z",
  "name": "string",
  "proxiable": true,
  "proxied": true,
  "ttl": 0,
  "type": "string",
  "zone_id": "string",
  "zone_name": "string"
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Delete a base domain dns record

DELETE/api/v0/base-domains/{base_domain_uuid}/dns/records/{record_id}
Path parameters:
base_domain_uuidUUIDRequired#
record_idstringRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid}/dns/records/{record_id} \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
204Deleted
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Retry setup for base domain dns

POST/api/v0/base-domains/{base_domain_uuid}/dns/retry
Path parameters:
base_domain_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid}/dns/retry \
  -X POST \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "base_domain": "string",
  "uses_dns": true,
  "auto_generate_ssl_failures": 0,
  "auto_generate_ssl_max_failures": 0,
  "next_ssl_generate_attempt_at": "2024-01-01T00:00:00Z",
  "ssl_generation_failing_email_sent_at": "2024-01-01T00:00:00Z",
  "in_cloudflare_beta": true,
  "cloudflare_dns_migrated": true,
  "cloudflare_zone_id": "string",
  "cloudflare_zone_create_error": "string",
  "cloudflare_zone_create_error_from_cloudflare": true,
  "mx_record": "string",
  "spf_record": "string",
  "minimum_tls_version": "string",
  "site_count": 0,
  "subdomain_count": 0,
  "fallback_domain": "string",
  "organisation_uuid": "00000000-0000-0000-0000-000000000000",
  "name_server_checks": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "base_domain": "string",
      "base_domain_uuid": "string"
    }
  ]
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Validate base domain dns

GET/api/v0/base-domains/{base_domain_uuid}/dns/validate
Path parameters:
base_domain_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid}/dns/validate \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "valid": true
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Migrate base domain to Cloudflare

PUT/api/v0/base-domains/{base_domain_uuid}/migrate
Path parameters:
base_domain_uuidUUID | integerRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid}/migrate \
  -X PUT \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "base_domain": "string",
  "uses_dns": true,
  "auto_generate_ssl_failures": 0,
  "auto_generate_ssl_max_failures": 0,
  "next_ssl_generate_attempt_at": "2024-01-01T00:00:00Z",
  "ssl_generation_failing_email_sent_at": "2024-01-01T00:00:00Z",
  "in_cloudflare_beta": true,
  "cloudflare_dns_migrated": true,
  "cloudflare_zone_id": "string",
  "cloudflare_zone_create_error": "string",
  "cloudflare_zone_create_error_from_cloudflare": true,
  "mx_record": "string",
  "spf_record": "string",
  "minimum_tls_version": "string",
  "site_count": 0,
  "subdomain_count": 0,
  "fallback_domain": "string",
  "organisation_uuid": "00000000-0000-0000-0000-000000000000",
  "name_server_checks": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "base_domain": "string",
      "base_domain_uuid": "string"
    }
  ]
}
Response
401Unauthorized
JSON
Copied to clipboard
{
  "error": "string"
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Get subdomains from base domain

GET/api/v0/base-domains/{base_domain_uuid}/subdomains
Path parameters:
base_domain_uuidUUID | integerRequired#
Filters:
searchstring#
Pagination:
pageinteger#

Page number to fetch (1-indexed)

itemsinteger#

Number of items per page

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/base-domains/{base_domain_uuid}/subdomains \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "domain_name": "string",
    "subpath": "string",
    "hosting_choice": "string",
    "force_ssl": true,
    "auto_generate_ssl": true,
    "latest_hosted_build_id": 0,
    "ssl_certificate_id": 0,
    "pinned_build_id": 0,
    "mode": "string",
    "is_fallback_redirect": true,
    "site_uuid": "00000000-0000-0000-0000-000000000000",
    "site_id": "00000000-0000-0000-0000-000000000000"
  }
]
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
Open in a new tab