The VVCR API enables programmatic control over key functions of the VVCR product, such as clusters, streams, destinations, and more. Built using REST technology, the VVCR API is versatile and can be implemented in any programming language or technology, including Node.js, Python, PHP, Java, and .NET.
\nTo begin using the VVCR API, you must first obtain your organization's client_id and client_secret. Follow the steps below to retrieve your API credentials:
Log in to your VVCR account with an \"admin\" role.
\nNavigate to your organization's settings:
\nClick on your profile picture.
\nSelect the \"Organization\" link.
\nOnce the API is enabled, you will be able to access the necessary credentials for integration.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"39264081","collectionId":"38d31292-9d8c-4ae4-93c2-fc2172aedc78","publishedId":"2sAY4shPCc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"c72f2a"},"publishDate":"2024-10-24T17:00:38.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get Token","event":[{"listen":"test","script":{"id":"ceea02a0-ce0f-4a86-8563-f864e7a23fec","exec":["pm.test(\"response is ok\", ()=>{"," pm.response.to.have.status(201)","})","","var jsonData = JSON.parse(pm.response.text());","","pm.collectionVariables.set(\"token\", jsonData.accessToken);",""],"type":"text/javascript","packages":{}}}],"id":"fb980aa0-444e-4015-a688-eed0e5efb4e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://api.vvcr.tv/v1/auth/oauth?client_id=&client_secret=","description":"This endpoint authenticates your application with the VVCR API and returns an access token required to use all API endpoints. The request must include client_id and client_secret as query parameters, which can be obtained from your VVCR organization's settings.
No request body is required for this endpoint.
\nThe response to this request is a JSON object with the following properties:
\naccessToken (string): Access token obtained after successful authentication.
tokenType (string): Type of the token.
expiresIn (string): Unix timestamp (in seconds) indicating the token's expiration date and time.
This endpoint allows the retrieval of a list of AWS regions enabled in your VVCR organization's account.
\nNo request body is required for this endpoint.
\nThe response to this request is a JSON array that contains objects with the following properties:
\ncode (string): Code of the region.
name (string): Name of the region.
This endpoint allows the retrieval of a list of instance types enabled in the specified AWS :region in your VVCR organization's account.
No request body is required for this endpoint.
\nThe response to this request is a JSON array that contains objects with the following properties:
\nname (string): Name of the instance type.This endpoint allows the retrieval of a list of all AWS VPCs available in your VVCR organization's account.
\nNo request body is required for this endpoint.
\nThe response to this request is a JSON array that contains objects with the following properties:
\nid (string): Unique identifier of the VPC.
name (string): Name of the VPC.
region (string): Region where the VPC is available.
isDefault (boolean): Indicates whether this VPC is the default in its region.
This endpoint allows the retrieval of a list of AWS VPCs available in a specific :region of your VVCR organization's account.
No request body is required for this endpoint.
\nThe response to this request is a JSON array that contains objects with the following properties:
\nid (string): VPC id.
name (string): VPC name.
region (string): The region of VPC's availability.
isDefault (boolean): a boolean flag indicating whether this is a default VPC in the region.
This endpoint allows the retrieval of a list of persistent addresses available and not assigned in a specific :region within your VVCR organization's account. It also provides the total number of available persistent addresses that can be assigned in the specified region.
No request body is required for this endpoint.
\nThe response to this request is a JSON array that contains objects with the following properties:
\navailable (string): Total number of remaining persistent addresses that can be assigned in the specified region.
addresses (array): An array of persistent addresses with the following sub-parameters:
allocationId (string): Unique identifier of the AWS Elastic IP address resource.
publicIp (string): Public IP address.
name (string): Name of the AWS elastic IP address resource.
This endpoint allows the retrieval of a list of clusters currently available in the organization, along with all associated metadata.
\nNo request body is required for this endpoint.
\nThe response to this request is a JSON array that contains objects with the following properties:
\nid (string): Unique identifier of the cluster.
name (string): Name of the cluster.
type (string): AWS EC2 instance type of the cluster's workload. A list of available options can be found on AWS's website.
region (string): AWS region where the cluster is deployed. A list of available options can be found on AWS's website
vpcId (string): The identifier of the VPC where the cluster is deployed.
status (string): Represents the current status of the cluster. Possible values:
creating
\nactive
\n'deleting
\ndeleted
\nstopping
\nstopped
\nstarting
\nfailed
\nerrorMessage (string|null): An error message if cluster status is failed, or null.
instances (array): An array of objects representing instances within the cluster, each with the following properties:
id (string): Unique identifier of the instance.
name (string): Name of the instance.
privateIp (string): The private IP address of the instance.
publicIp (string): The public IP address of the instance.
dns (string): The public hostname of the instance.
isTranscoder (boolean): Indicates if the instance has a transcoding feature enabled.
isPersistentIp (boolean): Indicates if the instance has a persistent IP address.
This endpoint allows the creation of a new cluster.
\nname (string): Name of the cluster.
type (string): WS EC2 instance type of the cluster's workload. A list of available options can be found on AWS's website.
Note: Available instance types may be restricted in VVCR organization settings, and certain instance types are incompatible with VVCR. Use the List Account Instance Types end point to retrieve a list of available instance types in the desired region of the current VVCR organization.
\nregion (string): AWS region where the cluster will be created. A list of available options can be found on AWS's websiteNote: Available regions may be restricted in VVCR organization settings, and certain regions are incompatible with VVCR. Use the List Account Regions end point to retrieve a list of available regions in the current VVCR organization.
\ninstances (array): An array of objects representing instances to be created within the cluster, each with the following properties:
name (string): Name of the instance.
isTranscoder (boolean): Indicates whether the instance should have the transcoding feature enabled. Refer to our help center for more information about transcoding feature.
persistentAddress (string): Indicates whether the instance should have a static IP address. This parameter value can be set to:
\"new\" to assign a new persistent IP address to the instance.
Identifier of a previously created persistent address (can be retrieved from List Persistent Addresses by Region API end point).
\nnull to attach an ephemeral IP address to the instance.
A JSON object containing details about the created cluster.
\n","urlObject":{"path":["clusters"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[]}},"response":[{"id":"c1273357-5220-4080-b17a-48677723e301","name":"201 OK - Create Cluster","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"sample-cluster\",\n \"type\": \"t3.medium\",\n \"region\": \"us-east-2\",\n \"instances\": [\n {\n \"name\": \"streamer-1\",\n \"isTranscoder\": false,\n \"persistentAddress\": null\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/clusters"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"78a8bb22-a9a0-4c21-84b1-fcc177222030\",\n \"name\": \"sample-cluster\",\n \"type\": \"t3.medium\",\n \"region\": \"us-east-2\",\n \"vpcId\": null,\n \"status\": \"creating\",\n \"errorMessage\": null,\n \"instances\": []\n}"}],"_postman_id":"230562ec-6fd7-407d-9baa-81b1a4d4c9cd"},{"name":"Get Cluster","event":[{"listen":"test","script":{"id":"678993e2-8ba1-4369-8508-d6c6c6f24867","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"17f750f9-35bc-4b6c-b41b-946db82c85ec","exec":[""],"type":"text/javascript","packages":{}}}],"id":"702de1d0-0478-412d-8edc-eb8327851292","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/clusters/:id","description":"This endpoint allows the retrieval of the information about a specific cluster identified by the provided :id, along with all associated metadata.
No request body is required for this endpoint.
\nThe response to this request is a cluster JSON object with the following properties:
\nid (string): Unique identifier of the cluster.
name (string): Name of the cluster.
type (string): AWS EC2 instance type of the cluster's workload. A list of available options can be found on AWS's website.
region (string): AWS region where the cluster is deployed. A list of available options can be found on AWS's website
vpcId (string): The identifier of the VPC where the cluster is deployed.
status (string): Represents the current status of the cluster. Possible values:
creating
\nactive
\n'deleting
\ndeleted
\nstopping
\nstopped
\nstarting
\nfailed
\nerrorMessage (string|null): An error message if cluster status is failed, or null.
instances (array): An array of objects representing instances within the cluster, each with the following properties:
id (string): Unique identifier of the instance.
name (string): Name of the instance.
privateIp (string): The private IP address of the instance.
publicIp (string): The public IP address of the instance.
dns (string): The public hostname of the instance.
isTranscoder (boolean): Indicates if the instance has a transcoding feature enabled.
isPersistentIp (boolean): Indicates if the instance has a persistent IP address.
This endpoint allows to start a specific cluster identified by the provided :id.
No request body is required for this endpoint.
\nA JSON object containing details about the cluser being started.
\n","urlObject":{"path":["clusters",":id","start"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"6f163295-8316-4a8d-8bdf-75f665d0a850","name":"200 OK - Start Cluster","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.vvcr.tv/v1/clusters/:id/start","host":["https://api.vvcr.tv/v1"],"path":["clusters",":id","start"],"variable":[{"key":"id","value":"afd2fd69-8462-445d-b7a0-d4b7880f36c2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"afd2fd69-8462-445d-b7a0-d4b7880f36c2\",\n \"name\": \"sample-cluster\",\n \"type\": \"t3.medium\",\n \"region\": \"us-east-2\",\n \"vpcId\": \"vpc-002e6662439d6d6ae\",\n \"status\": \"starging\",\n \"errorMessage\": null,\n \"instances\": [\n {\n \"id\": \"907a3995-63b3-48c0-a06b-4a8b0567c05e\",\n \"name\": \"cluster-1-streamer-1\",\n \"privateIp\": \"172.1.1.1\",\n \"publicIp\": \"8.8.8.8\",\n \"dns\": \"sample-cluster-streamer-1.apiorg.vvcr.live\",\n \"isTranscoder\": true,\n \"isPersistentIp\": false\n }\n ]\n}"}],"_postman_id":"0b4f4e89-0b87-445f-9101-418ba7becf19"},{"name":"Stop Cluster","id":"4e4c4de7-5486-4715-96b2-9835524c5c7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/clusters/:id/stop","description":"This endpoint allows to stop a specific cluster identified by the provided :id.
No request body is required for this endpoint.
\nA JSON object containing details about the cluser being stopped.
\n","urlObject":{"path":["clusters",":id","stop"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"f9d4419d-8238-4211-8a64-0b8c8511602b","name":"200 OK - Stop Cluster","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.vvcr.tv/v1/clusters/:id/stop","host":["https://api.vvcr.tv/v1"],"path":["clusters",":id","stop"],"variable":[{"key":"id","value":"afd2fd69-8462-445d-b7a0-d4b7880f36c2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"afd2fd69-8462-445d-b7a0-d4b7880f36c2\",\n \"name\": \"sample-cluster\",\n \"type\": \"t3.medium\",\n \"region\": \"us-east-2\",\n \"vpcId\": \"vpc-002e6662439d6d6ae\",\n \"status\": \"stopping\",\n \"errorMessage\": null,\n \"instances\": [\n {\n \"id\": \"907a3995-63b3-48c0-a06b-4a8b0567c05e\",\n \"name\": \"sample-cluster-streamer-1\",\n \"privateIp\": \"172.1.1.1\",\n \"publicIp\": \"8.8.8.8\",\n \"dns\": \"sample-cluster-streamer-1.apiorg.vvcr.live\",\n \"isTranscoder\": true,\n \"isPersistentIp\": false\n }\n ]\n}"}],"_postman_id":"4e4c4de7-5486-4715-96b2-9835524c5c7c"},{"name":"Delete Cluster","id":"d6a21c2b-2ae0-427b-95bb-94c718fe9e49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.vvcr.tv/v1/clusters/:id?isDeleteDvrBucket=false&isDeleteClipsBucket=false","description":"This endpoint enables the deletion of a specific cluster identified by the provided :id. Optionally, it can also delete the AWS S3 storage buckets and their content where all of the cluster's DVR recordings and clips are stored.
IMPORTANT: Ensure there are no active DVR recordings or production instances running before deleting the cluster.
\nNo request body is required for this endpoint.
\nA JSON object containing details about the cluster that is being deleted.
\n","urlObject":{"path":["clusters",":id"],"host":["https://api.vvcr.tv/v1"],"query":[{"description":{"content":"(Optional) A boolean flag indicating whether to delete the DVR bucket. If not specified, the default value is \"false.\"
\n","type":"text/plain"},"key":"isDeleteDvrBucket","value":"false"},{"description":{"content":"(Optional) A boolean flag indicating whether to delete the clips bucket. If not specified, the default value is \"false.\"
\n","type":"text/plain"},"key":"isDeleteClipsBucket","value":"false"}],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"11a9824e-38c5-4d7c-a688-e9f55160c1a8","name":"200 OK - Delete Cluster","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.vvcr.tv/v1clusters/:id?isDeleteDvrBucket=true&isDeleteClipsBucket=true","host":["https://api.vvcr.tv/v1clusters"],"path":[":id"],"query":[{"key":"isDeleteDvrBucket","value":"true","description":"A boolean flag to indicate whether the DVR bucket should be deleted."},{"key":"isDeleteClipsBucket","value":"true","description":"A boolean flag to indicate whether the clips bucket should be deleted."}],"variable":[{"key":"id","value":"afd2fd69-8462-445d-b7a0-d4b7880f36c2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"afd2fd69-8462-445d-b7a0-d4b7880f36c2\",\n \"name\": \"sample-cluster\",\n \"type\": \"t3.medium\",\n \"region\": \"us-east-2\",\n \"vpcId\": \"vpc-002e6662439d6d6ae\",\n \"status\": \"deleting\",\n \"errorMessage\": null,\n \"instances\": [\n {\n \"id\": \"907a3995-63b3-48c0-a06b-4a8b0567c05e\",\n \"name\": \"sample-cluster-streamer-1\",\n \"privateIp\": \"172.1.1.1\",\n \"publicIp\": \"8.8.8.8\",\n \"dns\": \"sample-cluster-streamer-1.apiorg.vvcr.live\",\n \"isTranscoder\": true,\n \"isPersistentIp\": false\n }\n ]\n}"}],"_postman_id":"d6a21c2b-2ae0-427b-95bb-94c718fe9e49"}],"id":"eb39d32b-db90-45ac-b788-2968c882f47b","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"07cf46d3-29f2-401e-a7eb-b5bc7839f39d","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"5f2d7691-55a3-4c05-a203-7eab76256882","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"eb39d32b-db90-45ac-b788-2968c882f47b","description":""},{"name":"Streams","item":[{"name":"List Streams","id":"001b1c1c-185f-45e1-a0e2-831be9da92a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/stream-configurations","description":"This endpoint allows the retrieval of a list of stream configurations currently available in the organization, along with all associated metadata.
\nNo request body is required for this endpoint.
\nThe response to this request is a JSON array that contains stream configuration objects with the following properties:
\nid (string): Unique identifier of the stream configuration.
name (string): Stream configuration name.
protocol (string): Stream configuration's ingestion streaming protocol (SRT, RTMP, or NDI).
mode (string): Streaming protocol mode. Supoprted values:
SRT: listener, caller
RTMP: push, pull
NDI: signal
streamKey (string): Unique stream key. Used in RTMP and SRT URLs.
createdAt (number): Unix timestamp (in seconds) indicating when the stream configuration was initially created.
updatedAt (number): Unix timestamp (in seconds) indicating the last time the stream configuration was updated.
streamInputSettings (object): Protocol-specific input settings.
latency (number): Latency in milliseconds
streamId (string, optional): SRT Stream ID
encryption (object, optional):
encryptionType (string): Encryption type (AES128/AES192/AES256)
passphrase (string): Encryption passphrase
address (string): IP or hostname of the SRT stream.
port (number): Port of the SRT stream.
latency (number): Latency in milliseconds.
streamId (string, optional): SRT Stream ID.
encryption (object, optional):
passphrase (string): Encryption passphrase,connectionType (string): RTMP connection type (RTMP/RTMPS).
address (string): IP or hostname of the RTMP stream.
port (number, optional): Port number.
application (string): Application name.
streamKey (string): RTMP stream key.
username (string, optional): Authentication username.
password (string, optional): Authentication password.
streamInputSettings has null in responce for RTMP Push mode.
signal (string): Name of the NDI signal to receive.streamOutputSettings (object): Output configuration.
srt (object): SRT output settings:
latency (number): Output latency in milliseconds.
srtStreamId (string|null): SRT stream ID.
encryption (object|null): Encryption configuration:
encryptionType (string): Encryption type.
passphrase (string): Encryption passphrase.
isPassphraseGenerated (boolean): Auto-generated passphrase flag.
streams (array): Array of objects that contains available input streams of the stream configuration with the following sub-parameters:
id (string): Stream instance unique identifier.
instanceId (string): Cluster onstance identifier.
clusterRole (string): Role in cluster (primary/backup).
encoderRole (string): Instance role as encoder (primary/backup).
port (number|null): Stream instance's port number.
output (object): Output configuration:
ports (object): An object, containing output ports configuration for various output protocols. ports object properties:
srt (number): Output SRT port.
rtmp (number): Output RTMP port.
rtmps (number): Output RTMPS port.
resolutionStreamKey (string|null): Unique stream key of the transcoded stream.
mpegtsAudioTrackPid (number|null): MPEG-TS audio packet identifier (PID). This property indicates the stream's audio track to be used for the RTMP and HLS outputs.
srtAudioTrackPid (number|null): MPEG-TS audio packet identifier (PID). This property indicates the stream's audio track to be used for the SRT output.
transcoding (object): Transcoding settings:
resolution (string|null): Output resolution.
ndiOutput (boolean): NDI output status.
This endpoint allows the creation of a new stream configuration. A stream configuration is a collection of input streams (or simply \"streams\") provisioned on different clusters (cloud instances) for redundancy and reliable streaming. A stream configuration can include up to four redundant streams. All streams within the configuration share the same parameters, such as streaming protocol type, ingestion mode, latency, and encryption.
\nname (string): The name of the stream configuration.
protocol (string): Streaming protocol for ingestion. Supported values: SRT, RTMP, NDI.
mode (string): Ingestion mode for the protocol. Supported values:
SRT: listener, caller
RTMP: pull, push
NDI: signal
streams (array): Array of objects defining input streams with the following sub-parameters:
instanceId (string): Unique cloud instance identifier. Obtainable via List Clusters or Get Cluster.
clusterRole (string): Instance role in the cluster. Supported values: primary, backup.
encoderRole (string): Stream role for the instance. Supported values: primary, backup.
transcoding (object, optional): Configure video transcoding for playback performance in browsers. Ignored if the instance lacks transcoding capabilities. When enabled, transcoded streams will be used in Multiview by default. Set the value of the resolution and ndiOutput parameters to null to avoid transcoding to be enabled. Supported transcoding settings:
resolution (string): Transcoder resolution. Supported values: 240p, 360p, 480p, 720p, 1080p, 1440p, 2160p.
ndiOutput (boolean): This parameter allows to enable input stream transcoding into NDI. If enabled, the NDI output will be automatically populated in the VPC of the instance, used for the given stream.
streamOutputSettings (object): Contains an object with output configuration. Currentlysupports srt output type only.
srt(object): SRT output stream configuration with the following sub-parameters:
latency(number or null): Latency in milliseconds. Supoprted range of values - 120-4000.
encryption (object, optional): Output stream encryption settings:
encryptionType(string, optional): Encryption type. Supported values: AES128, AES192, AES256. Default value: AES128
passphrase (string, optional): Passphrase for encryption (required if encryption is defined).
streamId (string, optional): SRT Stream ID. More info.
streamInputSettings (object): Input streams ingest configuration settings.
Note: Each combination of protocol and mode has specific streamInputSettings. Refer to examples and description below for available configurations.
streamInputSettings• latency (number): Latency in milliseconds.
• streamId (string, optional): SRT Stream ID. More info.
• encryption (object, optional): Settings for stream encryption:
encryptionType(string, optional): Encryption type. Supported values: AES128, AES192, AES256.
passphrase (string, optional): Passphrase for encryption (required if encryption is defined).
• latency (number): Latency in milliseconds.
• address (string): IP or hostname of the SRT stream.
• port (number): Port of the SRT stream.
•encryption (object, optional): Stream encryption settings:
passphrase (string, optional): Passphrase for encryption (required if encryption is defined).• streamId (string, optoinal): SRT Stream ID. More info.
• connectionType (string): RTMP connection type. Supported values: RTMP, RTMPS.
• address (string): IP or hostname of the RTMP stream.
• port (number): Port number of the RTMP stream. Default value: 1935
• application (string): Application name of the RTMP stream.
• streamKey (string): RTMP stream key.
• username (string, optional): Authentication username.
• password (string, optional): Authentication password.
No settings required. streamInputSettings parameter will be ignored and can be ommited.
• signal (string): Name of the NDI signal to receive.
Please reffer to our examples for more informaiton about the format of inputSettings for each streaming protocol type and mode.
A JSON object containing details about the created stream configuration.
\n","urlObject":{"path":["stream-configurations"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[]}},"response":[{"id":"51e90217-97f9-4d0f-b0fa-f5e276330b87","name":"201 Created - Create SRT Listener Stream","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"srt-listener\",\n \"protocol\": \"SRT\",\n \"mode\": \"listener\",\n \"streamInputSettings\": {\n \"latency\": 200,\n \"streamId\": \"input-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES128\",\n \"passphrase\": \"input-passphrase\"\n }\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 400,\n \"streamId\": \"output-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES192\",\n \"passphrase\": \"output-passphrase\"\n }\n }\n },\n \"streams\": [\n {\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": null\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/stream-configurations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"cdf9c287-baeb-47f6-8d58-a0cecf4451a6\",\n \"name\": \"srt-listener\",\n \"protocol\": \"SRT\",\n \"mode\": \"listener\",\n \"streamKey\": \"5a2cf8f6-a26d-4576-8cd7-dad3d8b37cf3\",\n \"createdAt\": 1734094906401,\n \"updatedAt\": 1734094906401,\n \"streamInputSettings\": {\n \"latency\": 200,\n \"streamId\": \"input-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES128\",\n \"passphrase\": \"input-passphrase\",\n \"isPassphraseGenerated\": false\n }\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 400,\n \"streamId\": \"output-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES192\",\n \"passphrase\": \"output-passphrase\",\n \"isPassphraseGenerated\": false\n }\n }\n },\n \"streams\": [\n {\n \"id\": \"ac8ff9f5-bb32-47a3-acec-c4e13aa7d75c\",\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"port\": 3001,\n \"output\": {\n \"ports\": {\n \"srt\": 4003,\n \"rtmp\": 1935,\n \"rtmps\": 1934\n },\n \"resolutionStreamKey\": null,\n \"mpegtsAudioTrackPid\": null,\n \"srtAudioTrackPid\": null\n },\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": false\n }\n }\n ]\n}"},{"id":"b934eeaa-d524-4b20-aa14-891f220026c9","name":"201 Created - Create SRT Caller Stream","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"srt-caller\",\n \"protocol\": \"SRT\",\n \"mode\": \"caller\",\n \"streamInputSettings\": {\n \"address\": \"8.8.8.8\",\n \"port\": 4000,\n \"latency\": 200,\n \"streamId\": \"source-stream-id\",\n \"encryption\": {\n \"passphrase\": \"input-passphrase\"\n }\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 300,\n \"streamId\": \"output-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES192\",\n \"passphrase\": \"output-passphrase\"\n }\n }\n },\n \"streams\": [\n {\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": null\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/stream-configurations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"402a0dbe-0d9d-47d2-9cfb-4f6013ad6207\",\n \"name\": \"srt-caller\",\n \"protocol\": \"SRT\",\n \"mode\": \"caller\",\n \"streamKey\": \"5a2cf8f6-a26d-4576-8cd7-dad3d8b37cf3\",\n \"createdAt\": 1734094936488,\n \"updatedAt\": 1734094936488,\n \"streamInputSettings\": {\n \"address\": \"8.8.8.8\",\n \"port\": 4000,\n \"latency\": 200,\n \"streamId\": \"source-stream-id\",\n \"encryption\": {\n \"passphrase\": \"input-passphrase\"\n }\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 300,\n \"streamId\": \"output-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES192\",\n \"passphrase\": \"output-passphrase\",\n \"isPassphraseGenerated\": false\n }\n }\n },\n \"streams\": [\n {\n \"id\": \"79266af9-25f3-4cf1-bc87-78cda1c0a2f7\",\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"port\": 3002,\n \"output\": {\n \"ports\": {\n \"srt\": 4004,\n \"rtmp\": 1935,\n \"rtmps\": 1934\n },\n \"resolutionStreamKey\": null,\n \"mpegtsAudioTrackPid\": null,\n \"srtAudioTrackPid\": null\n },\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": false\n }\n }\n ]\n}"},{"id":"890e4296-de81-45c4-a41e-8a206c99e20c","name":"201 Created - Create RTMP Push Stream","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"rtmp-push\",\n \"protocol\": \"RTMP\",\n \"mode\": \"push\",\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 200,\n \"streamId\": \"output-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES128\",\n \"passphrase\": \"output-passphrase\"\n }\n }\n },\n \"streams\": [\n {\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": null\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/stream-configurations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"c3cf3aba-62c6-4973-8425-b908ea42ea51\",\n \"name\": \"rtmp-push\",\n \"protocol\": \"RTMP\",\n \"mode\": \"push\",\n \"streamKey\": \"5a2cf8f6-a26d-4576-8cd7-dad3d8b37cf3\",\n \"createdAt\": 1734094956673,\n \"updatedAt\": 1734094956673,\n \"streamInputSettings\": null,\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 200,\n \"streamId\": \"output-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES128\",\n \"passphrase\": \"output-passphrase\",\n \"isPassphraseGenerated\": false\n }\n }\n },\n \"streams\": [\n {\n \"id\": \"9ff02cb0-df90-46bf-a005-84e234a7a364\",\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"port\": 1935,\n \"output\": {\n \"ports\": {\n \"srt\": 4005,\n \"rtmp\": 1935,\n \"rtmps\": 1934\n },\n \"resolutionStreamKey\": null,\n \"mpegtsAudioTrackPid\": null,\n \"srtAudioTrackPid\": null\n },\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": false\n }\n }\n ]\n}"},{"id":"5e57f764-abb2-4c4a-b2ea-9da70ad57df7","name":"201 Created - Create RTMP Pull Stream","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"rtmp-pull\",\n \"protocol\": \"RTMP\",\n \"mode\": \"pull\",\n \"streamInputSettings\": {\n \"connectionType\": \"RTMP\",\n \"address\": \"8.8.8.8\",\n \"port\": 1935,\n \"application\": \"live\",\n \"streamKey\": \"source-stream-key\",\n \"username\": \"stream-user\",\n \"password\": \"stream-password\"\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 600,\n \"streamId\": \"output-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES256\",\n \"passphrase\": \"output-passphrase\",\n \"isPassphraseGenerated\": true\n }\n }\n },\n \"streams\": [\n {\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": null\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/stream-configurations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7c92414a-f4ef-4db8-b838-3e1b9bff2d74\",\n \"name\": \"rtmp-pull\",\n \"protocol\": \"RTMP\",\n \"mode\": \"pull\",\n \"streamKey\": \"5a2cf8f6-a26d-4576-8cd7-dad3d8b37cf3\",\n \"createdAt\": 1734095062066,\n \"updatedAt\": 1734095062066,\n \"streamInputSettings\": {\n \"connectionType\": \"RTMP\",\n \"address\": \"8.8.8.8\",\n \"port\": 1935,\n \"application\": \"live\",\n \"streamKey\": \"source-stream-key\",\n \"username\": \"stream-user\",\n \"password\": \"stream-password\"\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 600,\n \"streamId\": \"output-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES256\",\n \"passphrase\": \"output-passphrase\",\n \"isPassphraseGenerated\": true\n }\n }\n },\n \"streams\": [\n {\n \"id\": \"d80be44b-990e-417b-a500-0d9a0ca4d922\",\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"port\": 1935,\n \"output\": {\n \"ports\": {\n \"srt\": 4007,\n \"rtmp\": 1935,\n \"rtmps\": 1934\n },\n \"resolutionStreamKey\": null,\n \"mpegtsAudioTrackPid\": null,\n \"srtAudioTrackPid\": null\n },\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": false\n }\n }\n ]\n}"},{"id":"da996359-0ead-4bb0-9481-0e3c4a4d6889","name":"201 Created - Create NDI Stream","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"ndi-input\",\n \"protocol\": \"NDI\",\n \"mode\": \"signal\",\n \"streamInputSettings\": {\n \"signal\": \"source-signal-name\"\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 400,\n \"streamId\": \"output-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES192\",\n \"passphrase\": \"output-passphrase\"\n }\n }\n },\n \"streams\": [\n {\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": null\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/stream-configurations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"b16fb9f7-3396-4018-a77b-35dc1e41bbf8\",\n \"name\": \"ndi-input\",\n \"protocol\": \"NDI\",\n \"mode\": \"signal\",\n \"streamKey\": \"5a2cf8f6-a26d-4576-8cd7-dad3d8b37cf3\",\n \"createdAt\": 1734095088718,\n \"updatedAt\": 1734095088718,\n \"streamInputSettings\": {\n \"signal\": \"source-signal-name\"\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 400,\n \"streamId\": \"output-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES192\",\n \"passphrase\": \"output-passphrase\",\n \"isPassphraseGenerated\": false\n }\n }\n },\n \"streams\": [\n {\n \"id\": \"1b44efb4-5934-4ea2-9bf1-11f98309bb5d\",\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"port\": null,\n \"output\": {\n \"ports\": {\n \"srt\": 4008,\n \"rtmp\": 1935,\n \"rtmps\": 1934\n },\n \"resolutionStreamKey\": null,\n \"mpegtsAudioTrackPid\": null,\n \"srtAudioTrackPid\": null\n },\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": true\n }\n }\n ]\n}"}],"_postman_id":"8ba08618-fb6f-4dcf-b787-c912b05b5c9f"},{"name":"Get Stream","id":"b3b26cc0-9d22-4850-afd8-f0c193738d54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/stream-configurations/:id","description":"This endpoint allows the retrieval of the information about a specific stream configuration identified by the provided :id, along with all associated metadata.
No request body is required for this endpoint.
\nThe response is a stream configuration JSON object with the following properties:
\nid (string): Unique configuration identifier
name (string): Configuration name
protocol (string): Streaming protocol (SRT, RTMP, or NDI)
mode (string): Ingestion mode for the protocol. Supported values:
SRT: listener, caller
RTMP: pull, push
NDI: signal
streamKey (string): Unique stream key
createdAt (number): The Unix timestamp (in seconds) indicating when the stream configuration was initially created.
updatedAt (number): The Unix timestamp (in seconds) indicating the last time the stream configuration was updated.
streamInputSettingslatency (number): Latency in milliseconds
streamId (string, optional): SRT Stream ID
encryption (object, optional):
encryptionType (string): Encryption type (AES128/AES192/AES256)
passphrase (string): Encryption passphrase
address (string): IP or hostname of the SRT stream.
port (number): Port of the SRT stream.
latency (number): Latency in milliseconds
streamId (string, optional): SRT Stream ID
encryption (object, optional):
passphrase (string): Encryption passphraseconnectionType (string): RTMP connection type (RTMP/RTMPS)
address (string): IP or hostname of the RTMP stream
port (number, optional): Port number
application (string): Application name
streamKey (string): RTMP stream key
username (string, optional): Authentication username
password (string, optional): Authentication password
streamInputSettings has null in responce for RTMP Push mode.
signal (string): Name of the NDI signal to receivestreamOutputSettings (object): Output stream settings:
srt (object): SRT output configuration:
latency (number): Output stream latency in milliseconds
streamId (string): Output stream identifier
encryption (object): Output stream encryption settings:
encryptionType (string): Type of encryption
passphrase (string): Encryption passphrase
isPassphraseGenerated (boolean): Passphrase generation flag
streams (array): Array of configured stream instances. Each contains:
id (string): Stream instance identifier
instanceId (string): Cloud instance identifier
clusterRole (string): Role in cluster (primary/backup)
encoderRole (string): Instance role (primary/backup)
port (number): Port number
output (object): Output ports configuration:
ports (object): Available protocol ports:
srt (number): SRT port
rtmp (number): RTMP port
rtmps (number): RTMPS port
resolutionStreamKey (string|null): Stream key with resolution suffix
mpegtsAudioTrackPid (number|null): MPEG-TS audio track PID
srtAudioTrackPid (number|null): SRT audio track PID
transcoding (object): Transcoding configuration:
resolution (string|null): Output resolution
ndiOutput (boolean): NDI output status
This endpoint allows the retrieval of a list of NDI signals, available to instanceId.
No request body is required for this endpoint.
\nThe response to this request is a JSON array that contains NDI signal objects with the following properties:
\nname (string): The name of the NDI signal, used for creating an NDI stream configuration.
address (string): The local network address of the NDI signal. Format: ip:port
This endpoint enables the modification of a stream configuration identified by the specified :id.
name (string): The name of the stream configuration.
protocol (string): Streaming protocol for ingestion. Supported values: SRT, RTMP, NDI.
mode (string): Ingestion mode for the protocol. Supported values:
SRT: listener, caller
RTMP: pull, push
NDI: signal
streams (array): Array of objects defining input streams. Each object requires:
instanceId (string): Unique cloud instance identifier
clusterRole (string): Instance role in the cluster (primary/backup)
encoderRole (string): Stream role for the instance (primary/backup)
transcoding (object, optional): Configure video transcoding settings:
resolution (string): Transcoder resolution (240p, 360p, 480p, 720p, 1080p, 1440p, 2160p)
ndiOutput (boolean): Enable input stream transcoding into NDI
streamOutputSettings (object): Output configuration settings:
srt (object): SRT output stream settings
latency (number|null): Latency in milliseconds (120-4000)
encryption (object, optional): Stream encryption settings:
encryptionType (string): Encryption type (AES128/AES192/AES256)
passphrase (string): Encryption passphrase
streamId (string, optional): SRT Stream ID
streamInputSettings (object): Input streams ingest configuration settings
streamInputSettingslatency (number): Latency in milliseconds
streamId (string, optional): SRT Stream ID
encryption (object, optional):
encryptionType (string): Encryption type (AES128/AES192/AES256)
passphrase (string): Encryption passphrase
latency (number): Latency in milliseconds
address (string): IP or hostname of the SRT stream
port (number): Port of the SRT stream
encryption (object, optional):
passphrase (string): Encryption passphrasestreamId (string, optional): SRT Stream ID
connectionType (string): RTMP connection type (RTMP/RTMPS)
address (string): IP or hostname of the RTMP stream
port (number, optional): Port number (default: 1935)
application (string): Application name
streamKey (string): RTMP stream key
username (string, optional): Authentication username
password (string, optional): Authentication password
No settings required. streamInputSettings parameter can be omitted.
signal (string): Name of the NDI signal to receiveNote: Each combination of protocol and mode has specific streamInputSettings. Refer to examples for more information about the format of inputSettings for each streaming protocol type and mode.
A JSON object containing details about the updated stream configuration.
\n","urlObject":{"path":["stream-configurations",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"638692d2-e0ee-4a00-b60f-5de1bc7d9043","name":"200 OK - Update SRT Listener Stream","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"srt-listener\",\n \"protocol\": \"SRT\",\n \"mode\": \"listener\",\n \"streamInputSettings\": {\n \"latency\": 300,\n \"streamId\": \"input-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES256\",\n \"passphrase\": \"input-passphrase\"\n }\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 600,\n \"streamId\": \"output-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES128\",\n \"passphrase\": \"output-passphrase-updated\"\n }\n }\n },\n \"streams\": [\n {\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": null\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.vvcr.tv/v1/stream-configurations/:id","host":["https://api.vvcr.tv/v1"],"path":["stream-configurations",":id"],"variable":[{"key":"id","value":"cdf9c287-baeb-47f6-8d58-a0cecf4451a6"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"cdf9c287-baeb-47f6-8d58-a0cecf4451a6\",\n \"name\": \"srt-listener\",\n \"protocol\": \"SRT\",\n \"mode\": \"listener\",\n \"createdAt\": 1734094906401,\n \"updatedAt\": 1734095165842,\n \"streamInputSettings\": {\n \"latency\": 300,\n \"streamId\": \"input-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES256\",\n \"passphrase\": \"input-passphrase\",\n \"isPassphraseGenerated\": true\n }\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 600,\n \"streamId\": \"output-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES128\",\n \"passphrase\": \"output-passphrase-updated\",\n \"isPassphraseGenerated\": false\n }\n }\n },\n \"streams\": [\n {\n \"id\": \"ac8ff9f5-bb32-47a3-acec-c4e13aa7d75c\",\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"port\": 3001,\n \"output\": {\n \"ports\": {\n \"srt\": 4003,\n \"rtmp\": 1935,\n \"rtmps\": 1934\n },\n \"resolutionStreamKey\": null,\n \"mpegtsAudioTrackPid\": null,\n \"srtAudioTrackPid\": null\n },\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": false\n }\n }\n ]\n}"},{"id":"a613c949-5353-49f4-a193-edeb990ffc6c","name":"200 OK - Update SRT Caller Stream","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"srt-caller\",\n \"protocol\": \"SRT\",\n \"mode\": \"caller\",\n \"streamInputSettings\": {\n \"address\": \"8.8.8.8\",\n \"port\": 5000,\n \"latency\": 400,\n \"streamId\": \"source-stream-id-update\",\n \"encryption\": {\n \"passphrase\": \"input-passphrase\"\n }\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 500,\n \"streamId\": \"output-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES192\",\n \"passphrase\": \"output-passphrase-updated\"\n }\n }\n },\n \"streams\": [\n {\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": null\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.vvcr.tv/v1/stream-configurations/:id","host":["https://api.vvcr.tv/v1"],"path":["stream-configurations",":id"],"variable":[{"key":"id","value":"402a0dbe-0d9d-47d2-9cfb-4f6013ad6207"}]}},"status":"Created","code":20,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"402a0dbe-0d9d-47d2-9cfb-4f6013ad6207\",\n \"name\": \"srt-caller\",\n \"protocol\": \"SRT\",\n \"mode\": \"caller\",\n \"createdAt\": 1734094936488,\n \"updatedAt\": 1734095288381,\n \"streamInputSettings\": {\n \"address\": \"8.8.8.8\",\n \"port\": 5000,\n \"latency\": 400,\n \"streamId\": \"source-stream-id-update\",\n \"encryption\": {\n \"passphrase\": \"input-passphrase\"\n }\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 500,\n \"streamId\": \"output-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES192\",\n \"passphrase\": \"output-passphrase-updated\",\n \"isPassphraseGenerated\": true\n }\n }\n },\n \"streams\": [\n {\n \"id\": \"79266af9-25f3-4cf1-bc87-78cda1c0a2f7\",\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"port\": 3002,\n \"output\": {\n \"ports\": {\n \"srt\": 4004,\n \"rtmp\": 1935,\n \"rtmps\": 1934\n },\n \"resolutionStreamKey\": null,\n \"mpegtsAudioTrackPid\": null,\n \"srtAudioTrackPid\": null\n },\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": false\n }\n }\n ]\n}"},{"id":"77b13a19-1ba1-4b14-8ab4-988613828b73","name":"200 OK - Update RTMP Push Stream","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"rtmp-push\",\n \"protocol\": \"RTMP\",\n \"mode\": \"push\",\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 500,\n \"streamId\": \"output-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES256\",\n \"passphrase\": \"output-passphrase-updated\"\n }\n }\n },\n \"streams\": [\n {\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": null\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.vvcr.tv/v1/stream-configurations/:id","host":["https://api.vvcr.tv/v1"],"path":["stream-configurations",":id"],"variable":[{"key":"id","value":"c3cf3aba-62c6-4973-8425-b908ea42ea51"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"c3cf3aba-62c6-4973-8425-b908ea42ea51\",\n \"name\": \"rtmp-push\",\n \"protocol\": \"RTMP\",\n \"mode\": \"push\",\n \"createdAt\": 1734094956673,\n \"updatedAt\": 1734095339107,\n \"streamInputSettings\": null,\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 500,\n \"streamId\": \"output-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES256\",\n \"passphrase\": \"output-passphrase-updated\",\n \"isPassphraseGenerated\": true\n }\n }\n },\n \"streams\": [\n {\n \"id\": \"9ff02cb0-df90-46bf-a005-84e234a7a364\",\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"port\": 1935,\n \"output\": {\n \"ports\": {\n \"srt\": 4005,\n \"rtmp\": 1935,\n \"rtmps\": 1934\n },\n \"resolutionStreamKey\": null,\n \"mpegtsAudioTrackPid\": null,\n \"srtAudioTrackPid\": null\n },\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": false\n }\n }\n ]\n}"},{"id":"f31a394a-caf1-4cd5-8cf7-bce7be37fde9","name":"200 OK - Update RTMP Pull Stream","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"rtmp-pull\",\n \"protocol\": \"RTMP\",\n \"mode\": \"pull\",\n \"streamInputSettings\": {\n \"connectionType\": \"RTMP\",\n \"address\": \"8.8.8.8\",\n \"port\": 1934,\n \"application\": \"live2\",\n \"streamKey\": \"stream-key-updated\",\n \"password\": \"source-stream-password-updated\",\n \"username\": \"source-stream-user-updated\"\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 500,\n \"streamId\": \"output-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES256\",\n \"passphrase\": \"output-passphrase\"\n }\n }\n },\n \"streams\": [\n {\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": null\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.vvcr.tv/v1/stream-configurations/:id","host":["https://api.vvcr.tv/v1"],"path":["stream-configurations",":id"],"variable":[{"key":"id","value":"7c92414a-f4ef-4db8-b838-3e1b9bff2d74"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7c92414a-f4ef-4db8-b838-3e1b9bff2d74\",\n \"name\": \"rtmp-pull\",\n \"protocol\": \"RTMP\",\n \"mode\": \"pull\",\n \"createdAt\": 1734095062066,\n \"updatedAt\": 1734096816602,\n \"streamInputSettings\": {\n \"connectionType\": \"RTMP\",\n \"address\": \"8.8.8.8\",\n \"port\": 1934,\n \"application\": \"live2\",\n \"streamKey\": \"stream-key-updated\",\n \"username\": \"source-stream-user-updated\",\n \"password\": \"source-stream-password-updated\"\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 500,\n \"streamId\": \"output-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES256\",\n \"passphrase\": \"output-passphrase\",\n \"isPassphraseGenerated\": true\n }\n }\n },\n \"streams\": [\n {\n \"id\": \"d80be44b-990e-417b-a500-0d9a0ca4d922\",\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"port\": 1935,\n \"output\": {\n \"ports\": {\n \"srt\": 4007,\n \"rtmp\": 1935,\n \"rtmps\": 1934\n },\n \"resolutionStreamKey\": null,\n \"mpegtsAudioTrackPid\": null,\n \"srtAudioTrackPid\": null\n },\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": false\n }\n }\n ]\n}"},{"id":"3345811a-fb7b-46df-8800-cd13278cfb9f","name":"200 OK - Update NDI Stream","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"ndi-input\",\n \"protocol\": \"NDI\",\n \"mode\": \"signal\",\n \"streamInputSettings\": {\n \"signal\": \"source-signal-name-updated\"\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 500,\n \"streamId\": \"output-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES128\",\n \"passphrase\": \"output-passphrase-updated\"\n }\n }\n },\n \"streams\": [\n {\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": null\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.vvcr.tv/v1/stream-configurations/:id","host":["https://api.vvcr.tv/v1"],"path":["stream-configurations",":id"],"variable":[{"key":"id","value":"b16fb9f7-3396-4018-a77b-35dc1e41bbf8"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"b16fb9f7-3396-4018-a77b-35dc1e41bbf8\",\n \"name\": \"ndi-input\",\n \"protocol\": \"NDI\",\n \"mode\": \"signal\",\n \"createdAt\": 1734095088718,\n \"updatedAt\": 1734096893184,\n \"streamInputSettings\": {\n \"signal\": \"source-signal-name-updated\"\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 500,\n \"streamId\": \"output-stream-id-updated\",\n \"encryption\": {\n \"encryptionType\": \"AES128\",\n \"passphrase\": \"output-passphrase-updated\",\n \"isPassphraseGenerated\": true\n }\n }\n },\n \"streams\": [\n {\n \"id\": \"1b44efb4-5934-4ea2-9bf1-11f98309bb5d\",\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"port\": null,\n \"output\": {\n \"ports\": {\n \"srt\": 4008,\n \"rtmp\": 1935,\n \"rtmps\": 1934\n },\n \"resolutionStreamKey\": null,\n \"mpegtsAudioTrackPid\": null,\n \"srtAudioTrackPid\": null\n },\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": true\n }\n }\n ]\n}"}],"_postman_id":"db72a043-ec26-40ab-bd44-1bd30ed26a9f"},{"name":"Delete Stream","id":"88c5f21d-8a8c-414e-9896-60ec2778c7f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.vvcr.tv/v1/stream-configurations/:id","description":"This endpoint enables the deletion of a stream configuration identified by the provided :id.
IMPORTANT: Ensure there are no active DVR recordings assosiated with this stream configuration running before deleting the stream.
\nNo request body is required for this endpoint.
\nA JSON object containing details about the stream configuration that is being deleted.
\n","urlObject":{"path":["stream-configurations",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"5d1907d8-6867-4206-bfe1-959b09fd9b6e","name":"200 OK - Delete Stream","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.vvcr.tv/v1/stream-configurations/:id","host":["https://api.vvcr.tv/v1"],"path":["stream-configurations",":id"],"variable":[{"key":"id","value":"cdf9c287-baeb-47f6-8d58-a0cecf4451a6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"cdf9c287-baeb-47f6-8d58-a0cecf4451a6\",\n \"name\": \"srt-listener\",\n \"protocol\": \"SRT\",\n \"mode\": \"listener\",\n \"streamKey\": \"6f31d90c-e09b-484e-b13e-dca5792b3faf\",\n \"createdAt\": 1734094906401,\n \"updatedAt\": 1734094906401,\n \"streamInputSettings\": {\n \"latency\": 200,\n \"streamId\": \"input-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES128\",\n \"passphrase\": \"input-passphrase\",\n \"isPassphraseGenerated\": false\n }\n },\n \"streamOutputSettings\": {\n \"srt\": {\n \"latency\": 400,\n \"streamId\": \"output-stream-id\",\n \"encryption\": {\n \"encryptionType\": \"AES192\",\n \"passphrase\": \"output-passphrase\",\n \"isPassphraseGenerated\": false\n }\n }\n },\n \"streams\": [\n {\n \"id\": \"ac8ff9f5-bb32-47a3-acec-c4e13aa7d75c\",\n \"instanceId\": \"686e6806-fb8b-4703-afe5-9408300327a4\",\n \"clusterRole\": \"primary\",\n \"encoderRole\": \"primary\",\n \"port\": 3001,\n \"output\": {\n \"ports\": {\n \"srt\": 4003,\n \"rtmp\": 1935,\n \"rtmps\": 1934\n },\n \"resolutionStreamKey\": null,\n \"mpegtsAudioTrackPid\": null,\n \"srtAudioTrackPid\": null\n },\n \"transcoding\": {\n \"resolution\": null,\n \"ndiOutput\": false\n }\n }\n ]\n}"}],"_postman_id":"88c5f21d-8a8c-414e-9896-60ec2778c7f6"}],"id":"441827fa-4ecb-4e16-a10d-814d8cf9fde8","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"46a0c06f-eb4c-462e-977c-3544865c3af1","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"b7b8be40-fed4-4965-8b64-8289c22cd58d","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"441827fa-4ecb-4e16-a10d-814d8cf9fde8","description":""},{"name":"Destinations","item":[{"name":"List Destinations","id":"20d83aac-b569-464e-89cb-f6b0775b33dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/destinations","description":"This endpoint allows the retrieval of a list of destinations available in the organization, along with all associated metadata.
\nNo request body is required for this endpoint.
\nThe response to this request is a JSON array that contains destination objects with the following properties:
\nid (string): Unique identifier of the destination.
name (string): Destination name.
type (string): Destination type (srt, rtmp, vvcr_stream).
streamId (string | null): Identifier of the stream instance (withing the stream configuration), utilized as a input source of the destination.
isRunning (boolean): A boolean flag indicating whether the destination is currently active.
audioTrackPID (number | null): The MPEG-TS audio packet identifier (PID), indicating the stream's audio track utilized in the destination.
createdAt (number): The Unix timestamp (in seconds) indicating when the destination was initially created.
updatedAt (number): The Unix timestamp (in seconds) indicating the last time the destniation was updated.
target (object): Protocol-specific output settings.
type = srt)address (string): IP or hostname of the target SRT stream.
port (number): Port of the target SRT stream.
latency (number): Latency in milliseconds.
passphrase (string | null): Encryption passphrase. null if not set.
type = rtmp)connectionType (string): RTMP connection type (RTMP/RTMPS).
address (string): IP or hostname of the target RTMP stream.
port (number): Port of the target RTMP stream.
application (string): Application name of the target RTMP stream.
streamKey (string): Stream key of the target RTMP stream.
authentication (object | null): Optional authentication settings. null if authentication is not required.
type = vvcr_stream)streamId (string | null): Stream identifier specific to VVCR destinations.This endpoint enables the creation of a new destination for a specified stream. A destination is an output stream that distributes incoming input streams to multiple platforms using supported streaming protocols, such as RTMP or SRT.
name (string, required): Destination name.
streamId (string, required): Identifier of the stream instance (withing the stream configuration), to be utilized as a source of the destination.
type (string, required): Destination type. This parameter specifies the streaming protocol to be used for the output stream. Supported values:
srt: Configures the destination as an SRT Caller.
rtmp: Configures the destination as an RTMP Push.
vvcr_stream: Configures the destination as a VVCR stream (this type can be used to transmit the stream between clusters, for example).
isRunning (boolean, required): This parameter specifies whether the destination should start immediately upon creation.
audioTrackPID (number | null, optional): This parameter specifies the MPEG-TS audio packet identifier (PID) from the source to be used as the audio track for the destination.
transcoding (object | null, optional): This parameter specifies the transcoding settings to be applied to the source stream, such as changing its bitrate or resolution, before transmitting it to the destination. If the parameter is set to null or omitted, the stream will be passed through without any transcoding.
resolution (string, optional): Specifies the transcoder resolution profile. Supported values: 240p, 360p, 480p, 720p, 1080p, 1440p, 2160p. Each resolution profile has optimized bitrate and encoder settings tailored for the corresponding target resolution.target (object, required): Specifies the output settings for the destination. The structure and format of the configuration object depend on the selected destination type.
type = srt)address (string, required): IP address or hostname of the target SRT server.
port (number, required): The port number designated for the target SRT stream.
latency (number, required): Specifies the amount of latency, in milliseconds, to be added to the stream.
passphrase (string, optional): Passphrase used to encrypt the output SRT stream.
srtStreamId (string, optional): The SRT stream ID designated for the target SRT server.
type = rtmp)connectionType (string, required): This parameter indicates whether SSL encryption should be utilized to establish RTMP connection. Supported values: RTMP, RTMPS.
address (string, required): IP address or hostname of the target RTMP server.
port (number, required): The port number designated for the target RTMP stream. Default value: 1935.
application (string, required): The application name designated for the target RTMP stream.
streamKey (string, required): The RTMP stream key designated for the target RTMP stream.
authentication (object, optional): Authentication settings, required for the autorization with the target RTMP server. This parameter can be omitted if target RTMP server is not requiring authorization.
scheme (string, optional): The authentication scheme (e.g., basic). Supported values: AKAMAI, LIMELIGHT, NIMBLE, RTMP, TELEGRAM, TWITCH, TWITTER.
username (string, optional): Username for authentication. Required for AKAMAI, LIMELIGHT, NIMBLE, RTMP authentication types.
password (string, optional): Password for authentication. Required for AKAMAI, LIMELIGHT, NIMBLE, RTMP authentication types.
akamaiStreamId (string, optional): Akamai stream ID.
type = vvcr_stream)streamId (string, required): The stream ID for the VVCR stream.A JSON object containing details about the created destination.
\n","urlObject":{"path":["destinations"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[]}},"response":[{"id":"acad2cdf-8252-4a3e-afda-05bb81ed6706","name":"201 OK - Create SRT Destination","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"srt-destination\",\n \"streamId\": \"f5e1a427-9634-4a73-9e8c-65cfee75ce3f\",\n \"type\": \"srt\",\n \"isRunning\": true,\n \"audioTrackPID\": null,\n \"transcoding\": {\n \"resolution\": null\n },\n \"target\":\n {\n \"address\": \"8.8.8.8\",\n \"port\": 3003,\n \"latency\": 200,\n \"passphrase\": null,\n \"srtStreamId\": \"\"\n }\n}\n\n\n\n\n\n\n","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/destinations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"6d43ffee-3535-44f7-9759-f8140969d774\",\n \"name\": \"srt-destination\",\n \"type\": \"srt\",\n \"streamId\": \"f5e1a427-9634-4a73-9e8c-65cfee75ce3f\",\n \"isRunning\": true,\n \"audioTrackPID\": null,\n \"createdAt\": 1734967827124,\n \"updatedAt\": 1734967827124,\n \"target\": {\n \"address\": \"8.8.8.8\",\n \"port\": 3003,\n \"latency\": 200,\n \"passphrase\": null\n }\n}"},{"id":"87a8caa8-709d-482b-84fe-3137d06a6ce7","name":"201 OK - Create RTMP Destination","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"rtmp-destination\",\n \"streamId\": \"f5e1a427-9634-4a73-9e8c-65cfee75ce3f\",\n \"type\": \"rtmp\",\n \"isRunning\": true,\n \"audioTrackPID\": null,\n \"transcoding\": {\n \"resolution\": \"240p\"\n },\n \"target\":\n {\n \"connectionType\": \"RTMPS\",\n \"address\": \"8.8.8.8\",\n \"port\": 1935,\n \"application\": \"live\",\n \"streamKey\": \"61c123b0-f6a0-4939-95a5-850f48b51bed\",\n \"authentication\": {\n \"scheme\": null,\n \"username\": null,\n \"password\": null,\n \"akamaiStreamId\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/destinations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"96dbb631-6243-415b-bc87-240530ba2f77\",\n \"name\": \"rtmp-destination\",\n \"type\": \"rtmp\",\n \"streamId\": \"f5e1a427-9634-4a73-9e8c-65cfee75ce3f\",\n \"isRunning\": true,\n \"audioTrackPID\": null,\n \"createdAt\": 1734969084946,\n \"updatedAt\": 1734969084946,\n \"target\": {\n \"connectionType\": \"RTMP\",\n \"address\": \"8.8.8.8\",\n \"port\": 1935,\n \"application\": \"live\",\n \"streamKey\": \"61c123b0-f6a0-4939-95a5-850f48b51bed\",\n \"authentication\": null\n }\n}\n"},{"id":"84c21b8b-9bdc-4ea5-9172-3b9f94cb5ca2","name":"201 OK - Create VVCR Destination","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"vvcr-destination\",\n \"streamId\": \"55d8073e-86fe-40c2-a8e3-c669632c6156\",\n \"type\": \"vvcr_stream\",\n \"isRunning\": true,\n \"audioTrackPID\": null,\n \"transcoding\": {\n \"resolution\": \"240p\"\n },\n \"target\":\n {\n \"streamId\": \"9f551b2e-724a-4883-bd75-1c5c8acda731\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/destinations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0e142323-e443-4a45-812c-d9cca45534a7\",\n \"name\": \"vvcr-destination\",\n \"type\": \"vvcr_stream\",\n \"streamId\": \"55d8073e-86fe-40c2-a8e3-c669632c6156\",\n \"isRunning\": true,\n \"audioTrackPID\": null,\n \"createdAt\": 1737048425778,\n \"updatedAt\": 1737048425778,\n \"transcoding\": {\n \"resolution\": \"240p\"\n },\n \"target\":\n {\n \"streamId\": \"9f551b2e-724a-4883-bd75-1c5c8acda731\"\n }\n}"}],"_postman_id":"30f30979-ff15-4e16-96fc-f01335959b6c"},{"name":"Get Destination","id":"fc3d58a5-7b5b-4b7b-809d-cfbfb8f12007","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/destinations/:id","description":"This endpoint allows the retrieval of the information about a specific destination identified by the provided :id, along with all associated metadata.
No request body is required for this endpoint.
\nThe response to this request is a destination JSON object with the following properties:
\nid (string): Unique identifier of the destination.
name (string): Destination name.
type (string): Destination type (srt, rtmp, vvcr_stream).
streamId (string|null): Identifier of the associated stream in stream configuration.
isRunning (boolean): A boolean flag indicating whether the destination is currently active.
audioTrackPID (number|null): The MPEG-TS audio packet identifier (PID), specifying the audio track within the stream to be used for the destination.
createdAt (number): The Unix timestamp (in seconds) indicating when the destination was initially created.
updatedAt (number): The Unix timestamp (in seconds) indicating the last time the destination was updated.
target (object): Protocol-specific output settings.
type = srt)address (string): IP or hostname of the target SRT stream.
port (number): Port of the target SRT stream.
latency (number): Latency in milliseconds.
passphrase (string|null): Encryption passphrase. null if not set.
type = rtmp)connectionType (string): RTMP connection type (RTMP/RTMPS).
address (string): IP or hostname of the target RTMP stream.
port (number): Port of the target RTMP stream.
application (string): Application name of the target RTMP stream.
streamKey (string): Stream key of the target RTMP stream.
authentication (object|null): Optional authentication settings. null if authentication is not required.
type = vvcr_stream)streamId (string|null): Stream identifier specific to VVCR destinations.This endpoint enables the modification of a destination identified by the specified :id.
name (string, optional): The name of the destination.
streamId (string, required): The stream ID associated with the destination.
isRunning (boolean, required): Whether the destination is running or not. Set to true to start, false to stop.
audioTrackPID (number|null, optional): Audio packet identifier (e.g., 256).
transcoding (object, optional): Transcoding settings for the destination.
resolution (string, optional): Transcoder resolution. Supported values: 240p, 360p, 480p, 720p, 1080p, 1440p, 2160p.target (object, required): The target configuration for the destination, which differs based on the destination type.
For srt type:
address (string, required): IP address or hostname of the destination.
port (number, required): Port of the destination.
latency (number, required): Latency in milliseconds.
passphrase (string, optional): Passphrase for encryption (if any).
srtStreamId (string, optional): SRT stream ID (if applicable).
For rtmp type:
connectionType (string, required): Possible values: RTMP, RTMPS.
address (string, required): IP address or hostname.
port (number, required): Port of the RTMP stream.
application (string, required): Application name for RTMP.
streamKey (string, required): Stream key for RTMP.
authentication (object, optional): Authentication settings (optional for some RTMP services).
scheme (string, optional): The authentication scheme. Possible values: AKAMAI, LIMELIGHT, NIMBLE, RTMP, TELEGRAM, TWITCH, TWITTER.
username (string, optional): Username for authentication.
password (string, optional): Password for authentication.
akamaiStreamId (string, optional): Akamai stream ID.
For vvcr_stream type:
streamId (string, required): The stream ID for the VVCR stream.A JSON object containing details about the updated destination.
\n","urlObject":{"path":["destinations",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"c9fd2fe1-3b43-4dda-8221-c020015a9480","name":"200 OK - Update SRT Destination","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"srt-destination\",\n \"streamId\": \"89d3ea29-3218-4c9d-ac67-617dad22d95b\",\n \"type\": \"srt\",\n \"isRunning\": false,\n \"audioTrackPID\": null,\n \"transcoding\": {\n \"resolution\": null\n },\n \"target\":\n {\n \"address\": \"8.8.8.8\",\n \"port\": 3010,\n \"latency\": 300,\n \"passphrase\": null,\n \"srtStreamId\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.vvcr.tv/v1/destinations/:id","host":["https://api.vvcr.tv/v1"],"path":["destinations",":id"],"variable":[{"key":"id","value":"ba2bdd2f-4d48-431c-ab62-e885db137f1f"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ba2bdd2f-4d48-431c-ab62-e885db137f1f\",\n \"name\": \"srt-destination\",\n \"type\": \"srt\",\n \"streamId\": \"89d3ea29-3218-4c9d-ac67-617dad22d95b\",\n \"isRunning\": false,\n \"audioTrackPID\": null,\n \"createdAt\": 1737051760712,\n \"updatedAt\": 1737051772561,\n \"transcoding\": {\n \"resolution\": null\n },\n \"target\": {\n \"address\": \"8.8.8.8\",\n \"port\": 3010,\n \"latency\": 300,\n \"passphrase\": null\n }\n}"},{"id":"773a8374-2b9d-4e4c-8f01-aa6eb07cf3ef","name":"200 OK - Update RTMP Destination","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"rtmp-destination\",\n \"streamId\": \"24590f65-9ef5-4182-a415-61105b5253e5\",\n \"type\": \"rtmp\",\n \"isRunning\": false,\n \"audioTrackPID\": null,\n \"transcoding\": {\n \"resolution\": null\n },\n \"target\":\n {\n \"connectionType\": \"RTMP\",\n \"address\": \"google.com\",\n \"port\": 1935,\n \"application\": \"live2\",\n \"streamKey\": \"stream-key\",\n \"authentication\": {\n \"scheme\": \"RTMP\",\n \"username\": \"testusername\",\n \"password\": \"testpassword\",\n \"akamaiStreamId\": null\n }\n }\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.vvcr.tv/v1/destinations/:id","host":["https://api.vvcr.tv/v1"],"path":["destinations",":id"],"variable":[{"key":"id","value":"9ea2cc7b-f212-4d4f-a3d1-b5d71149393f"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9ea2cc7b-f212-4d4f-a3d1-b5d71149393f\",\n \"name\": \"rtmp-destination\",\n \"type\": \"rtmp\",\n \"streamId\": \"24590f65-9ef5-4182-a415-61105b5253e5\",\n \"isRunning\": false,\n \"audioTrackPID\": null,\n \"createdAt\": 1737051799321,\n \"updatedAt\": 1737051803298,\n \"transcoding\": {\n \"resolution\": null\n },\n \"target\": {\n \"connectionType\": \"RTMP\",\n \"address\": \"google.com\",\n \"port\": 1935,\n \"application\": \"live2\",\n \"streamKey\": \"stream-key\",\n \"authentication\": {\n \"scheme\": \"RTMP\",\n \"username\": \"testusername\",\n \"password\": \"testpassword\",\n \"akamaiStreamId\": null\n }\n }\n}"},{"id":"319be69a-bfbb-4939-bd79-7c1b4a989e09","name":"200 OK - Update VVCR Destination","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"vvcr-destination\",\n \"streamId\": \"6ee043db-b232-4e17-8010-4df24a4f7731\",\n \"type\": \"vvcr_stream\",\n \"isRunning\": false,\n \"audioTrackPID\": null,\n \"transcoding\": {\n \"resolution\": null\n },\n \"target\":\n {\n \"streamId\": \"1852cb34-8d38-4e51-a100-1ce072979b12\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.vvcr.tv/v1/destinations/:id","host":["https://api.vvcr.tv/v1"],"path":["destinations",":id"],"variable":[{"key":"id","value":"515b2553-0f2c-40af-8f1d-b75d6e833b7e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"515b2553-0f2c-40af-8f1d-b75d6e833b7e\",\n \"name\": \"vvcr-destination\",\n \"type\": \"vvcr_stream\",\n \"streamId\": \"6ee043db-b232-4e17-8010-4df24a4f7731\",\n \"isRunning\": false,\n \"audioTrackPID\": null,\n \"createdAt\": 1737051841006,\n \"updatedAt\": 1737051857840,\n \"transcoding\": {\n \"resolution\": null\n },\n \"target\": {\n \"streamId\": \"1852cb34-8d38-4e51-a100-1ce072979b12\"\n }\n}"}],"_postman_id":"9923d651-eb54-4ed9-a380-e6334ed1f6e6"},{"name":"Delete Destination","id":"b8d8dfdb-c2a0-45ae-bac2-0ac7216c26b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.vvcr.tv/v1/destinations/:id","description":"This endpoint enables the deletion of a specific destination identified by the provided :id.
No request body is required for this endpoint.
\nA JSON object containing details about the destination that is being deleted.
\n","urlObject":{"path":["destinations",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"id":"6f72a6cb-d79a-4177-bfb6-e85d1b5a2302","type":"any","value":"","key":"id"}]}},"response":[{"id":"01a3fb62-3142-4a43-a807-353aaf9b8b82","name":"200 OK - Delete Destination","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.vvcr.tv/v1/destinations/:id","host":["https://api.vvcr.tv/v1"],"path":["destinations",":id"],"variable":[{"key":"id","value":"9ea2cc7b-f212-4d4f-a3d1-b5d71149393f"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"9ea2cc7b-f212-4d4f-a3d1-b5d71149393f\",\n \"name\": \"rtmp-destination\",\n \"type\": \"rtmp\",\n \"streamId\": \"6ee043db-b232-4e17-8010-4df24a4f7731\",\n \"isRunning\": false,\n \"audioTrackPID\": null,\n \"createdAt\": 1737051799321,\n \"updatedAt\": 1737051843774,\n \"transcoding\": {\n \"resolution\": null\n },\n \"target\": {\n \"connectionType\": \"RTMP\",\n \"address\": \"google.com\",\n \"port\": 1935,\n \"application\": \"live2\",\n \"streamKey\": \"stream-key\",\n \"authentication\": {\n \"scheme\": \"RTMP\",\n \"username\": \"testusername\",\n \"password\": \"testpassword\",\n \"akamaiStreamId\": null\n }\n }\n}"}],"_postman_id":"b8d8dfdb-c2a0-45ae-bac2-0ac7216c26b6"}],"id":"d27db4ee-a32a-43b5-a80f-c5df0ea08cf0","_postman_id":"d27db4ee-a32a-43b5-a80f-c5df0ea08cf0","description":""},{"name":"Multiview","item":[{"name":"List Multiviews","id":"b1e9056c-2143-464d-9dc0-4091bce8b838","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/multiviews","description":"This endpoint allows the retrieval of a list of multiviews currently available in the organization, along with all associated metadata.
\nNo request body is required for this endpoint.
\nThe response to this request is a JSON array that contains multiview configuration objects with the following properties:
\nid (string): Unique multiview configuration identifier.
name (string): Multiview configuration name.
shortName (string|null): Optional short name for the multiview.
url (string): URL to access the multiview.
columns (number): Number of columns in the multiview grid.
rows (number): Number of rows in the multiview grid.
visibility (string): Visibility of the multiview (public/private/protected).
password (string|null): Password for accessing the multiview (if applicable).
overlays (object): Configuration of overlay elements displayed on video tiles:
vuMeter (boolean): Displays a VU meter for audio levels.
bitrate (boolean): Displays the bitrate of the stream.
streamName (boolean): Displays the stream name.
sourceAddress (boolean): Displays the input address of the stream.
entities (array): Array of objects defining individual components (tiles) in the multiview. Each tile can either be a stream or a destination. Each object contains:
order (number): Position of the entity in the multiview grid.
type (string): Type of entity (stream/destination).
streamId (string|null): Identifier for the associated stream (if applicable).
destinationId (string|null): Identifier for the associated destination (if applicable).
Each multiview grid displays tiles representing individual streams or destinations. Tiles may include the following elements:
\nConfigured tiles display:
\nStream name (if overlay is enabled).
\nProtocol and address (e.g., SRT and port details).
Role (e.g., \"Primary\").
\nUnconfigured tiles display a message: \"Input is not configured.\"
\nThis endpoint allows the creation of a new multiview with a grid of tiles representing streams or destinations.
\nThe request body must contain the following parameters:
\nname (string): Multiview configuration name.
shortName (string): Unique short name for the multiview.
columns (number): Number of columns in the multiview grid.
rows (number): Number of rows in the multiview grid.
visibility (string): Visibility of the multiview (public/private/protected).
password (string, required if visibility is protected): Password for accessing the multiview.
overlays (object, optional): Configuration of overlay elements displayed on video tiles:
vuMeter (boolean): Displays a VU meter for audio levels.
bitrate (boolean): Displays the bitrate of the stream.
streamName (boolean): Displays the stream name.
sourceAddress (boolean): Displays the input address of the stream.
entities (array, optional): Array of objects defining individual components (tiles) in the multiview grid. If omitted or empty, all tiles will display \"No stream configured.\" Each object contains:
column (number): Column position of the tile in the grid (starting from 1).
row (number): Row position of the tile in the grid (starting from 1).
type (string): Type of entity (stream/destination). When type is destination tile will show the source stream of this destination.
streamId (string, required if type is stream): Identifier for the associated stream.
destinationId (string, required if type is destination): Identifier for the associated destination.
A JSON object containing details about the created multiview.
\n","urlObject":{"path":["multiviews"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[]}},"response":[{"id":"c2e34ae1-7813-4d16-a6b3-99267bed2234","name":"201 OK - Create Multiview","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"sample-multiview\",\n \"shortName\": \"sample-multiview\",\n \"rows\": 1,\n \"columns\": 2,\n \"visibility\": \"private\",\n \"password\": null,\n \"overlays\": {\n \"vuMeter\": true,\n \"bitrate\": true,\n \"sourceAddress\": true,\n \"streamName\": true\n },\n \"entities\": [\n {\n \"row\": 1,\n \"column\": 1,\n \"type\": \"stream\",\n \"streamId\": \"b00f6844-57e1-409b-b1a2-5978eb7e7059\",\n \"destinationId\": null\n },\n {\n \"row\": 1,\n \"column\": 2,\n \"type\": \"stream\",\n \"streamId\": \"5d0f6dcd-4f62-45c1-b67a-1cee65107cc7\",\n \"destinationId\": null\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/multiviews"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"29616fc6-bd61-463f-8310-1907d1394382\",\n \"name\": \"sample-multiview\",\n \"shortName\": \"sample-multiview\",\n \"url\": \"https://app.vvcr.tv/#/multiview/apiorg/sample-multiview\",\n \"columns\": 2,\n \"rows\": 1,\n \"visibility\": \"private\",\n \"password\": null,\n \"createdAt\": 1737152986711,\n \"updatedAt\": 1737152986711,\n \"overlays\": {\n \"vuMeter\": true,\n \"bitrate\": true,\n \"streamName\": true,\n \"sourceAddress\": true\n },\n \"entities\": [\n {\n \"row\": 1,\n \"column\": 1,\n \"type\": \"stream\",\n \"streamId\": \"b00f6844-57e1-409b-b1a2-5978eb7e7059\",\n \"destinationId\": null\n },\n {\n \"row\": 1,\n \"column\": 2,\n \"type\": \"stream\",\n \"streamId\": \"5d0f6dcd-4f62-45c1-b67a-1cee65107cc7\",\n \"destinationId\": null\n }\n ]\n}"}],"_postman_id":"6e2c4980-8cc5-407d-890c-e000cefc53bf"},{"name":"Get Multiview","id":"84fc6d8b-5519-4dd2-977d-eeb4f4867c1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/multiviews/:id","description":"This endpoint allows the retrieval of the information about a specific multiview identified by the provided :id, along with all associated metadata.
The response to this request is a multiview JSON object with the following properties:
\nid (string): Unique multiview configuration identifier.
name (string): Multiview configuration name.
shortName (string|null): Optional short name for the multiview.
url (string): URL to access the multiview.
columns (number): Number of columns in the multiview grid.
rows (number): Number of rows in the multiview grid.
visibility (string): Visibility of the multiview (public/private/protected).
password (string|null): Password for accessing the multiview (if applicable).
overlays (object): Configuration of overlay elements displayed on video tiles:
vuMeter (boolean): Displays a VU meter for audio levels.
bitrate (boolean): Displays the bitrate of the stream.
streamName (boolean): Displays the stream name.
sourceAddress (boolean): Displays the input address of the stream.
entities (array): Array of objects defining individual components (tiles) in the multiview. Each tile can either be a stream or a destination. Each object contains:
order (number): Position of the entity in the multiview grid.
type (string): Type of entity (stream/destination).
streamId (string|null): Identifier for the associated stream (if applicable).
destinationId (string|null): Identifier for the associated destination (if applicable).
This endpoint enables the modification of a multiview identified by the specified :id.
The request body supports updating the following parameters:
\nname (string, optional): New multiview configuration name.
shortName (string, optional): New unique short name for the multiview.
columns (number, optional): Updated number of columns in the multiview grid.
rows (number, optional): Updated number of rows in the multiview grid.
visibility (string, optional): New visibility setting (public/private/protected).
password (string, required if changing visibility to protected): New password for accessing the multiview.
overlays (object, optional): Updated configuration of overlay elements:
vuMeter (boolean): Toggles VU meter display for audio levels.
bitrate (boolean): Toggles bitrate display.
streamName (boolean): Toggles stream name display.
sourceAddress (boolean): Toggles input address display.
entities (array, optional): Updated array of tile configurations. Each object contains:
column (number): Column position of the tile (starting from 1).
row (number): Row position of the tile (starting from 1).
type (string): Type of entity (stream/destination). When type is destination tile will show the source stream of this destination.
streamId (string, required if type is stream): Identifier for the associated stream.
destinationId (string, required if type is destination): Identifier for the associated destination.
A JSON object containing details about the updated multivew.
\n","urlObject":{"path":["multiviews",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"ae4aeec3-687c-4670-b5f2-579594b87b82","name":"200 OK - Update Multiview","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"sample-multiview\",\n \"shortName\": \"sample-multiview-1\",\n \"columns\": 2,\n \"rows\": 1,\n \"visibility\": \"public\",\n \"password\": null,\n \"overlays\": {\n \"vuMeter\": true,\n \"bitrate\": true,\n \"streamName\": true,\n \"sourceAddress\": true\n },\n \"entities\": [\n {\n \"row\": 1,\n \"column\": 1,\n \"type\": \"stream\",\n \"streamId\": \"b00f6844-57e1-409b-b1a2-5978eb7e7059\",\n \"destinationId\": null\n },\n {\n \"row\": 1,\n \"column\": 2,\n \"type\": \"stream\",\n \"streamId\": \"5d0f6dcd-4f62-45c1-b67a-1cee65107cc7\",\n \"destinationId\": null\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.vvcr.tv/v1/multiviews/:id","host":["https://api.vvcr.tv/v1"],"path":["multiviews",":id"],"variable":[{"key":"id","value":"29616fc6-bd61-463f-8310-1907d1394382"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"29616fc6-bd61-463f-8310-1907d1394382\",\n \"name\": \"sample-multiview\",\n \"shortName\": \"sample-multiview-1\",\n \"url\": \"https://app.vvcr.tv/#/multiview/apiorg/sample-multiview-1\",\n \"columns\": 2,\n \"rows\": 1,\n \"visibility\": \"public\",\n \"password\": null,\n \"createdAt\": 1737152986711,\n \"updatedAt\": 1737153337431,\n \"overlays\": {\n \"vuMeter\": true,\n \"bitrate\": true,\n \"streamName\": true,\n \"sourceAddress\": true\n },\n \"entities\": [\n {\n \"row\": 1,\n \"column\": 1,\n \"type\": \"stream\",\n \"streamId\": \"b00f6844-57e1-409b-b1a2-5978eb7e7059\",\n \"destinationId\": null\n },\n {\n \"row\": 1,\n \"column\": 2,\n \"type\": \"stream\",\n \"streamId\": \"5d0f6dcd-4f62-45c1-b67a-1cee65107cc7\",\n \"destinationId\": null\n }\n ]\n}"}],"_postman_id":"d0178d58-c5ad-433e-9833-c478fdf566b9"},{"name":"Delete Multiview","id":"d4a51741-744a-4ea3-bb32-8b3bdc5b2be3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.vvcr.tv/v1/multiviews/:id","description":"This endpoint enables the deletion of a specific multiview identified by the provided :id.
No request body is required for this endpoint.
\nA JSON object containing details about the multiview that is being deleted.
\n","urlObject":{"path":["multiviews",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"98692e8b-5039-456c-b8a4-91280c745bc7","name":"200 OK - Delete Multiview","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.vvcr.tv/v1/multiviews/:id","host":["https://api.vvcr.tv/v1"],"path":["multiviews",":id"],"variable":[{"key":"id","value":"29616fc6-bd61-463f-8310-1907d1394382"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"29616fc6-bd61-463f-8310-1907d1394382\",\n \"name\": \"sample-multiview\",\n \"shortName\": \"sample-multiview\",\n \"url\": \"https://app.vvcr.tv/#/multiview/apiorg/sample-multiview\",\n \"columns\": 2,\n \"rows\": 1,\n \"visibility\": \"public\",\n \"password\": null,\n \"createdAt\": 1737152986711,\n \"updatedAt\": 1737153337431,\n \"overlays\": {\n \"vuMeter\": true,\n \"bitrate\": true,\n \"streamName\": true,\n \"sourceAddress\": true\n },\n \"entities\": [\n {\n \"row\": 1,\n \"column\": 1,\n \"type\": \"stream\",\n \"streamId\": \"b00f6844-57e1-409b-b1a2-5978eb7e7059\",\n \"destinationId\": null\n },\n {\n \"row\": 1,\n \"column\": 2,\n \"type\": \"stream\",\n \"streamId\": \"5d0f6dcd-4f62-45c1-b67a-1cee65107cc7\",\n \"destinationId\": null\n }\n ]\n}"}],"_postman_id":"d4a51741-744a-4ea3-bb32-8b3bdc5b2be3"}],"id":"f8a24695-96aa-462d-8e2a-2a3228131b8f","_postman_id":"f8a24695-96aa-462d-8e2a-2a3228131b8f","description":""},{"name":"DVR","item":[{"name":"List DVR Recordings","id":"b9772500-5b2a-4e84-b30d-a064a99f1179","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/dvr","description":"This endpoint allows the retrieval of a list of DVR recordings currently available in the organization, along with all associated metadata.
\nNo request body is required for this endpoint.
\nThe response to this request is a JSON array that contains DVR recording objects with the following properties:
\nid (string): Unique identifier of the DVR recording.
streamId (string): Identifier of the associated stream.
filename (string): Name of the recording file.
status (string): Current status of the recording. Possible values:
initialization: Recording is being initialized
waiting: Recording is waiting for incoming signal
recording: Recording is actively in progress
stopping: Recording is in the process of stopping
completed: Recording has finished successfully
deleting: Recording is being deleted
failed: Recording failed (check error field)
error (string|null): Error message if recording failed, null otherwise.
start (number): Timestamp when the recording started (in milliseconds since epoch).
end (number): Timestamp when the recording ended (in milliseconds since epoch).
createdAt (number): The Unix timestamp (in seconds) indicating when the DVR record was initially created.
updatedAt (number): The Unix timestamp (in seconds) indicating the last time the DVR record was updated.
This endpoint allows the retrieval of the information about a specific DVR record identified by the provided :id, along with all associated metadata.
No request body is required for this endpoint.
\nA JSON object containing details about the specific DVR recording with the following properties:
\nid (string): Unique identifier of the DVR recording.
streamId (string): Identifier of the associated stream.
filename (string): Name of the recording file.
status (string): Current status of the recording. Possible values:
initialization: Recording is being initialized
waiting: Recording is queued to start
recording: Recording is in progress
stopping: Recording is being stopped
completed: Recording has finished successfully
deleting: Recording is being deleted
failed: Recording has failed
error (string|null): Error message if recording failed, null otherwise.
start (number): Timestamp when recording started (0 if not started yet).
end (number): Timestamp when recording ended (0 if still recording).
createdAt (number): The Unix timestamp (in seconds) indicating when the DVR record was initially created.
updatedAt (number): The Unix timestamp (in seconds) indicating the last time the DVR record was updated.
This endpoint initiates a new DVR recording for a specified stream.
\nstreamId (string, required): The unique identifier of the stream to record.
filename (string, required): The name for the recording file.
A JSON object containing details about the new DVR recording with the following properties:
\nid (string): Unique identifier of the created DVR recording.
streamId (string): Identifier of the stream being recorded.
filename (string): Name of the recording file.
status (string): Current status of the recording.
error (string|null): Error message if any issues occur, null otherwise.
start (number): Timestamp when recording started (0 if not started).
end (number): Timestamp when recording ended (0 if not ended).
createdAt (number): The Unix timestamp (in seconds) indicating when the DVR record was initially created.
updatedAt (number): The Unix timestamp (in seconds) indicating the last time the DVR record was updated.
This endpoint stops the active DVR recording identified by the provided :id.
No request body is required for this endpoint.
\nA JSON object containing details about the DVR Recording that is being stopped.
\n","urlObject":{"path":["dvr","stop",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"id":"4ce9959b-43cb-46a3-81fd-c9e25b9248e4","type":"any","value":"","key":"id"}]}},"response":[{"id":"c672b93a-9bab-4268-9888-1d79a98e1ffd","name":"200 OK - Stop DVR Recording","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.vvcr.tv/v1/dvr/stop/:id","host":["https://api.vvcr.tv/v1"],"path":["dvr","stop",":id"],"variable":[{"key":"id","value":"5f65d3eb-ab02-4af6-8d06-d060b4903813"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5f65d3eb-ab02-4af6-8d06-d060b4903813\",\n \"streamId\": \"a978946f-8d97-4387-b494-23ded5fafa3d\",\n \"filename\": \"sample-dvr-recording\",\n \"status\": \"stopping\",\n \"error\": null,\n \"start\": 1736248864000,\n \"end\": 0,\n \"createdAt\": 1736248846565,\n \"updatedAt\": 1736249160435\n}"}],"_postman_id":"468a038a-b4fd-4c0f-8301-1af813c11262"},{"name":"Delete DVR Recording","id":"b27bb94a-e82a-407a-8d72-c78beb794e55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.vvcr.tv/v1/dvr/:id","description":"This endpoint enables the deletion of a specific DVR Recording identified by the provided :id.
No request body is required for this endpoint.
\nA JSON object containing details about the DVR Recording that is being deleted.
\n","urlObject":{"path":["dvr",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"320efc82-23cf-4487-ad60-62196bec3cd9","name":"200 OK - Delete DVR Recording","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.vvcr.tv/v1/dvr/:id","host":["https://api.vvcr.tv/v1"],"path":["dvr",":id"],"variable":[{"key":"id","value":"5f65d3eb-ab02-4af6-8d06-d060b4903813"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5f65d3eb-ab02-4af6-8d06-d060b4903813\",\n \"streamId\": \"a978946f-8d97-4387-b494-23ded5fafa3d\",\n \"filename\": \"sample-dvr-recording\",\n \"status\": \"completed\",\n \"error\": null,\n \"start\": 1737152215000,\n \"end\": 1737152286000,\n \"createdAt\": 1737152212784,\n \"updatedAt\": 1737152408508\n}"}],"_postman_id":"b27bb94a-e82a-407a-8d72-c78beb794e55"}],"id":"74a3ced7-16c9-4cd8-a099-afb4684100c5","_postman_id":"74a3ced7-16c9-4cd8-a099-afb4684100c5","description":""},{"name":"Production Instances","item":[{"name":"List Production Instances","id":"f3b6fb2a-8916-4af8-ba53-f897a5c2dc0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/production-instances","description":"This endpoint allows the retrieval of a list of production instances currently available in the organization, along with all associated metadata.
\nNo request body is required for this endpoint.
\nThe response to this request is a JSON array that contains production instance objects with the following properties:
\nid (string): Unique identifier of the production instance.
clusterId (string|null): Identifier of the cluster if the instance belongs to one, null otherwise.
region (string): AWS region where the instance is deployed.
vpcId (string): Identifier of the VPC where the instance is deployed.
instanceType (string): Production instance's AWS instance type (e.g., 'g4dn.xlarge').
name (string): Name of the production instance.
status (string): Current status of the instance. Possible values:
launching: Instance is being launched
active: Instance is running
stopping: Instance is being stopped
stopped: Instance is stopped
starting: Instance is starting
deleting: Instance is being deleted
failed: Instance creation or operation failed
password (string): The administrator user's password for Microsoft Windows.
privateIp (string): Private (internal) IP address of the instance.
publicIp (string): Public IP address of the instance.
dnsName (string): DNS hostname assigned to the instance.
additionalStorageSize (number|null): Size of additional storage assigned to the instance in GB, if any.
errorMessage (string|null): Error message if instance is in failed state, null otherwise.
createdAt (number): The Unix timestamp (in seconds) indicating when the production instance was initially created.
updatedAt (number): The Unix timestamp (in seconds) indicating the last time the production instance was updated.
This endpoint enables the creation of a new production instance.
\nname (string): The name of the production instance.
clusterId (string, optional): Identifier of the cluster to which the instance will belong. Required only if the instance is associated with a cluster.
region (string): The AWS region code where the Production Instance will be created. (e.g. us-east-1) Required only if the instance is NOT associated with a cluster. A list of available options can be found on AWS's website
Note: Available regions may be restricted in VVCR organization settings, and certain regions are incompatible with VVCR. Use the List Account Regions end point to retrieve a list of available regions in the current VVCR organization.
\nvpcId (string, optional): The AWS VPC ID for the instance. Required only if the instance is NOT associated with a cluster.
password (string): The password for the instance.
Minimum length: 4 characters
\nMust contain at least one uppercase letter
\nMust contain at least one lowercase letter
\nMust contain at least one digit
\nMust contain at least one special character (e.g., +, -, _, #, !)
instanceType (string): The instance type for the production. Available options:
G4 family: g4dn.xlarge, g4dn2.xlarge, g4dn4.xlarge, g4dn8.xlarge
G5 family: g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge
additionalStorageSize (number, optional): Additional storage size for the instance in GB (optional).
If you are creating a production instance associated with a cluster, you must provide clusterId. In this case, region and vpcId are not required.
If you are creating a production instance that is not associated with a cluster, you must provide region and vpcId instead of clusterId.
Once your production instance is in \"active\" status, you can connect to it using either RDP (Remote Desktop Protocol) or NICE DCV Client.
\nUse any RDP client (Remote Desktop Connection on Windows, Microsoft Remote Desktop on macOS)
\nConnect to the instance using:
\nHostname: Use the dnsName or publicIp from the instance details
Username: Administrator
Password: The password you specified during instance creation
\nPort: 3389 (default RDP port)
\nDownload and install NICE DCV Client from the official website
\nLaunch NICE DCV Client and connect using:
\nServer URL: dnsName or publicIp
Username: Administrator
Password: The password you specified during instance creation
\nPort: 8443 (default NICE DCV port)
\nA JSON object containing details about the created production instance.
\n","urlObject":{"path":["production-instances"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[]}},"response":[{"id":"9e11eb6e-3b6f-4e33-8498-ab01f43f9f65","name":"201 Created - Create Production Instance in cluster","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"sample-production-instance\",\n \"clusterId\": \"a9f2d41c-b2c9-4b0d-855b-76788378a71d\",\n \"region\": null,\n \"vpcId\": null,\n \"password\": \"password\",\n \"instanceType\": \"g4dn.xlarge\",\n \"additionalStorageSize\": 100\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/production-instances"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"96609a13-e3e3-4159-945b-9b18af43076e\",\n \"clusterId\": \"a9f2d41c-b2c9-4b0d-855b-76788378a71d\",\n \"region\": \"us-east-2\",\n \"vpcId\": \"vpc-002e6662439d6d6ae\",\n \"instanceType\": \"g4dn.xlarge\",\n \"name\": \"sample-production-instance\",\n \"status\": \"launching\",\n \"password\": \"password\",\n \"privateIp\": null,\n \"publicIp\": null,\n \"dnsName\": null,\n \"additionalStorageSize\": 100,\n \"errorMessage\": null,\n \"createdAt\": 1736186020968,\n \"updatedAt\": 1736186020968\n}"},{"id":"74f71746-ff61-4b1b-ac71-6e11638fc3c6","name":"201 Created - Create Production Instance without cluster","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"sample-production-instance\",\n \"region\": \"us-east-2\",\n \"vpcId\": \"vpc-002e6662439d6d6ae\",\n \"password\": \"password\",\n \"instanceType\": \"g4dn.xlarge\",\n \"additionalStorageSize\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/production-instances"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2ada65ac-6366-468e-880e-0bd8ceb84447\",\n \"clusterId\": null,\n \"region\": \"us-east-2\",\n \"vpcId\": \"vpc-002e6662439d6d6ae\",\n \"instanceType\": \"g4dn.xlarge\",\n \"name\": \"sample-production-instance\",\n \"status\": \"launching\",\n \"password\": \"password\",\n \"privateIp\": null,\n \"publicIp\": null,\n \"dnsName\": null,\n \"additionalStorageSize\": null,\n \"errorMessage\": null,\n \"createdAt\": 1736186138326,\n \"updatedAt\": 1736186138326\n}"}],"_postman_id":"c8fd0375-131d-458b-a91a-89e6a7a703df"},{"name":"Get Production Instance","id":"73919f3e-8f56-437f-b246-15d4f3078ff6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/production-instances/:id","description":"This endpoint allows the retrieval of the information about a specific production instance identified by the provided :id, along with all associated metadata.
No request body is required for this endpoint.
\nThe response to this request is a production instance JSON object with the following properties:
\nid (string): Unique identifier of the production instance.
clusterId (string|null): Identifier of the cluster if the instance belongs to one, null otherwise.
region (string): AWS region where the instance is deployed.
vpcId (string): Identifier of the VPC where the instance is deployed.
instanceType (string): Production instance's AWS instance type (e.g., 'g4dn.xlarge').
name (string): Name of the production instance.
status (string): Current status of the instance. Possible values:
launching: Instance is being launched
active: Instance is running
stopping: Instance is being stopped
stopped: Instance is stopped
starting: Instance is starting
deleting: Instance is being deleted
failed: Instance creation or operation failed
password (string): The administrator user's password for Microsoft Windows.
privateIp (string): Private (internal) IP address of the instance.
publicIp (string): Public IP address of the instance.
dnsName (string): DNS hostname assigned to the instance.
additionalStorageSize (number|null): Size of additional storage assigned to the instance in GB, if any.
errorMessage (string|null): Error message if instance is in failed state, null otherwise.
createdAt (number): The Unix timestamp (in seconds) indicating when the production instance was initially created.
updatedAt (number): The Unix timestamp (in seconds) indicating the last time the production instance was updated.
This endpoint allows to start a specific production instance identified by the provided :id.
No request body is required for this endpoint.
\nA JSON object containing details about the production instance being started.
\n","urlObject":{"path":["production-instances",":id","start"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"ce56a61b-ee13-4b21-b5ab-3d0d08124d2d","name":"200 OK - Start Production Instance","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.vvcr.tv/v1/production-instances/:id/stop","host":["https://api.vvcr.tv/v1"],"path":["production-instances",":id","stop"],"variable":[{"key":"id","value":"96609a13-e3e3-4159-945b-9b18af43076e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"96609a13-e3e3-4159-945b-9b18af43076e\",\n \"clusterId\": \"a9f2d41c-b2c9-4b0d-855b-76788378a71d\",\n \"region\": \"us-east-2\",\n \"vpcId\": \"vpc-002e6662439d6d6ae\",\n \"instanceType\": \"g4dn.xlarge\",\n \"name\": \"sample-production-instance-2\",\n \"status\": \"starting\",\n \"password\": \"password\",\n \"privateIp\": \"172.1.1.1\",\n \"publicIp\": \"8.8.8.8\",\n \"dnsName\": \"sample-production-instance-2.apiorg.vvcr.live\",\n \"additionalStorageSize\": 100,\n \"errorMessage\": null,\n \"createdAt\": 1736186020968,\n \"updatedAt\": 1736186185072\n}"}],"_postman_id":"635d5e4a-44c7-42e7-9f66-20a10fdbdd4b"},{"name":"Stop Production Instance","id":"870a8dc8-8f53-431a-a8d0-131f984b635c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/production-instances/:id/stop","description":"This endpoint allows to stop a specific production instance identified by the provided :id.
No request body is required for this endpoint.
\nA JSON object containing details about the production instance being stopped.
\n","urlObject":{"path":["production-instances",":id","stop"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"e09e1988-9378-4428-9986-2b4925c491fa","name":"200 OK - Stop Production Instance","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.vvcr.tv/v1/production-instances/:id/stop","host":["https://api.vvcr.tv/v1"],"path":["production-instances",":id","stop"],"variable":[{"key":"id","value":"96609a13-e3e3-4159-945b-9b18af43076e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"96609a13-e3e3-4159-945b-9b18af43076e\",\n \"clusterId\": \"a9f2d41c-b2c9-4b0d-855b-76788378a71d\",\n \"region\": \"us-east-2\",\n \"vpcId\": \"vpc-002e6662439d6d6ae\",\n \"instanceType\": \"g4dn.xlarge\",\n \"name\": \"sample-production-instance-2\",\n \"status\": \"stopping\",\n \"password\": \"password\",\n \"privateIp\": \"172.1.1.1\",\n \"publicIp\": \"8.8.8.8\",\n \"dnsName\": \"sample-production-instance-2.apiorg.vvcr.live\",\n \"additionalStorageSize\": 100,\n \"errorMessage\": null,\n \"createdAt\": 1736186020968,\n \"updatedAt\": 1736186185072\n}"}],"_postman_id":"870a8dc8-8f53-431a-a8d0-131f984b635c"},{"name":"Delete Production Instance","id":"b8a9e9fa-c44c-43c3-8276-e6bf2109d0e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.vvcr.tv/v1/production-instances/:id","description":"This endpoint enables the deletion of a specific production instance identified by the provided :id.
No request body is required for this endpoint.
\nA JSON object containing details about the production instance that is being deleted.
\n","urlObject":{"path":["production-instances",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"38e0157e-23b9-4cd0-bdf1-8baeb312f97d","name":"200 OK - Delete Production Instance","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.vvcr.tv/v1/production-instances/:id","host":["https://api.vvcr.tv/v1"],"path":["production-instances",":id"],"variable":[{"key":"id","value":"96609a13-e3e3-4159-945b-9b18af43076e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"96609a13-e3e3-4159-945b-9b18af43076e\",\n \"clusterId\": \"a9f2d41c-b2c9-4b0d-855b-76788378a71d\",\n \"region\": \"us-east-2\",\n \"vpcId\": \"vpc-002e6662439d6d6ae\",\n \"instanceType\": \"g4dn.xlarge\",\n \"name\": \"sample-production-instance-2\",\n \"status\": \"deleting\",\n \"password\": \"password\",\n \"privateIp\": \"172.1.1.1\",\n \"publicIp\": \"8.8.8.8\",\n \"dnsName\": \"sample-production-instance-2.apiorg.vvcr.live\",\n \"additionalStorageSize\": 100,\n \"errorMessage\": null,\n \"createdAt\": 1736186020968,\n \"updatedAt\": 1736186185072\n}"}],"_postman_id":"b8a9e9fa-c44c-43c3-8276-e6bf2109d0e9"}],"id":"5a112886-465e-4927-8ef6-879e8de75110","_postman_id":"5a112886-465e-4927-8ef6-879e8de75110","description":""},{"name":"Clip&Post","item":[{"name":"List Clips","id":"e1e10899-9db7-41ac-9ebe-90d67be4fced","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/clips","description":"This endpoint allows the retrieval of a list of all clips currently available in the organization, along with all associated metadata.
\nNo request body is required for this endpoint.
\nThe response to this request is a JSON array that contains clip objects with the following properties:
\nid (string): Unique identifier of the clip.
name (string): Name of the clip.
filename (string): Clip's filename.
dvrId (string): Identifier of the source DVR video.
startPoint (float): Time offset in seconds from the beginning of the source DVR video, indicating the clip's start marker. Note: decimal numbers can be used for frame-precise clip trimming.
endPoint (float): Time offset in seconds from the beginning of the source DVR video, indicating the clip's end marker. Note: decimal numbers can be used for frame-precise clip trimming.
status (string): Current status of the clip. Possible values:
initializing: Clip creation is being set up
processing: Clip is being generated
completed: Clip has been successfully created
failed: Clip creation failed
createdAt (number): The Unix timestamp (in seconds) indicating when the clip was initially created.
updatedAt (number): The Unix timestamp (in seconds) ) indicating the last time the clip was updated.
This endpoint allows the creation of a new clip from a DVR video.
\nJSON object with the following properties:
\ndvrId (string, required): Unique identifier of the source DVR recording.
name (string, required): Name for the clip.
filename (string, required): Base filename for the clip (.mp4 extension will be added automatically).
startPoint (number, required): Time offset in seconds from the beginning of the source DVR video, indicating the clip's start marker. Note: decimal numbers can be used for frame-precise clip trimming.
endPoint (number, required): Time offset in seconds from the beginning of the source DVR video, indicating the clip's end marker. Note: decimal numbers can be used for frame-precise clip trimming.
A JSON object containing details about the created clip.
\n","urlObject":{"path":["clips"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[]}},"response":[{"id":"d9599f3e-f964-4709-a523-a0c5283fa6b4","name":"201 Created - Created Clip","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dvrId\": \"56525eac-f0fb-424b-bb07-82aa55799586\",\n \"name\": \"sample-clip\",\n \"filename\": \"sample-clip-file\",\n \"startPoint\": 10,\n \"endPoint\": 30\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vvcr.tv/v1/clips"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58109c48-01c8-4a01-9508-d7535e000c20\",\n \"name\": \"sample-clip\",\n \"filename\": \"sample-clip-file.mp4\",\n \"dvrId\": \"56525eac-f0fb-424b-bb07-82aa55799586\",\n \"startPoint\": 10,\n \"endPoint\": 30,\n \"status\": \"initializing\",\n \"createdAt\": 1736956602888,\n \"updatedAt\": 1736956602888\n}"}],"_postman_id":"819aee54-acf4-48e3-80f7-98f56e8201bc"},{"name":"Get Clip","id":"1e412ae7-544b-481e-9e08-d2430e693d4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.vvcr.tv/v1/clips/:id","description":"This endpoint allows the retrieval of the information about a specific clip identified by the provided :id, along with all associated metadata.
No request body is required for this endpoint.
\nThe response to this request is a clip JSON object with the following properties:
\nid (string): Unique identifier of the clip.
name (string): Name of the clip.
filename (string): Clip's filename.
dvrId (string): Identifier of the source DVR video.
startPoint (float): Time offset in seconds from the beginning of the source DVR video, indicating the clip's start marker. Note: decimal numbers can be used for frame-precise clip trimming.
endPoint (float): Time offset in seconds from the beginning of the source DVR video, indicating the clip's end marker. Note: decimal numbers can be used for frame-precise clip trimming.
status (string): Current status of the clip. Possible values:
initializing: Clip creation is being set up
processing: Clip is being generated
completed: Clip has been successfully created
failed: Clip creation failed
createdAt (number): The Unix timestamp (in seconds) indicating when the clip was initially created.
updatedAt (number): The Unix timestamp (in seconds) ) indicating the last time the clip was updated.
This endpoint enables the retrieval of the download link for a specific clip identified by the provided :id.
No request body is required for this endpoint.
\nA raw HTTP URL for downloading the clip file.
\n","urlObject":{"path":["clips","link",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"bb7ada5d-874b-44a4-9a9e-f9a7a07e8963","name":"200 OK - Get Clip Link","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.vvcr.tv/v1/clips/link/:id","host":["https://api.vvcr.tv/v1"],"path":["clips","link",":id"],"variable":[{"key":"id","value":"58109c48-01c8-4a01-9508-d7535e000c20"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"https://apitest-clips.vvcr-team.vvcr.live/clip-file-1736956603.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAV5AJYCN7MTZIDJ7Z/20250115/us-east-2/s3/aws4_request&X-Amz-Date=20250115T155908Z&X-Amz-Expires=300&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEDgaCXVzLWVhc3QtMiJHMEUCIB0RtH1zxOG4e8Q%2BKHGo6aAD3T7qBNDU%2B2jjA81XGZTOAiEA4V2DSHxycIyoHiSLZt7sEKkfnLO45QX9Mbjk4%2Bdu64cqoQIIMRAAGgw0MDU4OTQ4NjE2OTQiDGuMsHgERaLSTTVvZCr%2BAZ/rpsQx1ZykFWzLgIjBDCj4WxFe0ntUJHSfrUvK4iVpQ9xhfenlgA0chXsGee/gyhs8MGC/PvEZBkg92uENJoOET%2Br8XaOiYwrth9A6eP0toY2DAFEYmV5RYudKXgsCNsTM1PVanPxxqGApTLgDO8F0f8nl6MFZN9bXLbue9abtNwQN/AK2AwCKa3slzscrYbiFoYgm9UvqSOektDEeV%2BVgQoF6thZ9uw7bbzugDYZ%2Bp5COCRdVklgixqUVgTPVECSwLi9NsZdznQMIWVVT0RyYOvRmYSFJ1cRWqiCG0qHl9t85J6Drb0fmcmOBI07rpBRamO7monS%2BWpTSBUZRMMy2n7wGOp0BVW0W4wyjvCEHPkhlKxZB/9HE1Rl8l64DTAZKOQI/Ykimz3B12ANgUnaHr%2BxapHifSa0omOGdQhpIEyR23gqws0I1EeTG0slSr1zESGd6Tt9/JpoTO6USmEmKxmAgNaZVT0d2a1334mmMUL7H%2BbJcJ2pHVnufwZpPVNW7hfiyBNdq4gRc%2BPnggFWidQW97OwqvZP5UhsgBFqSOhHqUA%3D%3D&X-Amz-Signature=60edd31adf5ab93334121900421600a33cdfedb92b94b8312ac49821b7b5ceba&X-Amz-SignedHeaders=host"}],"_postman_id":"0deae346-19e1-46f5-8588-ccb09df4c86d"},{"name":"Update Clip","id":"abecdb58-9483-4852-8355-5cd7ae03c75e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"dvrId\": \"This endpoint enables the modification of a clip identified by the specified :id.
JSON object with the following properties:
\nname (string, optional): New name for the clip.
filename (string, optional): New base filename for the clip (.mp4 extension will be added automatically).
startPoint (number, optional): New time offset in seconds from the beginning of the source DVR video, indicating the clip's start marker. Note: decimal numbers can be used for frame-precise clip trimming.
endPoint (number, optional): New time offset in seconds from the beginning of the source DVR video, indicating the clip's end marker. Note: decimal numbers can be used for frame-precise clip trimming.
A JSON object containing details about the updated clip.
\n","urlObject":{"path":["clips",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"92c112b0-494f-4737-b52d-63ebb817ab9c","name":"200 OK - Update Clip","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"dvrId\": \"56525eac-f0fb-424b-bb07-82aa55799586\",\n \"name\": \"sample-clip\",\n \"filename\": \"sample-clip-file.mp4\",\n \"startPoint\": 10,\n \"endPoint\": 20\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.vvcr.tv/v1/clips/:id","host":["https://api.vvcr.tv/v1"],"path":["clips",":id"],"variable":[{"key":"id","value":"58109c48-01c8-4a01-9508-d7535e000c20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58109c48-01c8-4a01-9508-d7535e000c20\",\n \"name\": \"sample-clip\",\n \"filename\": \"sample-clip-file.mp4\",\n \"dvrId\": \"56525eac-f0fb-424b-bb07-82aa55799586\",\n \"startPoint\": 10,\n \"endPoint\": 20,\n \"status\": \"initializing\",\n \"createdAt\": 1736956602888,\n \"updatedAt\": 1736956839953\n}"}],"_postman_id":"abecdb58-9483-4852-8355-5cd7ae03c75e"},{"name":"Delete Clip","id":"edf1cf2d-860f-47e3-a890-c9941dc92612","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.vvcr.tv/v1/clips/:id","description":"This endpoint enables the deletion of a specific clip identified by the provided :id.
No request body is required for this endpoint.
\nA JSON object containing details about the clip that is being deleted.
\n","urlObject":{"path":["clips",":id"],"host":["https://api.vvcr.tv/v1"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"d87571a4-1859-4774-935e-4dd8125bd99c","name":"200 OK - Delete Clip","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.vvcr.tv/v1/clips/:id","host":["https://api.vvcr.tv/v1"],"path":["clips",":id"],"variable":[{"key":"id","value":"58109c48-01c8-4a01-9508-d7535e000c20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"58109c48-01c8-4a01-9508-d7535e000c20\",\n \"name\": \"sample-clip\",\n \"filename\": \"sample-clip-file.mp4\",\n \"dvrId\": \"56525eac-f0fb-424b-bb07-82aa55799586\",\n \"startPoint\": 10,\n \"endPoint\": 20,\n \"status\": \"processing\",\n \"createdAt\": 1736956602888,\n \"updatedAt\": 1736956839953\n}"}],"_postman_id":"edf1cf2d-860f-47e3-a890-c9941dc92612"}],"id":"5859e8c5-92db-4d4c-838c-080c531af916","_postman_id":"5859e8c5-92db-4d4c-838c-080c531af916","description":""}],"event":[{"listen":"prerequest","script":{"id":"4f755d67-53a3-469d-b22b-c904875c37a5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9bc17fe9-cf6a-4606-bbd9-b804a4e1db1a","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.vvcr.tv/v1"},{"key":"token","value":"","type":"string"},{"key":"client_id","value":"","type":"default"},{"key":"client_secret","value":"","type":"default"}]}