> This page is for Beam.

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

# List Interfaces

GET https://app.mk.io/api/interfaces/

Return available interfaces grouped by type.

Reference: https://mediakind.ferndocs.com/beam/api/channels/interfaces/list-interfaces

## Authentication

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

## Response

### 200

Successful Response

- `ip` (list of IpInterface, optional, default: [])
- `sdi` (list of InterfacesResponseSdiItems, optional, default: [])
- `asi` (list of SlotPortInterface, optional, default: [])
- `rf_demod` (list of SlotPortInterface, optional, default: [])
- `rf_modulator` (list of RfModulatorInterface, optional, default: [])
- `cam` (list of CamSlotInterface, optional, default: [])
- `st2110` (list of IpInterface, optional, default: [])

## Types

### IpInterface

- `name` (string, required)
- `ipAddresses` (list of string, required)
- `displayName` (string, required)
- `type` (string, optional, default: IP)

### InterfacesResponseSdiItems

- `type`: `SDIASI` (SdiSlotPortInterface)
  - `caps` (SdiCaps, required)
  - `displayName` (string, required)
  - `name` (string, required)
  - `url` (string, required)

### SlotPortInterface

- `name` (string, required)
- `type` (enum, required)
  - Allowed values: `SDIASI`, `RF_DEMOD`, `CAM`
- `url` (string, required)
- `displayName` (string, required)

### RfModulatorInterface

RF output always routes to the modulator — there's never a choice of interface, so an entry carries no identity, only presence. There is at most one entry in the list, regardless of what hardware reports.

- `type` ("RF_MODULATOR", optional, default: RF_MODULATOR)

### CamSlotInterface

A DVB-CI (CAM) slot. Unlike SDI/ASI/RF-demod, CP has no chassis-slot + port addressing for CAM — its wire-format camSlot is a single flat, 1-indexed integer (confirmed against content-processing's own CiDescrambler/hardware-scan code), so this does not reuse SlotPortInterface's two-number slot_X_port_Y convention. `name`/`url`/`type`/`displayName` all lean into "cam" rather than CP's own "slot" wire vocabulary — the wizard team's preference. `url` is opaque from the API user's perspective, same as SDI/ASI/RF-demod: enumerate this list, pick one, send its `url` back verbatim as `DecryptConfig.camUrl` — no parsing/interpretation by the caller. channels-api parses the trailing number back out server-side (services/blocks/cp.py) to build CP's own "slotN" wire value — `cam2` here always means CP's internal `slot2` (CP calls it that in its own config, daemon logs, and Advanced UI), same number, different word. Worth knowing when cross-referencing a raw CP config/log against this API's output.

- `name` (string, required)
- `url` (string, required)
- `displayName` (string, required)
- `type` ("CAM", optional, default: CAM)

### SdiCaps

- `type` (enum, required)
  - Allowed values: `3G`, `12G`, `Unknown`

## Examples

**Response**

```json
{
  "ip": [
    {
      "name": "string",
      "ipAddresses": [
        "string"
      ],
      "displayName": "string",
      "type": "IP"
    }
  ],
  "sdi": [
    {
      "type": "SDIASI",
      "caps": {
        "type": "3G"
      },
      "displayName": "string",
      "name": "string",
      "url": "string"
    }
  ],
  "asi": [
    {
      "name": "string",
      "type": "SDIASI",
      "url": "string",
      "displayName": "string"
    }
  ],
  "rf_demod": [
    {
      "name": "string",
      "type": "SDIASI",
      "url": "string",
      "displayName": "string"
    }
  ],
  "rf_modulator": [
    {
      "type": "RF_MODULATOR"
    }
  ],
  "cam": [
    {
      "name": "string",
      "url": "string",
      "displayName": "string",
      "type": "CAM"
    }
  ],
  "st2110": [
    {
      "name": "string",
      "ipAddresses": [
        "string"
      ],
      "displayName": "string",
      "type": "IP"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://app.mk.io/api/interfaces/"

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

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

print(response.json())
```

```javascript
const url = 'https://app.mk.io/api/interfaces/';
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://app.mk.io/api/interfaces/"

	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://app.mk.io/api/interfaces/")

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://app.mk.io/api/interfaces/")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.mk.io/api/interfaces/', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://app.mk.io/api/interfaces/");
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://app.mk.io/api/interfaces/")! 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()
```