...

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/push/sound_off HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 48
Content-Type: application/json

{
	"mediaSessionId": "gocrv1ncahlkcqht9k2nbs8tbc"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Mon, 03 Jul 2017 09:12:25 GMT

/pull/rtmp/pull

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/pull/rtmp/pull HTTP/1.1
Host: 192.168.1.101:8081
Content-Type: application/json;charset=UTF-8
Content-Length: 60

{
	"uri":"rtmp://rtmp.flashphoner.com:1935/live/rtmp_stream1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Thu, 23 Nov 2017 09:47:23 GMT

/pull/rtmp/find_all

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/pull/rtmp/find_all HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 0
Content-Type: application/json

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json;charset=UTF-8
Date: Fri, 24 Nov 2017 14:27:35 GMT

[
	{
		"localMediaSessionId":"69695ed6-6e78-455c-9fee-ae1af8d4a0b5",
		"remoteMediaSessionId":null,
		"localStreamName":"rtmp://rtmp.flashphoner.com:1935/live/stream1",
		"remoteStreamName":null,
		"uri":"rtmp://rtmp.flashphoner.com:1935/live/stream1",
		"status":"PROCESSED_REMOTE"
	},{
		"localMediaSessionId":"dfae1a1c-f99b-4e56-9f19-7dc7903ede8d",
		"remoteMediaSessionId":null,
		"localStreamName":"rtmp://wowzaec2demo.streamlock.net/vod/mp4:BigBuckBunny_115k.mov",
		"remoteStreamName":null,
		"uri":"rtmp://wowzaec2demo.streamlock.net/vod/mp4:BigBuckBunny_115k.mov",
		"status":"PROCESSED_REMOTE"
	}
]

/pull/rtmp/terminate

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/pull/rtmp/terminate HTTP/1.1
Host: 192.168.1.101:8081
Content-Type: application/json;charset=UTF-8
Content-Length: 60

{
	"uri":"rtmp://rtmp.flashphoner.com:1935/live/rtmp_stream1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Thu, 23 Nov 2017 09:47:31 GMT

/mixer/startup

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/mixer/startup HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 70

{
	"uri": "mixer://mixer1",
	"localStreamName": "mixer1_stream"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Fri, 24 Nov 2017 14:55:26 GMT

/mixer/add

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/mixer/add HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 99

{
	"uri": "mixer://mixer1",
	"remoteStreamName": "rtmp://rtmp.flashphoner.com:1935/live/stream1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Fri, 24 Nov 2017 15:21:06 GMT

/mixer/remove

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/mixer/remove HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 99

{
	"uri": "mixer://mixer1",
	"remoteStreamName": "rtmp://rtmp.flashphoner.com:1935/live/stream1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Fri, 24 Nov 2017 15:21:12 GMT

/mixer/find_all

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/mixer/find_all HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 0

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json;charset=UTF-8
Date: Fri, 24 Nov 2017 15:01:23 GMT

[
	{
		"localMediaSessionId":"b38c284d-2d8c-4c1b-9a9b-c3049e5fe870",
		"remoteMediaSessionId":null,
		"localStreamName":"mixer2",
		"remoteStreamName":null,
		"uri":"mixer://mixer2",
		"status":"PROCESSED_LOCAL",
		"mediaSessions":[]
	},{
		"localMediaSessionId":"cafdd756-3451-4c0c-bf04-049cc2d5994a",
		"remoteMediaSessionId":null,
		"localStreamName":"mixer1_stream",
		"remoteStreamName":null,
		"uri":"mixer://mixer1",
		"status":"PROCESSED_LOCAL",
		"mediaSessions":[]
	}
]

/mixer/terminate

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/mixer/terminate HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 31

{
	"uri": "mixer://mixer1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Fri, 24 Nov 2017 14:55:35 GMT

/mixer/test/start

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/mixer/test/start HTTP/1.1
HOST: 192.168.1.101:8081
Content-type: application/json
Content-length: 107

{
	"feedingStreams": [
		"s1",
		"s2"
    ],
    "mixerCount": 3,
    "streamsInMixer": 1,
    "intervalInSeconds": 60
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Wed, 22 Aug 2018 08:53:26 GMT

...

/logger/enable_client_log

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/logger/enable_client_log HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 71

{
	"sessionId": "/127.0.0.1:57539/192.168.1.101:8443",
	"logLevel": "DEBUG"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Wed, 03 Sep 2018 06:58:40 GMT

/logger/disable_client_log

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/logger/disable_client_log HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 71

{
	"sessionId": "/127.0.0.1:57539/192.168.1.101:8443"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Wed, 03 Sep 2018 06:58:40 GMT

/cdn/show_nodes

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/show_nodes HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 0

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 224
Date: Thu, 06 Dec 2018 4:16:40 GMT


[
	{
        "globalState": "ACTIVE",
        "id": "192.168.1.64",
        "processingState": "NEW_STREAMS_ALLOWED",
        "role": "TRANSCODER"
    },
    {
        "globalState": "ACTIVE",
        "id": "192.168.1.39",
        "processingState": "NEW_STREAMS_ALLOWED",
        "role": "ORIGIN"
    }
]

/cdn/show_routes

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/show_routes HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 0

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 26
Date: Thu, 06 Dec 2018 4:16:40 GMT

{
    "0-192.168.1.5-0": "test"
}

/cdn/show_state

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/show_state HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 0

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 19
Date: Thu, 06 Dec 2018 8:26:44 GMT

[
	"NEW_STREAMS_ALLOWED"
]

/cdn/enforce_state

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/enforce_state HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 44

{
	"state": "GROUP_CONNECTIONS_ALLOWED"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Thu, 06 Dec 2018 8:36:30 GMT

/cdn/stream/show_routes

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/stream/show_routes HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 30

{
	"streamName":"test-profile1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 411
Date: Mon, 07 Jan 2018 4:16:40 GMT

{
    "REQUESTED-PROFILE": [
        "AUDIO{bitrate=0, codec='opus', rate=48000, channels=0}",
        "VIDEO{width=640, height=360, gop=90, fps=30, bitrate=0, codec='h264', codecImpl='OPENH264', quality=null}"
    ],
    "1-NEW-TRANSCODER-95.191.131.64": [],
    "2-PROXY-95.191.130.39": [
        "AUDIO{bitrate=0, codec='opus', rate=48000, channels=2}",
        "VIDEO{width=0, height=0, gop=null, fps=null, bitrate=0, codec='H264', codecImpl='null', quality=null}"
    ]
}

/cdn/stream/access_list/add

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/stream/access_list/add HTTP/1.1
Content-Type: application/json
Host: test.flashphoner.com:8081                            
Content-Length: 39                                
                                                  
{                                                 
	"keys": [                                     
		"key1",                                   
		"key2"                                    
    ],                                            
    "name": "test"                                
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json

/cdn/stream/access_list/remove

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/stream/access_list/remove HTTP/1.1
Content-Length: 32                                   
Content-Type: application/json                       
Host: test.flashphoner.com:8081                       
                                                     
{                                                    
	"keys": [                                        
		"key1"                                       
    ],                                               
    "name": "test"                                   
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json

/cdn/stream/access_list/print

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/stream/access_list/print HTTP/1.1
Content-Length: 15                                  
Content-Type: application/json                      
Host: test.flashphoner.com:8081                      
                                                    
{                                                   
	"name": "test"                                  
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK               
Access-Control-Allow-Origin: *
Content-Length: 8             
Content-Type: application/json
                              
[                             
    "key2"                    
]

/cdn/stream/access_list/delete

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/stream/access_list/delete HTTP/1.1
Content-Length: 15                                   
Content-Type: application/json                       
Host: test.flashphoner.com:8081                       
                                                     
{                                                    
	"name": "test"                                   
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json

/cdn/profile/add

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/profile/add HTTP/1.1
Content-Length: 502                                   
Content-Type: application/json                       
Host: test.flashphoner.com:8081                       
                                  
{
	"name": "-profile1",
	"profile": {
        "audio": {
            "type": "audio"
            "bitrate": 0,
            "channels": 0,
            "codec": "opus",
            "rate": 48000,
       	},
		"video": {
			"type": "video",
            "bitrate": 0,
            "codec": "h264",
            "codecImpl": "FF",
            "fps": 30,
            "gop": 90,
            "height": 360,
            "quality": 0,
            "width": 640
        }
	}
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json

/cdn/profile/modify

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/profile/modify HTTP/1.1
Content-Length: 15                                   
Content-Type: application/json                       
Host: test.flashphoner.com:8081                       
                                                     
{
	"name": "-profile1",
	"profile": {
		"video": {
			"bitrate": 400,
			"quality": 25
        }
	}
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json

/cdn/profile/print

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/profile/print HTTP/1.1
Content-Length: 0                                   
Content-Type: application/json                       
Host: test.flashphoner.com:8081

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json

[
	"-240p": {
	    "audio": {
	        "bitrate": 0,
	        "channels": 0,
	        "codec": "opus",
	        "rate": 48000,
	        "type": "audio"
	    },
	    "video": {
	        "bitrate": 0,
	        "codec": "h264",
	        "codecImpl": "FF",
	        "fps": 25,
	        "gop": 50,
	        "height": 240,
	        "preset": "veryfast",
	        "quality": 0,
	        "type": "video",
	        "width": 0
    	}
	},
	"-480p": {
	    "audio": {
	        "bitrate": 0,
	        "channels": 0,
	        "codec": "opus",
	        "rate": 48000,
	        "type": "audio"
	    },
	    "video": {
	        "bitrate": 0,
	        "codec": "h264",
	        "codecImpl": "FF",
	        "fps": 25,
	        "gop": 50,
	        "height": 480,
	        "preset": "veryfast",
	        "quality": 0,
	        "type": "video",
	        "width": 0
	    }
	}
]

/cdn/profile/remove

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/cdn/profile/remove HTTP/1.1
Content-Length: 15                                   
Content-Type: application/json                       
Host: test.flashphoner.com:8081                       
                                                     
{                                                    
	"name": "-profile1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json

/recorder/startup

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/recorder/startup HTTP/1.1
Content-Length: 52
Content-Type: application/json                       
Host: test.flashphoner.com:8081                       
                                                     
{
	"mediaSessionId": "5a072377-73c1-4caf-abd3"
		"config": {
			"fileTemplate": "{streamName}-{startTime}-{endTime}",
			"rotation": "20M"
		}
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json

/recorder/terminate

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/recorder/terminate HTTP/1.1
Content-Length: 26                                   
Content-Type: application/json                       
HOST: 192.168.1.101:8081
                                                     
{
	"mediaSessionId": "5a072377-73c1-4caf-abd3"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json

/recorder/find_all

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/recorder/find_all HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 0

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 125
Date: Thu, 06 Dec 2018 4:16:40 GMT

[
    {
        "fileName": "9c3e-test-1563776083752-{endTime}.mp4",
        "mediaSessionId": "5a072377-73c1-4caf-abd3"
    }
]

/transcoder/startup

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/transcoder/startup HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 83

{
	"uri": "transcoder://tcode1",
	"remoteStreamName": "test",
	"localStreamName": "testT",
	"encoder": {
		"width": 640,
		"height": 480,
		"keyFrameInterval": 30,
		"fps": 30
 	}
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Thu, 06 Dec 2018 4:16:40 GMT

/transcoder/find

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/transcoder/find HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 30

{
	"remoteStreamName": "test"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 286
Date: Thu, 06 Dec 2018 4:16:40 GMT

[
    {
        "localMediaSessionId": "42a92132-bcd1-4436-a96f-3fec36b32b37",
        "localStreamName": "testT",
        "remoteStreamName": "test",
        "uri": "transcoder://tcode1",
        "status": "PROCESSED_LOCAL",
        "hasAudio": true,
        "hasVideo": true,
        "record": false,
        "encoder": {
            "width": 640,
            "height": 480,
            "keyFrameInterval": 30,
            "fps": 30
        }
    }
]

/transcoder/find_all

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/transcoder/find_all HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 0

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 286
Date: Thu, 06 Dec 2018 4:16:40 GMT

[
    {
        "localMediaSessionId": "42a92132-bcd1-4436-a96f-3fec36b32b37",
        "localStreamName": "testT",
        "remoteStreamName": "test",
        "uri": "transcoder://tcode1",
        "status": "PROCESSED_LOCAL",
        "hasAudio": true,
        "hasVideo": true,
        "record": false,
        "encoder": {
            "width": 640,
            "height": 480,
            "keyFrameInterval": 30,
            "fps": 30
        }
    }
]

/transcoder/terminate

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/transcoder/terminate HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 30

{
	"uri":"transcoder://tcode1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Thu, 06 Dec 2018 4:16:40 GMT

/vod/startup

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/vod/startup HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 83

{
	"uri":"vod-live://sample.mp4"
	"localStreamName": "test"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Thu, 06 Dec 2018 4:16:40 GMT

/vod/find

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/vod/find HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 30

{
	"localStreamName": "test"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 286
Date: Thu, 06 Dec 2018 4:16:40 GMT

[
    {
        "localMediaSessionId": "29ec3236-1093-42bb-88d6-d4ac37af3ac0",
        "localStreamName": "test",
        "uri": "vod-live://sample.mp4",
        "status": "PROCESSED_LOCAL",
        "hasAudio": true,
        "hasVideo": true,
        "record": false
    }
]

/vod/find_all

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/vod/find_all HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 0

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 286
Date: Thu, 06 Dec 2018 4:16:40 GMT

[
    {
        "localMediaSessionId": "29ec3236-1093-42bb-88d6-d4ac37af3ac0",
        "localStreamName": "test",
        "uri": "vod-live://sample.mp4",
        "status": "PROCESSED_LOCAL",
        "hasAudio": true,
        "hasVideo": true,
        "record": false
    }
]

/vod/terminate

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/vod/terminate HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 30

{
	"uri":"vod://sample.mp4"
	"localStreamName": "test"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Thu, 06 Dec 2018 4:16:40 GMT

7

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 32

New Version 33

Key

/pull/rtmp/pull

/pull/rtmp/find_all

/pull/rtmp/terminate

/mixer/startup

/mixer/add

/mixer/remove

/mixer/find_all

/mixer/terminate

/mixer/test/start

/logger/enable_client_log

/logger/disable_client_log

/cdn/show_nodes

/cdn/show_routes

/cdn/show_state

/cdn/enforce_state

/cdn/stream/show_routes

/cdn/stream/access_list/add

/cdn/stream/access_list/remove

/cdn/stream/access_list/print

/cdn/stream/access_list/delete

/cdn/profile/add

/cdn/profile/modify

/cdn/profile/print

/cdn/profile/remove

/recorder/startup

/recorder/terminate

/recorder/find_all

/transcoder/startup

/transcoder/find

/transcoder/find_all

/transcoder/terminate

/vod/startup

/vod/find

/vod/find_all

/vod/terminate