Systems

This endpoint allows you to fetch data about the defined Systems of your Team.

Read All Systems

GEThttps://{{goodaccess_integration_api_base}}/api/v1/systems

Authorization

bearerAuth

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://{{goodaccess_integration_api_base}}/api/v1/systems', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Read System

GEThttps://{{goodaccess_integration_api_base}}/api/v1/system/<system-id>

Authorization

bearerAuth

Response

200404

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://{{goodaccess_integration_api_base}}/api/v1/system/<system-id>', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Create System

POSThttps://{{goodaccess_integration_api_base}}/api/v1/system

Authorization

bearerAuth

Body

application/json

object

Response

200409

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://{{goodaccess_integration_api_base}}/api/v1/system', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "GoodAccess Example System",
      "host": "https://goodaccess.com",
      "uri": "https://goodaccess.com",
      "port": "8080",
      "protocol": "UDP"
    }),
});
const data = await response.json();

Update System

PUThttps://{{goodaccess_integration_api_base}}/api/v1/system/<system-id>

Authorization

bearerAuth

Body

application/json

object

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://{{goodaccess_integration_api_base}}/api/v1/system/<system-id>', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "GoodAccess Example System",
      "host": "https://goodaccess.com",
      "uri": "https://goodaccess.com",
      "port": "8080",
      "protocol": "UDP"
    }),
});
const data = await response.json();

Remove System

DELETEhttps://{{goodaccess_integration_api_base}}/api/v1/system/<system-id>

Authorization

bearerAuth

Response

200404

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://{{goodaccess_integration_api_base}}/api/v1/system/<system-id>', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();