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
addon 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.
1247 1248 1249 |
# File 'lib/platform-api/client.rb', line 1247 def initialize(client) @client = client end |
Instance Method Details
#create(app_id_or_app_name, body) ⇒ Object
Create a new SSL endpoint.
1255 1256 1257 |
# File 'lib/platform-api/client.rb', line 1255 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.
1263 1264 1265 |
# File 'lib/platform-api/client.rb', line 1263 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.
1271 1272 1273 |
# File 'lib/platform-api/client.rb', line 1271 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.
1278 1279 1280 |
# File 'lib/platform-api/client.rb', line 1278 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.
1287 1288 1289 |
# File 'lib/platform-api/client.rb', line 1287 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 |