Skip to content

Latest commit

 

History

History
136 lines (95 loc) · 3.09 KB

Streamer.md

File metadata and controls

136 lines (95 loc) · 3.09 KB
Raw

Streamer

Streamers are plugins which send extracted data elsewhere. Streamers must be registered within the system, making them available to Crawls.

Routes

/streamer GET

List Streamers.

https://github.com/tiredpixel/isoxya-api/blob/latest/bin/isoxya-api-list-streamer

Response parameters

Response parameters are as for /streamer/:streamer_id GET.

Response example

HTTP/1.1 200 OK
content-type: application/json
link: </streamer>; rel="first", </streamer?_next=2021-12-16T14:20:42.418362Z>; rel="next", </streamer?_prev=2021-12-16T14:20:42.418362Z>; rel="prev"
[
  {
    "channels": 1,
    "href": "/streamer/b49fcc24-6562-415a-94a6-3e8dcd848aac",
    "tag": "nginx",
    "url": "http://isoxya-plugin-nginx.localhost"
  }
]

/streamer POST

Create a Streamer.

https://github.com/tiredpixel/isoxya-api/blob/latest/bin/isoxya-api-create-streamer

Request parameters

Name Edition Type Description
channels Pro number? channels, used for scaling Streamers
tag string tag
url string plugin endpoint URL (absolute)

Response parameters

Response parameters are as for /streamer/:streamer_id GET.

Request example

POST /streamer HTTP/1.1
content-type: application/json
{
  "channels": null,
  "tag": "nginx",
  "url": "http://isoxya-plugin-nginx.localhost"
}

Response example

HTTP/1.1 201 Created
content-type: application/json
location: /streamer/b49fcc24-6562-415a-94a6-3e8dcd848aac
{
  "channels": 1,
  "href": "/streamer/b49fcc24-6562-415a-94a6-3e8dcd848aac",
  "tag": "nginx",
  "url": "http://isoxya-plugin-nginx.localhost"
}

/streamer/:streamer_id DELETE

Delete a Streamer.

https://github.com/tiredpixel/isoxya-api/blob/latest/bin/isoxya-api-delete

Response example

HTTP/1.1 204 No Content

/streamer/:streamer_id GET

Read a Streamer.

https://github.com/tiredpixel/isoxya-api/blob/latest/bin/isoxya-api-read

Response parameters

Name Edition Type Description
channels Pro number channels, used for scaling Streamers
href string Href
tag string tag
url string plugin endpoint URL (absolute)

Response example

HTTP/1.1 200 OK
content-type: application/json
{
  "channels": 1,
  "href": "/streamer/b49fcc24-6562-415a-94a6-3e8dcd848aac",
  "tag": "nginx",
  "url": "http://isoxya-plugin-nginx.localhost"
}