Use the GET {{apiPath}}/environments/{{envID}}/integrations endpoint to retrieve a list of integration metadata for the environment identified by {{envID}}. You can apply a filter to create a more targeted list of results.

Optional parameters

Parameter Description
expand Use the expand flag to return relevant data from the request. For example, if you call {{apiPath}}/environments/{{envID}}/integrations?expand=versions, you will receive version information within the response data.
The options for the expand flag include:
  • versions - Include version information.
  • latestVersion - Include only the latest version metadata in the response.
filter Use the filter flag to retrieve a targeted list of integrations that match the query you provide. See the following Filters table for available options.

Filters

Parameter Operator Value type Description
name eq or co string Filter results by name of integration.
publisher eq or co string Filter results by publisher of integration.
tags eq or co string Filter results by tag applied to integration.
pingProductNames eq or co string Filter results by the Ping product name the integration supports.
version.name eq or co string Filter results by version name of the integration.
version.number eq, gt, ge, lt, or le string Filter results by the version number of the integration.
version.endOfLifeOn eq, gt, ge, lt, or le date Filter results by the support end of life for the integration version.
version.integratedWith.name eq string Filter results by the name of the Ping product name the integration supports. Use this filter instead of pingProductNames when you want to include Ping product versions in the filter (version.integratedWith.maxVersion and version.integratedWith.minVersion). The value is case insensitive.
version.integratedWith.maxVersion eq, gt, ge, lt, or le string Filter results by maximum version number of the associated Ping product.
version.integratedWith.minVersion eq, gt, ge, lt, or le string Filter results by minimum version number of the associated Ping product.
version.releasedOn eq, gt, ge, lt, or le date Filter results by the release date of the integration version.

Operator definitions

Operator Definition
eq equals
co contains
gt greater than
ge greater than or equal to
lt less than
le less than or equal to
and Logical and
or Logical or

Include the filter flag to filter the results that PingOne includes in the response for this endpoint. So, ?expand=versions&filter=(pingProductNames eq "PINGFEDERATE" and version.releasedOn ge "2020-05-20") will respond with a list that includes version information (expand=versions) for integrations that support PingFederate and that were released on or after May 5, 2020.