Domain name examples

Jump to bottom Edit New page

Ben Richardson edited this page Sep 7, 2020 · 1 revision

Establish a connection

First, follow the steps in the readme (repeated below) to establish a connection.

require 'platform-api'
heroku = PlatformAPI.connect_oauth(ENV['HEROKU_OAUTH_TOKEN']

You can test the connection by running heroku and getting a response like this.

#<PlatformAPI::Client:0x00007tt457cc82358 @client=#<Heroics::Client url="https://api.heroku.com">>

Sample operations on domain names

heroku.domain.create(app_id, {'hostname': host_name})
heroku.domain.list(app_id)
heroku.domain.info(app_id, domain_id/host_name)
heroku.domain.delete(app_id, domain_id/host_name)

nb// host_name represents a full domain name e.g. test.example.com