> 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.

# Create uplink

POST https://device.example.com:443/cluster1/vos-api/uplink-hub/v1/uplinks
Content-Type: application/json

Create new uplink.

Reference: https://mediakind.ferndocs.com/harmonic/api/vos/uplink-hub/create-uplink

## Authentication

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

## Request

### Body (application/json)

This endpoint expects a com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkRequest.

- `id` (string, required) — Id of the uplink
- `ipAddress` (string, required) — IP address of the uplink
- `name` (string, required) — Display name of a uplink
- `publicIpAddress` (string, required) — Public IP address of the uplink
- `currentVersion` (string, optional) — Current version of cloudlink.
- `isInitialized` (boolean, optional) — [Obsoleted]whether the uplink is ready to be used by properly assigned the rank and name.
- `needToBeUpgraded` (boolean, optional) — [Obsoleted]whether the uplink is ready to be used by properly assigned the rank and name.
- `rank` (integer, optional) — Priority of Uplink. Auto assigned when uplink is created. It can be updated afterwards.
- `version` (string, optional) — Version which need to be upgraded to.

## Response

### 200

OK

### 201

Uplink Created

## Errors

### 400 Bad Request Error

Uplink Creation Failed

- `any`

### 401 Unauthorized Error

Unauthorized

- `any`

### 403 Forbidden Error

Forbidden

- `any`

### 404 Not Found Error

Not Found

- `any`

## Examples

### Example 1

**Request**

```json
{
  "id": "string",
  "ipAddress": "string",
  "name": "string",
  "publicIpAddress": "string"
}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks"

payload = {
    "id": "string",
    "ipAddress": "string",
    "name": "string",
    "publicIpAddress": "string"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"id":"string","ipAddress":"string","name":"string","publicIpAddress":"string"}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks"

	payload := strings.NewReader("{\n  \"id\": \"string\",\n  \"ipAddress\": \"string\",\n  \"name\": \"string\",\n  \"publicIpAddress\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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/uplink-hub/v1/uplinks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"string\",\n  \"ipAddress\": \"string\",\n  \"name\": \"string\",\n  \"publicIpAddress\": \"string\"\n}"

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.post("https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"string\",\n  \"ipAddress\": \"string\",\n  \"name\": \"string\",\n  \"publicIpAddress\": \"string\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks', [
  'body' => '{
  "id": "string",
  "ipAddress": "string",
  "name": "string",
  "publicIpAddress": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"id\": \"string\",\n  \"ipAddress\": \"string\",\n  \"name\": \"string\",\n  \"publicIpAddress\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "id": "string",
  "ipAddress": "string",
  "name": "string",
  "publicIpAddress": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```

### Example 2

**Request**

```json
{
  "id": "string",
  "ipAddress": "string",
  "name": "string",
  "publicIpAddress": "string"
}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks"

payload = {
    "id": "string",
    "ipAddress": "string",
    "name": "string",
    "publicIpAddress": "string"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"id":"string","ipAddress":"string","name":"string","publicIpAddress":"string"}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks"

	payload := strings.NewReader("{\n  \"id\": \"string\",\n  \"ipAddress\": \"string\",\n  \"name\": \"string\",\n  \"publicIpAddress\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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/uplink-hub/v1/uplinks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"string\",\n  \"ipAddress\": \"string\",\n  \"name\": \"string\",\n  \"publicIpAddress\": \"string\"\n}"

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.post("https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"string\",\n  \"ipAddress\": \"string\",\n  \"name\": \"string\",\n  \"publicIpAddress\": \"string\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks', [
  'body' => '{
  "id": "string",
  "ipAddress": "string",
  "name": "string",
  "publicIpAddress": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"id\": \"string\",\n  \"ipAddress\": \"string\",\n  \"name\": \"string\",\n  \"publicIpAddress\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "id": "string",
  "ipAddress": "string",
  "name": "string",
  "publicIpAddress": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```