Systems
This endpoint allows you to perform actions on a specific System of your Team.
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"
}
]
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"
}
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"
}
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"
}
Last updated
Was this helpful?