turn

Creates, updates, deletes, gets or lists a turn resource.

Overview

Name	turn
Type	Resource
Id	cloudflare.calls.turn

Fields

The following fields are returned by SELECT queries:

get

Retrieve TURN key 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

List TURN key 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	key_id, account_id		Fetches details for a single TURN key.
list	select	account_id		Lists all TURN keys in the Cloudflare account
create	insert	account_id		Creates a new Cloudflare Calls TURN key.
update	replace	key_id, account_id		Edit details for a single TURN key.
delete	delete	key_id, account_id		Deletes a TURN key 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.
key_id	string

SELECT examples

get

Fetches details for a single TURN key.

SELECT
name,
created,
modified,
uid
FROM cloudflare.calls.turn
WHERE key_id = '{{ key_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

Lists all TURN keys in the Cloudflare account

SELECT
name,
created,
modified,
uid
FROM cloudflare.calls.turn
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Creates a new Cloudflare Calls TURN key.

INSERT INTO cloudflare.calls.turn (
name,
account_id
)
SELECT 
'{{ name }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: turn
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the turn resource.
  - name: name
    value: "{{ name }}"
    description: |
      A short description of a TURN key, not shown to end users.
    default: 

REPLACE examples

update

Edit details for a single TURN key.

REPLACE cloudflare.calls.turn
SET 
name = '{{ name }}'
WHERE 
key_id = '{{ key_id }}' --required
AND account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes a TURN key from Cloudflare Calls

DELETE FROM cloudflare.calls.turn
WHERE key_id = '{{ key_id }}' --required
AND account_id = '{{ account_id }}' --required
;