Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 108 lines (75 sloc) 2.97 kb
b0968232 » aeden
2010-07-10 copy from README
1 A Ruby wrapper for the DNSimple API.
2
c4fa11ef » aeden
2010-07-10 fix header
3 == Credentials
b0968232 » aeden
2010-07-10 copy from README
4
5 Create a file in your home directory called .dnsimple
6
7 In this file add the following:
8
2fa36f11 » aeden
2010-07-10 trying to get a decent readme
9 username: YOUR_USERNAME
10 password: YOUR_PASSWORD
11
18d31957 » aeden
2010-10-19 missing doc
12 Alternatively you can pass the credentials via command-line arguments, as in:
13
14 dnsimple -u username -p password command
15
16
98169a36 » aeden
2010-07-10 add more to README
17 == Commands
18
19 The following commands are available for domains:
20
21 * dnsimple list
22 * dnsimple describe domain.com
23 * dnsimple create domain.com
be80c49c » aeden
2010-09-30 Documentation.
24 * dnsimple register domain.com registrant_id
25 * dnsimple transfer domain.com registrant_id [authinfo]
98169a36 » aeden
2010-07-10 add more to README
26 * dnsimple delete domain.com
27 * dnsimple apply domain.com template_short_name
28
1e288755 » aeden
2010-10-19 Update readme with new info about contact API.
29 Please note that domain registration and transfer can only be done through the API for domains that do not require extended attributes. A future version of the API will add support for extended attributes.
30
98169a36 » aeden
2010-07-10 add more to README
31 The following commands are available for records:
32
33 * dnsimple record:create [--prio=priority] domain.com name type content [ttl]
34 * dnsimple record:list domain.com
35 * dnsimple record:delete domain.com record_id
be80c49c » aeden
2010-09-30 Documentation.
36
37 The following commands are available for custom templates:
38
39 * dnsimple template:list
40 * dnsimple template:create name short_name [description]
41 * dnsimple template:delete short_name
42 * dnsimple template:list_records short_name
43 * dnsimple template:add_record short_name name type content [ttl] [prio]
44 * dnsimple template:delete_record short_name template_record_id
45
1e288755 » aeden
2010-10-19 Update readme with new info about contact API.
46 The following commands are available for managing contacts:
47
48 * dnsimple contact:list
49 * dnsimple contact:describe id
50 * dnsimple contact:create [name:value name:value ...]
51 * dnsimple contact:update id [name:value name:value ...]
52 * dnsimple contact:delete id
53
cda7fc48 » aeden
2011-11-11 Refresh specs and improve the certificate portion of the client.
54 The following commands are available for purchasing certificates:
55
56 * dnsimple certificate:purchase domain.com name
57 * dnsimple certificate:submit id
58
9a2eaa5d » aeden
2010-10-19 Tweak docs.
59 === Contact Attributes
60
61 The contact attributes that can be used in the name:value pairs are:
62
1e288755 » aeden
2010-10-19 Update readme with new info about contact API.
63 * first_name
64 * last_name
65 * organization_name (optional)
66 * job_title (required if organization name is specified)
67 * address1
68 * address2 (optional)
69 * city
70 * state_province (also aliased as state)
71 * postal_code
72 * country
73 * email
74 * phone
75 * phone_ext (optional)
76 * fax (optional)
be80c49c » aeden
2010-09-30 Documentation.
77
78 == Wrapper Classes
79
80 In addition to the command line utility you may also use the included Ruby
81 classes directly in your Ruby applications.
82
83 Sample:
84
85 require 'rubygems'
86 require 'dnsimple'
87
88 DNSimple::Client.username = 'YOUR_USERNAME'
89 DNSimple::Client.password = 'YOUR_PASSWORD'
90
91 user = User.me
92 puts "#{user.domain_count} domains"
93
94 puts "Domains..."
95 Domain.all.each do |domain|
96 puts " #{domain.name}"
97 end
98
99 domain = Domain.find("example.com")
100 domain.apply("template") # applies a standard or custom template to the domain
101
102 domain = Domain.create("newdomain.com")
103 puts "Added #{domain.name}"
104 domain.delete # removes from DNSimple
105
106 The complete RDoc for the wrapper classes can be found here:
107
4f18afc1 » aeden
2010-09-30 Clean up.
108 http://rdoc.info/projects/aetrion/dnsimple-ruby
Something went wrong with that request. Please try again.