Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 3.07 KB

DocServiceUrlDto.md

File metadata and controls

37 lines (29 loc) · 3.07 KB

DocServiceUrlDto

The document service location as this portal has it configured, together with the editor entry points a client needs in order to open a document.

Properties

Name Type Description Notes
version str The editor version the running Document Server reported. It is filled in only when the version was asked for, and comes back empty otherwise. When the Document Server does not answer, a fallback version is reported rather than an error, so a value here is no proof that the server is reachable.
doc_service_url_api str The absolute URL of the editor api script that a client has to load before it can open a document. It is derived from the public Document Server address unless the deployment overrides it separately.
doc_service_url str The public Document Server address a browser loads the editor from. Empty means no document server is configured for this portal, and documents cannot be opened for editing or viewing.
doc_service_preload_url str The absolute URL of a page a client may load in advance to warm the editor scripts up. Loading it is optional and changes nothing on the portal.
doc_service_url_internal str The address the portal uses for its own server-to-server calls to the Document Server. When no private-network address is configured, it repeats the public one.
doc_service_portal_url str The address the Document Server is told to call this portal back on. Empty means nothing overrides it and the portal's own resolved address is used.
doc_service_signature_header str The name of the HTTP header that carries the signature on requests between the portal and the Document Server. The secret itself is not part of the answer, so this only tells a client whether request signing is set up and under which header.
doc_service_ssl_verification bool Whether the portal validates the TLS certificate of the Document Server. False means any certificate is accepted, which is expected only in a test deployment.
is_default bool Whether every one of these settings is still the one the deployment ships with. False means at least one of the addresses, the signature settings or SSL verification has been overridden for this portal.

Example

from docspace_api_sdk.models.doc_service_url_dto import DocServiceUrlDto

# TODO update the JSON string below
json = "{}"
# create an instance of DocServiceUrlDto from a JSON string
doc_service_url_dto_instance = DocServiceUrlDto.from_json(json)
# print the JSON string representation of the object
print(DocServiceUrlDto.to_json())

# convert the object into a dict
doc_service_url_dto_dict = doc_service_url_dto_instance.to_dict()
# create an instance of DocServiceUrlDto from a dict
doc_service_url_dto_from_dict = DocServiceUrlDto.from_dict(doc_service_url_dto_dict)

[Back to Model list] [Back to API list] [Back to README]