GoodAccess Website Request Free Trial Download App

Systems

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

PreviousGroups NextAccess Cards

Last updated 5 months ago

Was this helpful?

Fetch All Systems

get

Authorizations

Responses

200

application/json

Responseobject

get

GET /api/v1/systems HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

[
  {
    "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

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

Create System

post

Authorizations

Body

objectOptionalExample:

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

Responses

200

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

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"
}