Media servers

PreviousDestroy NextStatus

Was this helpful?

List media servers

Retrieve a collection of media servers

get

/media_servers

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/media_servers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "name": "text",
      "enabled": true,
      "private_ipv4": "text",
      "private_ipv6": "text",
      "public_ipv4": "text",
      "public_ipv6": "text",
      "max_concurrency": 2000,
      "custom_options": "text",
      "type": "INTERNAL",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

Create a media server

post

/media_servers

Authorizations

Body

namestring · min: 1 · max: 64required

The name of media server.

enabledboolean · default: true

The activate status or deactivated status.

private_ipv4string

Host IPV4 address.

private_ipv6string

Host IPV6 address.

public_ipv4string

Host IPV4 address.

public_ipv6string

Host IPV6 address.

max_concurrencyinteger · int32 · min: 1 · default: 2000

Max concurrent sessions.

custom_optionsstring

Some custom configuration options serialized as json string

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/media_servers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "enabled": true,
    "private_ipv4": "text",
    "private_ipv6": "text",
    "public_ipv4": "text",
    "public_ipv6": "text",
    "max_concurrency": 2000,
    "custom_options": "text"
  }'

200

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created media server

Retrieve a media server

Retrieve a media server.

get

/media_servers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of media server.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/media_servers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "name": "text",
  "enabled": true,
  "private_ipv4": "text",
  "private_ipv6": "text",
  "public_ipv4": "text",
  "public_ipv6": "text",
  "max_concurrency": 2000,
  "custom_options": "text",
  "type": "INTERNAL",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Update a media server

post

/media_servers/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of media server.

The unique ID of the resource.

Body

enabledboolean · default: true

The activate status or deactivated status.

max_concurrencyinteger · int32 · min: 1 · default: 2000

Max concurrent sessions.

custom_optionsstring

Some custom configuration options serialized as json string

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/media_servers/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "enabled": true,
    "max_concurrency": 2000,
    "custom_options": "text"
  }'

200

4XX

No body