Sign in

v58

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-036490116.2 KB
SharedPolicyGroups

Create a shared policy group

post/shared-policy-groups

Request body

crossIdstring

The unique ID of the shared policy group

namestring required

The name of the 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.

apiType'A2A_PROXY' | 'AUTHZ' | 'EDGE' | 'LLM_PROXY' | 'MCP_PROXY' | 'MESSAGE' | 'PROXY' | 'NATIVE' required

API's type.

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

The execution phase of a policy.

Example request

{
  "crossId": "5e2b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b",
  "name": "My Shared Policy Group",
  "description": "This is a shared policy group",
  "prerequisiteMessage": "The resource cache \"my-cache\" is required",
  "apiType": "MESSAGE",
  "originContext": {
    "origin": "MANAGEMENT"
  },
  "phase": "REQUEST"
}

Response

Shared policy group created

idstring

The unique ID of the shared policy group

crossIdstring

The unique ID of the shared policy group

namestring

The name of the 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.

versionnumber

The version of the shared policy group

apiType'A2A_PROXY' | 'AUTHZ' | 'EDGE' | 'LLM_PROXY' | 'MCP_PROXY' | 'MESSAGE' | 'PROXY' | 'NATIVE'

API's type.

phase'ENTRYPOINT_CONNECT' | 'REQUEST' | 'RESPONSE' | 'INTERACT' | 'PUBLISH' | 'SUBSCRIBE'

The execution phase of a policy.

deployedAtstring date-time

The date at which the shared policy group was deployed

createdAtstring date-time

The date at which the shared policy group was created

updatedAtstring date-time

The date at which the shared policy group was last updated

lifecycleState'DEPLOYED' | 'UNDEPLOYED' | 'PENDING'

The lifecycle state of a shared policy group

Example response

{
  "crossId": "5e2b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b",
  "name": "My Shared Policy Group",
  "description": "This is a shared policy group",
  "prerequisiteMessage": "The resource cache \"my-cache\" is required",
  "version": 1,
  "apiType": "MESSAGE",
  "originContext": {
    "origin": "MANAGEMENT"
  },
  "phase": "REQUEST",
  "deployedAt": "2020-01-01T00:00:00Z",
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2020-01-01T00:00:00Z",
  "lifecycleState": "DEPLOYED"
}