Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Policy Decision Points

Migrate PDP Config number of shards

The migration process is as followed:

  1. Perform request to this endpoint with the new number of shards
  2. A new PDP Config will be created with the new number of shards and a new api-key
  3. Create a new PDP cluster with the same instances as the number of shards defined in the new PDP Config
  4. Wait for the new PDP cluster to be ready
  5. Update your PDP load balancer to point to the new PDP cluster

More info can be found here https://docs.permit.io/concepts/pdp-sharding

post/v2/pdps/{proj_id}/{env_id}/configs/migrate-shards

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Request body

num_shardsinteger required

Response

Successful Response

idstring uuid required
namestring
organization_idstring uuid required

Unique id of the organization that the pdp_config belongs to.

project_idstring uuid required

Unique id of the project that the pdp_config belongs to.

environment_idstring uuid required

Unique id of the environment that the pdp_config belongs to.

client_secretstring required
opal_server_access_tokenstring
num_shardsinteger
debug_audit_logsboolean

Whether debug audit logs are enabled or not

min_pdp_versionstring

The minimum image version of PDP that can connect to this config