LogoLogo
GoodAccess WebsiteRequest Free TrialDownload App
  • Getting Started
    • 1. What is GoodAccess?
    • 2. Architecture Overview
    • 3. Sign up for Free Trial
    • 4. Download App & Connect
  • 🖥️Configuration guides
    • Features
      • Zero Trust Access Control
        • Access Cards
        • Device Posture Check
        • Device Approval
        • Geo Restrictions
      • API Integration
        • API Reference
          • Members
          • Groups
          • Systems
          • Access Cards
          • Relations
          • Gateways
          • Logs
        • Acronis Integration
      • SIEM Integration
      • SSO/SCIM
        • Auth0
        • Cisco Duo
        • Google Workspace
        • JumpCloud
        • Microsoft Entra ID
        • Okta
        • OneLogin
        • Ping Identity
        • Universal (SAML)
      • MFA
      • Passkeys
      • MSI deployment
      • Threat Blocker
      • Custom Domain Blocking
      • DNS Management
      • Split Tunneling
      • Port Forwarding
    • Branch Connector
      • Cisco
      • Cisco Meraki
      • FortiGate
      • MikroTik
      • SonicWall
      • UniFi USG
      • Zyxel Nebula Control Center
      • Other supported routers and firewalls
    • Cloud Connector
      • AWS
      • Google Cloud
      • Microsoft Azure
      • Other Public Cloud providers
    • IP whitelisting
      • APACHE Web Server
      • AWS VPC
      • Azure (Office 365)
      • Google Cloud
      • Google Workspace
      • Magento
      • Microsoft IIS
      • NGINX
        • Domain
        • Subdomain
        • URL
      • OpenCart
      • PHP
      • PHPMyAdmin
      • Pipedrive
      • SalesForce
      • SSH server
      • WordPress
      • Zoho CRM
    • Linux
      • DEB repository
      • RPM repository
      • Manual installation
      • Linux Troubleshooting
  • 🆘FAQ & Troubleshooting
    • FAQ
      • Business
      • Technical
    • Troubleshooting
  • 📓Product Changelog
    • Windows
    • macOS
Powered by GitBook
On this page

Was this helpful?

  1. Configuration guides
  2. Features
  3. API Integration
  4. API Reference

Logs

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

PreviousGatewaysNextAcronis Integration

Last updated 4 months ago

Was this helpful?

🖥️
  • GETGateway Level Logs
  • GETSystem Level Access Logs

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": "user@goodaccess.com"
    },
    "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": "user@goodaccess.com"
    },
    "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"
    }
  }
]