How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Opal Security event-streams API

Operations related to event streaming connections

Opal Security event-streams API is one of 22 APIs that Opal Security publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event Streams. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.opal.dev/v1.

4 operations 2 paths 11 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.opal.dev/v1
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Opal Security event-streams API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

event-streams 4

Operations related to event streaming connections

GET
/event-streams
Get event streams
getEventStreams → 200
POST
/event-streams
Create event stream
createEventStream body → 200
PUT
/event-streams/{event_stream_id}
Update event stream
updateEventStream 1 param body → 200
DELETE
/event-streams/{event_stream_id}
Delete event stream
deleteEventStream 1 param → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are EventStreamConnection (5 properties), UpdateEventStreamInfo (4 properties), WebhookCredentials (4 properties), CreateEventStreamInfo (4 properties). Each schema is shown below with its type and property counts.

WebhookAuthTypeEnum
string
The authentication type for webhook connections.
EventStreamConnectionTypeEnum
string
The type of event stream connection.
WebhookApiKeyLocationEnum
string
Where the API key is placed in webhook requests.
EventStreamList
object
A list of event streams.
1 property 1 required
CreateEventStreamInfo
object
Information needed to create an event stream.
4 properties 2 required
WebhookCredentials
object
Authentication credentials for a webhook connection.
4 properties 1 required
EventStreamConnection
object
The connection configuration for an event stream.
5 properties 3 required
UpdateEventStreamInfo
object
Information needed to update an event stream.
4 properties
WebhookHmacCredential
object
An HMAC credential for webhook authentication.
3 properties 3 required
EventStream
object
An event streaming connection that publishes events to an external system.
2 properties 2 required
WebhookApiKeyCredential
object
An API key credential for webhook authentication.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opal-security-event-streams-api-openapi.yml Raw ↑

Other APIs Opal Security publishes across the network.

Opal Security access-rules API
Opal Security apps API
Opal Security bundles API
Opal Security configuration-templates API
Opal Security delegations API
Opal Security events API
Opal Security group-bindings API
Opal Security groups API
Opal Security idp-group-mappings API
Opal Security message-channels API
Opal Security non-human-identities API
Opal Security on-call-schedules API
Where this information came from

This is an independent, third-party profile of Opal Security event-streams API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.