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

site_subdomain_redirect.List()

Return Values

Returns a *site_subdomain_redirect.Iter and an error. Range over All() to receive files_sdk.SiteSubdomainRedirect values and errors. Check each loop error before using its resource. Next() and Err() remain supported.

Authorization Requirement

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

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    site_subdomain_redirect "github.com/Files-com/files-sdk-go/v3/sitesubdomainredirect"
)

siteSubdomainRedirectIterator, err := site_subdomain_redirect.List(files_sdk.SiteSubdomainRedirectListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

for siteSubdomainRedirect, err := range siteSubdomainRedirectIterator.All() {
    if err != nil {
        var respErr files_sdk.ResponseError
        if errors.As(err, &respErr) {
            fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
        } else {
            fmt.Printf("Request failed: %v\n", err)
        }
        return
    }
    fmt.Println(siteSubdomainRedirect)
}

Show Site Subdomain Redirect

SDK Method

site_subdomain_redirect.Find()

Return Values

Returns a files_sdk.SiteSubdomainRedirect value and an error.

Authorization Requirement

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

SiteSubdomainRedirectFindParams Fields

FieldDescription
Id
int64
Required		Site Subdomain Redirect ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    site_subdomain_redirect "github.com/Files-com/files-sdk-go/v3/sitesubdomainredirect"
)

siteSubdomainRedirect, err := site_subdomain_redirect.Find(files_sdk.SiteSubdomainRedirectFindParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(siteSubdomainRedirect)

Delete Site Subdomain Redirect

SDK Method

site_subdomain_redirect.Delete()

Return Values

Returns an error, or nil on success.

Authorization Requirement

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

SiteSubdomainRedirectDeleteParams Fields

FieldDescription
Id
int64
Required		Site Subdomain Redirect ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    site_subdomain_redirect "github.com/Files-com/files-sdk-go/v3/sitesubdomainredirect"
)

err := site_subdomain_redirect.Delete(files_sdk.SiteSubdomainRedirectDeleteParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

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.
CreatedAt
date-time		When this redirect was created.
UpdatedAt
date-time		When this redirect was last updated.