FIfiles
custom_domains
Custom Domains

List Custom Domains

Changed on

List Custom Domains

get/custom_domains

Request

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

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id, id or available_to_all_workspaces.

If set, return records where the specified field is equal to the supplied value. Valid fields are workspace_id.

Response

A list of CustomDomains objects.

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