Systems

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

Fetch All Systems

get

/api/v1/systems

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://integration.goodaccess.com/api/v1/systems' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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

OK

Fetch System by its ID

get

/api/v1/system/{systemId}

Authorizations

Path parameters

systemIdstringrequired

ID of system

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://integration.goodaccess.com/api/v1/system/{systemId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

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

OK

Create System

post

/api/v1/system

Authorizations

Body

object

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://integration.goodaccess.com/api/v1/system' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "GoodAccess Example System",
    "host": "https://goodaccess.com",
    "uri": "https://goodaccess.com",
    "port": "8080",
    "protocol": "UDP"
  }'

200

409

200

{
  "created_id": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
  "message": "System created successfully"
}

OK

Update System by its ID

put

/api/v1/system/{systemId}

Authorizations

Path parameters

systemIdstringrequired

ID of system

Body

object

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

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://integration.goodaccess.com/api/v1/system/{systemId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "GoodAccess Example System",
    "host": "https://goodaccess.com",
    "uri": "https://goodaccess.com",
    "port": "8080",
    "protocol": "UDP"
  }'

200

404

409

200

{
  "message": "System updated successfully"
}

OK

Remove System by its ID

delete

/api/v1/system/{systemId}

Authorizations

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://integration.goodaccess.com/api/v1/system/{systemId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

No body

Successful response

Relations