GRgravitee-io
SharedPolicyGroups

Search shared policy groups

Changed on
get/shared-policy-groups

Request

  • Base URL
    /management/v2/environments/DEFAULT (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/DEFAULT/shared-policy-groups
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Query parameters

pageinteger

The page number for pagination.

perPageinteger

The number of items per page for pagination.

sortBy'name' | '-name' | 'apiType' | '-apiType' | 'phase' | '-phase' | 'updatedAt' | '-updatedAt' | 'deployedAt' | '-deployedAt'
Example:name

Possibility to sort Shared Policy Group results by field. Can be ascending or descending with minus '-' prefix. By default, no sort is applied.

qstring
Example:my shared policy group

A search query to filter shared policy groups.

Response

Page of shared policy groups

Example response

{
  "data": [
    {
      "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"
    }
  ]
}

Changes

  • d1cab18ccf47Revision changes
    • warning

      added the new AUTHZ enum value to the // response property for the response status

  • 34e152417e4eRevision changes
    • warning

      added the new EDGE enum value to the // response property for the response status