Back to top

bintu.live

Info

© 2016 nanocosmos gmbh

https://bintu.nanocosmos.de

bintu.live is a stream management platform used by nanoStream for end to end live streaming services.

bintu live can be used to create, manage, group and tag live streams.

Errors

400 - Parameter required

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Parameter required",
        "code" : 1002,
        "userinfo" : {
            "required_parameter" : "<parameter>"
        }
    }
}

400 - Parameter not unique

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Parameter not unique",
        "code" : 1003,
        "userinfo" : {
            "duplicated_parameter" : "<parameter>"
        }
    }
}

400 - Wrong Data Type

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Wrong Data Type",
        "code" : 1004,
        "userinfo" : {
            "parameter" : "<parameter>",
            "type" : "<type>"
        }
    }
}

400 - StreamTypeNotAvailableError

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Stream Type is not available",
        "code" : 3002,
        "userinfo" : {
            "stream_type" : "<stream_type>"
        }
    }
}

401 - User Credentials not valid

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "User Credentials are not valid",
        "code" : 4002,
        "userinfo" : {
            "user" : "<username>"
        }
    }
}

403 - Access denied

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message": "Access denied",
        "code": 2001
    }
}

403 - Organisation not enabled

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Organisation is not enabled",
        "code" : 6002,
        "userinfo" : {
            "organisation" : "<organisation_id>"
        }
    }
}

404 - Stream not found

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Stream not found",
        "code" : 3001,
        "userinfo" : {
            "stream" : "<stream_id>"
        }
    }
}

404 - User not found

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "User not found",
        "code" : 4001,
        "userinfo" : {
            "user" : "<username>"
        }
    }
}

404 - Invite Token not found

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Invite Token not found",
        "code" : 5001,
        "userinfo" : {
            "invite_token" : "<token>"
        }
    }
}

404 - Organisation not found

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Organisation not found",
        "code" : 6001,
        "userinfo" : {
            "Organisation" : "<organisation_id>"
        }
    }
}

404 - Api Key not found

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Api Key not found",
        "code" : 7001,
        "userinfo" : {
            "apikey" : "<key>"
        }
    }
}

404 - HLS Playout not found

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "HLS Playout not found",
        "code" : 8001,
        "userinfo" : {
            "hls_playout_id" : "<id>"
        }
    }
}

404 - RTMP Ingest not found

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "RTMP Ingest not found",
        "code" : 9001,
        "userinfo" : {
            "rtmp_ingest_id" : "<id>"
        }
    }
}

404 - RTMP Ingest for Stream not found

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "RTMP Ingest for Stream not found",
        "code" : 9002,
        "userinfo" : {
            "stream_name" : "<id>"
        }
    }
}

404 - Tag not found

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Tag not found",
        "code" : 10001,
        "userinfo" : {
            "tag" : "<tag>",
            "organisation" : "<organisation_name>"
        }
    }
}

404 - Log Record not found

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Log Record not found",
        "code" : 11001,
        "userinfo" : {
            "ip" : "<ip>",
            "protocol" : "<protocol>",
            "type" : "<type>"
        }
    }
}

404 - Password Token not found

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Password Token not found",
        "code" : 12001,
        "userinfo" : {
            "password_token" : "<token>"
        }
    }
}

409 - E-Mailadress is not unique

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "E-Mailadress is already in use",
        "code" : 4003,
        "userinfo" : {
            "email" : "<email>"
        }
    }
}

409 - Invite Token already redeemed

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Invite Token is already redeemed",
        "code" : 5002,
        "userinfo" : {
            "invite_token" : "<token>"
        }
    }
}

409 - Password Token expired

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Password Token is expired",
        "code" : 12002,
        "userinfo" : {
            "password_token" : "<token>"
        }
    }
}

409 - Password Token already redeemed

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error": {
        "message" : "Password Token is already redeemed",
        "code" : 12003,
        "userinfo" : {
            "password_token" : "<token>"
        }
    }
}

500 - Internal Server Error

  • Headers
Content-Type: application/json; charset=utf-8
  • Body
{
    "error" : {
        "message" : "Internal Server Error",
        "code": 1001
    }
}

Stream

Stream Info

public Stream Info
GET/stream/{id}

Example URI

GET /stream/9d9dc062-2bdc-4bee-8bef-4c56b9953b14
URI Parameters
HideShow
id
uuid (required) Example: 9d9dc062-2bdc-4bee-8bef-4c56b9953b14
Request  Stream state is created
HideShow
Headers
content-type: application/json
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": "9d9dc062-2bdc-4bee-8bef-4c56b9953b14",
  "state": "created",
  "type": "low-latency",
  "playout": {
    "rtmp": [],
    "hls": [],
    "web": []
  }
}
Response  404
HideShow
Body
{
        "status": 2001,
        "message" : "Stream not found"
        "userinfo" : {
            "stream": "9d9dc062-2bdc-4bee-8bef-4c56b9953b14"
        }
    }
Request  Stream state is ended
HideShow
Headers
content-type: application/json
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": "9d9dc062-2bdc-4bee-8bef-4c56b9953b14",
  "state": "ended",
  "type": "low-latency",
  "playout": {
    "rtmp": [],
    "hls": [],
    "web": []
  }
}
Response  404
HideShow
Body
{
        "status": 2001,
        "message" : "Stream not found"
        "userinfo" : {
            "stream": "9d9dc062-2bdc-4bee-8bef-4c56b9953b14"
        }
    }

private Stream Info
GET/stream/{id}

Example URI

GET /stream/9d9dc062-2bdc-4bee-8bef-4c56b9953b14
URI Parameters
HideShow
id
uuid (required) Example: 9d9dc062-2bdc-4bee-8bef-4c56b9953b14
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": "9d9dc062-2bdc-4bee-8bef-4c56b9953b14",
  "state": "created",
  "type": "low-latency",
  "tags": [
    "foo",
    "bar"
  ],
  "ingest": {
    "rtmp": {
      "url": "rtmp://ws2.nanocosmos.de:1935/live",
      "streamname": "-bH2k9x1HS"
    }
  },
  "playout": {
    "rtmp": [
      {
        "url": "rtmp://ws2.nanocosmos.de:1935/live",
        "streamname": "-bH2k9x1HS",
        "type": "live"
      }
    ],
    "hls": [
      {
        "url": "http://ws2.nanocosmos.de:80/live/-bH2k9x1HS/playlist.m3u8",
        "type": "live"
      }
    ],
    "web": [
      {
        "url": "https://bintu-dev.nanocosmos.de:443/playout/9d9dc062-2bdc-4bee-8bef-4c56b9953b14",
        "type": "live"
      }
    ]
  }
}
Response  403
Response  404
HideShow
Body
{
        "status": 2001,
        "message" : "Stream not found"
        "userinfo" : {
            "stream": "9d9dc062-2bdc-4bee-8bef-4c56b9953b14"
        }
    }

Create Stream

Create Stream
POST/stream

Example URI

POST /stream
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7d
Body
{
  "tags": [
    "foo",
    "bar"
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "tags": {
      "required": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": "95088b6a-a96e-45a1-9552-8647942a67fb",
  "state": "created",
  "type": "low-latency",
  "tags": [
    "foo",
    "bar"
  ],
  "ingest": {
    "rtmp": {
      "url": "rtmp://ws2.nanocosmos.de:1935/live",
      "streamname": "nOlmzlakcC"
    }
  },
  "playout": {
    "rtmp": [
      {
        "url": "rtmp://ws2.nanocosmos.de:1935/live",
        "streamname": "nOlmzlakcC",
        "type": "live"
      }
    ],
    "hls": [
      {
        "url": "http://ws2.nanocosmos.de:80/live/nOlmzlakcC/playlist.m3u8",
        "type": "live"
      }
    ],
    "web": []
  }
}
Response  403

Validate Stream

Validate Stream
POST/stream/validate

Example URI

POST /stream/validate
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7dw1Ir7d
Body
{
  "stream": "your_stream_name"
}
Schema
{
  "type": "object",
  "properties": {
    "stream": {
      "required": true,
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "userinfo": {
      "required_parameter": "stream"
    },
    "code": 1002
  }
}
Response  403
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Access denied",
    "code": 2001
  }
}
Response  404
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "RTMP Ingest for Stream not found",
    "code": 9002,
    "userinfo": {
      "stream_name": "foo-bar"
    }
  }
}

Delete Stream

Delete Stream
DELETE/stream/{id}

Example URI

DELETE /stream/9d9dc062-2bdc-4bee-8bef-4c56b9953b14
URI Parameters
HideShow
id
uuid (required) Example: 9d9dc062-2bdc-4bee-8bef-4c56b9953b14
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7dw1Ir7d
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "userinfo": {
      "required_parameter": "id"
    },
    "code": 1002
  }
}
Response  404
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
    "status": 2001,
    "message" : "Stream not found"
    "userinfo" : {
        "stream": "9d9dc062-2bdc-4bee-8bef-4c56b9953b14"
    }
}

Stream Collection

Stream Collection Info
GET/stream{?state,offset,quantity}

List with maximum 10 stream objects. Its possible to change the maximum list length, by using the query parameter quantity.

Example URI

GET /stream?state=live&offset=10&quantity=20
URI Parameters
HideShow
tags[]
array[string] (optional) 

Usage: /stream?tags[]=foo&tags[]=bar

state
string (optional) Example: live

Choices: created live ended

offset
int (optional) Example: 10

Usage: /stream/public?tags[]=foo&offset=10

quantity
int (optional) Example: 20

Usage: /stream/public?tags[]=foo&quantity=20

Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7dw1Ir7d
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "id": "c9ce0948-d99f-49ef-b97d-344cb9bb9929",
    "state": "live",
    "type": "low-latency",
    "created_at": "2016-04-13T21:02:35.686Z",
    "tags": [
      "foo"
    ],
    "ingest": {
      "rtmp": {
        "url": "rtmp://bintu-stream.nanocosmos.de:80/live",
        "streamname": "-!6pY_12ut"
      }
    },
    "playout": {
      "rtmp": [
        {
          "url": "rtmp://bintu-stream.nanocosmos.de:80/live",
          "streamname": "-!6pY_12ut",
          "type": "live"
        }
      ],
      "hls": [
        {
          "url": "http://bintu-stream.nanocosmos.de:80/live/-!6pY_12ut/playlist.m3u8",
          "type": "live"
        }
      ],
      "web": [
        {
          "url": "https://bintu.nanocosmos.de:443/playout/c9ce0948-d99f-49ef-b97d-344cb9bb9929",
          "type": "live"
        }
      ]
    }
  },
  {
    "id": "52979kb9-fce0-4090-b51e-20df423cfbb7",
    "state": "live",
    "type": "low-latency",
    "created_at": "2016-04-05T18:27:06.251Z",
    "tags": [
      "foo"
    ],
    "ingest": {
      "rtmp": {
        "url": "rtmp://bintu-stream.nanocosmos.de:80/live",
        "streamname": "4wAORv0Up9"
      }
    },
    "playout": {
      "rtmp": [
        {
          "url": "rtmp://bintu-stream.nanocosmos.de:80/live",
          "streamname": "4wAORv0Up9",
          "type": "live"
        }
      ],
      "hls": [
        {
          "url": "http://bintu-stream.nanocosmos.de:80/live/4wAORv0Up9/playlist.m3u8",
          "type": "live"
        }
      ],
      "web": [
        {
          "url": "https://bintu.nanocosmos.de:443/playout/52979kb9-fce0-4090-b51e-20df423cfbb7",
          "type": "live"
        }
      ]
    }
  }
]
Response  403
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Wrong Data Type",
    "userinfo": {
      "type": "array",
      "parameter": "tags"
    },
    "code": 1003
  }
}

Stream Collection Count

Stream Collection Count
GET/stream/count{?state}

Example URI

GET /stream/count?state=live
URI Parameters
HideShow
tags[]
array[string] (optional) 

Usage: /stream?tags[]=foo&tags[]=bar

state
string (optional) Example: live

Choices: created live ended

Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7dw1Ir7d
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "count": 112
}
Response  403
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Wrong Data Type",
    "userinfo": {
      "type": "array",
      "parameter": "tags"
    },
    "code": 1003
  }
}

Public Stream Collection

Public Stream Collection Info
GET/stream/public?tags[]{?state,offset,quantity}

List with maximum 10 stream objects. Its possible to change the maximum list length, by using the query parameter quantity.

Example URI

GET /stream/public?tags%5B%5D?state=live&offset=10&quantity=20
URI Parameters
HideShow
tags[]
array[string] (required) Example: foo

Usage: /stream/public?tags[]=foo

state
string (optional) Example: live

Usage: /stream/public?tags[]=foo&state=live

Choices: created live ended

offset
int (optional) Example: 10

Usage: /stream/public?tags[]=foo&offset=10

quantity
int (optional) Example: 20

Usage: /stream/public?tags[]=foo&quantity=20

Request
HideShow
Headers
content-type: application/json
X-BINTU-PLAYERKEY: OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7dw1Ir7d
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "id": "c9ce0948-d99f-49ef-b97d-344cb9bb9929",
    "state": "live",
    "type": "low-latency",
    "playout": {
      "rtmp": [
        {
          "url": "rtmp://bintu-stream.nanocosmos.de:80/live",
          "streamname": "-!6pY_12ut",
          "type": "live"
        }
      ],
      "hls": [
        {
          "url": "http://bintu-stream.nanocosmos.de:80/live/-!6pY_12ut/playlist.m3u8",
          "type": "live"
        }
      ],
      "web": [
        {
          "url": "https://bintu.nanocosmos.de:443/playout/c9ce0948-d99f-49ef-b97d-344cb9bb9929",
          "type": "live"
        }
      ]
    }
  }
]
Response  403
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Wrong Data Type",
    "userinfo": {
      "type": "array",
      "parameter": "tags"
    },
    "code": 1003
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "userinfo": {
      "required_parameter": "tags"
    },
    "code": 1002
  }
}

Public Stream Collection Count

Public Stream Collection Count
GET/stream/public/count?tags[]{?state}

Example URI

GET /stream/public/count?tags%5B%5D?state=live
URI Parameters
HideShow
tags[]
array[string] (required) Example: foo

Usage: /stream/public?tags[]=foo

state
string (optional) Example: live

Usage: /stream/public?tags[]=foo&state=live

Choices: created live ended

Request
HideShow
Headers
content-type: application/json
X-BINTU-PLAYERKEY: OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7dw1Ir7d
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "count": 112
}
Response  403
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Wrong Data Type",
    "userinfo": {
      "type": "array",
      "parameter": "tags"
    },
    "code": 1003
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "userinfo": {
      "required_parameter": "tags"
    },
    "code": 1002
  }
}

Stream Tags

Set Stream Tags
PUT/stream/{id}/tag

Example URI

PUT /stream/f4e089a0-3711-4166-929c-e41eb6ffc72a/tag
URI Parameters
HideShow
id
string (required) Example: f4e089a0-3711-4166-929c-e41eb6ffc72a
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7
Body
{
  "tags": [
    "foo",
    "bar"
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "tags": {
      "required": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "ingest": {
    "rtmp": {
      "url": "rtmp://localhost:1935/live",
      "streamname": "7HsDirQ6fw"
    }
  },
  "playout": {
    "hls": [
      {
        "url": "http://localhost:80/live/7HsDirQ6fw/playlist.m3u8",
        "type": "live"
      }
    ],
    "rtmp": [
      {
        "url": "rtmp://localhost:1935/live",
        "streamname": "7HsDirQ6fw",
        "type": "live"
      }
    ],
    "web": [
      {
        "url": "https://localhost:8081/playout/f4e089a0-3711-4166-929c-e41eb6ffc72a",
        "type": "live"
      }
    ]
  },
  "id": "f4e089a0-3711-4166-929c-e41eb6ffc72a",
  "created_at": "2016-03-18T12:30:22.210Z",
  "type": "low-latency",
  "state": "created",
  "tags": [
    "foo",
    "bar"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "userinfo": {
      "required_parameter": "tags"
    },
    "code": 1002
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Wrong Data Type",
    "userinfo": {
      "type": "array",
      "parameter": "tags"
    },
    "code": 1003
  }
}
Response  403
Response  404
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "status": 3001,
  "message": "Stream not found",
  "userinfo": {
    "stream": "9d9dc062-2bdc-4bee-8bef-4c56b9953b14"
  }
}

Push Url

Set Push URL
PUT/stream/{id}/push_url

To delete an push url, set null as value in the body.

Example URI

PUT /stream/f4e089a0-3711-4166-929c-e41eb6ffc72a/push_url
URI Parameters
HideShow
id
string (required) Example: f4e089a0-3711-4166-929c-e41eb6ffc72a
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7
Body
{
  "url": "rtmp://mydomain.de/live/streamname"
}
Schema
{
  "type": "object",
  "properties": {
    "url": {
      "required": true,
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "ingest": {
    "rtmp": {
      "url": "rtmp://localhost:1935/live",
      "streamname": "7HsDirQ6fw"
    }
  },
  "playout": {
    "hls": [
      {
        "url": "http://localhost:80/live/7HsDirQ6fw/playlist.m3u8",
        "type": "live"
      }
    ],
    "rtmp": [
      {
        "url": "rtmp://localhost:1935/live",
        "streamname": "7HsDirQ6fw",
        "type": "live"
      }
    ],
    "web": [
      {
        "url": "https://localhost:8081/playout/f4e089a0-3711-4166-929c-e41eb6ffc72a",
        "type": "live"
      }
    ]
  },
  "id": "f4e089a0-3711-4166-929c-e41eb6ffc72a",
  "created_at": "2016-03-18T12:30:22.210Z",
  "type": "low-latency",
  "state": "created",
  "tags": [
    "foo",
    "bar"
  ],
  "webrtc": false,
  "transcoding": false,
  "pushUrl": "rtmp://144.76.112.234/live/test"
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "userinfo": {
      "required_parameter": "url"
    },
    "code": 1002
  }
}
Response  403
Response  404
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "status": 3001,
  "message": "Stream not found",
  "userinfo": {
    "stream": "9d9dc062-2bdc-4bee-8bef-4c56b9953b14"
  }
}

Tag

Tag Collection

Tag Collection
GET/tag

Example URI

GET /tag
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: 0b7bbadf-e7ae-4d01-8eaa-bfe6ccae0656
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "id": "e92471df-9ddd-4d86-9bc4-a23c812d6b83",
    "tag": "webrtc",
    "created_at": "2016-04-13T15:36:01.852Z"
  },
  {
    "id": "125f1dcb-32a9-44bd-819a-ab8a730262fb",
    "tag": "ios",
    "created_at": "2016-04-13T18:09:04.270Z"
  },
  {
    "id": "6a88792d-a451-40a1-9dac-2ef006e8a4fb",
    "tag": "title:cdn",
    "created_at": "2016-04-13T18:09:04.276Z"
  }
]
Response  403

Create Tag

Create Tag
POST/tag

Example URI

POST /tag
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: 0b7bbadf-e7ae-4d01-8eaa-bfe6ccae0656
Body
{
  "tag": "foo"
}
Schema
{
  "type": "object",
  "properties": {
    "tag": {
      "required": true,
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": "b33e2b6e-e4ad-4c73-95e4-88c649d48cc6",
  "tag": "foo",
  "created_at": "2016-04-14T17:03:30.443Z"
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "tag"
    }
  }
}
Response  403

API Key

ApiKey

Validate Api Key
POST/apikey

Example URI

POST /apikey
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "apikey": "OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7dw1Ir7"
}
Schema
{
  "type": "object",
  "properties": {
    "apikey": {
      "required": true,
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "success": "true"
}
Response  404
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "status": 7001,
  "message": "Api Key not found",
  "userinfo": {
    "apikey": "OGvhN2a5hQCCuMh5Fb8IVWGzb0kMyl7dw1Ir7"
  }
}

Organisation

Organisation

Organisation Info
GET/organisation

Example URI

GET /organisation
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: 0b7bbadf-e7ae-4d01-8eaa-bfe6ccae0656
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": "b2550f2f-1039-46c8-b0ce-9c0f3856670c",
  "name": "nano"
}
Response  403

Logs

Logs
GET/organisation/logs{?from_date,until_date}

Example URI

GET /organisation/logs?from_date=2016-04-14T15%3A35%3A26.109Z&until_date=2016-04-15T11%3A03%3A51.466Z
URI Parameters
HideShow
from_date
ISO-8601 (optional) Example: 2016-04-14T15%3A35%3A26.109Z
until_date
ISO-8601 (optional) Example: 2016-04-15T11%3A03%3A51.466Z
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: 0b7bbadf-e7ae-4d01-8eaa-bfe6ccae0656
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "stream": "23a2c27a-9939-4f68-9946-67a54a6ce02b",
    "logs": []
  },
  {
    "stream": "b93cf489-442c-4a59-954e-4ab02efa1da5",
    "logs": [
      {
        "type": "stream",
        "timestamp_start": "2016-02-20T14:38:11.238Z",
        "timestamp_stop": "2016-02-20T14:38:31.224Z",
        "client": "88.198.15.148",
        "protocol": "RTMP"
      },
      {
        "type": "playout",
        "timestamp_start": "2016-02-20T14:38:23.603Z",
        "timestamp_stop": "2016-02-20T14:39:10.006Z",
        "client": "78.52.155.57",
        "protocol": "RTMP"
      },
      {
        "type": "stream",
        "timestamp_start": "2016-02-20T15:17:36.448Z",
        "timestamp_stop": "2016-02-20T15:17:47.001Z",
        "client": "88.198.15.148",
        "protocol": "RTMP"
      }
    ]
  }
]
Response  403

Usage

Usage
GET/organisation/usage{?from_date,until_date}

Example URI

GET /organisation/usage?from_date=2016-04-14T15%3A35%3A26.109Z&until_date=2016-04-15T11%3A03%3A51.466Z
URI Parameters
HideShow
from_date
ISO-8601 (optional) Example: 2016-04-14T15%3A35%3A26.109Z
until_date
ISO-8601 (optional) Example: 2016-04-15T11%3A03%3A51.466Z
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: 0b7bbadf-e7ae-4d01-8eaa-bfe6ccae0656
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "total_time": 2506046987,
  "ingest": {
    "total_time": 2468365892,
    "rtmp_time": 2468365892,
    "hls_time": 0
  },
  "playout": {
    "total_time": 37681095,
    "rtmp_time": 37326585,
    "hls_time": 354510
  }
}
Response  403

User

User Info

User Info
GET/user

Example URI

GET /user
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: 0b7bbadf-e7ae-4d01-8eaa-bfe6ccae0656
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "id": "7af8c490-ee5e-419b-9a21-539d4d78f3c4",
    "email": "1@nanocosmos.de",
    "created_at": "2016-03-15T19:10:40.114Z"
  },
  {
    "id": "e82d5ea6-3e7d-486c-8383-3728e058fab5",
    "email": "2@nanocosmos.de",
    "created_at": "2016-04-13T15:35:53.170Z"
  },
  {
    "id": "d76b4f9f-a24c-434e-b23f-46457fac6aec",
    "email": "3@nanocosmos.de",
    "created_at": "2016-04-13T15:37:43.919Z"
  }
]
Response  403

Create User

Create User
POST/user

Example URI

POST /user
Request
HideShow
Headers
content-type: application/json
Body
{
  "email": "test@nanocosmos.de",
  "password": "password",
  "organisation": "nanocosmos"
}
Schema
{
  "type": "object",
  "properties": {
    "email": {
      "required": true,
      "type": "string"
    },
    "password": {
      "required": true,
      "type": "string"
    },
    "organisation": {
      "required": true,
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": "0e6e4313-561c-4fef-b31d-5bfc65bb5993",
  "email": "test@nanocosmos.de",
  "created_at": "2016-04-14T17:54:40.603Z",
  "organisation": {
    "id": "0e55c5f4-e952-4d37-b9e0-017c5f6e196c",
    "name": "nanocosmos123",
    "isEnabled": false,
    "created_at": "2016-04-14T17:54:40.514Z"
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "email"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "password"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "organisation"
    }
  }
}

Validate

Validate User Credentials
POST/user/validate

Example URI

POST /user/validate
Request
HideShow
Headers
content-type: application/json
Body
{
  "email": "test@nanocosmos.de",
  "password": "password"
}
Schema
{
  "type": "object",
  "properties": {
    "email": {
      "required": true,
      "type": "string"
    },
    "password": {
      "required": true,
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "success": true,
  "apiKey": "BcUEF38jXJxDWhSOn7BcdBj5wT"
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "email"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "password"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "User Credentials are not valid",
    "code": 4002,
    "userinfo": {
      "user": "test@nanocosmos.de"
    }
  }
}

Password

Reset Password
POST/user/password

Example URI

POST /user/password
Request
HideShow
Headers
content-type: application/json
Body
{
  "email": "test@nanocosmos.de"
}
Schema
{
  "type": "object",
  "properties": {
    "email": {
      "required": true,
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "email"
    }
  }
}

Set Password
PUT/user/password

Example URI

PUT /user/password
Request
HideShow
Headers
content-type: application/json
Body
{
  "email": "test@nanocosmos.de",
  "password": "password",
  "token": "6Ymd15Q6"
}
Schema
{
  "type": "object",
  "properties": {
    "email": {
      "required": true,
      "type": "string"
    },
    "password": {
      "required": true,
      "type": "string"
    },
    "token": {
      "required": true,
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": "0e6e4313-561c-4fef-b31d-5bfc65bb5993",
  "email": "test@nanocosmos.de",
  "created_at": "2016-04-14T17:54:40.603Z"
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "email"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "password"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "token"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Password Token not found",
    "code": 12001,
    "userinfo": {
      "password_token": "token"
    }
  }
}
Response  409
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Password Token is expired",
    "code": 12002,
    "userinfo": {
      "password_token": "token"
    }
  }
}
Response  409
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Password Token is already redeemed",
    "code": 12003,
    "userinfo": {
      "password_token": "token"
    }
  }
}

Invite Token

Invite Token Collection

Invite Token Collection
GET/invitetoken

Example URI

GET /invitetoken
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: 0b7bbadf-e7ae-4d01-8eaa-bfe6ccae0656
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
[
  {
    "token": "xgfl6aE3",
    "redeemed": false
  },
  {
    "token": "NcSA5Sbq",
    "redeemed": false
  },
  {
    "token": "wRk4AHsE",
    "redeemed": true,
    "email": "test@nanocosmos.de"
  },
  {
    "token": "q5aS4H4f",
    "redeemed": true,
    "email": "test+1@nanocosmos.de"
  }
]
Response  403

Create Invite Token

Create Invite Token
POST/invitetoken

Example URI

POST /invitetoken
Request
HideShow
Headers
content-type: application/json
X-BINTU-APIKEY: 0b7bbadf-e7ae-4d01-8eaa-bfe6ccae0656
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "token": "Y683cNeT",
  "redeemed": false
}
Response  403

Redeem

Redeem Invite Token
POST/invitetoken/redeem

Example URI

POST /invitetoken/redeem
Request
HideShow
Headers
content-type: application/json
Body
{
  "email": "test@nanocosmos.de",
  "password": "password",
  "token": "wRk4AHsE"
}
Schema
{
  "type": "object",
  "properties": {
    "email": {
      "required": true,
      "type": "string"
    },
    "password": {
      "required": true,
      "type": "string"
    },
    "token": {
      "required": true,
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "id": "37a6177e-aa93-4486-ba73-2deea22c8e95",
  "email": "test@nanocosmos.de",
  "created_at": "2016-04-14T18:54:19.206Z",
  "organisation": {
    "id": "1b7b8cef-fd5c-42c1-9cc2-bc029cf89260",
    "name": "nano",
    "isEnabled": true,
    "created_at": "2016-02-04T20:12:16.956Z"
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "email"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "password"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Parameter required",
    "code": 1002,
    "userinfo": {
      "required_parameter": "token"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Invite Token not found",
    "code": 5001,
    "userinfo": {
      "invite_token": "token"
    }
  }
}
Response  409
HideShow
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "error": {
    "message": "Invite Token is already redeemed",
    "code": 5002,
    "userinfo": {
      "invite_token": "token"
    }
  }
}

Generated by aglio on 24 Jan 2019