> This page is for mk.io.

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

PUT https://app.mk.io/api/v1/projects/{project_name}/media/sources/{name}
Content-Type: application/json

Create a source. To learn more about sources, read [Content and sources](doc:content-and-sources#sources).

RBAC Capability Required: `flow.source.create`

Reference: https://mediakind.ferndocs.com/mkio/api/media/sources/create-source

## Authentication

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

## Request

### Path parameters

- `project_name` (string, required)
- `name` (string, required)

### Body (application/json)

This endpoint expects a ContentSourceBody.

- `metadata` (DefaultMetadata, required) — Resource metadata.
- `spec` (ContentSourceBodySpec, required)

## Response

### 201

The created source

- `kind` (string, required) — The kind of record.
- `metadata` (MetadataSchema, required) — Source metadata.
- `spec` (ContentSourceBodySpec, required) — Source specification.
- `status` (ContentSourceStatusSchema, required) — Source status.

## Errors

### 400 Bad Request Error

Bad Request

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 401 Unauthorized Error

Unauthorized

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 403 Forbidden Error

Forbidden

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 404 Not Found Error

Not Found

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 409 Conflict Error

Conflict

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 429 Too Many Requests Error

Too Many Requests

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

### 500 Internal Server Error

Internal Server Error

- `error` (ErrorDetail, required) — Pertinent information about the error
- `ref` (string, required) — A reference to the request that caused the error.
- `status` (integer, required) — The HTTP status code

## Types

### DefaultMetadata

- `displayName` (string, required) — A human-readable name for the resource.
- `labels` (map from string to string, optional) — A dictionary of labels associated with the resource. Maximum number of labels: 32. Maximum length of a label or value: 256 characters. Label: alphanumeric, hyphens and underscores. Value: alphanumeric, hyphens, underscores and spaces.

### ContentSourceBodySpec

- `transport` (TransportSpecJsonFragment, required) — Details of the \<\<glossary:transport>> that the content will be carried on. To learn more about the kinds of transport that can be configured, read [Set up transports on sources and destinations](doc:set-up-transports). Most transport fields are set at creation. The source PATCH contract defines the fields that can be updated for each transport type.
- `contentName` (string, optional, nullable) — Name of the \<\<glossary:content>> that will be carried by this source. If omitted, the source can only be used via a direct sourceName reference in a flow input. Use source PATCH to change this association or set it to null to ungroup the source.
- `networkName` (string, optional) — Name of the \<\<glossary:network>> that this source is available on. Only \<\<glossary:flow>>s that can reach this network will be able to resolve content to this source; read about [Resolving content](doc:content-and-sources#resolving-content) to learn more. This field cannot be modified, only set during creation.

### MetadataSchema

- `id` (string, required) — The ID of the resource
- `created` (datetime, optional) — The time when the resource was created
- `createdBy` (string, optional) — ID of the user who created the resource
- `createdByEmail` (string, optional) — Email of the user who created the resource
- `displayName` (string, optional) — The display name of the resource
- `labels` (map from string to string, optional) — A dictionary of labels associated with the resource
- `name` (string, optional) — The name of the resource
- `updated` (datetime, optional) — The time when the resource was last updated
- `updatedBy` (string, optional) — ID of the user who last updated the resource
- `updatedByEmail` (string, optional) — Email of the user who last updated the resource

### ContentSourceStatusSchema

- `networkDisplayName` (string, optional) — The display name of the network this source is available on.
- `shortId` (string, optional) — An alternative short identifier for the source. This is used only for visual inspection and should not be used for any programmatic purposes.
- `state` (enum, optional, default: Inactive) — Indicates if the source is currently in use by any active \<\<glossary:flow>>s.
  - Allowed values: `Inactive`, `Active`
- `transport` (TransportStatusJsonFragment, optional) — Transport status information for the source.

### ErrorDetail

- `code` (string, required) — The error code.
- `detail` (string, required) — The error message.
- `extraDetail` (map from string to any, optional) — Extra information regarding this error.

### TransportSpecJsonFragment

- `type` (enum, required) — Type of transport. This field cannot be modified, only set during creation.
  - Allowed values: `UDP`, `SDI`, `SRTCaller`, `SRTListener`, `HLSPullInput`, `RTMPPushOutput`
- `allowList` (list of string, optional) — List of IP addresses that are allowed to connect, if the transport type supports it. The following transport types can use the `allowList` field: `SRTListener`.
- `encryptionStandard` (enum, optional, default: None) — Encryption standard for the transport, if the transport type supports it. The following transport types can use the `encryptionStandard` field: `SRTCaller`, `SRTListener`. This field cannot be modified, only set during creation.
  - Allowed values: `None`, `AES128`, `AES192`, `AES256`
- `ipResource` (IpResourceJsonFragment, optional) — Add an IP resource reservation for the transport. This is necessary for \<\<glossary:source>>s and \<\<glossary:destination>>s that need to access a \<\<glossary:SaaS site>> through a public IP address or public URL. The following transport types can use the `ipResource` field: `SRTListener`. This field cannot be modified, only set during creation.
- `latency` (double, optional, default: 0.5) — Minimum Latency, in seconds, for the transport, if the transport type supports it. The following transport types can use the `latency` field: `SRTCaller`, `SRTListener`. This field cannot be modified, only set during creation.
- `maxBitrate` (integer, optional, default: 30000000) — Maximum bitrate, in bits per second, expected through each individual connection to the Listener. The following transport types can use the `maxBitrate` field: `SRTCaller`, `SRTListener`. This field cannot be modified, only set during creation.
- `maxConnections` (integer, optional, default: 10) — Maximum number of connections for a Listener destination. Overrides the flow output maxConnections setting if present. The following transport types can use the `maxConnections` field: `SRTCaller`, `SRTListener`. This field cannot be modified, only set during creation.
- `maxOverheadBandwidth` (integer, optional, default: 100) — Maximum Overhead Bandwidth, as an integer (e.g., 100), for the transport, if the transport type supports it. The following transport types can use the `maxOverheadBandwidth` field: `SRTCaller`, `SRTListener`. This field cannot be modified, only set during creation.
- `passPhrase` (string, optional, default: ) — Password phrase for the transport, if the transport type supports it. The following transport types can use the `passPhrase` field: `SRTCaller`, `SRTListener`.
- `password` (string, optional) — Password for HLS pull authentication. For sources, this field can be updated via PATCH when the transport type is `HLSPullInput`. For all other transport types, it can only be set during creation.
- `port` (integer, optional, default: 5000) — Port for the transport, if the transport type supports it. The following transport types need the `port` field: `SRTListener`. This field cannot be modified, only set during creation.
- `streamId` (string, optional, default: ) — The SRT stream ID sent by the caller during the SRT handshake. Used by the listener to identify or route the stream. Optional. The following transport types can use the `streamId` field: `SRTCaller`. This field cannot be modified, only set during creation.
- `streamKey` (string, optional, default: ) — The RTMP stream key (appended to the URL when connecting). The following transport types need the `streamKey` field: `RTMPPushOutput`. This field cannot be modified, only set during creation.
- `url` (string, optional) — The URL for the transport, if the transport type supports it. The following transport types need the `url` field: `SRTCaller`, `UDP`, `SDI`, `HLSPullInput`, `RTMPPushOutput`. For sources, this field can be updated via PATCH when the transport type is `SRTCaller` or `HLSPullInput`. For all other transport types, and for destinations, it can only be set during creation.
- `user` (string, optional) — Username for HLS pull authentication. For sources, this field can be updated via PATCH when the transport type is `HLSPullInput`. For all other transport types, it can only be set during creation.
- `urls` (list of string, optional, deprecated) — DEPRECATED: Use `url` instead. This is provided for backwards compatibility and will be removed in a future release. If `urls` is used, only the first URL will be considered. If both `url` and `urls` are provided, `url` takes precedence.

### TransportStatusJsonFragment

- `urls` (list of string, optional) — The URLs configured or allocated/discovered for the transport. Where the `spec.transport.url` field is supported by the transport `type` (e.g. an SRTCaller), the `urls` field will contain that data. Where the system automatically allocates/discovers one or more URLs (e.g. an SRTListener), the `urls` field will contain that data.

### IpResourceJsonFragment

- `type` (enum, required) — Type of IP resource reservation: - `External` means reserve a public IP address, - `Internal` means reserve an internal IP address (please contact MediaKind personnel for usage), and - `None` means don't try to reserve an IP resource. Transports between on-prem devices don't need to explicitly reserve an IP address.
  - Allowed values: `None`, `External`, `Internal`

## Examples

**Request**

```json
{
  "metadata": {
    "displayName": "string"
  },
  "spec": {
    "transport": {
      "type": "UDP"
    }
  }
}
```

**Response**

```json
{
  "kind": "string",
  "metadata": {
    "id": "string",
    "created": "2024-01-15T09:30:00Z",
    "createdBy": "string",
    "createdByEmail": "string",
    "displayName": "string",
    "labels": {
      "label1": "value1",
      "label2": "value2"
    },
    "name": "string",
    "updated": "2024-01-15T09:30:00Z",
    "updatedBy": "string",
    "updatedByEmail": "string"
  },
  "spec": {
    "transport": {
      "type": "UDP",
      "allowList": [
        "string"
      ],
      "encryptionStandard": "None",
      "ipResource": {
        "type": "None"
      },
      "latency": 0.5,
      "maxBitrate": 30000000,
      "maxConnections": 10,
      "maxOverheadBandwidth": 100,
      "passPhrase": "",
      "password": "string",
      "port": 5000,
      "streamId": "",
      "streamKey": "",
      "url": "string",
      "user": "string",
      "urls": [
        "string"
      ]
    },
    "contentName": "sports1",
    "networkName": "internet"
  },
  "status": {
    "networkDisplayName": "string",
    "shortId": "string",
    "state": "Inactive",
    "transport": {
      "urls": [
        "string"
      ]
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://app.mk.io/api/v1/projects/project_name/media/sources/name"

payload = {
    "metadata": { "displayName": "string" },
    "spec": { "transport": { "type": "UDP" } }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://app.mk.io/api/v1/projects/project_name/media/sources/name';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"metadata":{"displayName":"string"},"spec":{"transport":{"type":"UDP"}}}'
};

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://app.mk.io/api/v1/projects/project_name/media/sources/name"

	payload := strings.NewReader("{\n  \"metadata\": {\n    \"displayName\": \"string\"\n  },\n  \"spec\": {\n    \"transport\": {\n      \"type\": \"UDP\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PUT", 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://app.mk.io/api/v1/projects/project_name/media/sources/name")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {\n    \"displayName\": \"string\"\n  },\n  \"spec\": {\n    \"transport\": {\n      \"type\": \"UDP\"\n    }\n  }\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.put("https://app.mk.io/api/v1/projects/project_name/media/sources/name")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {\n    \"displayName\": \"string\"\n  },\n  \"spec\": {\n    \"transport\": {\n      \"type\": \"UDP\"\n    }\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://app.mk.io/api/v1/projects/project_name/media/sources/name', [
  'body' => '{
  "metadata": {
    "displayName": "string"
  },
  "spec": {
    "transport": {
      "type": "UDP"
    }
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://app.mk.io/api/v1/projects/project_name/media/sources/name");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"metadata\": {\n    \"displayName\": \"string\"\n  },\n  \"spec\": {\n    \"transport\": {\n      \"type\": \"UDP\"\n    }\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "metadata": ["displayName": "string"],
  "spec": ["transport": ["type": "UDP"]]
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/projects/project_name/media/sources/name")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
```