jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-17 14:26:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added more clarity to REST integration docs. (#34885)

Browse Source
This commit is contained in:
Stuart Holland 2024-09-24 15:10:59 +01:00 committed by GitHub
parent 0ed3179680
commit 3d10a7ae71
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/_integrations/rest.markdown
View File

@ -128,21 +128,21 @@ payload:
required: false required: false
type: string type: string
payload_template: payload_template:
description: The payload to send with a POST request with template support. Depends on the service, but usually formed as JSON. description: The payload to send with a POST request, with template support. Depends on the service, but usually formed as JSON.
required: false required: false
type: template type: template
verify_ssl: verify_ssl:
description: Verify the SSL certificate of the endpoint. description: Whether to verify the SSL certificate of the endpoint.
required: false required: false
type: boolean type: boolean
default: True default: True
ssl_cipher_list: ssl_cipher_list:
description: Define the list of SSL ciphers to be accepted from this endpoint. `python_default` (_default_), `modern` or `intermediate` (_inspired by [Mozilla Security/Server Side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS)_). description: The list of SSL ciphers to be accepted from this endpoint. `python_default` (_default_), `modern` or `intermediate` (_inspired by [Mozilla Security/Server Side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS)_).
required: false required: false
type: string type: string
default: default default: default
timeout: timeout:
description: Defines max time to wait data from the endpoint. description: The maximum time in seconds to wait for data from the endpoint. If the timeout is reached, the sensor will become `unavailable`.
required: false required: false
type: integer type: integer
default: 10 default: 10
@ -167,7 +167,7 @@ params:
required: false required: false
type: [list, template] type: [list, template]
scan_interval: scan_interval:
description: Define the refrequency to call the REST endpoint in seconds. description: The frequency in seconds to call the REST endpoint.
required: false required: false
type: integer type: integer
default: 30 default: 30