Skip to main content

Rest API - Introduction

In Metered we provide the REST APIs to perform all the functions that can be done from the dashboard and more.

Explore all the available API through the sidebar.

Pre-requisite​

To use the Metered REST API you need to have an account, if you don't already have an account you can easily signup for a free account from here: https://dashboard.metered.ca/signup

Acquiring the Secret Key​

Two dashboards

Screenshots below show the new dashboard. If you use the classic dashboard, pick the Classic dashboard tab — your choice is remembered on every page. You can switch at any time: Old dashboard in the header takes you back to the classic dashboard, and dashboard.metered.ca/v2 opens the new one. What changed in the new dashboard →

You will need the Secret Key to authenticate with the API. Open dashboard.metered.ca/v2, pick your app in the Workspace switcher and go to Developers. The page shows your Metered domain and your secret key. The secret key is hidden — click Reveal to show it, or the copy button to copy it.

Developers page with the Metered domain and secret key secret key

Once you have obtained the Secret Key we can use it to call the REST API.

Never Expose your Secret Key to the Front End

Secret Key should never be exposed in the Front End and must always be used by your back-end server-side application.

Calling the REST API​

To call REST API you would have to send the request to your metered domain.

Here is an example cURL request to Create A Room:

cURL
curl --request POST \
   --url https://yourappname.metered.live/api/v1/api/v1/token \
   --header 'Accept: application/json' \
   --header 'Content-Type: application/json' \
   --data '{"globalToken":true}'

You will receive the following response:

JSON

{
  "privacy": "public",
  "deleteOnExp": false,
  "autoJoin": false,
  "enableRequestToJoin": true,
  "enableChat": true,
  "enableScreenSharing": true,
  "joinVideoOn": true,
  "joinAudioOn": true,
  "ownerOnlyBroadcast": false,
  "enableRecording": false,
  "ejectAtRoomExp": false,
  "lang": "en",
  "archived": false,
  "_id": "6113f3901baf459debe6a33b",
  "roomName": "myroom",
  "app": "61017571c22d9d49b56f6996",
  "created": "2021-08-11T15:58:08.559Z",
}