Use the GET /bulk/export?includeExternalResources=false endpoint to export all API resources to a JSON file. For the /configStore resource type, only the settings that are different from the defaults for this version of PingFederate are included in the export. Only resource types currently supported by the administrative API are included in the exported data.

Resources not yet supported include:

Query parameters

Parameter Value Description
includeExternalResources boolean(default: false) Include external resources like OAuth clients stored outside of PingFederate.

Status codes

Code Reason
200 Success.
403 The current configuration cannot be bulk exported.

BulkConfig - Model describing a series of configuration operations.

Property Type Description
metadata * BulkConfigMetadata The metadata detailing how this config was generated.
operations * array[ConfigOperation] A list of configuration operations.

BulkConfigMetadata - Model describing how bulk configuration data was generated.

Property Type Description
pfVersion * string The version of PingFederate this config was generated from.

ConfigOperation - Model describing a list of configuration operations for a given resource type.

Property Type Description
itemIds array[string] The item ID’s for the operation. This field only applies to the DELETE operation type.
items array[object] The configuration items for the operation. This field only applies to the SAVE operation type.
operationType * ConfigOperationType The type of operation to be performed.
resourceType * string The identifier for the resource type the operation applies to.
subResource string The subResource for the operation.