Skip to main content

Manage IP restrictions

This example demonstrates how to retrieve and update IP restriction settings in ONLYOFFICE DocSpace using API requests. IP restrictions enhance security by controlling which IP addresses are allowed access, ensuring that only authorized users can log in from designated networks.

Before you start​

  1. Replace https://yourportal.onlyoffice.com and YOUR_API_KEY with your actual DocSpace portal URL and API key. Ensure you have the necessary data and permissions to perform migration operations.
  2. Before you can make requests to the API, you need to authenticate. Check out the Personal access tokens page to learn how to obtain and use access tokens.
Full example
// Set API base URL
const API_HOST = 'https://yourportal.onlyoffice.com';
const API_KEY = 'your_api_key';

// Headers with API key for authentication
const HEADERS = {
  Accept: 'application/json',
  Authorization: `Bearer ${API_KEY}`,
  'Content-Type': 'application/json',
};

// Step 1: Update IP restrictions settings
async function saveRestrictions(ipRestrictions, enable = true) {
  const url = `${API_HOST}/api/2.0/settings/iprestrictions`;
  const body = JSON.stringify({ enable, ipRestrictions });

  const res = await fetch(url, { method: 'PUT', headers: HEADERS, body });
  if (!res.ok) {
    const text = await res.text();
    console.log(`IP restrictions update failed. Status code: ${res.status}, Message: ${text}`);
    return null;
  }
  const settings = await res.json();
  console.log('IP restrictions updated successfully.');
  return settings;
}

// Step 2: Retrieve current IP restrictions settings
async function getRestrictions() {
  const url = `${API_HOST}/api/2.0/settings/iprestrictions`;

  const res = await fetch(url, { method: 'GET', headers: HEADERS });
  if (!res.ok) {
    const text = await res.text();
    console.log(`IP restrictions retrieval failed. Status code: ${res.status}, Message: ${text}`);
    return null;
  }
  const settings = await res.json();
  console.log('IP restrictions settings retrieved:', settings);
  return settings;
}

// Run
(async () => {
  await saveRestrictions([
    { ip: '192.168.1.1', forAdmin: true },
  ]);

  await getRestrictions();
})();

Step 1: Update IP restrictions​

A PUT request is sent to /api/2.0/settings/iprestrictions with:

  • enable: Whether to enable or disable restrictions.
  • ipRestrictions: A list of allowed IP addresses.
async function saveRestrictions(ipRestrictions, enable = true) {
  const url = `${API_HOST}/api/2.0/settings/iprestrictions`;
  const body = JSON.stringify({ enable, ipRestrictions });

  const res = await fetch(url, { method: 'PUT', headers: HEADERS, body });
  if (!res.ok) {
    const text = await res.text();
    console.log(`IP restrictions update failed. Status code: ${res.status}, Message: ${text}`);
    return null;
  }
  const settings = await res.json();
  console.log('IP restrictions updated successfully.');
  return settings;
}

Step 2: Retrieve IP restrictions​

A GET request is sent to /api/2.0/settings/iprestrictions.

Fetches the current security policy to verify allowed addresses.

async function getRestrictions() {
  const url = `${API_HOST}/api/2.0/settings/iprestrictions`;

  const res = await fetch(url, { method: 'GET', headers: HEADERS });
  if (!res.ok) {
    const text = await res.text();
    console.log(`IP restrictions retrieval failed. Status code: ${res.status}, Message: ${text}`);
    return null;
  }
  const settings = await res.json();
  console.log('IP restrictions settings retrieved:', settings);
  return settings;
}