Opal Security

Opal Security Resources API

Operations related to resources

GitHub OpenAPI

Operations 27

GET /resources Get resources #
PUT /resources Update resources #
POST /resources Create resource #
GET /resources/{resource_id} Get resource by ID #
DELETE /resources/{resource_id} Delete resource #
GET /resources/{resource_id}/message-channels Get resource message channels #
PUT /resources/{resource_id}/message-channels Set resource message channels #
GET /resources/{resource_id}/visibility Get resource visibility #
PUT /resources/{resource_id}/visibility Set resource visibility #
GET /resources/{resource_id}/reviewers Get resource reviewers #
PUT /resources/{resource_id}/reviewers Set resource reviewers #
GET /resources/{resource_id}/reviewer-stages Get resource reviewer stages #
PUT /resources/{resource_id}/reviewer-stages Set resource reviewer stages #
GET /resources/{resource_id}/non-human-identities Get resource nhis #
GET /resources/{resource_id}/users Get resource users #
POST /resources/{resource_id}/non-human-identities/{non_human_identity_id} Add resource nhi #
DELETE /resources/{resource_id}/non-human-identities/{non_human_identity_id} Delete resource nhi #
POST /resources/{resource_id}/users/{user_id} Add resource user #
PUT /resources/{resource_id}/users/{user_id} Update resource user #
DELETE /resources/{resource_id}/users/{user_id} Delete resource user #
GET /resources/{resource_id}/users/{user_id} Get resource user #
GET /resource-user-access-status/{resource_id}/{user_id} Resource user access status retrieve #
GET /resources/{resource_id}/tags Get resource tags #
GET /resources/{resource_id}/scoped-role-permissions Get resource scoped role permissions #
PUT /resources/{resource_id}/scoped-role-permissions Set resource scoped role permissions #
GET /resources/users/{user_id} Get user resources #
GET /resources/{resource_id}/groups Get resource groups #

Documentation

📖
Documentation
https://docs.opal.dev/
📖
APIReference
https://docs.opal.dev/api-reference/access-rules/get-access-rules

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/openapi/opal-security-resources-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/errors/opal-security-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/data-model/opal-security-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/conventions/opal-security-conventions.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/asyncapi/opal-security-events-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/opal-security-resources-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

opal-security-resources-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: hello@opal.dev
    name: Opal Team
    url: https://www.opal.dev/
  description: The Opal API is a RESTful API that allows you to interact with the Opal Security platform programmatically.
  title: Opal Resources API
  version: '1.0'
servers:
- description: Production
  url: https://api.opal.dev/v1
tags:


# --- truncated at 32 KB (124 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opal-security/refs/heads/main/openapi/opal-security-resources-api-openapi.yml