Get Streams

GET 
https://platform.nativeframe.com/program/api/v1/projects/:projectID/streams

Get all streams by project ID

Generate JWT

Request

Path Parameters

projectID stringrequired

ID of the project

Query Parameters

page integer

Page number

limit integer

Limit

q string

Search query, may include stream name or stream ID

active boolean

Active

Responses

200

Get streams

application/json

Schema

Schema

streams

object[]

Array [

idstring

programIdstring

streamNamestring

ingress

object

rtmpstring

webrtcstring

manifestUrlstring

streamKeystring

activeboolean

transcodeboolean

authTypeProgram_AuthType (string)

The type of authentication used for a program or stream.

• public will allow anyone to view the stream.
• private will require a JWT to start or view a stream.
• private+program-states will work with both JWTs and integrator custom tokens.

Possible values: [private, public, private+program-states]

]

totalCountinteger

Example (from schema)

{
  "streams": [
    {
      "id": "string",
      "programId": "string",
      "streamName": "string",
      "ingress": {
        "rtmp": "string",
        "webrtc": "string"
      },
      "manifestUrl": "string",
      "streamKey": "string",
      "active": true,
      "transcode": true,
      "authType": "private"
    }
  ],
  "totalCount": 0
}

404

Not Found

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

500

Internal Server Error

application/json

Schema

Schema

messagestringrequired

Error message for the end user

errorCodestring

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

Authorization: http

name: JWTtype: httpscopes: aud:internal-account,service-account,roles:internal-account,service-accountscheme: bearerbearerFormat: JWTdescription: Bearer Token authentication for applications

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://platform.nativeframe.com/program/api/v1/projects/:projectID/streams");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://platform.nativeframe.com

Auth

Bearer Token

Parameters

projectID — pathrequired

page — query

limit — query

q — query

active — query

---truefalse

ResponseClear

Click the Send API Request button above and see the response here!