Arm

POST

/v1/{alarmId}/arm

const url = 'https://api.openalarm.io/v1/k7m3x9q2f8d4w1b5/arm';
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 \
  --header 'X-API-Key: <X-API-Key>'

Arm the alarm to the default mode (Away) and store it. The stored mode is what a bare trigger fires. Arming is an optimisation for stateful sources (Home Assistant); it is never required for a trigger to fire.

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

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.