Media Server | PortSIP Knowledge Base

PortSIP Knowledge Base

Retrieve a media server

get

Retrieve a media server.

Authorizations

Path parameters

idall ofRequired

The unique ID of media server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

4XX

Error

get

GET /api/media_servers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Query media server Status

get

Query media server's status by it's ID

Authorizations

Path parameters

idall ofRequired

The unique ID of media server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

4XX

Error

get

GET /api/media_servers/{id}/status HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "current_concurrency": 1,
  "cpu_usage": 1,
  "memory_usage": 1,
  "status": "OFFLINE"
}

Delete a media server

post

Authorizations

Path parameters

idall ofRequired

The unique ID of media server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid server ID supplied.

post

POST /api/media_servers/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List media servers

get

Retrieve a collection of media servers

Authorizations

Query parameters

filterstringOptional

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

searchstringOptional

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

orderbystringOptional

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

skipinteger · int32Optional

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

Default: 0

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

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

Default: 100

Responses

200

application/json

4XX

Error

get

GET /api/media_servers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create a media server

post

Authorizations

Body

namestring · min: 1 · max: 64Required

The name of media server.

enabledbooleanOptional

The activate status or deactivated status.

Default: true

private_ipv4stringOptional

Host IPV4 address.

private_ipv6stringOptional

Host IPV6 address.

public_ipv4stringOptional

Host IPV4 address.

public_ipv6stringOptional

Host IPV6 address.

max_concurrencyinteger · int32 · min: 1Optional

Max concurrent sessions.

Default: 2000

custom_optionsstringOptional

Some custom configuration options serialized as json string

Responses

200

Created media server

application/json

4XX

Error

post

POST /api/media_servers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

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

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Update a media server

post

Update a media server

Authorizations

Path parameters

idall ofRequired

The unique ID of media server.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

enabledbooleanOptional

The activate status or deactivated status.

Default: true

max_concurrencyinteger · int32 · min: 1Optional

Max concurrent sessions.

Default: 2000

custom_optionsstringOptional

Some custom configuration options serialized as json string

Responses

200

4XX

Error

post

POST /api/media_servers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "enabled": true,
  "max_concurrency": 2000,
  "custom_options": "text"
}

No content