Arm / Mode

POST

/v1/{alarmId}/arm/{mode}

const url = 'https://api.openalarm.io/v1/k7m3x9q2f8d4w1b5/arm/home';
const options = {method: 'POST', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.openalarm.io/v1/k7m3x9q2f8d4w1b5/arm/home \
  --header 'X-API-Key: <X-API-Key>'

Arm the alarm to a specific mode and store it for later bare triggers.

Authorizations

ApiKeyHeader
BearerAuth

Parameters

Path Parameters

alarmId

required

string

The alarm’s identifier. The API key gates the call; this names which alarm it acts on.

Example

k7m3x9q2f8d4w1b5

mode

required

string

Allowed values: home away night

The alarm mode.

Responses

401

The API key is missing or invalid.

403

Unauthorized.

404

Alarm ID not found.

2XX

The event was accepted. Pre-release: the exact success status code and response body are being finalized and are not documented yet.