Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
custom_domains
Custom Domains

Create Custom Domain

Create Custom Domain

post/custom_domains

Response

The CustomDomains object.

idinteger

Custom Domain ID.

domainstring

Customer-owned domain name.

destination'site_alias' | 'public_hosting' | 's3_endpoint' | 'unassigned'

Where this custom domain routes. Can be site_alias, public_hosting, s3_endpoint, or unassigned (not routing traffic). Set to unassigned automatically when a bound public_hosting folder behavior is deleted, and can be set manually via the API for any reason.

dns_status'disabled' | 'correct' | 'no_records' | 'cname_wrong' | 'a_record' | 'caa_conflict'

Current DNS verification status.

ssl_certificate_idinteger

Current SSL certificate ID.

brick_managedboolean

Is this domain's SSL certificate automatically managed and renewed by Files.com?

folder_behavior_idinteger

Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.

created_atstring date-time

When this Custom Domain was created.

updated_atstring date-time

When this Custom Domain was last updated.

Example response

{
  "id": 1,
  "domain": "files.example.com",
  "destination": "site_alias",
  "dns_status": "correct",
  "ssl_certificate_id": 1,
  "brick_managed": true,
  "folder_behavior_id": 1,
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}