> This page is for Harmonic.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# Get Cloud Source by pipeId

GET https://device.example.com:443/cluster1/vos-api/syndicate/v1/cloudsources/{pipeId}

Reference: https://mediakind.ferndocs.com/harmonic/api/vos/syndicate-cloud/get-cloud-source-by-pipe-id

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `pipeId` (string, required) — pipeId

## Response

### 200

OK

- `backupCallerModeConfig` (com.harmonicinc.vos.syndicate.cloud.hms.model.pipe.CallerModeConfig, optional)
- `backupIngress` (com.harmonicinc.vos.syndicate.cloud.hms.model.pipe.LrsIngress, optional)
- `callerModeConfig` (com.harmonicinc.vos.syndicate.cloud.hms.model.pipe.CallerModeConfig, optional)
- `connectionMode` (enum, optional)
  - Allowed values: `LISTENER`, `CALLER`
- `customDnsName` (string, optional)
- `groomingEndpoint` (com.harmonicinc.vos.syndicate.cloud.hms.model.pipe.GroomingEndpoint, optional)
- `ingress` (com.harmonicinc.vos.syndicate.cloud.hms.model.pipe.LrsIngress, optional)
- `labels` (list of string, optional)
- `maxOutputConnections` (integer, optional)
- `name` (string, optional)
- `pendingRestart` (boolean, optional)
- `pipeId` (string, optional)
- `profileId` (string, optional)
- `publicIpMode` (enum, optional)
  - Allowed values: `IPV4_ONLY`, `IPV6_ONLY`, `IPV4_IPV6`
- `redundancyMode` (string, optional)
- `resourceMode` (enum, optional)
  - Allowed values: `DEDICATED`, `SHARED`
- `state` (string, optional)
- `statistics` (com.harmonicinc.vos.syndicate.cloud.hms.model.statistics.CombinedLrsStatistics, optional)
- `streamConfig` (list of com.harmonicinc.vos.syndicate.cloud.hms.model.pipe.StreamSetting, optional)
- `version` (string, optional)

## Errors

### 400 Bad Request Error

Failed to return Cloud Source

- `any`

### 401 Unauthorized Error

Unauthorized

- `any`

### 403 Forbidden Error

Forbidden

- `any`

### 404 Not Found Error

No cloud source with specified pipeId

- `any`

### 422 Unprocessable Entity Error

Unprocessable entity to get Cloud Source

- `any`

### 424 Failed Dependency Error

Failed to get specific cloud source because of failed dependency

- `any`

## Types

### com.harmonicinc.vos.syndicate.cloud.hms.model.pipe.CallerModeConfig

- `address` (string, optional)
- `clientId` (string, optional)
- `crypto` (com.harmonicinc.vos.syndicate.cloud.hms.model.CryptoSetting, optional)
- `latency` (integer, optional)
- `port` (integer, optional)
- `sessionId` (string, optional)
- `streamId` (string, optional)

### com.harmonicinc.vos.syndicate.cloud.hms.model.pipe.LrsIngress

- `cryptoSetting` (com.harmonicinc.vos.syndicate.cloud.hms.model.CryptoSetting, optional)
- `customUrl` (string, optional)
- `platform` (string, optional)
- `privateUrl` (string, optional)
- `protocol` (string, optional)
- `region` (string, optional)
- `streamCount` (integer, optional)
- `url` (string, optional)

### com.harmonicinc.vos.syndicate.cloud.hms.model.pipe.GroomingEndpoint

- `cryptoSetting` (com.harmonicinc.vos.syndicate.cloud.hms.model.CryptoSetting, optional)
- `customUrl` (string, optional)
- `privateUrl` (string, optional)
- `url` (string, optional)

### com.harmonicinc.vos.syndicate.cloud.hms.model.statistics.CombinedLrsStatistics

- `backupSelected` (boolean, optional)
- `egressStatistics` (com.harmonicinc.vos.syndicate.cloud.hms.model.statistics.CombinedEgressStatistics, optional)
- `ingressStatistics` (com.harmonicinc.vos.syndicate.cloud.hms.model.statistics.CombinedIngressStatistics, optional)

### com.harmonicinc.vos.syndicate.cloud.hms.model.pipe.StreamSetting

- `egressConnectionLimit` (string, optional)
- `streamId` (string, optional)

### com.harmonicinc.vos.syndicate.cloud.hms.model.CryptoSetting

- `key` (string, optional)
- `method` (enum, optional)
  - Allowed values: `AES_128`, `AES_192`, `AES_256`, `NO_ENCRYPTION`

### com.harmonicinc.vos.syndicate.cloud.hms.model.statistics.CombinedEgressStatistics

- `egressSessionCount` (integer, optional)
- `egressThroughputInMbps` (double, optional)

### com.harmonicinc.vos.syndicate.cloud.hms.model.statistics.CombinedIngressStatistics

- `bitrate` (double, optional)
- `packetLost` (long, optional)
- `packetReceived` (long, optional)

## Examples

**Response**

```json
{
  "backupCallerModeConfig": {
    "address": "string",
    "clientId": "string",
    "crypto": {
      "key": "string",
      "method": "AES_128"
    },
    "latency": 1,
    "port": 1,
    "sessionId": "string",
    "streamId": "string"
  },
  "backupIngress": {
    "cryptoSetting": {
      "key": "string",
      "method": "AES_128"
    },
    "customUrl": "string",
    "platform": "string",
    "privateUrl": "string",
    "protocol": "string",
    "region": "string",
    "streamCount": 1,
    "url": "string"
  },
  "callerModeConfig": {
    "address": "string",
    "clientId": "string",
    "crypto": {
      "key": "string",
      "method": "AES_128"
    },
    "latency": 1,
    "port": 1,
    "sessionId": "string",
    "streamId": "string"
  },
  "connectionMode": "LISTENER",
  "customDnsName": "string",
  "groomingEndpoint": {
    "cryptoSetting": {
      "key": "string",
      "method": "AES_128"
    },
    "customUrl": "string",
    "privateUrl": "string",
    "url": "string"
  },
  "ingress": {
    "cryptoSetting": {
      "key": "string",
      "method": "AES_128"
    },
    "customUrl": "string",
    "platform": "string",
    "privateUrl": "string",
    "protocol": "string",
    "region": "string",
    "streamCount": 1,
    "url": "string"
  },
  "labels": [
    "string"
  ],
  "maxOutputConnections": 1,
  "name": "string",
  "pendingRestart": true,
  "pipeId": "string",
  "profileId": "string",
  "publicIpMode": "IPV4_ONLY",
  "redundancyMode": "string",
  "resourceMode": "DEDICATED",
  "state": "string",
  "statistics": {
    "backupSelected": true,
    "egressStatistics": {
      "egressSessionCount": 1,
      "egressThroughputInMbps": 1.1
    },
    "ingressStatistics": {
      "bitrate": 1.1,
      "packetLost": 1,
      "packetReceived": 1
    }
  },
  "streamConfig": [
    {
      "egressConnectionLimit": "string",
      "streamId": "string"
    }
  ],
  "version": "string"
}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/syndicate/v1/cloudsources/pipeId"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/syndicate/v1/cloudsources/pipeId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://device.example.com/cluster1/vos-api/syndicate/v1/cloudsources/pipeId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://device.example.com/cluster1/vos-api/syndicate/v1/cloudsources/pipeId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://device.example.com/cluster1/vos-api/syndicate/v1/cloudsources/pipeId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://device.example.com/cluster1/vos-api/syndicate/v1/cloudsources/pipeId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/syndicate/v1/cloudsources/pipeId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/syndicate/v1/cloudsources/pipeId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```