arangodb/Documentation/DocuBlocks/Rest/Administration/put_admin_server_mode.md

@startDocuBlock put_admin_server_mode @brief Update the mode of this server (read-only or default)

@RESTHEADER{PUT /_admin/server/mode, Update whether or not a server is in read-only mode, handleMode:set}

@RESTBODYPARAM{mode,string,required,string} The mode of the server readonly or default.

@RESTDESCRIPTION Update mode information about a server. The json response will contain a field mode with the value readonly or default. In a read-only server all write operations will fail with an error code of 1004 (ERROR_READ_ONLY). Creating or dropping of databases and collections will also fail with error code 11 (ERROR_FORBIDDEN).

This API so it does require authentication and administrative server rights.

@RESTRETURNCODES

@RESTRETURNCODE{200} This API will return HTTP 200 if everything is ok

@RESTRETURNCODE{401} if the request was not authenticated as a user with sufficient rights

@endDocuBlock