atlas api streams getStreamInstance

On this page

experimental: Returns the details of one stream instance within the specified project.

To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. This command is invoking the endpoint with OperationID: 'getStreamInstance'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance

Syntax

Command Syntax

atlas api streams getStreamInstance [options]

Name	Type	Required	Description
--envelope		false	flag that indicates whether Application wraps the response in an envelope JSON object
--groupId	string	true	unique 24-hexadecimal digit string that identifies your project
-h, --help		false	help for getStreamInstance
--includeConnections		false	flag to indicate whether connections information should be included in the stream instance
--output	string	false	preferred api format, can be ["json", go-template] This value defaults to "json".
--output-file	string	false	file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
--tenantName	string	true	human-readable label that identifies the stream instance to return
--version	string	false	api version to use when calling the api call [options: "2023-02-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-02-01".

Name	Type	Required	Description
-P, --profile	string	false	Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Back

getStreamConnection

getStreamProcessor