SDK
SDK Golang v1.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

Info #

Returns information about Kuzzle: available API (base + extended), plugins, external services (Redis, Elasticsearch, ...), servers, etc.

Arguments #

func (s* Server) Info(options types.QueryOptions) (json.RawMessage, error)
ArgumentsTypeDescription
options
types.QueryOptions
An object containing query options.

Options #

Additional query options

OptionTypeDescriptionDefault
Queuable
bool
If true, queues the request during downtime, until connected to Kuzzle againtrue

Return #

Returns server informations as a json.RawMessage or a KuzzleError. See how to handle error.

Usage #

info, err := kuzzle.Server.Info(nil)
if err != nil {
  log.Fatal(err)
} else {
  fmt.Println("Kuzzle Server information as JSON string:", string(info))
}