Check the document service URL

PUT /api/2.0/files/docservice

Request

Checks the document service location.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Request parameters for checking the document service location

docServiceUrlstring

The Document Server address

docServiceUrlInternalstring

The Document Server address in the local private network

docServiceUrlPortalstring

The Community Server address

Examples

PUT /api/2.0/files/docservice HTTP/1.1
Accept: application/json
Content-Length: 112
Content-Type: application/json
Host: example.com

{
  "docServiceUrl": "some text",
  "docServiceUrlInternal": "some text",
  "docServiceUrlPortal": "some text"
}

curl --request PUT \
  --url https://example.com/api/2.0/files/docservice \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "docServiceUrl": "some text",
  "docServiceUrlInternal": "some text",
  "docServiceUrlPortal": "some text"
}'

Responses

200

Document service information: the Document Server address, the Document Server address in the local private network, the Community Server address

versionstringrequired

Version

docServiceUrlApistringrequired

Doc service url api

docServiceUrlstringrequired

Doc service url

docServiceUrlInternalstringrequired

Doc service url internal

docServicePortalUrlstringrequired

Doc service portal url

isDefaultbooleanrequired

Is default

400

Invalid input urls/Mixed Active Content is not allowed. HTTPS address for Document Server is required

401

Unauthorized