heroku-client
Version:
A wrapper for the Heroku v3 API
65 lines (39 loc) • 1.05 kB
Markdown
# Region
Regions represent geographic locations in which your application may run.
## Actions
### `list`
`heroku.regions().list({callback});`
Method | Path | Expected Status(es)
--- | --- | ---
GET | /regions | 200, 206
### `info`
`heroku.regions({region_id_or_name}).info({callback});`
Method | Path | Expected Status(es)
--- | --- | ---
GET | /regions/{region_id_or_name} | 200
## Attributes
### `created_at`
*When region was created.*
Example | Serialized? | Type
--- | --- | ---
`2012-01-01T12:00:00Z` | true | datetime
### `description`
*Description of the region.*
Example | Serialized? | Type
--- | --- | ---
`United States` | true | string
### `id`
*Unique identifier of this region.*
Example | Serialized? | Type
--- | --- | ---
`01234567-89ab-cdef-0123-456789abcdef` | true | uuid
### `name`
*Unique name of the region.*
Example | Serialized? | Type
--- | --- | ---
`us` | true | string
### `updated_at`
*When region was updated.*
Example | Serialized? | Type
--- | --- | ---
`2012-01-01T12:00:00Z` | true | datetime