FastAPI (0.1.0)
Download OpenAPI specification:Download
Get Devices
header Parameters
Authorization (string) or Authorization (null) (Authorization) |
Responses
Response samples
- 200
- 422
Content type
application/json
[- {
- "description": {
- "id": "string",
- "attributes": { },
- "deviceInfo": { },
- "name": {
- "defaultNames": [
- "string"
], - "name": "string",
- "nicknames": [
- "string"
]
}, - "traits": [
- "string"
], - "type": "string"
}, - "states": { }
}
]
Create A Device
header Parameters
Authorization (string) or Authorization (null) (Authorization) |
Request Body schema: application/jsonrequired
required | object (DeviceDescription) |
required | object (States) |
Responses
Request samples
- Payload
Content type
application/json
{- "description": {
- "id": "string",
- "attributes": { },
- "deviceInfo": { },
- "name": {
- "defaultNames": [
- "string"
], - "name": "string",
- "nicknames": [
- "string"
]
}, - "traits": [
- "string"
], - "type": "string"
}, - "states": { }
}
Response samples
- 200
- 422
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
- 200
- 422
Content type
application/json
{- "description": {
- "id": "string",
- "attributes": { },
- "deviceInfo": { },
- "name": {
- "defaultNames": [
- "string"
], - "name": "string",
- "nicknames": [
- "string"
]
}, - "traits": [
- "string"
], - "type": "string"
}, - "states": { }
}
Update A Device
path Parameters
device_id required | string (Device Id) |
header Parameters
Authorization (string) or Authorization (null) (Authorization) |
Request Body schema: application/jsonrequired
required | object (DeviceDescription) |
required | object (States) |
Responses
Request samples
- Payload
Content type
application/json
{- "description": {
- "id": "string",
- "attributes": { },
- "deviceInfo": { },
- "name": {
- "defaultNames": [
- "string"
], - "name": "string",
- "nicknames": [
- "string"
]
}, - "traits": [
- "string"
], - "type": "string"
}, - "states": { }
}
Response samples
- 200
- 422
Content type
application/json
null
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/jsonrequired
property name* additional property | any |
Responses
Request samples
- Payload
Content type
application/json
{ }
Response samples
- 200
- 422
Content type
application/json
null
Get Settings
header Parameters
Authorization (string) or Authorization (null) (Authorization) |
Responses
Response samples
- 200
- 422
Content type
application/json
{- "client_id": "string",
- "client_secret": "string",
- "ddns": {
- "enabled": true,
- "hostname": "string",
- "password": "string",
- "provider": "string",
- "username": "string"
}, - "domain": "string",
- "log": {
- "days": 0
}, - "mqtt": {
- "user": "string",
- "password": "string"
}, - "sync_devices": true,
- "sync_google": true
}
Update Settings
header Parameters
Authorization (string) or Authorization (null) (Authorization) |
Request Body schema: application/jsonrequired
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
- Payload
Content type
application/json
{- "client_id": "string",
- "client_secret": "string",
- "ddns": {
- "enabled": true,
- "hostname": "string",
- "password": "string",
- "provider": "string",
- "username": "string"
}, - "domain": "string",
- "log": {
- "days": 0
}, - "mqtt": {
- "user": "string",
- "password": "string"
}, - "sync_devices": true,
- "sync_google": true
}
Response samples
- 200
- 422
Content type
application/json
{- "client_id": "string",
- "client_secret": "string",
- "ddns": {
- "enabled": true,
- "hostname": "string",
- "password": "string",
- "provider": "string",
- "username": "string"
}, - "domain": "string",
- "log": {
- "days": 0
}, - "mqtt": {
- "user": "string",
- "password": "string"
}, - "sync_devices": true,
- "sync_google": true
}
Set Service Account Key
header Parameters
Authorization (string) or Authorization (null) (Authorization) |
Request Body schema: application/jsonrequired
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
- Payload
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
- 200
- 422
Content type
application/json
null
Get System Status
header Parameters
Authorization (string) or Authorization (null) (Authorization) |
Responses
Response samples
- 200
- 422
Content type
application/json
{- "api": {
- "enable": true,
- "status": "string",
- "title": "string"
}, - "mqtt": {
- "enable": true,
- "status": "string",
- "title": "string"
}, - "tasks": {
- "enable": true,
- "status": "string",
- "title": "string"
}, - "redis": {
- "enable": true,
- "status": "string",
- "title": "string"
}, - "mongo": {
- "enable": true,
- "status": "string",
- "title": "string"
}
}
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
- Payload
Content type
application/json
null
Response samples
- 200
- 422
Content type
application/json
null