CheckDocServiceUrlRequestDto

The ONLYOFFICE Docs connection settings to store and verify.

Name	Type	Description	Notes
docServiceUrl	String	The public address of the Document Server, the one a browser loads the editor from. An empty value drops the portal's own setting, so the address configured for the deployment takes over again. A value with no scheme is stored with http:// prepended, and an absolute address may not carry a query string.	[required] [example: https://documentserver.example.com] [nullable]
docServiceUrlInternal	String	The address the portal itself uses for its server-to-server calls to the Document Server, for deployments where that traffic stays inside the private network. Left empty, those calls go to the public address instead.	[optional] [example: https://documentserver-internal.example.com] [nullable]
docServiceUrlPortal	String	The address of this portal as the Document Server has to call it back on in order to fetch and save a document. Set it when the Document Server cannot resolve the portal by its public name; left empty, the portal's own resolved address is used.	[optional] [example: https://portal.example.com] [nullable]
docServiceSignatureSecret	String	The shared secret that requests between the portal and the Document Server are signed with; it has to be the same value the Document Server itself is configured with, otherwise the verification of the new settings fails. It is write-only: the document service location is reported without it.	[optional] [example: secret-key-123] [nullable]
docServiceSignatureHeader	String	The name of the HTTP header the signature travels in, which has to match the header the Document Server expects. A secret without a header is not a usable pair and is rejected.	[optional] [example: Authorization] [nullable]
docServiceSslVerification	Boolean	Whether the portal validates the TLS certificate of the Document Server. With verification on, a self-signed certificate breaks the connection; with it off, any certificate is accepted, which is meant for test deployments only. Omitting the field turns verification on.	[optional] [example: true] [nullable]