Fetch list of Alarms

GET /v2/Alarms

Query parameters

PageSize integer

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum value is 1, maximum value is 1000.
Page integer

The page index. This value is simply for client state.

Minimum value is 0.
PageToken string

The page token. This is provided by the API.
SortOrder string

Values are asc or desc.

Responses

200 application/json

List of Alarms
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- alarms array[object]
  
  List of basic parameters defined for alarms for an account.
  
  Alarm response body
  
  Hide alarms attributes Show alarms attributes object
  
  friendlyName string Required
  
  Friendly name for alarm
  
  queryType string Required
  
  Type of query
  
  Values are ERROR_CODE, LOG_LEVEL, or ALL.
  
  query string
  
  Value to query for
  
  triggerValue integer Required
  
  Threshold to send customer alarm notification
  
  timeWindow string Required
  
  Time window for alarm to trigger
  
  Values are FIVE_MINS, FIFTEEN_MINS, ONE_HOUR, TWELVE_HOURS, or ONE_DAY.
  
  email array[string(email)]
  
  Email notifications to send
  
  webhook string(uri)
  
  Webhook notification to send
  
  consoleIndicator boolean
  
  Whether to send console notifications
  
  description string Required
  
  Description for the alarm.
  
  enabled boolean Required
  
  Is alarm enbled? Default is true.
  
  Default value is true.
  
  product string Required
  
  Product the alarm is related to.
  
  alertConfigSid string Required
  
  Sid for the alarm
  
  dateUpdated string(date-time) Required
  
  The date and time in UTC when the alarm was last updated specified in ISO 8601 format
  
  dateCreated string(date-time) Required
  
  The date and time in UTC when the alarm was created specified in ISO 8601 format.
- meta object
  
  Hide meta attributes Show meta attributes object
  
  first_page_url string(uri)
  
  key string
  
  next_page_url string(uri) | null
  
  page integer
  
  page_size integer
  
  previous_page_url string(uri) | null
  
  url string(uri)
400 application/json

BAD REQUEST
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- message string
  
  Error message
- code integer
  
  Twilio error code
- user_error boolean
  
  Indicates if it was a user error
- http_status_code integer
  
  Http error code returned
- params object
  
  Hide params attribute Show params attribute object
  
  * string Additional properties
- more_info string
  
  More information link
- status integer
  
  HTTP status code
401 application/json

UNAUTHORIZED
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- message string
  
  Error message
- code integer
  
  Twilio error code
- user_error boolean
  
  Indicates if it was a user error
- http_status_code integer
  
  Http error code returned
- params object
  
  Hide params attribute Show params attribute object
  
  * string Additional properties
- more_info string
  
  More information link
- status integer
  
  HTTP status code
500 application/json

INTERNAL SERVER ERROR
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- message string
  
  Error message
- code integer
  
  Twilio error code
- user_error boolean
  
  Indicates if it was a user error
- http_status_code integer
  
  Http error code returned
- params object
  
  Hide params attribute Show params attribute object
  
  * string Additional properties
- more_info string
  
  More information link
- status integer
  
  HTTP status code

GET /v2/Alarms

curl \
 --request GET 'https://monitor.twilio.com/v2/Alarms' \
 --user "username:password"

Response examples (200)

# Headers
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, OPTIONS
Access-Control-Allow-Headers: Content-Type, Authorization
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: X-Custom-Header1, X-Custom-Header2

# Payload
{
  "alarms": [
    {
      "friendlyName": "string",
      "queryType": "ERROR_CODE",
      "query": "string",
      "triggerValue": 42,
      "timeWindow": "FIVE_MINS",
      "email": [
        "hello@example.com"
      ],
      "webhook": "https://example.com",
      "consoleIndicator": true,
      "description": "string",
      "enabled": true,
      "product": "string",
      "alertConfigSid": "string",
      "dateUpdated": "2025-05-04T09:42:00Z",
      "dateCreated": "2025-05-04T09:42:00Z"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}

Response examples (400)

# Headers
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, OPTIONS
Access-Control-Allow-Headers: Content-Type, Authorization
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: X-Custom-Header1, X-Custom-Header2

# Payload
{
  "message": "string",
  "code": 42,
  "user_error": true,
  "http_status_code": 42,
  "params": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "more_info": "string",
  "status": 42
}

Response examples (401)

# Headers
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, OPTIONS
Access-Control-Allow-Headers: Content-Type, Authorization
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: X-Custom-Header1, X-Custom-Header2

# Payload
{
  "message": "string",
  "code": 42,
  "user_error": true,
  "http_status_code": 42,
  "params": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "more_info": "string",
  "status": 42
}

Response examples (500)

# Headers
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, OPTIONS
Access-Control-Allow-Headers: Content-Type, Authorization
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: X-Custom-Header1, X-Custom-Header2

# Payload
{
  "message": "string",
  "code": 42,
  "user_error": true,
  "http_status_code": 42,
  "params": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "more_info": "string",
  "status": 42
}