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

SiteSubdomainRedirect.list()

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.

Additional Arguments

Example Request

import SiteSubdomainRedirect from 'files.com/lib/models/SiteSubdomainRedirect';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const siteSubdomainRedirects = await SiteSubdomainRedirect.list();
  for (const siteSubdomainRedirect of siteSubdomainRedirects) {
    // Operate on siteSubdomainRedirect
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Show Site Subdomain Redirect

SDK Method

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

import SiteSubdomainRedirect from 'files.com/lib/models/SiteSubdomainRedirect';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const siteSubdomainRedirect = await SiteSubdomainRedirect.find(id);
  // Operate on siteSubdomainRedirect
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Delete Site Subdomain Redirect

SDK Method

siteSubdomainRedirect.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 SiteSubdomainRedirect from 'files.com/lib/models/SiteSubdomainRedirect';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the siteSubdomainRedirect object by its id.
  const siteSubdomainRedirect = await SiteSubdomainRedirect.find(id);
  await siteSubdomainRedirect.delete();
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

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.