mATRIC API (1.0.0)

mATRIC API for managing users, agents, and third-party apps.

Download OpenAPI description
Overview
License MIT
Languages
Servers
Mock server
https://matric-docs.redocly.app/_mock/openapi/
https://matric-docs.redocly.app/

token

Operations

users

Operations

agents

Operations

third_party_apps

Operations

Create Third Party App

Request

Bodyapplication/jsonrequired
app_nameany(App Name)required
api_keyany(Api Key)required
permissionsany(Permissions)required
curl -i -X POST \
  https://matric-docs.redocly.app/_mock/openapi/third_party_apps \
  -H 'Content-Type: application/json' \
  -d '{
    "app_name": null,
    "api_key": null,
    "permissions": null
  }'

Responses

Successful Response

Bodyapplication/json
idany(uuid)(Id)required
app_nameany(App Name)required
api_keyany(Api Key)required
permissionsany(Permissions)required
Response
application/json
{ "id": null, "app_name": null, "api_key": null, "permissions": null }

Get Third Party App

Request

Path
app_nameany(App Name)required
curl -i -X GET \
  'https://matric-docs.redocly.app/_mock/openapi/third_party_apps/{app_name}'

Responses

Successful Response

Bodyapplication/json
idany(uuid)(Id)required
app_nameany(App Name)required
api_keyany(Api Key)required
permissionsany(Permissions)required
Response
application/json
{ "id": null, "app_name": null, "api_key": null, "permissions": null }

Update Third Party App

Request

Path
app_nameany(App Name)required
Bodyapplication/jsonrequired
api_keyApi Key (any) or Api Key (any)(Api Key)
Any of:
any(Api Key)
permissionsPermissions (any) or Permissions (any)(Permissions)
Any of:
any(Permissions)
curl -i -X PUT \
  'https://matric-docs.redocly.app/_mock/openapi/third_party_apps/{app_name}' \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": {},
    "permissions": {}
  }'

Responses

Successful Response

Bodyapplication/json
idany(uuid)(Id)required
app_nameany(App Name)required
api_keyany(Api Key)required
permissionsany(Permissions)required
Response
application/json
{ "id": null, "app_name": null, "api_key": null, "permissions": null }

Delete Third Party App

Request

Path
app_nameany(App Name)required
curl -i -X DELETE \
  'https://matric-docs.redocly.app/_mock/openapi/third_party_apps/{app_name}'

Responses

Successful Response

Bodyapplication/json
any(Response Delete Third Party App Third Party Apps App Name Delete)
Response
application/json
null

agent_update

Operations

agent_details

Operations

agent_data

Operations

send_command

Operations

agent_data_callback

Operations

agent_details_callback

Operations