class PlatformAPI::SniEndpoint

SNI Endpoint is a public address serving a custom SSL cert for HTTPS traffic, using the SNI TLS extension, to a Heroku app.

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 2862
def initialize(client)
  @client = client
end

Public Instance Methods

create(app_id_or_app_name, body = {}) click to toggle source

Create a new SNI endpoint.

@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 2870
def create(app_id_or_app_name, body = {})
  @client.sni_endpoint.create(app_id_or_app_name, body)
end
delete(app_id_or_app_name, sni_endpoint_id_or_sni_endpoint_name) click to toggle source

Delete existing SNI endpoint.

@param app_id_or_app_name: unique identifier of app or unique name of app @param sni_endpoint_id_or_sni_endpoint_name: unique identifier of this SNI endpoint or unique name for SNI endpoint

# File lib/platform-api/client.rb, line 2878
def delete(app_id_or_app_name, sni_endpoint_id_or_sni_endpoint_name)
  @client.sni_endpoint.delete(app_id_or_app_name, sni_endpoint_id_or_sni_endpoint_name)
end
info(app_id_or_app_name, sni_endpoint_id_or_sni_endpoint_name) click to toggle source

Info for existing SNI endpoint.

@param app_id_or_app_name: unique identifier of app or unique name of app @param sni_endpoint_id_or_sni_endpoint_name: unique identifier of this SNI endpoint or unique name for SNI endpoint

# File lib/platform-api/client.rb, line 2886
def info(app_id_or_app_name, sni_endpoint_id_or_sni_endpoint_name)
  @client.sni_endpoint.info(app_id_or_app_name, sni_endpoint_id_or_sni_endpoint_name)
end
list(app_id_or_app_name) click to toggle source

List existing SNI endpoints.

@param app_id_or_app_name: unique identifier of app or unique name of app

# File lib/platform-api/client.rb, line 2893
def list(app_id_or_app_name)
  @client.sni_endpoint.list(app_id_or_app_name)
end
update(app_id_or_app_name, sni_endpoint_id_or_sni_endpoint_name, body = {}) click to toggle source

Update an existing SNI endpoint.

@param app_id_or_app_name: unique identifier of app or unique name of app @param sni_endpoint_id_or_sni_endpoint_name: unique identifier of this SNI endpoint or unique name for SNI endpoint @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 2902
def update(app_id_or_app_name, sni_endpoint_id_or_sni_endpoint_name, body = {})
  @client.sni_endpoint.update(app_id_or_app_name, sni_endpoint_id_or_sni_endpoint_name, body)
end