mATRIC API (1.0.0)

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

Download OpenAPI description
openapi.json
openapi.yaml
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

Create First Agent

Request

Bodyapplication/jsonrequired
ap_idany(Ap Id)required
passwordany(Password)required
configurationany(Configuration)required
curl -i -X POST \
  https://matric-docs.redocly.app/_mock/openapi/agents/public \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ap_id": null,
    "password": null,
    "configuration": null
  }'

Responses

Successful Response

Bodyapplication/json
idany(uuid)(Id)required
ap_idany(Ap Id)required
configurationany(Configuration)required
Response
application/json
{
  "id": null,
  "ap_id": null,
  "configuration": null
}

Create Agent

Request

Bodyapplication/jsonrequired
ap_idany(Ap Id)required
passwordany(Password)required
configurationany(Configuration)required
curl -i -X POST \
  https://matric-docs.redocly.app/_mock/openapi/agents \
  -H 'Content-Type: application/json' \
  -d '{
    "ap_id": null,
    "password": null,
    "configuration": null
  }'

Responses

Successful Response

Bodyapplication/json
idany(uuid)(Id)required
ap_idany(Ap Id)required
configurationany(Configuration)required
Response
application/json
{
  "id": null,
  "ap_id": null,
  "configuration": null
}

Get Agent

Request

Path
ap_idany(Ap Id)required
curl -i -X GET \
  'https://matric-docs.redocly.app/_mock/openapi/agents/{ap_id}'

Responses

Successful Response

Bodyapplication/json
idany(uuid)(Id)required
ap_idany(Ap Id)required
configurationany(Configuration)required
Response
application/json
{
  "id": null,
  "ap_id": null,
  "configuration": null
}

Update Agent

Request

Path
ap_idany(Ap Id)required
Bodyapplication/jsonrequired
passwordPassword (any) or Password (any)(Password)
Any of:
any(Password)
configurationConfiguration (any) or Configuration (any)(Configuration)
Any of:
any(Configuration)
curl -i -X PUT \
  'https://matric-docs.redocly.app/_mock/openapi/agents/{ap_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": {},
    "configuration": {}
  }'

Responses

Successful Response

Bodyapplication/json
idany(uuid)(Id)required
ap_idany(Ap Id)required
configurationany(Configuration)required
Response
application/json
{
  "id": null,
  "ap_id": null,
  "configuration": null
}

Delete Agent

Request

Path
ap_idany(Ap Id)required
curl -i -X DELETE \
  'https://matric-docs.redocly.app/_mock/openapi/agents/{ap_id}'

Responses

Successful Response

Bodyapplication/json
any(Response Delete Agent Agents Ap Id Delete)
Response
application/json
null

third_party_apps

Operations

agent_update

Operations

agent_details

Operations

agent_data

Operations

send_command

Operations

agent_data_callback

Operations

agent_details_callback

Operations