REST API Reference Version 5.2.1.0Search

Update

PUT v1/chap_users/id

Description

Modify attributes of specified CHAP user.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Request

Parameter Type JSON Type Description Mandatory Deprecated
id NsObjectID string Identifier for the CHAP user. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. true  
name NsObjectName string Name of CHAP user. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. false  
description NsDescription string Text description of CHAP user. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. false  
password NsChapPassword string CHAP secret.The CHAP secret should be between 12-16 characters and cannot contain spaces or most punctuation. String of 12 to 16 printable ASCII characters excluding ampersand and ^[];`. Example: 'password_25-24'. false  

JSON Request

            

{
   "data" : {
      "name" : "chapuser0.2615086886371541",
      "description" : "12345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901"
   }
}

        
         

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string Identifier for the CHAP user. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
name NsObjectName string Name of CHAP user. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
full_name NsObjectName string CHAP user's fully qualified name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
search_name NsSearchName string CHAP user name used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'.  
description NsDescription string Text description of CHAP user. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.  
creation_time NsTime number Time when this CHAP user was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
last_modified NsTime number Time when this CHAP user was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
vol_list NsVolumeList Array of NsVolumeSummary List of volumes associated with this CHAP user. List of volumes.  
vol_count NsUnsignedLong number Count of volumes associated with this CHAP user. Unsigned 64-bit integer. Example: 1234.  

JSON Response

            

{
   "data" : {
      "search_name" : "chapuser0.2615086886371541",
      "name" : "chapuser0.2615086886371541",
      "last_modified" : 1426776475,
      "id" : "0100000000000004d3000000000000000000000003",
      "creation_time" : 1426776475,
      "full_name" : "",
      "description" : "12345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901"
   }
}