Update an API Key

This example demonstrates how to update an existing API key in DocSpace using the API. You can change the name, permissions, or status of the key by providing its unique ID (UUID).

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

Node.js

// Set your DocSpace portal URL and access token
const API_HOST = 'https://yourportal.onlyoffice.com';
const API_KEY = 'your_api_key';

// Headers with authorization token
const HEADERS = {
  Authorization: API_KEY,
  'Content-Type': 'application/json',
};

// Step 1: Update an API key
async function updateApiKey(keyId, newName, newPermissions, isActive = true) {
  const url = `${API_HOST}/api/2.0/keys/${keyId}`;
  const payload = {
    name: newName,
    permissions: newPermissions,
    isActive: isActive,
  };

  const res = await fetch(url, {
    method: 'PUT',
    headers: HEADERS,
    body: JSON.stringify(payload),
  });

  if (!res.ok) {
    const text = await res.text();
    console.log(`API key update failed. Status code: ${res.status}, Message: ${text}`);
    return null;
  }

  const data = await res.json();
  if (data?.response === true) {
    console.log('API key updated successfully.');
    return true;
  } else {
    console.log('API key update failed. Unexpected response.');
    return null;
  }
}

// Example usage
(async () => {
  try {
    await updateApiKey(
      'your_key_uuid',
      'Updated Integration Bot Key',
      ['files:read', 'files:write', 'rooms:read', 'rooms:write', 'accounts:read'],
      true
    );
  } catch (err) {
    console.error(err.message);
  }
})();

Python

import requests

# Set your DocSpace portal URL and access token
API_HOST = 'https://yourportal.onlyoffice.com'
API_KEY = 'your_api_key'

# Headers with authorization token
HEADERS = {
  'Authorization': API_KEY,
  'Content-Type': 'application/json'
}

# Step 1: Update an API key
def update_api_key(key_id, new_name, new_permissions, is_active=True):
  url = f'{API_HOST}/api/2.0/keys/{key_id}'
  payload = {
    'name': new_name,
    'permissions': new_permissions,
    'isActive': is_active
  }

  response = requests.put(url, headers=HEADERS, json=payload)

  if response.status_code == 200 and response.json().get('response') is True:
    print('API key updated successfully.')
  else:
    print(f"API key update failed. Status code: {response.status_code}, Message: {response.text}")

# Example usage
if __name__ == '__main__':
  update_api_key(
    key_id='your_key_uuid',
    new_name='Updated Integration Bot Key',
    new_permissions=[
      'files:read',
      'files:write',
      'rooms:read',
      'rooms:write',
      'accounts:read'
    ],
    is_active=True
  )

How it works

A PUT request is sent to /api/2.0/keys/:keyId with the following parameters:

• name: Updated name for the key.
• permissions: Updated list of permission scopes.
• isActive: Boolean flag to activate or deactivate the key.

The request must include the UUID of the API key in the path (:keyId).