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

Systems

This endpoint allows you to perform actions on a specific System of your Team.

PreviousGroupsNextAccess Cards

Last updated 4 months ago

Was this helpful?

🖥️
Relations

Fetch All Systems

get
Authorizations
Responses
200
OK
application/json
Responseobject
get
GET /api/v1/systems HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "id": "69f25acc-7eb8-494b-bb64-7671b5726e2d",
    "created_at": "2024-08-15 10:48:44",
    "name": "GoodAccess System",
    "is_valid": true,
    "port": "8080",
    "host": "goodaccess.com",
    "uri": "https://goodaccess.com"
  }
]

Fetch System by its ID

get
Authorizations
Path parameters
systemIdstringRequired

ID of system

Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
get
GET /api/v1/system/{systemId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69f25acc-7eb8-494b-bb64-7671b5726e2d",
  "created_at": "2024-08-15 10:48:44",
  "name": "GoodAccess System",
  "is_valid": true,
  "port": "8080",
  "host": "goodaccess.com",
  "uri": "https://goodaccess.com"
}

Remove System by its ID

delete
Authorizations
Responses
200
Successful response
application/json
404
Not Found
application/json
delete
DELETE /api/v1/system/{systemId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

  • GETFetch All Systems
  • GETFetch System by its ID
  • POSTCreate System
  • PUTUpdate System by its ID
  • DELETERemove System by its ID
  • Relations

Create System

post
Authorizations
Body
objectOptionalExample: {"name":"GoodAccess Example System","host":"https://goodaccess.com","uri":"https://goodaccess.com","port":"8080","protocol":"UDP"}
Responses
200
OK
application/json
Responseobject
409
Conflict
application/json
post
POST /api/v1/system HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "name": "GoodAccess Example System",
  "host": "https://goodaccess.com",
  "uri": "https://goodaccess.com",
  "port": "8080",
  "protocol": "UDP"
}
{
  "created_id": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
  "message": "System created successfully"
}

Update System by its ID

put
Authorizations
Path parameters
systemIdstringRequired

ID of system

Body
objectOptionalExample: {"name":"GoodAccess Example System","host":"https://goodaccess.com","uri":"https://goodaccess.com","port":"8080","protocol":"UDP"}
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
409
Conflict
application/json
put
PUT /api/v1/system/{systemId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "name": "GoodAccess Example System",
  "host": "https://goodaccess.com",
  "uri": "https://goodaccess.com",
  "port": "8080",
  "protocol": "UDP"
}
{
  "message": "System updated successfully"
}