Skip to main content

Create TURN Credential

This endpoint is used to create a TURN Server Credential.


<appname> - replace it the name of your app.


POST /api/v1/turn/credential

Query Parameters

ParameterDescriptionData Type
secretKeyThe secret key for app identificationString

Request Body

The request body should be a JSON object with the following fields:

FieldDescriptionData Type
expiryInSeconds(optional) The time in seconds for the credential to expireInteger
label(optional) An label for the credentialString


Success Response

A JSON object containing the created TURN credential information:

FieldDescriptionData Type
usernameThe username of the credentialString
passwordThe password of the credentialString
expiryInSecondsThe time in seconds for the credential to expireInteger
labelThe label for the credentialString
apiKeyThe apiKey of the credentialString

HTTP Status: 200 OK


"username": "<username>",
"password": "<password>",
"expiryInSeconds": 3600,
"label": "<label>",
"apiKey": "<apiKey>"

Error Responses

  • Invalid Expiry Time:

    HTTP Status: 400 Bad Request


    "message": "please enter a positive integer value for expiryInSeconds"

Code Examples

JavaScript (Fetch API)

fetch("https://<appname><YOUR_SECRET_KEY>", {
method: 'POST',
headers: {
'Content-Type': 'application/json',
body: JSON.stringify({
"expiryInSeconds": 3600,
"label": "exampleLabel"