class PlatformAPI::SSLEndpoint
[SSL Endpoint](devcenter.heroku.com/articles/ssl-endpoint) is a public address serving custom SSL cert for HTTPS traffic to a Heroku app. Note that an app must have the `ssl:endpoint` add-on installed before it can provision an SSL Endpoint using these APIs.
Public Class Methods
# File lib/platform-api/client.rb, line 3043 def initialize(client) @client = client end
Public Instance Methods
Create a new SSL 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 3051 def create(app_id_or_app_name, body = {}) @client.ssl_endpoint.create(app_id_or_app_name, body) end
Delete existing SSL endpoint.
@param app_id_or_app_name: unique identifier of app or unique name of app @param ssl_endpoint_id_or_ssl_endpoint_name: unique identifier of this SSL endpoint or unique name for SSL endpoint
# File lib/platform-api/client.rb, line 3059 def delete(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name) @client.ssl_endpoint.delete(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name) end
Info for existing SSL endpoint.
@param app_id_or_app_name: unique identifier of app or unique name of app @param ssl_endpoint_id_or_ssl_endpoint_name: unique identifier of this SSL endpoint or unique name for SSL endpoint
# File lib/platform-api/client.rb, line 3067 def info(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name) @client.ssl_endpoint.info(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name) end
List existing SSL endpoints.
@param app_id_or_app_name: unique identifier of app or unique name of app
# File lib/platform-api/client.rb, line 3074 def list(app_id_or_app_name) @client.ssl_endpoint.list(app_id_or_app_name) end
Update an existing SSL endpoint.
@param app_id_or_app_name: unique identifier of app or unique name of app @param ssl_endpoint_id_or_ssl_endpoint_name: unique identifier of this SSL endpoint or unique name for SSL endpoint @param body: the object to pass as the request payload
# File lib/platform-api/client.rb, line 3083 def update(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name, body = {}) @client.ssl_endpoint.update(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name, body) end