Peer to Peer

edgegap.com Dashboard

Create a Relay Session

Create a relay session with users.

post

/v1/relays/sessions

Authorizations

Body

usersobject[]required

List of IP Addresses of session users

filtersobject[]

List of location filters to apply to the session

webhook_urlstring

URL to send the session data to

Example: https://my-webhook.com/dump

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/relays/sessions' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "users": [
      {
        "ip": "1.1.1.1"
      }
    ],
    "filters": [
      {
        "field": "location",
        "values": [
          "US"
        ],
        "filter_type": "any"
      }
    ],
    "webhook_url": "https://my-webhook.com/dump"
  }'

200

400

401

403

500

503

{
  "session_id": "7349356945f1-S",
  "authorization_token": 3500589645,
  "status": "READY",
  "ready": true,
  "linked": true,
  "error": "Session failed",
  "session_users": [
    {
      "ip_address": "1.1.1.1",
      "latitude": 45.5088,
      "longitude": -73.5878,
      "authorization_token": 21986334
    }
  ],
  "relay": {
    "ip": "2.2.2.2",
    "host": "7349356945f1.st.edgegap.net",
    "ports": {
      "server": {
        "port": 32000,
        "protocol": "UDP",
        "link": "7349356945f1.st.edgegap.net:32000"
      },
      "client": {
        "port": 32001,
        "protocol": "UDP",
        "link": "7349356945f1.st.edgegap.net:32001"
      }
    }
  },
  "webhook_url": "https://my-webhook.com/dump"
}

Success

List all Relay Sessions

List all the active relay sessions.

get

/v1/relays/sessions

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/relays/sessions' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

500

{
  "sessions": [
    {
      "session_id": "7349356945f1-S",
      "authorization_token": 3500589645,
      "status": "READY",
      "ready": true,
      "linked": true,
      "error": "Session failed",
      "session_users": [
        {
          "ip_address": "1.1.1.1",
          "latitude": 45.5088,
          "longitude": -73.5878,
          "authorization_token": 21986334
        }
      ],
      "relay": {
        "ip": "2.2.2.2",
        "host": "7349356945f1.st.edgegap.net",
        "ports": {
          "server": {
            "port": 32000,
            "protocol": "UDP",
            "link": "7349356945f1.st.edgegap.net:32000"
          },
          "client": {
            "port": 32001,
            "protocol": "UDP",
            "link": "7349356945f1.st.edgegap.net:32001"
          }
        }
      },
      "webhook_url": "https://my-webhook.com/dump"
    }
  ],
  "pagination": {
    "number": 1,
    "next_page_number": 1,
    "previous_page_number": 1,
    "paginator": {
      "num_pages": 1
    },
    "has_next": true,
    "has_previous": true
  }
}

Success

Delete a Relay Session

Delete a relay session.

delete

/v1/relays/sessions/{session_id}

Authorizations

Path parameters

session_idanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/relays/sessions/{session_id}' \
  --header 'authorization: YOUR_API_KEY'

204

401

403

404

500

503

No body

No Content

Get a Relay Session

Retrieve the information for a relay session.

get

/v1/relays/sessions/{session_id}

Authorizations

Path parameters

session_idanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/relays/sessions/{session_id}' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

500

{
  "session_id": "7349356945f1-S",
  "authorization_token": 3500589645,
  "status": "READY",
  "ready": true,
  "linked": true,
  "error": "Session failed",
  "session_users": [
    {
      "ip_address": "1.1.1.1",
      "latitude": 45.5088,
      "longitude": -73.5878,
      "authorization_token": 21986334
    }
  ],
  "relay": {
    "ip": "2.2.2.2",
    "host": "7349356945f1.st.edgegap.net",
    "ports": {
      "server": {
        "port": 32000,
        "protocol": "UDP",
        "link": "7349356945f1.st.edgegap.net:32000"
      },
      "client": {
        "port": 32001,
        "protocol": "UDP",
        "link": "7349356945f1.st.edgegap.net:32001"
      }
    }
  },
  "webhook_url": "https://my-webhook.com/dump"
}

Success

Authorize a user on a Relay Session

post

/v1/relays/sessions:authorize-user

Authorizations

Body

session_idstringrequired

Session Request ID (ex: 0724828881e2-S)

Example: 0724828881e2-S

user_ipstringrequired

User Ip to Authorize

Example: 1.1.1.1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/relays/sessions:authorize-user' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "session_id": "0724828881e2-S",
    "user_ip": "1.1.1.1"
  }'

200

400

401

403

409

500

503

{
  "session_id": "7349356945f1-S",
  "authorization_token": 3500589645,
  "status": "READY",
  "ready": true,
  "linked": true,
  "error": "Session failed",
  "session_user": {
    "ip_address": "1.1.1.1",
    "latitude": 45.5088,
    "longitude": -73.5878,
    "authorization_token": 21986334
  },
  "relay": {
    "ip": "2.2.2.2",
    "host": "7349356945f1.st.edgegap.net",
    "ports": {
      "server": {
        "port": 32000,
        "protocol": "UDP",
        "link": "7349356945f1.st.edgegap.net:32000"
      },
      "client": {
        "port": 32001,
        "protocol": "UDP",
        "link": "7349356945f1.st.edgegap.net:32001"
      }
    }
  },
  "webhook_url": "https://my-webhook.com/dump"
}

Success

Remove a user on a Relay Session

Authorize a user on a Relay Session

post

/v1/relays/sessions:revoke-user

Authorizations

Body

session_idstringrequired

Session Request ID (ex: 0724828881e2-S)

Example: 0724828881e2-S

authorization_tokenintegerrequired

Relay Authorization Token

Example: 3500589645

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/relays/sessions:revoke-user' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "session_id": "0724828881e2-S",
    "authorization_token": 3500589645
  }'

200

204

400

401

403

404

500

503

{
  "session_id": "7349356945f1-S",
  "authorization_token": 3500589645,
  "status": "READY",
  "ready": true,
  "linked": true,
  "error": "Session failed",
  "session_users": [
    {
      "ip_address": "1.1.1.1",
      "latitude": 45.5088,
      "longitude": -73.5878,
      "authorization_token": 21986334
    }
  ],
  "relay": {
    "ip": "2.2.2.2",
    "host": "7349356945f1.st.edgegap.net",
    "ports": {
      "server": {
        "port": 32000,
        "protocol": "UDP",
        "link": "7349356945f1.st.edgegap.net:32000"
      },
      "client": {
        "port": 32001,
        "protocol": "UDP",
        "link": "7349356945f1.st.edgegap.net:32001"
      }
    }
  },
  "webhook_url": "https://my-webhook.com/dump"
}

Success

Create a Lobby

Create a named lobby.

post

/v1/lobbies

Authorizations

Body

namestringrequired

Name of the lobby

Example: lobby_name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/lobbies' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "lobby_name"
  }'

200

400

401

409

500

{
  "name": "lobby_name",
  "url": "https://lobby.com",
  "status": "Released"
}

Success

List All Lobbies

List the Lobbies

get

/v1/lobbies

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/lobbies' \
  --header 'authorization: YOUR_API_KEY'

200

401

500

{
  "name": "lobby_name",
  "url": "https://lobby.com",
  "status": "Released"
}

Success

Delete a Lobby

Delete a named lobby.

delete

/v1/lobbies/{lobby_name}

Authorizations

Path parameters

lobby_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.edgegap.com//v1/lobbies/{lobby_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

500

{
  "name": "lobby_name",
  "url": "https://lobby.com",
  "status": "Released"
}

Success

Get a Lobby

Get a named lobby.

get

/v1/lobbies/{lobby_name}

Authorizations

Path parameters

lobby_nameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.edgegap.com//v1/lobbies/{lobby_name}' \
  --header 'authorization: YOUR_API_KEY'

200

400

401

404

409

500

{
  "name": "lobby_name",
  "url": "https://lobby.com",
  "status": "Released"
}

Success

Deploy a Lobby

Deploy the lobby with the given name.

post

/v1/lobbies:deploy

Authorizations

Body

namestringrequired

Name of the lobby

Example: lobby_name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/lobbies:deploy' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "lobby_name"
  }'

202

400

401

409

500

{
  "name": "lobby_name",
  "url": "https://lobby.com",
  "status": "Released"
}

Success

Terminate a Lobby

Terminate the lobby with the given name.

post

/v1/lobbies:terminate

Authorizations

Body

namestringrequired

Name of the lobby

Example: lobby_name

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.edgegap.com//v1/lobbies:terminate' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "lobby_name"
  }'

200

202

400

401

404

409

500

{
  "name": "lobby_name",
  "url": "https://lobby.com",
  "status": "Released"
}

Success

📫 Relays

🏨 Lobby Manager

📫 Relays

🏨 Lobby Manager

Create a Relay Session

List all Relay Sessions

Delete a Relay Session

Get a Relay Session

Authorize a user on a Relay Session

Remove a user on a Relay Session

Create a Lobby

List All Lobbies

Delete a Lobby

Get a Lobby

Deploy a Lobby

Terminate a Lobby

📫 Relays

🏨 Lobby Manager

📫 Relays

🏨 Lobby Manager

Create a Relay Session

Show child attributes

Show child attributes

List all Relay Sessions

Delete a Relay Session

Get a Relay Session

Authorize a user on a Relay Session

Remove a user on a Relay Session

Create a Lobby

List All Lobbies

Delete a Lobby

Get a Lobby

Deploy a Lobby

Terminate a Lobby