HTTP

The HTTP service provides functionality for sending HTTP/HTTPS requests through the RPC methods HTTP.GET and HTTP.POST. Also a generic HTTP.Request RPC call is provided which allows sending several HTTP methods.

HTTP.GET

This method allows fetching resources using HTTP/HTTPS GET requests.

Request

Parameters:

Property	Type	Description
url	string	Url address of the request. Required
timeout	number	Timeout in seconds. Optional
ssl_ca	string or null	Type of the TCP socket. Optional Value Description null Default value, the built-in ca.pem TLS CA is used for HTTPS requests user_ca.pem The user-provided TLS CA is used for HTTPS requests, see Shelly.PutUserCA * Disabled certificate validation

Response

Attributes in the result:

Property	Type	Description
code	number	Code of the HTTP response
message	string	Msssage of the HTTP response
headers	object	List of HTTP headers sent by the server
body	string	HTTP response body, if Content-Type is text or application/json
body_b64	string	base64 encoded HTTP response body, if body is binary data. Maximum accepted length is 16KB (16384 bytes)

HTTP.POST

This method allows posting data and receiving response using HTTP/HTTPS POST requests.

Request

Parameters:

Property	Type	Description
url	string	URL address of the request. Required
body	string	The request body. Required
body_b64	string	base64 encoded binary request body. Either body or body_b64 is allowed
content_type	string	Value of the Content-Type header sent with the request Optional, default is application/json
timeout	number	Timeout in seconds. Optional
ssl_ca	string or null	Type of the TCP socket. Optional Value Description null Default value, the built-in ca.pem TLS CA is used for HTTPS requests user_ca.pem The user-provided TLS CA is used for HTTPS requests, see Shelly.PutUserCA * Disabled certificate validation

Response

Attributes in the result:

Property	Type	Description
code	number	Code of the HTTP response
message	string	Message of the HTTP response
headers	object	List of HTTP headers sent by the server
body	string	HTTP response body, if Content-Type is text or application/json
body_b64	string	base64 encoded HTTP response body, if body is binary data. Maximum accepted length is 16KB (16384 bytes)

HTTP.Request

This method allows sending several HTTP methods through HTTP/HTTPS and receiving response. Currently supported are GET, POST, PUT, HEAD and DELETE.

Request

Parameters:

Property	Type	Description
method	string	Method to send. Valid values are GET, POST, PUT, HEAD, DELETE. Required
url	string	URL address of the request. Required
body	string	The request body. Disallowed for GET and HEAD and Required for POST and PUT.
body_b64	string	base64 encoded binary request body. Either body or body_b64 is allowed.
headers	object	User supplied headers for the request, keys are header names and values are header values. Optional. User-Agent and Content-Length headers are disallowed and will be replaced with default values if specified. Contnet-Type header defaults to application/json for body and application/octet-stream for body_b64 if not specified.
timeout	number	Timeout in seconds. Optional
ssl_ca	string or null	Type of the TCP socket. Optional Value Description null Default value, the built-in ca.pem TLS CA is used for HTTPS requests user_ca.pem The user-provided TLS CA is used for HTTPS requests, see Shelly.PutUserCA * Disabled certificate validation

Response

Attributes in the result:

Property	Type	Description
code	number	Code of the HTTP response
message	string	Message of the HTTP response
headers	object	List of HTTP headers sent by the server
body	string	HTTP response body, if Content-Type is text or application/json
body_b64	string	base64 encoded HTTP response body, if body is binary data. Maximum accepted length is 16KB (16384 bytes)

Examples

HTTP.GET example

HTTP.GET HTTP GET Request

http://192.168.33.1/rpc/HTTP.GET?url="http://10.33.53.21/rpc/Shelly.GetDeviceInfo"

HTTP.GET Curl Request

curl -X POST -d '{"id":1,"method":"HTTP.GET","params":{"url":"http://10.33.53.21/rpc/Shelly.GetDeviceInfo"}}' http://${SHELLY}/rpc

HTTP.GET Mos Request

mos --port ${PORT} call HTTP.GET '{"url":"http://10.33.53.21/rpc/Shelly.GetDeviceInfo"}'

Response

HTTP.GET HTTP GET Response

{
  "code": 200,
  "message": "OK",
  "headers": {
    "Server": "Mongoose/6.18",
    "Content-Type": "application/json",
    "Access-Control-Allow-Origin": "*",
    "Access-Control-Allow-Headers": "*",
    "Content-Length": "232",
    "Connection": "close"
  },
  "body": "{\"id\":\"shellydev1-f008d1e2cb4c\", \"mac\":\"F008D1E2CB4C\", \"model\":\"SNSW-devX16EU\", \"gen\":2, \"fw_id\":\"20210908-124312/0.7.0-29-g0df1661-145-rpc-http-get-improvements-2\", \"ver\":\"0.7.0\", \"app\":\"Dev1\", \"auth_en\":false,\"auth_domain\":null}\r\n"
}

HTTP.GET Curl Response

{
  "id": 1,
  "src": "shellydev1-f008d1e2cb4c",
  "params": {
    "code": 200,
    "message": "OK",
    "headers": {
      "Server": "Mongoose/6.18",
      "Content-Type": "application/json",
      "Access-Control-Allow-Origin": "*",
      "Access-Control-Allow-Headers": "*",
      "Content-Length": "232",
      "Connection": "close"
    },
    "body": "{\"id\":\"shellydev1-f008d1e2cb4c\", \"mac\":\"F008D1E2CB4C\", \"model\":\"SNSW-devX16EU\", \"gen\":2, \"fw_id\":\"20210908-124312/0.7.0-29-g0df1661-145-rpc-http-get-improvements-2\", \"ver\":\"0.7.0\", \"app\":\"Dev1\", \"auth_en\":false,\"auth_domain\":null}\r\n"
  }
}

HTTP.GET Mos Response

{
  "code": 200,
  "message": "OK",
  "headers": {
    "Server": "Mongoose/6.18",
    "Content-Type": "application/json",
    "Access-Control-Allow-Origin": "*",
    "Access-Control-Allow-Headers": "*",
    "Content-Length": "232",
    "Connection": "close"
  },
  "body": "{\"id\":\"shellydev1-f008d1e2cb4c\", \"mac\":\"F008D1E2CB4C\", \"model\":\"SNSW-devX16EU\", \"gen\":2, \"fw_id\":\"20210908-124312/0.7.0-29-g0df1661-145-rpc-http-get-improvements-2\", \"ver\":\"0.7.0\", \"app\":\"Dev1\", \"auth_en\":false,\"auth_domain\":null}\r\n"
}

HTTP.POST example

HTTP.POST HTTP GET Request

http://192.168.33.1/rpc/HTTP.POST?url="http://10.33.53.21/rpc/Sys.SetConfig"&body={"config":{"location":{"tz":"UTC"}}}

HTTP.POST Curl Request

curl -X POST -d '{"id":1,"method":"HTTP.POST","params":{"url":"http://10.33.53.21/rpc/Sys.SetConfig","body":{"config":{"location":{"tz":"UTC"}}}}}' http://${SHELLY}/rpc

HTTP.POST Mos Request

mos --port ${PORT} call HTTP.POST '{"url":"http://10.33.53.21/rpc/Sys.SetConfig","body":{"config":{"location":{"tz":"UTC"}}}}'

Response

HTTP.POST HTTP GET Response

{
  "code": 200,
  "message": "OK",
  "headers": {
    "Server": "Mongoose/6.18",
    "Content-Type": "application/json",
    "Access-Control-Allow-Origin": "*",
    "Access-Control-Allow-Headers": "*",
    "Content-Length": "28",
    "Connection": "close"
  },
  "body": "{\"restart_required\":false}\r\n"
}

HTTP.POST Curl Response

{
  "id": 1,
  "src": "shellydev1-f008d1e2cb4c",
  "params": {
    "code": 200,
    "message": "OK",
    "headers": {
      "Server": "Mongoose/6.18",
      "Content-Type": "application/json",
      "Access-Control-Allow-Origin": "*",
      "Access-Control-Allow-Headers": "*",
      "Content-Length": "28",
      "Connection": "close"
    },
    "body": "{\"restart_required\":false}\r\n"
  }
}

HTTP.POST Mos Response

{
  "code": 200,
  "message": "OK",
  "headers": {
    "Server": "Mongoose/6.18",
    "Content-Type": "application/json",
    "Access-Control-Allow-Origin": "*",
    "Access-Control-Allow-Headers": "*",
    "Content-Length": "28",
    "Connection": "close"
  },
  "body": "{\"restart_required\":false}\r\n"
}

HTTP.Request example

HTTP.Request HTTP GET Request

http://192.168.33.1/rpc/HTTP.Request?method="POST"&url="http://10.33.53.21/rpc/Sys.SetConfig"&body={"config":{"location":{"tz":"UTC"}}}

HTTP.Request Curl Request

curl -X POST -d '{"id":1,"method":"HTTP.Request","params":{"method":"POST","url":"http://10.33.53.21/rpc/Sys.SetConfig","body":{"config":{"location":{"tz":"UTC"}}}}}' http://${SHELLY}/rpc

HTTP.Request Mos Request

mos --port ${PORT} call HTTP.Request '{"method":"POST","url":"http://10.33.53.21/rpc/Sys.SetConfig","body":{"config":{"location":{"tz":"UTC"}}}}'

Response

HTTP.Request HTTP GET Response

{
  "code": 200,
  "message": "OK",
  "headers": {
    "Server": "Mongoose/6.18",
    "Content-Type": "application/json",
    "Access-Control-Allow-Origin": "*",
    "Access-Control-Allow-Headers": "*",
    "Content-Length": "28",
    "Connection": "close"
  },
  "body": "{\"restart_required\":false}\r\n"
}

HTTP.Request Curl Response

{
  "id": 1,
  "src": "shellydev1-f008d1e2cb4c",
  "params": {
    "code": 200,
    "message": "OK",
    "headers": {
      "Server": "Mongoose/6.18",
      "Content-Type": "application/json",
      "Access-Control-Allow-Origin": "*",
      "Access-Control-Allow-Headers": "*",
      "Content-Length": "28",
      "Connection": "close"
    },
    "body": "{\"restart_required\":false}\r\n"
  }
}

HTTP.Request Mos Response

{
  "code": 200,
  "message": "OK",
  "headers": {
    "Server": "Mongoose/6.18",
    "Content-Type": "application/json",
    "Access-Control-Allow-Origin": "*",
    "Access-Control-Allow-Headers": "*",
    "Content-Length": "28",
    "Connection": "close"
  },
  "body": "{\"restart_required\":false}\r\n"
}