mongoc_client_get_server_status(3)

MONGOC_CLIENT_GET_SERVER_STATUS(3)

libmongoc

MONGOC_CLIENT_GET_SERVER_STATUS(3)

Warning:

Deprecated since version 1.10.0: Run the serverStatus <https://www.mongodb.com/docs/manual/reference/command/serverStatus/> command directly with mongoc_client_read_command_with_opts() <> instead.

SYNOPSIS

bool
mongoc_client_get_server_status (mongoc_client_t *client,


                                 mongoc_read_prefs_t *read_prefs,


                                 bson_t *reply,


                                 bson_error_t *error);

Queries the server for the current server status. The result is stored in reply.

reply is always initialized, even in the case of failure. Always call bson_destroy() <https://www.mongoc.org/libbson/current/bson_destroy.html> to release it.

PARAMETERS

client: A mongoc_client_t <>.
read_prefs: A mongoc_read_prefs_t <>.
reply: A maybe-NULL pointer to overwritable storage <https://www.mongodb.com/docs/languages/c/c-driver/current/libbson/guides/lifetimes/#overwritable-storage> for a bson_t <https://www.mongoc.org/libbson/current/bson_t.html> to contain the results.
error: An optional location for a bson_error_t <> or NULL.

ERRORS

Errors are propagated via the error parameter.

RETURNS

Returns true if successful. Returns false and sets error if there are invalid arguments or a server or network error.

Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

February 10, 2026

1.30.7