Get Vendor Policy IDs by POP

New

Published on Jun 29, 2025

1 minute(s) read

Get

/orchestrator/2.0/pops/{envId}/{popId}/policies

This is an API to get a list of Policies by Environment and POP ID. 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 Location

United States (US) - https://API.us1.plainid.io

Canada (CA) - https://api.ca1.plainid.io

Europe (EU) - 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

*Required

Header	Value	cURL Line
Accept	`application/json`	`-H"Accept: 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 in the Try It or Code Sample tabs. You can then copy the cURL sample from the Code Sample tab 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.

Security

HTTP

Type bearer

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

Path parameters

envId

stringRequired

Environment ID. You can find the Environment ID in your Environment Settings.

popId

stringRequired

POP ID. You can find the POP ID using the GET List of POPs API or through the UI under your POP settings.

Pattern^POP[0-9A-Z]{11,13}$

Query parameters

filter[name]

string

Filter by Policy Name.

limit

number

Limit for pagination.

Minimum1

Maximum1000

Default50.0

offset

number

Offset for pagination.

Minimum0

Default0.0

Responses

200

List of POP-related Policies

{
  "data": [
    {
      "vendorPolicyId": "role_0b9192e5-6b04-4350-a781-021878c04689_20432",
      "name": "Role1",
      "type": "ALLOW"
    },
    {
      "vendorPolicyId": "role_0b9192e5-6b04-4350-a781-021878c04689_20441",
      "name": "Role2",
      "type": "ALLOW"
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0,
    "total": 2
  }
}

Array of object

object

data

Array of object (VendorPolicy)

object

vendorPolicyId

string

name

string

type

string