Logs

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

Gateway Level Logs

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"date":{"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","pagination":{"page":1,"limit":10}}

Responses

200

OK

application/json

Responseobject

get/api/v1/gateway-level-logs

HTTPcURLJavaScriptPython

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: 205

{
  "date": {
    "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",
  "pagination": {
    "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": "[e-mail]"
    },
    "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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"date":{"start":"2024-04-03 00:00:00","end":"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/api/v1/system-level-logs

HTTPcURLJavaScriptPython

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: 250

{
  "date": {
    "start": "2024-04-03 00:00:00",
    "end": "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": "[e-mail]"
    },
    "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"
    }
  }
]

Threat Blocker Logs

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

members[]string[]Optional

Filter by member UUIDs

domains[]string[]Optional

Filter by blocked domain names

searchstringOptional

Search across domain, member name and username

sort_bystring · enumOptional

Field to sort by

Possible values:

sort_dirstring · enumOptional

Sort direction

Default: descPossible values:

Body

application/json

objectOptionalExample: {"date":{"start":"2024-01-01 00:00:00","end":"2024-12-31 23:59:59"},"pagination":{"page":1,"limit":50},"members":["4514960a-2b6d-46a2-9c22-c02cc727abb7"],"domains":["malware-site.example.com"],"search":"malware","sort_by":"last_hit","sort_dir":"desc"}

Responses

200

OK

application/json

Responseobject[]

400

Bad Request

application/json

get/api/v1/threat-blocker-logs

HTTPcURLJavaScriptPython

GET /api/v1/threat-blocker-logs HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 251

{
  "date": {
    "start": "2024-01-01 00:00:00",
    "end": "2024-12-31 23:59:59"
  },
  "pagination": {
    "page": 1,
    "limit": 50
  },
  "members": [
    "4514960a-2b6d-46a2-9c22-c02cc727abb7"
  ],
  "domains": [
    "malware-site.example.com"
  ],
  "search": "malware",
  "sort_by": "last_hit",
  "sort_dir": "desc"
}

[
  {
    "member": {
      "uuid": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
      "name": "Jane Doe",
      "username": "[e-mail]"
    },
    "domain": "malware-site.example.com",
    "hits": 14,
    "last_hit": "2024-06-15 09:41:02",
    "block_source": "Threat Blocker"
  }
]

Device Posture Check Logs

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"date":{"start":"2024-06-01 00:00:00","end":"2024-06-30 23:59:59"},"member_id":"4514960a-2b6d-46a2-9c22-c02cc727abb7","device_id":"735df4b6-c4da-4fb6-9581-89c91fe866bf","policy_id":"9a1bc234-ef56-7890-ab12-cd34ef567890","status":"failed","pagination":{"page":1,"limit":50}}

Responses

200

OK

application/json

Responseobject[]

400

Bad Request

application/json

404

Not Found

application/json

get/api/v1/device-posture-check-logs

HTTPcURLJavaScriptPython

GET /api/v1/device-posture-check-logs HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 274

{
  "date": {
    "start": "2024-06-01 00:00:00",
    "end": "2024-06-30 23:59:59"
  },
  "member_id": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
  "device_id": "735df4b6-c4da-4fb6-9581-89c91fe866bf",
  "policy_id": "9a1bc234-ef56-7890-ab12-cd34ef567890",
  "status": "failed",
  "pagination": {
    "page": 1,
    "limit": 50
  }
}

[
  {
    "id": 301,
    "timestamp": "2024-06-15T08:30:00+02:00",
    "last_check": "2024-06-15T08:29:55+02:00",
    "is_successful": false,
    "member": {
      "id": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
      "name": "Jane Doe",
      "username": "[e-mail]"
    },
    "device": {
      "id": "735df4b6-c4da-4fb6-9581-89c91fe866bf",
      "name": "Jane's MacBook",
      "os_name": "macOS",
      "os_version": "14.4"
    },
    "checks": [
      {
        "policy_id": "9a1bc234-ef56-7890-ab12-cd34ef567890",
        "policy_name": "Disk Encryption Required",
        "is_deleted": false,
        "is_successful": false,
        "deny_access": true,
        "failure_reasons": [
          "Disk encryption is not enabled."
        ]
      }
    ]
  }
]

Admin Logs

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

categories[]string[]Optional

Filter by log category names

searchstringOptional

Search across message, category, admin name and email

Body

application/json

objectOptionalExample: {"date":{"start":"2024-01-01 00:00:00","end":"2024-12-31 23:59:59"},"pagination":{"page":1,"limit":50},"categories":["member_management"],"search":"jane.doe"}

Responses

200

OK

application/json

Responseobject[]

400

Bad Request

application/json

get/api/v1/admin-logs

HTTPcURLJavaScriptPython

GET /api/v1/admin-logs HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "date": {
    "start": "2024-01-01 00:00:00",
    "end": "2024-12-31 23:59:59"
  },
  "pagination": {
    "page": 1,
    "limit": 50
  },
  "categories": [
    "member_management"
  ],
  "search": "jane.doe"
}

[
  {
    "id": 1042,
    "admin": {
      "name": "John Doe",
      "email": "[e-mail]"
    },
    "ip": "203.0.113.42",
    "date": "2024-06-15 10:23:45",
    "category": "member_management",
    "message": "Team member [e-mail] was invited."
  }
]