Custom Domains

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

List Custom Domains

SDK Function

CustomDomain.list()

Return Object

ListIterator<CustomDomain>

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import com.files.ListIterator;
import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.CustomDomain;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  ListIterator<CustomDomain> customDomains = CustomDomain.list(parameters);
  for (CustomDomain customDomain : customDomains.listAutoPaging()) {
    // Operate on customDomain
  }
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Show Custom Domain

SDK Function

CustomDomain.find()

Return Object

CustomDomain

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Function Arguments

ArgumentDescription
id
int64
Required		Custom Domain ID.

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.CustomDomain;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  CustomDomain customDomain = CustomDomain.find(id, parameters);
  // Operate on customDomain
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Create Custom Domain

SDK Function

CustomDomain.create()

Return Object

CustomDomain

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Function Arguments

ArgumentDefaultDescription
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

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.CustomDomain;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("domain", "files.example.com");
  
  CustomDomain customDomain = CustomDomain.create(parameters);
  // Operate on customDomain
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Update Custom Domain

SDK Function

customDomain.update();

Return Object

CustomDomain

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Attribute Setters

SetterDescription
setDestination
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
setFolderBehaviorId
int64		Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when destination becomes unassigned.
setSslCertificateId
int64		Current SSL certificate ID.
setDomain
string		Customer-owned domain name.

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.CustomDomain;

try {
  // Find the customDomain object by its id.
  CustomDomain customDomain = CustomDomain.find(id, null);
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("destination", "site_alias");
  customDomain.update(parameters);
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Delete Custom Domain

SDK Function

customDomain.delete();

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.CustomDomain;

try {
  // Find the customDomain object by its id.
  CustomDomain customDomain = CustomDomain.find(id, null);
  customDomain.delete(null);
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The CustomDomain Object

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

AttributeDescription
id
int64		Custom Domain ID.
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.
created_at
date-time		When this Custom Domain was created.
updated_at
date-time		When this Custom Domain was last updated.