Save the IP restriction settings

PUT /api/2.0/settings/iprestrictions

Request

Updates the IP restriction settings with a parameter specified in the request.

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

New IP restriction settings

ipRestrictionsarray of object

List of IP addresses

ipstring
forAdminboolean
enableboolean

Enables IP restrictions or not

Examples

PUT /api/2.0/settings/iprestrictions HTTP/1.1
Accept: application/json
Content-Length: 136
Content-Type: application/json
Host: example.com

{
  "ipRestrictions": [
    {
      "value": {
        "ip": "some text",
        "forAdmin": true
      }
    }
  ],
  "enable": true
}
curl --request PUT \
  --url https://example.com/api/2.0/settings/iprestrictions \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "ipRestrictions": [
    {
      "value": {
        "ip": "some text",
        "forAdmin": true
      }
    }
  ],
  "enable": true
}'

Responses

200

Updated IP restriction settings

New IP restriction settings

ipRestrictionsarray of object

List of IP addresses

ipstring
forAdminboolean
enableboolean

Enables IP restrictions or not

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).