1
0
Fork 0
arangodb/Documentation/DocuBlocks/Rest/Administration/get_admin_server_mode.md

729 B

@startDocuBlock get_admin_server_mode @brief Return the mode of this server (read-only or default)

@RESTHEADER{GET /_admin/server/mode, Return whether or not a server is in read-only mode, handleMode:get}

@RESTDESCRIPTION Return 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 is a public API so it does not require authentication.

@RESTRETURNCODES

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