opal-queries

Run an ad-hoc OpalQuery

Changed on Oct 16, 2026

Executes an ad-hoc OpalQuery and returns paginated results. Two query types are supported: a Node query filters and returns entities (users, resources, or groups); an Access query returns the access grants between principals and their entitlements, one per (principal, entitlement, access level). Set type to NODE or ACCESS in the request body to select the query type.

This endpoint is available to OpalQuery beta participants. To request access, contact Opal support.

post/queries/run

Request

Base URL
https://api.opal.dev/v1
Auth
HTTP bearer

Request body

Example request

{
  "type": "NODE",
  "query": {
    "nodeFilters": {
      "entityTypes": [
        "RESOURCE"
      ],
      "entityTag": {
        "key": "env",
        "value": "prod"
      }
    },
    "accessFilters": {
      "isAccessibleBy": {
        "entityTypes": [
          "USER"
        ],
        "entityTag": {
          "key": "contractor"
        }
      }
    }
  },
  "first": 50
}

Response

The results of the OpalQuery.

Example response

{
  "edges": [
    {
      "node": {
        "entityItemType": "OPAL_ROLE"
      }
    }
  ]
}

Changes

Oct 16, 202619eb12e49e4a Revision changes
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ///
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ///
- info
  added the new optional request property ////
- info
  added the new optional request property ////
- info
  added the new optional request property ///
Oct 6, 2026c0ce333f6196 Revision changes
- warning
  added the new AWS_AGENTCORE_GATEWAY enum value to the /////// response property for the response status
- warning
  added the new AWS_AGENTCORE_GATEWAY_TARGET enum value to the /////// response property for the response status
- warning
  added the new AWS_AGENTCORE_GATEWAY_TOOL enum value to the /////// response property for the response status
- info
  added the new AWS_AGENTCORE_GATEWAY enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY enum value to the request property ////
- info
  added the new AWS_AGENTCORE_GATEWAY enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY enum value to the request property ////
- info
  added the new AWS_AGENTCORE_GATEWAY enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY enum value to the request property ////
- info
  added the new AWS_AGENTCORE_GATEWAY_TARGET enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TARGET enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TARGET enum value to the request property ////
- info
  added the new AWS_AGENTCORE_GATEWAY_TARGET enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TARGET enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TARGET enum value to the request property ////
- info
  added the new AWS_AGENTCORE_GATEWAY_TARGET enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TARGET enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TARGET enum value to the request property ////
- info
  added the new AWS_AGENTCORE_GATEWAY_TOOL enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TOOL enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TOOL enum value to the request property ////
- info
  added the new AWS_AGENTCORE_GATEWAY_TOOL enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TOOL enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TOOL enum value to the request property ////
- info
  added the new AWS_AGENTCORE_GATEWAY_TOOL enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TOOL enum value to the request property /////
- info
  added the new AWS_AGENTCORE_GATEWAY_TOOL enum value to the request property ////

Operation history (10 revisions)