Constructor
new Domains(endPointopt, optionsopt)
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
endPoint |
String |
<optional> |
Cloud Controller API endpoint URL | |
options |
Object |
<optional> |
{} | Options (same as CloudControllerBase) |
- Source:
Methods
add(domainOptions) → {Promise}
Create a Domain
Parameters:
| Name | Type | Description |
|---|---|---|
domainOptions |
Object | Domain creation options |
- Source:
Returns:
Resolves with JSON domain object
- Type
- Promise
getDomain(guid) → {Promise}
Get a single Domain by GUID
Parameters:
| Name | Type | Description |
|---|---|---|
guid |
String | Domain unique identifier |
- Source:
Returns:
Resolves with JSON domain object
- Type
- Promise
getDomains(filteropt) → {Promise}
Get Domains list
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
filter |
Object |
<optional> |
Query-string filter options |
- Source:
Returns:
Resolves with JSON domains list
- Type
- Promise
remove(guid) → {Promise}
Delete a Domain
Parameters:
| Name | Type | Description |
|---|---|---|
guid |
String | Domain unique identifier |
- Source:
Returns:
Resolves when domain is deleted
- Type
- Promise