Scene Stream Access

List scene stream access

get

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/scene-stream-access

Lists streaming access information for a specific scene or world. Only scene owners or administrators can access this endpoint. Requires Signed Fetch authentication from decentraland-kernel-scene. Must include the complete identity header chain: x-identity-auth-chain-0, x-identity-auth-chain-1, x-identity-auth-chain-2, x-identity-timestamp, and x-identity-metadata.

Authorizations

SignedFetch

x-identitystringRequired

Signed Fetch authentication for scene-based requests. Requires a chain of identity headers:

• x-identity-auth-chain-0: Signer information
• x-identity-auth-chain-1: Ephemeral key information
• x-identity-auth-chain-2: Signed entity information
• x-identity-timestamp: Request timestamp
• x-identity-metadata: Request metadata Used for authentication from decentraland-kernel-scene.

Responses

200

Stream access information retrieved successfully

application/json

idstringRequired

Unique identifier of the stream access

place_idstringRequired

ID of the place

streaming_keystringRequired

Streaming key for the stream

streaming_urlstringRequired

URL for the stream

ingress_idstringRequired

LiveKit ingress ID

created_atinteger · int64Required

Timestamp when the access was created

activebooleanRequired

Whether the stream access is active

streamingbooleanRequired

Whether the stream is currently active

streaming_start_timeinteger · int64Required

Timestamp when streaming started

401

Unauthorized - Authentication required

application/json

404

Stream access not found

application/json

500

Internal server error

application/json

get

/scene-stream-access

HTTPcURLJavaScriptPython

GET /scene-stream-access HTTP/1.1
Host: comms-gatekeeper.decentraland.org
x-identity: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "place_id": "text",
  "streaming_key": "text",
  "streaming_url": "text",
  "ingress_id": "text",
  "created_at": 1,
  "active": true,
  "streaming": true,
  "streaming_start_time": 1
}

Add scene stream access

post

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/scene-stream-access

Adds streaming access for a specific scene or world. Only scene owners or administrators can add stream access. Requires Signed Fetch authentication from decentraland-kernel-scene. Must include the complete identity header chain: x-identity-auth-chain-0, x-identity-auth-chain-1, x-identity-auth-chain-2, x-identity-timestamp, and x-identity-metadata.

Authorizations

SignedFetch

x-identitystringRequired

Signed Fetch authentication for scene-based requests. Requires a chain of identity headers:

• x-identity-auth-chain-0: Signer information
• x-identity-auth-chain-1: Ephemeral key information
• x-identity-auth-chain-2: Signed entity information
• x-identity-timestamp: Request timestamp
• x-identity-metadata: Request metadata Used for authentication from decentraland-kernel-scene.

Body

application/json

streaming_urlstringRequired

URL for the stream

streaming_keystringRequired

Streaming key for the stream

ingress_idstringRequired

LiveKit ingress ID

Responses

201

Stream access added successfully

application/json

400

Invalid request

application/json

401

Unauthorized - Authentication required

application/json

500

Internal server error

application/json

post

/scene-stream-access

HTTPcURLJavaScriptPython

POST /scene-stream-access HTTP/1.1
Host: comms-gatekeeper.decentraland.org
x-identity: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "streaming_url": "text",
  "streaming_key": "text",
  "ingress_id": "text"
}

{
  "id": "text",
  "place_id": "text",
  "streaming_key": "text",
  "streaming_url": "text",
  "ingress_id": "text",
  "created_at": 1,
  "active": true,
  "streaming": true,
  "streaming_start_time": 1
}

Reset scene stream access

put

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/scene-stream-access

Resets streaming access for a specific scene or world. This will stop any active streaming and reset the access configuration. Only scene owners or administrators can reset stream access. Requires Signed Fetch authentication from decentraland-kernel-scene. Must include the complete identity header chain: x-identity-auth-chain-0, x-identity-auth-chain-1, x-identity-auth-chain-2, x-identity-timestamp, and x-identity-metadata.

Authorizations

SignedFetch

x-identitystringRequired

Signed Fetch authentication for scene-based requests. Requires a chain of identity headers:

• x-identity-auth-chain-0: Signer information
• x-identity-auth-chain-1: Ephemeral key information
• x-identity-auth-chain-2: Signed entity information
• x-identity-timestamp: Request timestamp
• x-identity-metadata: Request metadata Used for authentication from decentraland-kernel-scene.

Responses

204

Stream access reset successfully

401

Unauthorized - Authentication required

application/json

404

Stream access not found

application/json

500

Internal server error

application/json

put

/scene-stream-access

HTTPcURLJavaScriptPython

PUT /scene-stream-access HTTP/1.1
Host: comms-gatekeeper.decentraland.org
x-identity: YOUR_API_KEY
Accept: */*

No content

Remove scene stream access

delete

https://comms-gatekeeper.decentraland.orghttps://comms-gatekeeper.decentraland.zone

/scene-stream-access

Removes streaming access for a specific scene or world. Only scene owners or administrators can remove stream access. Requires Signed Fetch authentication from decentraland-kernel-scene. Must include the complete identity header chain: x-identity-auth-chain-0, x-identity-auth-chain-1, x-identity-auth-chain-2, x-identity-timestamp, and x-identity-metadata.

Authorizations

SignedFetch

x-identitystringRequired

Signed Fetch authentication for scene-based requests. Requires a chain of identity headers:

• x-identity-auth-chain-0: Signer information
• x-identity-auth-chain-1: Ephemeral key information
• x-identity-auth-chain-2: Signed entity information
• x-identity-timestamp: Request timestamp
• x-identity-metadata: Request metadata Used for authentication from decentraland-kernel-scene.

Responses

204

Stream access removed successfully

401

Unauthorized - Authentication required

application/json

404

Stream access not found

application/json

500

Internal server error

application/json

delete

/scene-stream-access

HTTPcURLJavaScriptPython

DELETE /scene-stream-access HTTP/1.1
Host: comms-gatekeeper.decentraland.org
x-identity: YOUR_API_KEY
Accept: */*

No content