REST API Reference Version 5.2.1.0Search

Halt

POST v1/arrays/id/actions/halt

Description

Halt the specified array. Restarting the array will require physically powering it back on.

Normal Response Codes

202

HTTP Error Codes

400 401 403 404 409 500 503

Request

Parameter Type JSON Type Description Mandatory
id NsObjectID string ID of the array to halt. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. true

JSON Request

            
            
            {}
            
        
         

Response

Type:

JSON Response

            
            
            {}