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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
MongoDB

MongoDB Streams API

Returns, adds, edits, and removes Streams Workspaces. This resource requires your project ID.

Documentation Provider Profile APIs.io OpenAPI GitHub

MongoDB Streams API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Streams. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 31 operations across 21 paths, and defines 58 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://cloud.mongodb.com.

31 operations 21 paths 58 schemas 5 DELETE13 GET3 PATCH10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
License
CC BY-NC-SA 3.0 US
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

MongoDB Streams API declares 2 security schemes for authenticating requests. It uses HTTP digest authentication (DigestAuth). It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow. By default, every request must be authenticated.

  • ServiceAccounts — Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).

Paths & Operations 31

Across 21 paths, the API surfaces 31 operations — 5 DELETE, 13 GET, 3 PATCH, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Streams 31

Returns, adds, edits, and removes Streams Workspaces. This resource requires your project ID.

GET
/api/atlas/v2/groups/{groupId}/streams
Return All Stream Workspaces in One Project
listGroupStreamWorkspaces 5 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/streams
Create One Stream Workspace
createGroupStreamWorkspace 3 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/streams/accountDetails
Return Account ID and VPC ID for One Project and Region
getGroupStreamAccountDetails 4 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections
Return All Active Incoming VPC Peering Connections
listGroupStreamActiveVpcPeeringConnections 5 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections
Return All Private Link Connections
listGroupStreamPrivateLinkConnections 5 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections
Create One Private Link Connection
createGroupStreamPrivateLinkConnection 3 params body → 200400401403404409429500
DELETE
/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}
Delete One Private Link Connection
deleteGroupStreamPrivateLinkConnection 4 params → 202401403404429500
GET
/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}
Return One Private Link Connection
getGroupStreamPrivateLinkConnection 3 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections
Return All VPC Peering Connections
listGroupStreamVpcPeeringConnections 6 params → 200401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}
Delete One VPC Peering Connection
deleteGroupStreamVpcPeeringConnection 3 params → 202401403404429500
POST
/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept
Accept One Incoming VPC Peering Connection
acceptGroupStreamVpcPeeringConnection 3 params body → 202401403404429500
POST
/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject
Reject One Incoming VPC Peering Connection
rejectGroupStreamVpcPeeringConnection 3 params → 202401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/streams/{tenantName}
Delete One Stream Workspace
deleteGroupStreamWorkspace 4 params → 202401403404429500
GET
/api/atlas/v2/groups/{groupId}/streams/{tenantName}
Return One Stream Workspace
getGroupStreamWorkspace 4 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/streams/{tenantName}
Update One Stream Workspace
updateGroupStreamWorkspace 4 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs
Download Audit Logs for One Atlas Stream Processing Workspace
downloadGroupStreamAuditLogs 6 params → 200400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections
Return All Connections of the Stream Workspaces
listGroupStreamConnections 6 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections
Create One Stream Connection
createGroupStreamConnection 4 params body → 200400401403404409429500
DELETE
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}
Delete One Stream Connection
deleteGroupStreamConnection 5 params → 202401403404409429500
GET
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}
Return One Stream Connection
getGroupStreamConnection 4 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}
Update One Stream Connection
updateGroupStreamConnection 5 params body → 200400401403404409429500
POST
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor
Create One Stream Processor
createGroupStreamProcessor 4 params body → 200400401403404409429500
DELETE
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}
Delete One Stream Processor
deleteGroupStreamProcessor 5 params → 204401403404429500
GET
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}
Return One Stream Processor
getGroupStreamProcessor 5 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}
Update One Stream Processor
updateGroupStreamProcessor 5 params body → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start
Start One Stream Processor
startGroupStreamProcessor 5 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith
Start One Stream Processor With Options
startGroupStreamProcessorWith 5 params body → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop
Stop One Stream Processor
stopGroupStreamProcessor 5 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors
Return All Stream Processors in One Stream Workspace
getGroupStreamProcessors 7 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/streams/{tenantName}:downloadOperationalLogs
Download Operational Logs for One Atlas Stream Processing Workspace
downloadGroupStreamOperationalLogs 6 params → 200400401403404409429500
POST
/api/atlas/v2/groups/{groupId}/streams:withSampleConnections
Create One Stream Workspace with Sample Connections
withGroupStreamSampleConnections 3 params body → 200400401403404429500

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are StreamsPrivateLinkConnection (17 properties), VPCPeeringConnection (14 properties), StreamsKafkaAuthentication (13 properties), StreamsTenant (9 properties). Each schema is shown below with its type and property counts.

StreamsKafkaAuthentication
object
User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.
13 properties
StreamsKafkaNetworking
object
Networking configuration for Streams connections.
2 properties
PaginatedApiStreamsStreamProcessorWithStatsView
object
3 properties 1 required
StreamsGCPPubSubConnection
object
The configuration for GCP Pub/Sub connections.
StreamsOptions
object
Optional configuration for the stream processor.
2 properties
PaginatedApiStreamsTenantView
object
3 properties 1 required
StreamsModifyStreamProcessor
object
A request to modify an existing stream processor.
4 properties
ApiError
object
6 properties 2 required
Link
object
2 properties
PaginatedApiStreamsConnectionView
object
3 properties 1 required
SchemaRegistryAuthentication
object
Authentication configuration for Schema Registry.
1 property 1 required
PaginatedApiStreamsPrivateLinkView
object
3 properties 1 required
VPCPeeringActionChallenge
object
Container for elements used to challenge the user before taking certain actions on VPC Peering connections.
3 properties
StreamsPublicPrivateLinkNetworkingAccess
object
Information about networking access.
3 properties
FieldViolation
object
2 properties 2 required
StreamsAWSKinesisDataStreamsConnection
object
The configuration for AWS Kinesis Data Stream connections.
StreamsModifyStreamProcessorOptions
object
Additional options for modifying a stream processor.
3 properties
StreamsTenantUpdateRequest
object
Details to update a stream tenant.
4 properties
StreamsAzureBlobStorageConnection
object
The configuration for Azure Blob Storage connections.
StreamsSchemaRegistryConnection
object
The configuration for Schema Registry connections.
3 required
DBRoleToExecute
object
The name of a Built in or Custom DB Role to connect to an Atlas Cluster.
3 properties
StreamsSampleConnection
object
ApiStreamsGCPRegionView
string
Atlas Streams GCP Regions.
StreamsAWSConnectionConfig
object
AWS configurations for AWS-based connection types.
3 properties
StreamsDataProcessRegion
object
Information about the cloud provider region in which MongoDB Cloud processes the stream.
3 properties 2 required
StreamsSampleConnections
object
Sample connections to add to SPI.
2 properties
ApiStreamsAWSRegionView
string
Atlas Streams AWS Regions.
BaseStreamsRegion
object
Name of the cloud provider region hosting Atlas Stream Processing.
StreamConfig
objectnull
Configuration options for an Atlas Stream Processing Workspace.
3 properties
StreamsKafkaNetworkingAccess
object
Information about networking access.
5 properties
StreamsAWSLambdaConnection
object
The configuration for AWS Lambda connections.
StreamsPrivateLinkConnection
object
Container for metadata needed to create a Private Link connection.
17 properties 1 required
StreamsKafkaSecurity
object
Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.
3 properties
GCPAccountDetails
object
5 properties
PaginatedApiStreamsVPCPeeringConnectionView
object
3 properties 1 required
ConfluentUserInfoAuthentication
object
Authentication details for type USERINFO with username and password for Confluent Schema Registry.
3 required
AzureConnection
object
Azure-specific configuration for the connection.
4 properties
StreamsProcessor
object
An atlas stream processor.
6 properties
Document
object
ConfluentSaslInheritAuthentication
object
Inherits the authentication configuration from Kafka for the Confluent Schema Registry.
1 required
ApiStreamsAzureRegionView
string
Atlas Streams Azure Regions.
StreamsDLQ
object
Dead letter queue for the stream processor.
4 properties
AWSAccountDetails
object
5 properties
StreamsGCPConnectionConfig
object
GCP-specific configuration for the connection.
2 properties
TenantWithSampleConnections
object
AzureAccountDetails
object
5 properties
StreamsStartStreamProcessorWith
object
A request to start a stream processor.
4 properties
StreamsS3Connection
object
The configuration for S3 connections.
StreamsPublicPrivateLinkNetworking
object
Networking configuration for connections that support PUBLIC and PRIVATELINK access types. For GCP connections, use PRIVATELINK for GCP Private Service Connect…
2 properties
StreamsTenant
object
9 properties
StreamsClusterConnection
object
BadRequestDetail
object
Bad request detail.
1 property
StreamsConnection
object
Settings that define a connection to an external data store.
6 properties
StreamsProcessorWithStats
object
An atlas stream processor with optional stats.
8 properties 4 required
AccountDetails
object
Account details for the group, region, and provider.
StreamsKafkaConnection
object
StreamsHttpsConnection
object
VPCPeeringConnection
object
Represents a VPC Peering connection on AWS.
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-streams-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
AE Profile APIs.io
MongoDB Atlas App Services Admin API
AE Profile APIs.io
MongoDB Access Tracking API
AE Profile APIs.io
MongoDB Activity Feed API
AE Profile APIs.io
MongoDB Alert Configurations API
AE Profile APIs.io
MongoDB Alerts API
AE Profile APIs.io
MongoDB Atlas Search API
AE Profile APIs.io
MongoDB Auditing API
AE Profile APIs.io
MongoDB AWS Clusters DNS API
AE Profile APIs.io
MongoDB Cloud Backups API
AE Profile APIs.io
MongoDB Cloud Migration Service API
AE Profile APIs.io
MongoDB Cloud Provider Access API
AE Profile APIs.io
#Streams
← Back to M APIs
API Details
ID
mongodb:mongodb-streams-api
Base URL
https://cloud.mongodb.com/api/atlas/v2
Docs
https://www.mongodb.com/docs/atlas/api/
Provider
MongoDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mongodb-streams-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mongodb-streams-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of MongoDB 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.