Relays

📫 Relays

Create a Relay Session

post

Create a relay session with users.

Authorizations

authorizationstringRequired

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Body

webhook_urlstringOptional

URL to send the session data to

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

Responses

200

Success

application/json

session_idstringRequired

The session ID

Example: 7349356945f1-S

authorization_tokenintegerOptional

The authorization token for the session

Example: 3500589645

statusstringRequired

The status of the session

Example: READY

readybooleanRequired

If the session is ready to be used

linkedbooleanRequired

If the session is linked to a relay

errorstringOptional

The error message if the session failed

Example: Session failed

webhook_urlstringOptional

The webhook URL that we will call once the session is ready

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

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

post

/v1/relays/sessions

POST /v1/relays/sessions HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "users": [
    {
      "ip": "1.1.1.1"
    }
  ],
  "filters": [
    {
      "field": "location",
      "values": [
        "US"
      ],
      "filter_type": "any"
    }
  ],
  "webhook_url": "https://my-webhook.com/dump"
}

{
  "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"
}

List all Relay Sessions

get

List all the active relay sessions.

Authorizations

authorizationstringRequired

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

/v1/relays/sessions

GET /v1/relays/sessions HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "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
  }
}

Delete a Relay Session

delete

Delete a relay session.

Authorizations

authorizationstringRequired

Path parameters

session_idstringRequired

Responses

204

No Content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

delete

/v1/relays/sessions/{session_id}

DELETE /v1/relays/sessions/{session_id} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

No content

Get a Relay Session

get

Retrieve the information for a relay session.

Authorizations

authorizationstringRequired

Path parameters

session_idstringRequired

Responses

200

Success

application/json

session_idstringRequired

The session ID

Example: 7349356945f1-S

authorization_tokenintegerOptional

The authorization token for the session

Example: 3500589645

statusstringRequired

The status of the session

Example: READY

readybooleanRequired

If the session is ready to be used

linkedbooleanRequired

If the session is linked to a relay

errorstringOptional

The error message if the session failed

Example: Session failed

webhook_urlstringOptional

The webhook URL that we will call once the session is ready

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

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/v1/relays/sessions/{session_id}

GET /v1/relays/sessions/{session_id} HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Accept: */*

{
  "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"
}

Authorize a user on a Relay Session

post

Authorize a user on a Relay Session

Authorizations

authorizationstringRequired

Body

session_idstringRequired

Session Request ID (ex: 0724828881e2-S)

Example: 0724828881e2-S

user_ipstringRequired

User Ip to Authorize

Example: 1.1.1.1

Responses

200

Success

application/json

session_idstringRequired

The session ID

Example: 7349356945f1-S

authorization_tokenintegerOptional

The authorization token for the session

Example: 3500589645

statusstringRequired

The status of the session

Example: READY

readybooleanRequired

If the session is ready to be used

linkedbooleanRequired

If the session is linked to a relay

errorstringOptional

The error message if the session failed

Example: Session failed

webhook_urlstringOptional

The webhook URL that we will call once the session is ready

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

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

post

/v1/relays/sessions:authorize-user

POST /v1/relays/sessions:authorize-user HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "session_id": "0724828881e2-S",
  "user_ip": "1.1.1.1"
}

{
  "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"
}

Remove a user on a Relay Session

post

Authorize a user on a Relay Session

Authorizations

authorizationstringRequired

Body

session_idstringRequired

Session Request ID (ex: 0724828881e2-S)

Example: 0724828881e2-S

authorization_tokenintegerRequired

Relay Authorization Token

Example: 3500589645

Responses

200

Success

application/json

session_idstringRequired

The session ID

Example: 7349356945f1-S

authorization_tokenintegerOptional

The authorization token for the session

Example: 3500589645

statusstringRequired

The status of the session

Example: READY

readybooleanRequired

If the session is ready to be used

linkedbooleanRequired

If the session is linked to a relay

errorstringOptional

The error message if the session failed

Example: Session failed

webhook_urlstringOptional

The webhook URL that we will call once the session is ready

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

204

No Content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

post

/v1/relays/sessions:revoke-user

POST /v1/relays/sessions:revoke-user HTTP/1.1
Host: api.edgegap.com
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "session_id": "0724828881e2-S",
  "authorization_token": 3500589645
}

{
  "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"
}

PreviousIntegration NextRelease Notes

Last updated 5 months ago

Was this helpful?

hashtag📫 Relays

hashtagCreate a Relay Session

hashtagList all Relay Sessions

hashtagDelete a Relay Session

hashtagGet a Relay Session

hashtagAuthorize a user on a Relay Session

hashtagRemove a user on a Relay Session

📫 Relays

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