Sign in
latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

vpn agents

Returns the specified vpn agent.

You have to be a member of workspace

get/agents/vpn/{vpn-agent_id}

Path parameters

vpn-agent_idstring required

VPN agent identifier

Response

OK

metaobject required

Example response

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "links": {
      "self": "/v2/agents/vpn/5b4f337bff4304610483ba67"
    },
    "attributes": {
      "name": "My Agent",
      "status": "online",
      "port_mapping": [
        {
          "port": 1052,
          "destination_port": 3306,
          "destination_ip": "133.164.183.134"
        }
      ]
    },
    "relationships": {
      "workspace": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/workspaces/5b4f337bff4304610483ba67"
        }
      }
    }
  }
}