Sign in

v5

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

Get one policy group

Get a policy group using HRID

get/organizations/{orgId}/environments/{envId}/shared-policy-groups/{hrid}

Response

Shared policy group successfully retrieved

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"
}