Custom Domains

A CustomDomain object represents an additional customer-owned domain that routes to a Files.com site.

List Custom Domains

SDK Method

\Files\Model\CustomDomain::list;

Return Object

CustomDomain[]

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Additional Arguments

Example Request

try {
  $custom_domains = \Files\Model\CustomDomain::list();
  foreach ($custom_domains as $custom_domain) {
    // Operate on $custom_domain
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show Custom Domain

SDK Method

\Files\Model\CustomDomain::find;

Return Object

CustomDomain

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

Method Arguments

ArgumentDescription
id
int64
Required		Custom Domain ID.

Example Request

try {
  $custom_domain = \Files\Model\CustomDomain::find($id);
  // Operate on $custom_domain
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Allocate dedicated IP addresses to this Custom Domain

SDK Method

\Files\Model\CustomDomain::createAllocateIp;

Return Object

CustomDomain

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Method Arguments

ArgumentDescription
id
int64
Required		Custom Domain ID.
count
int64
Required		Number of dedicated IP addresses to allocate.
Possible values: 1, 2

Example Request

try {
  $custom_domain = \Files\Model\CustomDomain::createAllocateIp($id, [
    'count' => 1
  ]);
  // Operate on $custom_domain
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Create Custom Domain

SDK Method

\Files\Model\CustomDomain::create;

Return Object

CustomDomain

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Method Arguments

ArgumentDefaultDescription
available_to_all_workspaces
boolean		falseAllow all workspaces to use this default-workspace Custom Domain.
workspace_id
int64		0Workspace ID (0 for the default workspace).
destination
string		"site_alias"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.
Possible values: site_alias, public_hosting, s3_endpoint, unassigned
folder_behavior_id
int64		Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
ssl_certificate_id
int64		Current SSL certificate ID.
domain
string
Required		Customer-owned domain name.

Example Request

try {
  $custom_domain = \Files\Model\CustomDomain::create([
    'domain' => "files.example.com"
  ]);
  // Operate on $custom_domain
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Update Custom Domain

SDK Method

$custom_domain->update;

Return Object

CustomDomain

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Method Arguments

ArgumentDescription
available_to_all_workspaces
boolean		Allow all workspaces to use this default-workspace Custom Domain.
workspace_id
int64		Workspace ID (0 for the default workspace).
destination
string		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.
Possible values: site_alias, public_hosting, s3_endpoint, unassigned
folder_behavior_id
int64		Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
ssl_certificate_id
int64		Current SSL certificate ID.
domain
string		Customer-owned domain name.

Example Request

try {
  // Find the custom_domain object by its id.
  $custom_domain = \Files\Model\CustomDomain::find(id);
  $custom_domain->update([
    'available_to_all_workspaces' => false
  ]);
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Delete Custom Domain

SDK Method

$custom_domain->delete;

Return Object

No return value.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Example Request

try {
  // Find the custom_domain object by its id.
  $custom_domain = \Files\Model\CustomDomain::find(id);
  $custom_domain->delete();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The CustomDomain Object

Some of the methods above return a CustomDomain object. The attributes of this object are listed below.

AttributeDescription
id
int64		Custom Domain ID.
workspace_id
int64		Workspace ID (0 for the default workspace).
available_to_all_workspaces
boolean		Allow all workspaces to use this default-workspace Custom Domain.
outbound_ip_addresses
array(string)		Eligible public IP addresses for Remote Server outbound connections. Empty when this Custom Domain is not eligible for outbound selection.
domain
string		Customer-owned domain name.
destination
string		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.
Possible values: site_alias, public_hosting, s3_endpoint, unassigned
dns_status
string		Current DNS verification status.
Possible values: disabled, correct, no_records, cname_wrong, a_record, caa_conflict
ssl_certificate_id
int64		Current SSL certificate ID.
brick_managed
boolean		Is this domain's SSL certificate automatically managed and renewed by Files.com?
folder_behavior_id
int64		Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
ip_addresses
array(string)		Dedicated public IP addresses allocated to this Custom Domain.
created_at
date-time		When this Custom Domain was created.
updated_at
date-time		When this Custom Domain was last updated.