Skip to main content
API docs by Redocly

FastAPI (0.1.0)

Download OpenAPI specification:Download

Get Access

header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Access

header Parameters
Authorization (string) or Authorization (null) (Authorization)
Request Body schema: application/json
required
agent
required
string (Agent)

Responses

Request samples

Content type
application/json
{
  • "agent": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "agent": "string",
  • "apikey": "string"
}

Delete Access

path Parameters
apikey_id
required
string (Apikey Id)
header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "agent": "string",
  • "apikey": "string"
}

Get Backup

header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
null

Restore Backup

header Parameters
Authorization (string) or Authorization (null) (Authorization)
Request Body schema: application/json
Any of
property name*
additional property
any

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
null

Get Devices

header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create A Device

header Parameters
Authorization (string) or Authorization (null) (Authorization)
Request Body schema: application/json
required
required
object (DeviceDescription)
required
object (States)

Responses

Request samples

Content type
application/json
{
  • "description": {
    },
  • "states": { }
}

Response samples

Content type
application/json
null

Get A Device

path Parameters
device_id
required
string (Device Id)
header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
{
  • "description": {
    },
  • "states": { }
}

Update A Device

path Parameters
device_id
required
string (Device Id)
header Parameters
Authorization (string) or Authorization (null) (Authorization)
Request Body schema: application/json
required
required
object (DeviceDescription)
required
object (States)

Responses

Request samples

Content type
application/json
{
  • "description": {
    },
  • "states": { }
}

Response samples

Content type
application/json
null

Delete A Device

path Parameters
device_id
required
string (Device Id)
header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
null

Get States Of A Device

path Parameters
device_id
required
string (Device Id)
header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
{ }

Update States Of A Device

path Parameters
device_id
required
string (Device Id)
header Parameters
Authorization (string) or Authorization (null) (Authorization)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Get A State Of A Device

path Parameters
device_id
required
string (Device Id)
state_name
required
string (State Name)
header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
null

Get Log

header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Log

header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
true

Get Alerts

header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
{
  • "alert": "set"
}

Get Settings

header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "client_secret": "string",
  • "ddns": {
    },
  • "domain": "string",
  • "log": {
    },
  • "mqtt": {
    },
  • "sync_devices": true,
  • "sync_google": true
}

Update Settings

header Parameters
Authorization (string) or Authorization (null) (Authorization)
Request Body schema: application/json
required
required
Client Id (string) or Client Id (null) (Client Id)
required
Client Secret (string) or Client Secret (null) (Client Secret)
required
DDNS (object) or null
required
Domain (string) or Domain (null) (Domain)
required
Log (object) or null
required
MQTT (object) or null
required
Sync Devices (boolean) or Sync Devices (null) (Sync Devices)
required
Sync Google (boolean) or Sync Google (null) (Sync Google)

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "client_secret": "string",
  • "ddns": {
    },
  • "domain": "string",
  • "log": {
    },
  • "mqtt": {
    },
  • "sync_devices": true,
  • "sync_google": true
}

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "client_secret": "string",
  • "ddns": {
    },
  • "domain": "string",
  • "log": {
    },
  • "mqtt": {
    },
  • "sync_devices": true,
  • "sync_google": true
}

Set Service Account Key

header Parameters
Authorization (string) or Authorization (null) (Authorization)
Request Body schema: application/json
required
type
required
string (Type)
project_id
required
string (Project Id)
private_key_id
required
string (Private Key Id)
private_key
required
string (Private Key)
client_email
required
string (Client Email)
client_id
required
string (Client Id)
auth_uri
required
string (Auth Uri)
token_uri
required
string (Token Uri)
auth_provider_x509_cert_url
required
string (Auth Provider X509 Cert Url)
client_x509_cert_url
required
string (Client X509 Cert Url)
universe_domain
required
string (Universe Domain)

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "project_id": "string",
  • "private_key_id": "string",
  • "private_key": "string",
  • "client_email": "string",
  • "client_id": "string",
  • "auth_uri": "string",
  • "token_uri": "string",
  • "auth_provider_x509_cert_url": "string",
  • "client_x509_cert_url": "string",
  • "universe_domain": "string"
}

Response samples

Content type
application/json
null

Get System Version

header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
{
  • "version": "string"
}

Get System Status

header Parameters
Authorization (string) or Authorization (null) (Authorization)

Responses

Response samples

Content type
application/json
{
  • "api": {
    },
  • "mqtt": {
    },
  • "tasks": {
    },
  • "redis": {
    },
  • "mongo": {
    }
}

Validate User Token

header Parameters
Token (string) or Token (null) (Token)

Responses

Response samples

Content type
application/json
{
  • "valid": true
}

User Login

header Parameters
Username (string) or Username (null) (Username)
Password (string) or Password (null) (Password)

Responses

Response samples

Content type
application/json
{
  • "username": "string",
  • "token": "string",
  • "valid": true
}

Change User Password

header Parameters
Authorization (string) or Authorization (null) (Authorization)
Request Body schema: application/json
Any of
password
required
string (Password)
new_password
required
string (New Password)

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
null

Test Endpoint

Responses

System Clock

Responses

Response samples

Content type
application/json
null