Class: PlatformAPI::SSLEndpoint
- Inherits:
-
Object
- Object
- PlatformAPI::SSLEndpoint
- Defined in:
- lib/platform-api/client.rb
Overview
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.
Instance Method Summary collapse
-
#create(app_id_or_app_name, body = {}) ⇒ Object
Create a new SSL endpoint.
-
#delete(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name) ⇒ Object
Delete existing SSL endpoint.
-
#info(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name) ⇒ Object
Info for existing SSL endpoint.
-
#initialize(client) ⇒ SSLEndpoint
constructor
A new instance of SSLEndpoint.
-
#list(app_id_or_app_name) ⇒ Object
List existing SSL endpoints.
-
#update(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name, body = {}) ⇒ Object
Update an existing SSL endpoint.
Constructor Details
#initialize(client) ⇒ SSLEndpoint
Returns a new instance of SSLEndpoint.
2470 2471 2472 |
# File 'lib/platform-api/client.rb', line 2470 def initialize(client) @client = client end |
Instance Method Details
#create(app_id_or_app_name, body = {}) ⇒ Object
Create a new SSL endpoint.
2478 2479 2480 |
# File 'lib/platform-api/client.rb', line 2478 def create(app_id_or_app_name, body = {}) @client.ssl_endpoint.create(app_id_or_app_name, body) end |
#delete(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name) ⇒ Object
Delete existing SSL endpoint.
2486 2487 2488 |
# File 'lib/platform-api/client.rb', line 2486 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(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name) ⇒ Object
Info for existing SSL endpoint.
2494 2495 2496 |
# File 'lib/platform-api/client.rb', line 2494 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(app_id_or_app_name) ⇒ Object
List existing SSL endpoints.
2501 2502 2503 |
# File 'lib/platform-api/client.rb', line 2501 def list(app_id_or_app_name) @client.ssl_endpoint.list(app_id_or_app_name) end |
#update(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name, body = {}) ⇒ Object
Update an existing SSL endpoint.
2510 2511 2512 |
# File 'lib/platform-api/client.rb', line 2510 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 |