Skip to content

API Modules & Methods

All NestMTX APIs share a common structure for handling requests. Each request is processed by translating it into a command that the application can handle. The following describes the API modules and methods which are available for use.

The auth Module

User Authentication Operations

OperationDescriptionRequires Authentication
createAuthenticate a userNo

Payload for auth create

FieldType
usernamestring
passwordstring

The cameras Module

Manage Camera Feeds

OperationDescriptionRequires Authentication
listSearch for and list CamerasYes
readRead an cameras entityYes
updateUpdate an cameras entityYes

Payload for cameras update

FieldType
mtx_pathstring
is_enabledboolean
is_persistentboolean

The credentials Module

Manage Google Cloud Platform and Google Device Access Console credentials

OperationDescriptionRequires Authentication
listSearch for and list credentialsYes
createAdd new credentialsYes
readAuthorize credentials based on the authorization codeYes
updateGet either the authorization URL or the Device Access Console URLYes
deleteDelete an credentials entityYes

Payload for credentials create

FieldType
descriptionstring
oauth_client_idstring
oauth_client_secretstring
dac_project_idstring

Payload for credentials update

FieldType
originstring

The cronjobs Module

Cronjob Statuses

OperationDescriptionRequires Authentication
listList all cronjobs entitiesYes
updateUpdate an cronjobs entityYes

The health Module

Application Health

OperationDescriptionRequires Authentication
listCheck the health of the applicationNo

The htop Module

Health & Table of Processes

OperationDescriptionRequires Authentication
listGet the HTOP ReportYes
updateUpdate an htop entityYes

The swagger Module

API Specification

OperationDescriptionRequires Authentication
listGet the OpenAPI specification for the APINo

The users Module

Manage Users

OperationDescriptionRequires Authentication
listList all users entitiesYes
createCreate a new users entityYes
readRead an users entityYes
updateUpdate an users entityYes
deleteDelete an users entityYes

Payload for users create

FieldType
usernamestring
passwordstring
can_loginboolean

Payload for users update

FieldType
passwordstring
can_loginboolean

The version Module

Application Version Information

OperationDescriptionRequires Authentication
listGet the current Application Version InformationNo