sfu
Creates, updates, deletes, gets or lists a sfu resource.
Overview
| Name | sfu |
| Type | Resource |
| Id | cloudflare.calls.sfu |
Fields
The following fields are returned by SELECT queries:
- get
- list
Retrieve app details response
| Name | Datatype | Description |
|---|---|---|
name | string | A short description of Calls app, not shown to end users. (default: , example: production-realtime-app) |
created | string (date-time) | The date and time the item was created. (example: 2014-01-02T02:20:00Z) |
modified | string (date-time) | The date and time the item was last modified. (example: 2014-01-02T02:20:00Z) |
uid | string | A Cloudflare-generated unique identifier for a item. (example: 2a95132c15732412d22c1476fa83f27a) |
List apps response
| Name | Datatype | Description |
|---|---|---|
name | string | A short description of Calls app, not shown to end users. (default: , example: production-realtime-app) |
created | string (date-time) | The date and time the item was created. (example: 2014-01-02T02:20:00Z) |
modified | string (date-time) | The date and time the item was last modified. (example: 2014-01-02T02:20:00Z) |
uid | string | A Cloudflare-generated unique identifier for a item. (example: 2a95132c15732412d22c1476fa83f27a) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | app_id, account_id | Fetches details for a single Calls app. | |
list | select | account_id | Lists all apps in the Cloudflare account | |
create | insert | account_id | Creates a new Cloudflare calls app. An app is an unique enviroment where each Session can access all Tracks within the app. | |
update | replace | app_id, account_id | Edit details for a single app. | |
delete | delete | app_id, account_id | Deletes an app from Cloudflare Calls |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
account_id | string | The Cloudflare account ID. |
app_id | string | The Access application ID. |
SELECT examples
- get
- list
Fetches details for a single Calls app.
SELECT
name,
created,
modified,
uid
FROM cloudflare.calls.sfu
WHERE app_id = '{{ app_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;
Lists all apps in the Cloudflare account
SELECT
name,
created,
modified,
uid
FROM cloudflare.calls.sfu
WHERE account_id = '{{ account_id }}' -- required
;
INSERT examples
- create
- Manifest
Creates a new Cloudflare calls app. An app is an unique enviroment where each Session can access all Tracks within the app.
INSERT INTO cloudflare.calls.sfu (
name,
account_id
)
SELECT
'{{ name }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;
# Description fields are for documentation purposes
- name: sfu
props:
- name: account_id
value: "{{ account_id }}"
description: Required parameter for the sfu resource.
- name: name
value: "{{ name }}"
description: |
A short description of Calls app, not shown to end users.
default:
REPLACE examples
- update
Edit details for a single app.
REPLACE cloudflare.calls.sfu
SET
name = '{{ name }}'
WHERE
app_id = '{{ app_id }}' --required
AND account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;
DELETE examples
- delete
Deletes an app from Cloudflare Calls
DELETE FROM cloudflare.calls.sfu
WHERE app_id = '{{ app_id }}' --required
AND account_id = '{{ account_id }}' --required
;