IRPCServerAdmin.GetServerEndpointSettings

View as Markdown

Administration API / specialized admin session

Gets the TLS setting and the certificate of the server's gRPC endpoint.

Service	Server administration `MFiles.IRPCServerAdmin`
gRPC method	`/MFiles.IRPCServerAdmin/GetServerEndpointSettings`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-server-endpoint-settings`
Request	`GetServerEndpointSettingsRequest`
Response	`GetServerEndpointSettingsResponse`
Book and level	Administration API, specialized
Kind	admin
Session	Required: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotent	no
Returns metadata structure version	no
Streaming	none (unary)

Remarks

Requires the system administrator server role (server right shutdown). Denied for other callers.
Also fails with the same access denied error when certificate management has been disabled on the server.
Fails with "Not implemented." if more than one certificate is stored.
Only the public parts of the certificate and key are returned.

Request: GetServerEndpointSettingsRequest

No fields.

Response: GetServerEndpointSettingsResponse

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

Field	Type	Description
`server_endpoint_info`	`ServerEndpointSettings`	Whether TLS is enabled, the stored certificate, and whether changes are waiting to be applied (`has_pending_changes`). See ServerEndpointSettings.
`server_endpoint_info.use_tls`	`bool`	True to enable TLS on the endpoint.
`server_endpoint_info.server_certificates[]`	repeated `ServerCertificate`	Server certificates.
`server_endpoint_info.server_certificates[].id`	`int32`	Certificate id.
`server_endpoint_info.server_certificates[].certificate`	`CertificateInfo`	Certificate info.
`server_endpoint_info.server_certificates[].private_key`	`PrivateKeyInfo`	Private key info.
`server_endpoint_info.has_pending_changes`	`bool`	True if there are pending changes on the server.