Read One Plan
GET {{apiPath}}/environments/{{envID}}/propagation/plans/{{planID}}
To get data for a single propagation plan resource, the GET {{apiPath}}/environments/{{envID}}/propagation/plans/{{planID}} operation returns data for the propagation plan resource with the specified ID.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/propagation/plans/{{planID}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/plans/{{planID}}")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Accept", "application/json");
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}}/propagation/plans/{{planID}}"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
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}}/propagation/plans/{{planID}} HTTP/1.1
Host: {{apiPath}}
Accept: application/json
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}}/propagation/plans/{{planID}}")
.method("GET", body)
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/propagation/plans/{{planID}}",
"method": "GET",
"timeout": 0,
"headers": {
"Accept": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'GET',
'url': '{{apiPath}}/environments/{{envID}}/propagation/plans/{{planID}}',
'headers': {
'Accept': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "{{apiPath}}/environments/{{envID}}/propagation/plans/{{planID}}"
payload = {}
headers = {
'Accept': 'application/json',
'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}}/propagation/plans/{{planID}}');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Accept' => 'application/json',
'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}}/propagation/plans/{{planID}}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/propagation/plans/{{planID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Accept")
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
{
"id": "ea142a22-61d8-4df7-a93e-8de943c526fe",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"createdAt": "2022-01-13T19:54:00.125Z",
"updatedAt": "2022-01-13T19:54:00.125Z",
"name": "Default Plan",
"_links": {
"create": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans/"
},
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans/ea142a22-61d8-4df7-a93e-8de943c526fe"
},
"update": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans/ea142a22-61d8-4df7-a93e-8de943c526fe"
},
"delete": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans/ea142a22-61d8-4df7-a93e-8de943c526fe"
}
},
"_embedded": {
"rules": [
{
"id": "a9e576f8-bf43-45ba-8030-1f7beb38b585",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"createdAt": "2022-02-02T19:22:03.304Z",
"updatedAt": "2022-02-02T19:22:03.304Z",
"plan": {
"id": "ea142a22-61d8-4df7-a93e-8de943c526fe"
},
"sourceStore": {
"id": "a7115f69-136d-4b5d-8b24-5c1c218147f5"
},
"targetStore": {
"id": "9f95941f-9870-448c-9ff6-2a132e4b5d5a"
},
"name": "rule name",
"active": false,
"deprovision": true,
"populations": [
{
"id": "cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a"
}
],
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/a9e576f8-bf43-45ba-8030-1f7beb38b585"
},
"sourceStore": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/a7115f69-136d-4b5d-8b24-5c1c218147f5"
},
"targetStore": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/9f95941f-9870-448c-9ff6-2a132e4b5d5a"
}
}
},
{
"id": "f9d4c0fc-269d-4645-9079-2795b18f06a6",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"createdAt": "2022-01-13T20:37:29.220Z",
"updatedAt": "2022-01-13T20:37:29.220Z",
"plan": {
"id": "ea142a22-61d8-4df7-a93e-8de943c526fe"
},
"sourceStore": {
"id": "a7115f69-136d-4b5d-8b24-5c1c218147f5"
},
"targetStore": {
"id": "9f95941f-9870-448c-9ff6-2a132e4b5d5a"
},
"active": false,
"deprovision": true,
"populations": [
{
"id": "cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a"
}
],
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/f9d4c0fc-269d-4645-9079-2795b18f06a6"
},
"sourceStore": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/a7115f69-136d-4b5d-8b24-5c1c218147f5"
},
"targetStore": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/9f95941f-9870-448c-9ff6-2a132e4b5d5a"
}
}
}
]
}
}