FIfiles
custom_domains
Custom Domains

Update Custom Domain

Changed on

Update Custom Domain

patch/custom_domains/{id}

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/custom_domains/{id}
  • Auth
    none declared

Path parameters

idinteger required

Custom Domain ID.

Request body multipart/form-data

available_to_all_workspacesboolean

Allow all workspaces to use this default-workspace Custom Domain.

workspace_idinteger

Workspace ID (0 for the default workspace).

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.

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.

ssl_certificate_idinteger

Current SSL certificate ID.

domainstring

Customer-owned domain name.

Example request

{
  "destination": "site_alias",
  "folder_behavior_id": 1,
  "ssl_certificate_id": 1,
  "domain": "files.example.com"
}

Response

The CustomDomains object.

idinteger

Custom Domain ID.

workspace_idinteger

Workspace ID (0 for the default workspace).

available_to_all_workspacesboolean

Allow all workspaces to use this default-workspace Custom Domain.

outbound_ip_addressesstring[]

Eligible public IP addresses for Remote Server outbound connections. Empty when this Custom Domain is not eligible for outbound selection.

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.

ip_addressesstring[]

Dedicated public IP addresses allocated to this Custom Domain.

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,
  "outbound_ip_addresses": [
    "203.0.113.1",
    "203.0.113.2"
  ],
  "domain": "files.example.com",
  "destination": "site_alias",
  "dns_status": "correct",
  "ssl_certificate_id": 1,
  "brick_managed": true,
  "folder_behavior_id": 1,
  "ip_addresses": [
    "203.0.113.1",
    "203.0.113.2"
  ],
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}

Changes