Arm profile management

Create arm profile

Create a new arm profile. Only available when using local alarm manager.

post/v1/arm-profiles

Request

Request body

namestring required

Name of the arm profile.

automationsAutomationId[] required

List of automation IDs associated with this arm profile.

recordEverythingboolean required

Whether to record everything when this arm profile is active.

Example request

{
  "name": "Arm Profile",
  "automations": [
    "66d025b301ebc903e80003ea"
  ],
  "schedules": [
    {
      "start": "0 0 * * *",
      "end": "0 0 * * *"
    }
  ],
  "recordEverything": true
}

Response

idstring required

The primary key of armProfile

namestring required

Name of the arm profile.

automationsAutomationId[] required

List of automation IDs associated with this arm profile.

creatorstring required

The primary key of user

recordEverythingboolean required

Whether to record everything when this arm profile is active.

createdAtnumber required

Arm profile creation time.

updatedAtnumber required

Arm profile update time.

Example response

{
  "id": "66d025b301ebc903e80003ea",
  "name": "Arm Profile",
  "automations": [
    "66d025b301ebc903e80003ea"
  ],
  "creator": "66d025b301ebc903e80003ea",
  "schedules": [
    {
      "start": "0 0 * * *",
      "end": "0 0 * * *"
    }
  ],
  "recordEverything": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.