api.dc.group¶
/dc/(dc)/group¶
-
api.dc.group.views.dc_group_list(*args, **kwargs)¶ List (
GET) groups available in current datacenter (dc).-
GET/dc/(dc)/group¶ DC-bound?: Permissions: Asynchronous?: Parameters: - request.dc (string) – required - Datacenter name
- data.full (boolean) – Return list of objects with all group details (default: false)
- data.order_by (string) – Available fields for sorting:
name(default:name)
Status Codes: - 200 OK – SUCCESS
- 403 Forbidden – Forbidden
- 404 Not Found – Datacenter not found
-
/dc/(dc)/group/(name)¶
-
api.dc.group.views.dc_group(*args, **kwargs)¶ Show (
GET), create (POST) or delete (DELETE) a group (name) association with a datacenter (dc).-
GET/dc/(dc)/group/(name)¶ DC-bound?: Permissions: Asynchronous?: Parameters: - request.dc (string) – required - Datacenter name
- request.name (string) – required - Group name
Status Codes: - 200 OK – SUCCESS
- 403 Forbidden – Forbidden
- 404 Not Found – Datacenter not found / Group not found
-
POST/dc/(dc)/group/(name)¶ DC-bound?: Permissions: Asynchronous?: Parameters: - request.dc (string) – required - Datacenter name
- request.name (string) – required - Group name
Status Codes: - 200 OK – SUCCESS
- 400 Bad Request – FAILURE
- 403 Forbidden – Forbidden
- 404 Not Found – Datacenter not found / Group not found
- 406 Not Acceptable – Group already exists
-
DELETE/dc/(dc)/group/(name)¶ DC-bound?: Permissions: Asynchronous?: Parameters: - request.dc (string) – required - Datacenter name
- request.name (string) – required - Group name
Status Codes: - 200 OK – SUCCESS
- 400 Bad Request – FAILURE
- 403 Forbidden – Forbidden
- 404 Not Found – Datacenter not found / Group not found
-