v1

latestSwagger 2.02026-07-1798126172.4 KB

Connection

Starts new connection

Consumer opens connection to provider

put/connection

Request body

consumer_idstring required

consumer identity

hermes_idstring

hermes identity

provider_idstring required

provider identity

service_typestring

service type. Possible values are "openvpn", "wireguard" and "noop"

Example request

{
  "connect_options": {
    "kill_switch": true
  },
  "consumer_id": "0x0000000000000000000000000000000000000001",
  "hermes_id": "0x0000000000000000000000000000000000000003",
  "provider_id": "0x0000000000000000000000000000000000000002",
  "service_type": "openvpn"
}

Response

Connection started

consumer_idstring

hermes_idstring

session_idstring

statusstring

Example response

{
  "consumer_id": "0x00",
  "hermes_id": "0x00",
  "proposal": {
    "location": {
      "asn": 1,
      "city": "Amsterdam",
      "continent": "EU",
      "country": "NL",
      "ip_type": "residential",
      "isp": "Telia Lietuva, AB"
    },
    "provider_id": "0x0000000000000000000000000000000000000001",
    "service_type": "openvpn"
  },
  "session_id": "4cfb0324-daf6-4ad8-448b-e61fe0a1f918",
  "status": "Connected"
}