API user throttling

info

Function available upon request. Contact Siemens Support.

A Tenant-Administrator can reduce the number of API↑ endpoint accesses by individual users to reduce data communication within the tenant. The Tenant-Administrator can set the following:

Proceed as follows:

  1. The own role is 'Administrator' in the Main-Tenant.
  2. The user to be reduced has the Main administrator role↑ 'TenantAPIUser' with access level '0' (see 'Assign administrator roles'). The role can only access API endpoints marked as 'ReadOnly'.
  1. Go to the menu 'Administration > Tenants > 'My Tenant' > User throttling'.
  2. All users with the 'TenantAPIUser' role are listed (1).
  3. The table displays the configured limits for queries per minute (2), available queries (3), total number of queries (4), access level (5) and the number of restricted endpoints (6).
  4. Select one or more users to throttle (8).
  1. For selected users, you can determine the number of API↑ queries per minute from endpoints and the access level.

Select the endpoints to throttle

It is possible to throttle the number of requests a user can make, either for all API endpoints or only for a specific selection of API endpoints. Proceed as follows:

  1. Click an entry under 'Endpoints' (6).
  2. A new pop-up window opens:
  4. Select the API endpoints to throttle:
    • Open the drop-down list with the corresponding endpoint.
    • Select the appropriate endpoint.
  5. OR: Import an existing .json file containing endpoints:
    • Click 'Import'.
    • Select the .json file containing the desired endpoint selection and click 'Open.'
  6. Click 'Export'.
  7. The selected endpoints are exported to a .json file on the local computer.
  8. Click 'Update'.
  1. The pop-up window closes.
  2. Only the selected endpoints are throttled.

Set the number of queries per minute

The actual throttling of queries to the previously set API endpoints is configured as follows:

  1. Click 'Set maximum queries for selected users' (8).
  2. A new pop-up window opens:
  4. Enter the desired number of queries in the text field:
  5. Enter a number between 0 and 500.
  6. The value '0' means: 'Unlimited number of queries'.
    • Click 'Update'.
  7. The window closes.
  8. The maximum number of requests per minute is updated.
  9. Click 'Delete'.
  10. The window closes.
  11. The limit on the maximum number of queries per minute is rescinded.

Determine access levels

Proceed as follows to change a user's access level as determined by the user role:

  1. Click 'Set access level' (9).
  2. A new pop-up window opens:
  4. Enter the access level in the text field:
  5. A number between 0 and 255.
    • Click 'Update'.
  6. The window closes.
  7. The access level is updated.
  8. Click 'Delete'.
  9. The window closes.
  10. The access level is reset to the value specified by the API user role.

View history

'View history' indicates the number of API calls made by the user each month:

  1. Click 'View history'
  2. A new 'API usage' pop-up window opens:
  3. The pop-up window indicates the months and API queries.
  4. Select icon .
  5. All history data is exported to a .csv file on the local computer.