Sign in

v5

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-0330110112.1 KB
Shared Policy Group

Create or update Shared Policy Group from SharedPolicyGroupSpec

Create/update Shared Policy Group from Shared Policy Group Spec

put/organizations/{orgId}/environments/{envId}/shared-policy-groups

Path parameters

orgIdstring required
Example:dedd0e0f-b3e9-4d2f-89cd-b2a9de7cb145

organization ID

envIdstring required
Example:a44e0d1b-9fa9-4d64-8b76-3634623a2e27

environment ID

Query parameters

dryRunboolean
Example:true

For modifying requests, this parameter allow you to test the result of an endpoint without actually persisting the state of the underlying spec.

Request body

hridstring required

A unique human readable id identifying this resource

apiType'PROXY' | 'MESSAGE' required

API type compatible with a shared policy group.

descriptionstring

The description of the shared policy group

prerequisiteMessagestring

The prerequisite message of the shared policy group. This message is displayed to the user to help understand the prerequisite to use the shared policy group.

namestring required

The name of the shared policy group

phase'REQUEST' | 'RESPONSE' | 'PUBLISH' | 'SUBSCRIBE' required

The execution phase of a shared policy group policy. Only phases compatible with PROXY and MESSAGE API types are supported.

Example request

{
  "hrid": "demo_api",
  "description": "this is a shared policy group",
  "prerequisiteMessage": "the resource cache \"my-cache\" is required",
  "name": "My Shared Policy Group"
}

Response

State of the successfully created / updated Shared Policy Group

hridstring required

A unique human readable id identifying this resource

apiType'PROXY' | 'MESSAGE' required

API type compatible with a shared policy group.

descriptionstring

The description of the shared policy group

prerequisiteMessagestring

The prerequisite message of the shared policy group. This message is displayed to the user to help understand the prerequisite to use the shared policy group.

namestring required

The name of the shared policy group

phase'REQUEST' | 'RESPONSE' | 'PUBLISH' | 'SUBSCRIBE' required

The execution phase of a shared policy group policy. Only phases compatible with PROXY and MESSAGE API types are supported.

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

crossIdstring

Identifier used to track this resource across environment promotions.

Example response

{
  "hrid": "demo_api",
  "description": "this is a shared policy group",
  "prerequisiteMessage": "the resource cache \"my-cache\" is required",
  "name": "My Shared Policy Group"
}