Logs

This endpoint allows you to fetch the logs of your Team.

Gateway Level Logs

get
Authorizations
Body
objectOptionalExample: {"start":"2024-01-01 00:00:00","end":"2024-01-01 00:03:00","member_id":"4514960a-2b6d-46a2-9c22-c02cc727abb7","gateway_id":"12319na-31DA-gpaf-9c22-c02cc727abb7","page":1,"limit":10}
Responses
200
OK
application/json
Responseobject
get
GET /api/v1/gateway-level-logs HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "start": "2024-01-01 00:00:00",
  "end": "2024-01-01 00:03:00",
  "member_id": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
  "gateway_id": "12319na-31DA-gpaf-9c22-c02cc727abb7",
  "page": 1,
  "limit": 10
}
200

OK

[
  {
    "protocol": "OVPN",
    "start": "2024-04-03 00:00:00",
    "stop": "2024-04-03 00:03:00",
    "uploaded_bytes": 300,
    "downloaded_bytes": 20,
    "user": {
      "id": "8e4a413c-7f7b-4925-9b9b-e22c3f65f2a0",
      "name": "GoodAccess User",
      "username": "[email protected]"
    },
    "gateway": {
      "id": "8dfa00wds8-7f7b-4925-9b9b-e22c3f912f",
      "name": "USA Gateway",
      "ip": "192.168.0.1",
      "location": "San Francisco, USA"
    }
  }
]

System Level Access Logs

get
Authorizations
Body
objectOptionalExample: {"date":{"start":"2024-04-03 00:00:00","stop":"2024-04-03 00:03:00"},"member_id":"4514960a-2b6d-46a2-9c22-c02cc727abb7","gateway_id":"12319na-31DA-gpaf-9c22-c02cc727abb7","system_id":"adga12o-31DA-gpaf-9c22-agposa0","pagination":{"page":1,"limit":50}}
Responses
200
OK
application/json
Responseobject
get
GET /api/v1/system-level-logs HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 251

{
  "date": {
    "start": "2024-04-03 00:00:00",
    "stop": "2024-04-03 00:03:00"
  },
  "member_id": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
  "gateway_id": "12319na-31DA-gpaf-9c22-c02cc727abb7",
  "system_id": "adga12o-31DA-gpaf-9c22-agposa0",
  "pagination": {
    "page": 1,
    "limit": 50
  }
}
200

OK

[
  {
    "protocol": "proto",
    "start": "2024-04-03 00:00:00",
    "stop": "2024-04-03 00:03:00",
    "uploaded_bytes": 300,
    "downloaded_bytes": 20,
    "user": {
      "id": "8e4a413c-7f7b-4925-9b9b-e22c3f65f2a0",
      "name": "GoodAccess User",
      "username": "[email protected]"
    },
    "gateway": {
      "id": "8dfa00wds8-7f7b-4925-9b9b-e22c3f912f",
      "name": "USA Gateway",
      "ip": "192.168.0.1",
      "location": "San Francisco, USA"
    },
    "system": {
      "id": "iangalg1-afdoo1-afd3df-9b9b-e22c3f912f",
      "name": "GoodAccess System",
      "host": "goodaccess.com",
      "location": "https://goodaccess.com"
    }
  }
]

Last updated

Was this helpful?