Skip to main content

CPE Matching REST API

Use the CPE Matching Configuration REST API to add/set/remove CPE matching configuration to organizations and applications.

Get CPE Matching Configuration

Returns the current CPE Matching settings for an application or organization.

View IQ Elements permissions are required.

GET /api/v2/{ownerType}/{internalOwnerId}/configuration/publicSource/cpe
Path Variables

  • ownerType - Type of owner. Allowed values: application | organization.

  • internalOwnerId - Internal ID of the application or organization.

Example:

curl -i -u <UserToken>:<TokenPassword> \
  -X GET "http://localhost:8070/api/v2/application/3fa85f64e7/configuration/publicSource/cpe"
{
  "inheritedFromOrganizationName": "finance-services",
  "enabledInParent": true,
  "allowOverride": false,
  "enabled": true
}

  • enabled - true if CPE Matching is active for the specified owner.

  • allowOverride - true if child applications may override the setting.

  • enabledInParent - true if CPE Matching is enabled in any parent organization.

  • inheritedFromOrganizationName - parent organization providing the effective setting, or omitted when not inherited.

Apply CPE Matching Configuration

Enables or updates CPE Matching for an application or organization.

Edit IQ Elements permissions are required.

PUT /api/v2/{ownerType}/{internalOwnerId}/configuration/publicSource/cpe
Payload Fields

  • enabled - true if CPE Matching is active for the specified owner

  • allowOverride - true if child applications may override the setting

Example:

curl -i -u <UserToken>:<TokenPassword> \
  -H "Content-Type: application/json" \
  -d '{"allowOverride":false,"enabled":true}' \
  -X PUT "http://localhost:8070/api/v2/application/3fa85f64e7/configuration/publicSource/cpe"
{
  "allowOverride": false,
  "enabled": true
}