Skip to content
tripwire-plans/
Get a list of Tripwire pl...

Elevate Tripwire API (1.2)

Tripwire Management

Currently provides read-only access to Tripwire-related entities like alerts and notifications to allow API users to automate processes linked to Tripwire usage monitoring and alerting

Definitions

  • Tripwire alert - returns the date and time of alerts, the type of the alerts, and any additional details that may be useful in assessing the severity of the alerts
  • Tripwire notification - returns the activity that was performed when an alert was triggered, whether that's sending an email, SMS, or custom action Tripwire plan - a named tripwire plan of tripwire rules used to identify alerts and notifications
Download OpenAPI description
billing-rest-tripwire.json
billing-rest-tripwire.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

tripwire-alerts

returns the date and time of alerts, the type of alert, threshold value and other details to allow analysis of the alert

Operations

tripwire-notifications

the notifications that are (optionally) performed when alerts are triggered

Operations

tripwire-plans

the tripwire plans that are used to generate the alerts

Operations

Get a list of Tripwire plans

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
namestring(StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/tripwire-plans?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&name=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)

Plan identifier

Example: 1
namestring

Tripwire plan name

Example: "Expensive Dialed 250 Plus"
enabledboolean

Plan is enabled

Default true
]
Response
application/json
[
  {
    "id": 1,
    "name": "Expensive Dialed 250 Plus",
    "enabled": true
  }
]

tripwire-alert-activities

the tripwire alert activities

Operations