Protected resources

The following protected resources hosted in PI Web API are sensitive and require the calling user be a member of the local Windows group designated as the PI Web API administrator group during initial setup on the server that hosts PI Web API. By default, this group is PI Web API Admins.

See Install PI Web API for additional information.

Note: Protected resources cannot be used with bearer authentication.

DELETE /piwebapi/system/cacheinstance

DELETE /piwebapi/system/configuration/{key}

GET /piwebapi/system/activeconfiguration

GET /piwebapi/system/cacheinstances

GET /piwebapi/system/activeconfiguration

GET /piwebapi/system/configuration

GET /piwebapi/system/configuration/{key}

GET /piwebapi/system/metrics

GET /piwebapi/system/status

GET /piwebapi/system/versions

PUT /piwebapi/system/configuration/{key}

Disable Configuration Administration Filter

When the DisableConfigurationAdminRestriction setting is enabled, users without administrative privileges are provided with read-only access to the following specific system configuration endpoints:

GET /piwebapi/system/activeconfiguration

GET /piwebapi/system/configuration

GET /piwebapi/system/configuration/{key}

See DisableConfigurationAdminRestriction in the Configuration properties for additional information.