class PlatformAPI::Domain
Domains define what web routes should be routed to an app on Heroku.
Public Class Methods
# File lib/platform-api/client.rb, line 1680 def initialize(client) @client = client end
Public Instance Methods
Create a new domain.
@param app_id_or_app_name: unique identifier of app or unique name of app @param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 1696 def create(app_id_or_app_name, body = {}) @client.domain.create(app_id_or_app_name, body) end
Create a new domain. Deprecated in favor of this same endpoint, but with a new required attribute of `sni_endpoint`. During the transitional phase sni_endpoint can be omitted entirely (current behavior), can be a valid id, or can be null which will skip auto-association.
@param app_id_or_app_name: unique identifier of app or unique name of app @param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 1688 def create_deprecated(app_id_or_app_name, body = {}) @client.domain.create_deprecated(app_id_or_app_name, body) end
Delete an existing domain
@param app_id_or_app_name: unique identifier of app or unique name of app @param domain_id_or_domain_hostname: unique identifier of this domain or full hostname
# File lib/platform-api/client.rb, line 1713 def delete(app_id_or_app_name, domain_id_or_domain_hostname) @client.domain.delete(app_id_or_app_name, domain_id_or_domain_hostname) end
Info for existing domain.
@param app_id_or_app_name: unique identifier of app or unique name of app @param domain_id_or_domain_hostname: unique identifier of this domain or full hostname
# File lib/platform-api/client.rb, line 1721 def info(app_id_or_app_name, domain_id_or_domain_hostname) @client.domain.info(app_id_or_app_name, domain_id_or_domain_hostname) end
List existing domains.
@param app_id_or_app_name: unique identifier of app or unique name of app
# File lib/platform-api/client.rb, line 1728 def list(app_id_or_app_name) @client.domain.list(app_id_or_app_name) end
Associate an SNI endpoint
@param app_id_or_app_name: unique identifier of app or unique name of app @param domain_id_or_domain_hostname: unique identifier of this domain or full hostname @param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 1705 def update(app_id_or_app_name, domain_id_or_domain_hostname, body = {}) @client.domain.update(app_id_or_app_name, domain_id_or_domain_hostname, body) end