Halt
POST v1/groups/id/actions/halt
Description
Halt all arrays in the group.
Normal Response Codes
202
HTTP Error Codes
400 401 403 404 409 500 503
Detail Codes
Request
| Parameter | Type | JSON Type | Description | Mandatory |
|---|---|---|---|---|
| id | NsObjectID | string | ID of the group to halt. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | true |
| force | NsBoolean | boolean | Halt remaining arrays when one or more is unreachable. Possible values: 'true', 'false'. | false |
JSON Request
{
"data" : {
"force" : true
}
}
Response
Type:
JSON Response
{}