Sha256: c6250b551dca25d1d8188920d0e4a6077894d6d5ec8ba47b1c30b0608386d260
Contents?: true
Size: 1.99 KB
Versions: 15
Compression:
Stored size: 1.99 KB
Contents
module Lumberg
module Cpanel
class SubDomain < Base
# Public: Add a subdomain.
#
# options - Hash options for API call params (default: {}):
# :domain - String local part of the subdomain to add.
# "sub" if "sub.domain.com".
# :rootdomain - String domain on which to add the subdomain.
# :dir - String docroot for subdomain (optional, default:
# "public_html/[:domain value]")
# :disallowdot - String value (optional). Set to "1" to strip "."
# chars from specified :domain value.
#
# Returns Hash API response.
def add(options = {})
perform_request({
api_function: "addsubdomain"
}.merge(options))
end
# Public: Remove a subdomain.
#
# options - Hash options for API call params (default: {}):
# :domain - String subdomain to delete.
#
# Returns Hash API response.
def remove(options = {})
perform_request({
api_function: "delsubdomain"
}.merge(options))
end
# Public: Get list of subdomains.
#
# options - Hash options for API call params (default: {}):
# :regex - String regular expression to filter results (optional).
#
# Returns Hash API response.
def list(options = {})
perform_request({
api_function: "listsubdomains"
}.merge(options))
end
# Public: Modify the document root of a subdomain
#
# options - Hash options for API call params (default: {}):
# :dir - String docroot to which you want to move the subdomain
# :subdomain - String subdomain whose docroot you want to modify
# :rootdomain - String domain on which to modify the subdomain
#
# Returns Hash API response
def modify(options = {})
perform_request({
api_function: "changedocroot"
}.merge(options))
end
end
end
end
Version data entries
15 entries across 15 versions & 1 rubygems