PingOne Platform APIs - Early Access

Read All Snapshot Versions

   

GET {{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions

Use GET {{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions to return the version information for all versions of the snapshot of the specified configuration resource.

Any configuration attributes specified that contain sensitive information in plain text (such as, display names, client secrets, passwords) are masked in the response, and aren’t available to any caller, even administrators. Refer to Snapshots data model.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
GET /environments/{{envID}}/snapshots/{{configResourceID}}/versions HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions"

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Bearer {{accessToken}}'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/snapshots/{{configResourceID}}/versions")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/snapshots/0b7795ac-c589-4311-82bd-b1a9caff7a6a/versions"
        }
    },
    "_embedded": {
        "snapshots": [
            {
                "_links": {
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/snapshots/0b7795ac-c589-4311-82bd-b1a9caff7a6a/versions/ab00b05b-26d3-4de1-9c17-74a08adc238e"
                    }
                },
                "id": "c47e8abf-e830-4bb4-9fe0-260895ce326e",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "snapshotId": "ab00b05b-26d3-4de1-9c17-74a08adc238e",
                "resource": {
                    "id": "0b7795ac-c589-4311-82bd-b1a9caff7a6a"
                },
                "createdAt": "2024-09-09T14:43:55.346Z",
                "startedAt": "2024-09-09T14:43:55.482Z",
                "completedAt": "2024-09-09T14:43:55.538Z",
                "versionedAt": "2021-10-08T18:00:20.458Z",
                "status": "COMPLETE",
                "resourceUrl": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/0b7795ac-c589-4311-82bd-b1a9caff7a6a",
                "configuration": {
                    "_links": {
                        "self": {
                            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/0b7795ac-c589-4311-82bd-b1a9caff7a6a"
                        },
                        "environment": {
                            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                        }
                    },
                    "id": "0b7795ac-c589-4311-82bd-b1a9caff7a6a",
                    "environment": {
                        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "name": "ApplicationPopulation_1633716020",
                    "description": "Population for application users",
                    "userCount": 1,
                    "createdAt": "2021-10-08T18:00:20.458Z",
                    "updatedAt": "2021-10-08T18:00:20.458Z",
                    "default": false
                }
            },
            {
                "_links": {
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/snapshots/0b7795ac-c589-4311-82bd-b1a9caff7a6a/versions/79451a5d-8a8f-49be-800a-67f396eb81ed"
                    }
                },
                "id": "51edcd76-6b3e-4ddf-9bf3-44f81f415129",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "snapshotId": "79451a5d-8a8f-49be-800a-67f396eb81ed",
                "resource": {
                    "id": "0b7795ac-c589-4311-82bd-b1a9caff7a6a"
                },
                "createdAt": "2024-09-09T13:58:17.675Z",
                "startedAt": "2024-09-09T13:58:17.881Z",
                "completedAt": "2024-09-09T13:58:28.827Z",
                "versionedAt": "2021-10-08T18:00:20.458Z",
                "status": "COMPLETE",
                "resourceUrl": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/0b7795ac-c589-4311-82bd-b1a9caff7a6a",
                "configuration": {
                    "_links": {
                        "self": {
                            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/0b7795ac-c589-4311-82bd-b1a9caff7a6a"
                        },
                        "environment": {
                            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                        }
                    },
                    "id": "0b7795ac-c589-4311-82bd-b1a9caff7a6a",
                    "environment": {
                        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "name": "ApplicationPopulation_1633716020",
                    "description": "Population for application users",
                    "userCount": 1,
                    "createdAt": "2021-10-08T18:00:20.458Z",
                    "updatedAt": "2021-10-08T18:00:20.458Z",
                    "default": false
                }
            },
            {
                "_links": {
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/snapshots/0b7795ac-c589-4311-82bd-b1a9caff7a6a/versions/73a64c05-d67d-49fb-8430-9dc86634e528"
                    }
                },
                "id": "1377ce69-9d42-4e1a-952a-9d00031b4b71",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "snapshotId": "73a64c05-d67d-49fb-8430-9dc86634e528",
                "resource": {
                    "id": "0b7795ac-c589-4311-82bd-b1a9caff7a6a"
                },
                "createdAt": "2024-09-06T14:42:36.795Z",
                "startedAt": "2024-09-06T14:42:36.839Z",
                "completedAt": "2024-09-06T14:42:45.470Z",
                "versionedAt": "2021-10-08T18:00:20.458Z",
                "status": "COMPLETE",
                "resourceUrl": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/0b7795ac-c589-4311-82bd-b1a9caff7a6a",
                "configuration": {
                    "_links": {
                        "self": {
                            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/0b7795ac-c589-4311-82bd-b1a9caff7a6a"
                        },
                        "environment": {
                            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                        }
                    },
                    "id": "0b7795ac-c589-4311-82bd-b1a9caff7a6a",
                    "environment": {
                        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "name": "ApplicationPopulation_1633716020",
                    "description": "Population for application users",
                    "userCount": 1,
                    "createdAt": "2021-10-08T18:00:20.458Z",
                    "updatedAt": "2021-10-08T18:00:20.458Z",
                    "default": false
                }
            },
            {
                "_links": {
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/snapshots/0b7795ac-c589-4311-82bd-b1a9caff7a6a/versions/c719a926-dee7-4026-b2f6-70f569c9d60d"
                    }
                },
                "id": "7606c962-8b7a-4fb0-aa90-7e97b4953b7c",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "snapshotId": "c719a926-dee7-4026-b2f6-70f569c9d60d",
                "resource": {
                    "id": "0b7795ac-c589-4311-82bd-b1a9caff7a6a"
                },
                "createdAt": "2024-09-06T14:37:30.903Z",
                "startedAt": "2024-09-06T14:37:30.962Z",
                "completedAt": "2024-09-06T14:37:44.004Z",
                "versionedAt": "2021-10-08T18:00:20.458Z",
                "status": "COMPLETE",
                "resourceUrl": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/0b7795ac-c589-4311-82bd-b1a9caff7a6a",
                "configuration": {
                    "_links": {
                        "self": {
                            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/0b7795ac-c589-4311-82bd-b1a9caff7a6a"
                        },
                        "environment": {
                            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                        }
                    },
                    "id": "0b7795ac-c589-4311-82bd-b1a9caff7a6a",
                    "environment": {
                        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "name": "ApplicationPopulation_1633716020",
                    "description": "Population for application users",
                    "userCount": 1,
                    "createdAt": "2021-10-08T18:00:20.458Z",
                    "updatedAt": "2021-10-08T18:00:20.458Z",
                    "default": false
                }
            },
            {
                "_links": {
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/snapshots/0b7795ac-c589-4311-82bd-b1a9caff7a6a/versions/cc64ea07-1da0-4bf8-b487-5c178667d8c8"
                    }
                },
                "id": "d443b74c-542c-4ec4-b0b7-20a5e68a2882",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "snapshotId": "cc64ea07-1da0-4bf8-b487-5c178667d8c8",
                "resource": {
                    "id": "0b7795ac-c589-4311-82bd-b1a9caff7a6a"
                },
                "createdAt": "2024-09-06T14:24:54.035Z",
                "startedAt": "2024-09-06T14:24:54.080Z",
                "completedAt": "2024-09-06T14:25:08.706Z",
                "versionedAt": "2021-10-08T18:00:20.458Z",
                "status": "COMPLETE",
                "resourceUrl": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/0b7795ac-c589-4311-82bd-b1a9caff7a6a",
                "configuration": {
                    "_links": {
                        "self": {
                            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/0b7795ac-c589-4311-82bd-b1a9caff7a6a"
                        },
                        "environment": {
                            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                        }
                    },
                    "id": "0b7795ac-c589-4311-82bd-b1a9caff7a6a",
                    "environment": {
                        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "name": "ApplicationPopulation_1633716020",
                    "description": "Population for application users",
                    "userCount": 1,
                    "createdAt": "2021-10-08T18:00:20.458Z",
                    "updatedAt": "2021-10-08T18:00:20.458Z",
                    "default": false
                }
            }
        ]
    },
    "size": 5
}