/api/v1/home-assistant/link-requests (POST)

POST

/api/v1/home-assistant/link-requests

curl --request POST \
  --url https://example.com/api/v1/home-assistant/link-requests \
  --header 'Content-Type: application/json' \
  --data '{ "linkSecret": "example" }'

Request Body^required

Media typeapplication/json

object

linkSecret

required

string

>= 1 characters <= 512 characters

Example^generated

{
  "linkSecret": "example"
}

Responses

201

Default Response

Media typeapplication/json

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

code

required

string

claimKey

required

string

expiresAt

required

string

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "code": "example",
  "claimKey": "example",
  "expiresAt": "example"
}