Site Subdomain Redirects

A SiteSubdomainRedirect object represents an old Files.com subdomain that continues to work after the site's Files.com subdomain changes. HTTPS requests redirect to the current subdomain, and other protocols such as FTP and SFTP are routed through DNS.

List Site Subdomain Redirects

SDK Method

Files::SiteSubdomainRedirect.list

Return Object

List<SiteSubdomainRedirect>

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

begin
  site_subdomain_redirects = Files::SiteSubdomainRedirect.list
  site_subdomain_redirects.auto_paging_each do |site_subdomain_redirect|
    # Operate on site_subdomain_redirect
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Site Subdomain Redirect

SDK Method

Files::SiteSubdomainRedirect.find

Return Object

SiteSubdomainRedirect

Authorization Requirement

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

Method Arguments

ArgumentDescription
id
int64
Required		Site Subdomain Redirect ID.

Example Request

begin
  site_subdomain_redirect = Files::SiteSubdomainRedirect.find(id)
  # Operate on site_subdomain_redirect
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete Site Subdomain Redirect

SDK Method

site_subdomain_redirect.delete

Return Object

nil

Authorization Requirement

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

Example Request

begin
  # Find the site_subdomain_redirect object by its id.
  site_subdomain_redirect = Files::SiteSubdomainRedirect.find(id)
  site_subdomain_redirect.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The SiteSubdomainRedirect Object

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

AttributeDescription
id
int64		Site subdomain redirect ID.
subdomain
string		Files.com subdomain that continues to route to the current site subdomain.
created_at
date-time		When this redirect was created.
updated_at
date-time		When this redirect was last updated.