Read observed egress state and rejections
GET
cookie
vg_session<token>The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.
orgId*stringAuthorised orgId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthprojectId*stringAuthorised projectId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthAuthorised read result. Null means unreported, never zero. Source-specific coverage limits remain visible.
application/json- response
source*stringegress*array<>rejected*array<>sourceStatus?How fresh a sampled read is. Present when the worker samples the layer; a layer never read successfully answers 503 source_unavailable instead.
Example Request
curl -X GET 'https://example.com/api/v1/org/string/project/string/egress'Example Response
{ "source": "string", "egress": [ { "id": "string", "room": "string", "status": "string", "startedAt": "2019-08-24T14:15:22Z", "endedAt": "2019-08-24T14:15:22Z", "error": "string", "details": "string", "request": { "kind": "string", "audioOnly": true, "fileType": "string", "storage": "string", "outputs": [ "string" ] }, "file": { "name": "string", "sizeBytes": 0, "durationS": 0, "bucketHost": "string", "playable": "string" }, "history": [ { "at": "2019-08-24T14:15:22Z", "status": "string" } ], "sampled": true, "streams": [ { "host": "string", "status": "string", "error": "string", "startedAt": "2019-08-24T14:15:22Z", "endedAt": "2019-08-24T14:15:22Z" } ], "outcome": "recorded" } ], "rejected": [ { "at": "2019-08-24T14:15:22Z", "case": "string", "error": "string" } ], "sourceStatus": { "lastReadAt": "2019-08-24T14:15:22Z", "lastGoodReadAt": "2019-08-24T14:15:22Z", "errorClass": "unauthenticated" }}Was this page helpful?