UNPKG

heroku-client

Version:

A wrapper for the Heroku v3 API

jclem/node-heroku-client

78 lines (46 loc) • 1.48 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# Domain Domains define what web routes should be routed to an app on Heroku. ## Actions ### `create` `heroku.apps({app_id_or_name}).domains().create({attributes}, {callback});` Method | Path | Expected Status(es) --- | --- | --- POST | /apps/{app_id_or_name}/domains | 201 #### Required Attributes - hostname ### `list` `heroku.apps({app_id_or_name}).domains().list({callback});` Method | Path | Expected Status(es) --- | --- | --- GET | /apps/{app_id_or_name}/domains | 200, 206 ### `info` `heroku.apps({app_id_or_name}).domains({domain_id_or_hostname}).info({callback});` Method | Path | Expected Status(es) --- | --- | --- GET | /apps/{app_id_or_name}/domains/{domain_id_or_hostname} | 200 ### `delete` `heroku.apps({app_id_or_name}).domains({domain_id_or_hostname}).delete({callback});` Method | Path | Expected Status(es) --- | --- | --- DELETE | /apps/{app_id_or_name}/domains/{domain_id_or_hostname} | 200 ## Attributes ### `created_at` *When domain was created.* Example | Serialized? | Type --- | --- | --- `2012-01-01T12:00:00Z` | true | datetime ### `hostname` *Full hostname.* Example | Serialized? | Type --- | --- | --- `subdomain.example.com` | true | string ### `id` *Unique identifier of this domain.* Example | Serialized? | Type --- | --- | --- `01234567-89ab-cdef-0123-456789abcdef` | true | uuid ### `updated_at` *When domain was updated.* Example | Serialized? | Type --- | --- | --- `2012-01-01T12:00:00Z` | true | datetime