Trigger the POP Discovery Process using the POP and Environment IDs. You can find the POP ID using the GET List of POPs API or through the UI under your POP settings.
Notice
Accessing the APIs is through a dedicated domain/URL, according to your PlainID Tenant Locationhttps://API.us1.plainid.io
https://api.ca1.plainid.io
https://api.eu1.plainid.io
Using HTML Encoded Special Characters
Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.
Important note about headers
Refer to the headers below to modify your cURL sample. Check if the following headers are in the sample, if not, ensure you add it to your cURL sample before pasting into your API tool.Headers
*RequiredHeader | Value | cURL Line |
---|---|---|
Accept | `application/json` | `-H"Accept: application/json"` |
Content Type | `application/json` | `-H"Content-Type: application/json"` |
cURL Sample Guidelines
In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right. They will then appear in the cURL sample on the bottom of the page in the correct format.
Using HTML Encoded Special Characters
Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.
'
For more details about Administration API Authentication, check out the Authentication APIs documentation. Provide your bearer token in the Authorization header when making requests to protected resources. Example: Authorization: Bearer 123
POP ID. You can find the POP ID in the POP Settings by clicking the three dots next to the POP name.
Environment ID. You can find the Environment ID in your Environment Settings.
The Discovery Process has been triggered and is being processed.
Bad Request
{
"errors": [
{
"code": "ORC-025",
"id": "E880D0",
"status": 400,
"name": "PopDoesNotBelongToEnvironment",
"message": "Pop [POP1P00XFYS0NVJ] does not belong to Environment [ec3ff4ee-81f9-4e7f-9037-6fa9fde62cc8]",
"args": {
"popId": "POP1P00XFYS0NVJ",
"envId": "ec3ff4ee-81f9-4e7f-9037-6fa9fde62cc8"
}
}
]
}
{
"errors": [
{
"code": "ORC-015",
"id": "E28087",
"status": 400,
"name": "DiscoveryAlreadyInProgressError",
"message": "Discovery is currently in progress, and parallel discoveries for the same POP are not allowed",
"args": {
"name": "PowerBI"
}
}
]
}
Response object