Search results for "{{ search.query }}"

No results found for "{{search.query}}". 
View All Results
Suggest Edits

Getting Started

 

The Rollbar API provides a RESTful interface to much of the data in the
system. It is used by our official libraries to report exceptions,
deploys, and other messages. It can be used to create notifiers for
additional languages, get data out to integrate with other systems, or
whatever else you can imagine. If the API is missing something you'd
like to see, please let us know.

At this time the best way to discover the available resources/calls is
by exploring the test console.

Ping

To test whether you're able to ping the API server, you can simply run the following command:

curl 'https://api.rollbar.com/api/1/status/ping'

You will get back pong from our server if your request was successful.

Timestamps

All timestamps (inputs and outputs) are GMT unix timestamps.

Authentication

Authentication is done via access token included as a parameter. For GET, PUT, PATCH, and DELETE requests, it should be included as a query parameter. For POST requests, it should be included in the form data.

curl 'https://api.rollbar.com/api/1/item/12345?access_token=YOUR_ACCESS_TOKEN'

Project access tokens

Many operations require a project-specific access token. You can find and administer your
access tokens in Settings -> Project Access Tokens. Access tokens can have any or
all of the following scopes:

Scope Description
post_server_item Can perform all POST requests to /deploy/ and /item/
post_client_item Can perform POST requests to /deploy/ and /item/, but only if the item has a client-side (browser, mobile) platform.
read Can perform all GET requests
write Can perform PATCH and DELETE requests.

New projects are created with four tokens, one with each scope. As client tokens often need to be embedded in publicly-visible code (i.e the HTML source of a page), we recommend keeping this setup with an isolated post_client_item-only token.

Account Access Tokens

Operations performed at the level of the account require an account-specific access token. These can be found and managed at {Account name} Settings -> Account Access Tokens. Account access tokens can have the following scopes:

Scope Description
read Supports all GET operations at the account level.
write Supports all POST, PUT, PATCH, and DELETE operations at the account level.

HTTP responses

The API can return the following HTTP response codes:

Code Type Description
200 OK Operation was completed successfully
400 Bad request The request was malformed and could not be parsed.
403 Access denied Access token was missing, invalid, or does not have the necessary permissions.
404 Not found The requested resource was not found. This response will be returned if the URL is entirely invalid (i.e. /asdf), or if it is a URL that could be valid but is referencing something that does not exist (i.e. /item/12345).
413 Request entity too large The request exceeded the maximum size of 128KB.
422 Unprocessable Entity The request was parseable (i.e. valid JSON), but some parameters were missing or otherwise invalid.
429 Too Many Requests If rate limiting is enabled for your access token, this return code signifies that the rate limit has been reached and the item was not processed.

Examples

Link Author Language Description
api-examples Rollbar Python Examples using RQL, deploys, occurrences, and reports
api-people-example Rollbar Python Shows how to gather the Person data for each occurrence of a list of items
rolltools Jonathan Slate Ruby A few utilities using the Rollbar API

Last updated: March 1st, 2018

Suggest Edits

Create item

 
posthttps://api.rollbar.com/api/1/item/
curl --request POST \
  --url https://api.rollbar.com/api/1/item/
var request = require("request");

var options = { method: 'POST', url: 'https://api.rollbar.com/api/1/item/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/item/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.rollbar.com/api/1/item/");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/item/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

access_token
string
required

post_server_item project access token

data
json
required

Details of the exception or log message. For a simple example, try {"environment": "development", "body": { "message": {"body": "Hello, world!"}}}

 

Overview

Rollbar receives Occurrences (exceptions and messages) via a RESTful JSON API. Clients send
JSON data via an HTTP POST to https://api.rollbar.com/api/1/item/

We strongly recommend using HTTPS, but HTTP is also supported. For HTTP,
use http://api.rollbar.com/api/1/item/

POSTed JSON data is accepted either as the body of the request, or form-encoded as the value of
the payload parameter (which should be the only parameter).

All responses (including error responses) are returned as JSON.

Data Format

The example JSON payload below describes all the required and optional params that Rollbar understands. The meaning of each key is explained in the comments.

{
  // Required: access_token
  // An access token with scope "post_server_item" or "post_client_item".
  // A post_client_item token must be used if the "platform" is "browser", "android", "ios", "flash", or "client"
  // A post_server_item token should be used for other platforms.
  "access_token": "aaaabbbbccccddddeeeeffff00001111",

  // Required: data
  "data": {

    // Required: environment
    // The name of the environment in which this occurrence was seen.
    // A string up to 255 characters. For best results, use "production" or "prod" for your
    // production environment.
    // You don't need to configure anything in the Rollbar UI for new environment names;
    // we'll detect them automatically.
    "environment": "production",

    // Required: body
    // The main data being sent. It can either be a message, an exception, or a crash report.
    "body": {

      // Required: "trace", "trace_chain", "message", or "crash_report" (exactly one)
      // If this payload is a single exception, use "trace"
      // If a chain of exceptions (for languages that support inner exceptions), use "trace_chain"
      // If a message with no stack trace, use "message"
      // If an iOS crash report, use "crash_report"

      // Optional: "telemetry". Only applicable if you are sending telemetry data. 
      "telemetry": {
        // Required: level
        // The severity level of the telemetry data. One of: "critical", "error", "warning", "info", "debug".
        "level": "info",

        // Required: type
        // The type of telemetry data. One of: "log", "network", "dom", "navigation", "error", "manual".
        "type": "network",

        // Required: source
        // The source of the telemetry data. Usually "client" or "server".
        "source": "client",

        // Required: timestamp_ms
        // When this occurred, as a unix timestamp in milliseconds.
        "timestamp_ms": 1500413393557,

        // Required: body
        // The key-value pairs for the telemetry data point. See "body" key below.
        // If type above is "log", body should contain "message" key.
        // If type above is "network", body should contain "method", "url", and "status_code" keys.
        // If type above is "dom", body should contain "element" key.
        // If type above is "navigation", body should contain "from" and "to" keys.
        // If type above is "error", body should contain "message" key. 
        "body": {
          "subtype": "xhr",
          "method": "GET",
          "url": "/api/1/item/4/",
          "status_code": "200",
          "start_timestamp_ms": 1500413394557,
          "end_timestamp_ms": 1500413394957
        },
      },

      // Option 1: "trace"
      "trace": {

        // Required: frames
        // A list of stack frames, ordered such that the most recent call is last in the list.
        "frames": [
          // Each frame is an object.
          {
            // Required: filename
            // The filename including its full path.
            "filename": "/Users/brian/www/mox/mox/views/project.py",

            // Optional: lineno
            // The line number as an integer
            "lineno": 26,

            // Optional: colno
            // The column number as an integer
            "colno": 8,

            // Optional: method
            // The method or function name
            "method": "index",

            // Optional: code
            // The line of code
            "code": "_save_last_project(request, project_id, force=True)",
            
            // Optional: class_name
            // A string containing the class name.
            // Used in the UI when the payload's top-level "language" key has the value "java"
            "class_name": "java.lang.String",

            // Optional: context
            // Additional code before and after the "code" line
            "context": {
              // Optional: pre
              // List of lines of code before the "code" line
              "pre": [
                "project = request.context",
                "project_id = project.id"
              ],

              // Optional: post
              // List of lines of code after the "code" line
              "post": []
            },

            // (Deprecated) Optional: args
            // List of values of positional arguments to the method/function call
            // NOTE: as this can contain sensitive data, you may want to scrub the values
            "args": ["<Request object>", 25],

            // (Deprecated) Optional: kwargs
            // Object of keyword arguments (name => value) to the method/function call
            // NOTE: as this can contain sensitive data, you may want to scrub the values
            "kwargs": {
              "force": true
            },

            // Optional: argspec
            // List of the names of the arguments to the method/function call.
            "argspec": ["request", "user"],

            // Optional: varargspec
            // If the function call takes an arbitrary number of unnamed positional arguments,
            // the name of the argument that is the list containing those arguments.
            // For example, in Python, this would typically be "args" when "*args" is used.
            // The actual list will be found in locals.
            "varargspec": "args",

            // Optional: keywordspec
            // If the function call takes an arbitrary number of keyword arguments, the name
            // of the argument that is the object containing those arguments.
            // For example, in Python, this would typically be "kwargs" when "**kwargs" is used.
            // The actual object will be found in locals.
            "keywordspec": "kwargs",

            // Optional: locals
            // Object of local variables for the method/function call.
            // The values of variables from argspec, vararspec and keywordspec
            // can be found in locals.
            "locals": {
                "request": "<Request object>",
                "user": "<User object>",
                "args": [true, "Python"],
                "kwargs": {"level": "warning"}
            }
          },
          {
            "filename": "/Users/brian/www/mox/mox/views/project.py",
            "lineno": 497,
            "method": "_save_last_project",
            "code": "user = foo"
          }
        ],

        // Required: exception
        // An object describing the exception instance.
        "exception": {
          // Required: class
          // The exception class name.
          "class": "NameError",

          // Optional: message
          // The exception message, as a string
          "message": "global name 'foo' is not defined",

          // Optional: description
          // An alternate human-readable string describing the exception
          // Usually the original exception message will have been machine-generated;
          // you can use this to send something custom
          "description": "Something went wrong while trying to save the user object"
        }

      },

      // Option 2: "trace_chain"
      // Used for exceptions with inner exceptions or causes
      "trace_chain": [
        // Each element in the list should be a "trace" object, as shown above
        // Must contain at least one element.
      ],

      // Option 3: "message"
      // Only one of "trace", "trace_chain", "message", or "crash_report" should be present.
      // Presence of a "message" key means that this payload is a log message.
      "message": {

        // Required: body
        // The primary message text, as a string
        "body": "Request over threshold of 10 seconds",

        // Can also contain any arbitrary keys of metadata. Their values can be any valid JSON.
        // For example:

        "route": "home#index",
        "time_elapsed": 15.23

      },

      // Option 4: "crash_report"
      // Only one of "trace", "trace_chain", "message", or "crash_report" should be present.
      "crash_report": {
        // Required: raw
        // The raw crash report, as a string
        // Rollbar expects the format generated by rollbar-ios
        "raw": "<crash report here>"
      }

    },

    // Optional: level
    // The severity level. One of: "critical", "error", "warning", "info", "debug"
    // Defaults to "error" for exceptions and "info" for messages.
    // The level of the *first* occurrence of an item is used as the item's level.
    "level": "error",

    // Optional: timestamp
    // When this occurred, as a unix timestamp.
    "timestamp": 1369188822,

    // Optional: code_version
    // A string, up to 40 characters, describing the version of the application code
    // Rollbar understands these formats:
    // - semantic version (i.e. "2.1.12")
    // - integer (i.e. "45")
    // - git SHA (i.e. "3da541559918a808c2402bba5012f6c60b27661c")
    // If you have multiple code versions that are relevant, those can be sent inside "client" and "server"
    // (see those sections below)
    // For most cases, just send it here.
    "code_version": "3da541559918a808c2402bba5012f6c60b27661c",

    // Optional: platform
    // The platform on which this occurred. Meaningful platform names:
    // "browser", "android", "ios", "flash", "client", "heroku", "google-app-engine"
    // If this is a client-side event, be sure to specify the platform and use a post_client_item access token.
    "platform": "linux",

    // Optional: language
    // The name of the language your code is written in.
    // This can affect the order of the frames in the stack trace. The following languages set the most
    // recent call first - 'ruby', 'javascript', 'php', 'java', 'objective-c', 'lua'
    // It will also change the way the individual frames are displayed, with what is most consistent with
    // users of the language.
    "language": "python",

    // Optional: framework
    // The name of the framework your code uses
    "framework": "pyramid",

    // Optional: context
    // An identifier for which part of your application this event came from.
    // Items can be searched by context (prefix search)
    // For example, in a Rails app, this could be `controller#action`.
    // In a single-page javascript app, it could be the name of the current screen or route.
    "context": "project#index",

    // Optional: request
    // Data about the request this event occurred in.
    "request": {
      // Can contain any arbitrary keys. Rollbar understands the following:

      // url: full URL where this event occurred
      "url": "https://rollbar.com/project/1",

      // method: the request method
      "method": "GET",

      // headers: object containing the request headers.
      "headers": {
        // Header names should be formatted like they are in HTTP.
        "Accept": "text/html",
        "Referer": "https://rollbar.com/"
      },

      // params: any routing parameters (i.e. for use with Rails Routes)
      "params": {
        "controller": "project",
        "action": "index"
      },

      // GET: query string params
      "GET": {},

      // query_string: the raw query string
      "query_string": "",

      // POST: POST params
      "POST": {},

      // body: the raw POST body
      "body": "",

      // user_ip: the user's IP address as a string.
      // Can also be the special value "$remote_ip", which will be replaced with the source IP of the API request.
      // Will be indexed, as long as it is a valid IPv4 address.
      "user_ip": "100.51.43.14"

    },

    // Optional: person
    // The user affected by this event. Will be indexed by ID, username, and email.
    // People are stored in Rollbar keyed by ID. If you send a multiple different usernames/emails for the
    // same ID, the last received values will overwrite earlier ones.
    "person": {
      // Required: id
      // A string up to 40 characters identifying this user in your system.
      "id": "12345",

      // Optional: username
      // A string up to 255 characters
      "username": "brianr",

      // Optional: email
      // A string up to 255 characters
      "email": "brian@rollbar.com"
    },

    // Optional: server
    // Data about the server related to this event.
    "server": {
      // Can contain any arbitrary keys. Rollbar understands the following:

      // host: The server hostname. Will be indexed.
      "host": "web4",

      // root: Path to the application code root, not including the final slash.
      // Used to collapse non-project code when displaying tracebacks.
      "root": "/Users/brian/www/mox",

      // branch: Name of the checked-out source control branch. Defaults to "master"
      "branch": "master",

      // Optional: code_version
      // String describing the running code version on the server
      // See note about "code_version" above
      "code_version": "b6437f45b7bbbb15f5eddc2eace4c71a8625da8c",

      // (Deprecated) sha: Git SHA of the running code revision. Use the full sha.
      "sha": "b6437f45b7bbbb15f5eddc2eace4c71a8625da8c"
    },

    // Optional: client
    // Data about the client device this event occurred on.
    // As there can be multiple client environments for a given event (i.e. Flash running inside
    // an HTML page), data should be namespaced by platform.
    "client": {
      // Can contain any arbitrary keys. Rollbar understands the following:

      "javascript": {

        // Optional: browser
        // The user agent string
        "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_3)",

        // Optional: code_version
        // String describing the running code version in javascript
        // See note about "code_version" above
        "code_version": "b6437f45b7bbbb15f5eddc2eace4c71a8625da8c",

        // Optional: source_map_enabled
        // Set to true to enable source map deobfuscation
        // See the "Source Maps" guide for more details.
        "source_map_enabled": false,

        // Optional: guess_uncaught_frames
        // Set to true to enable frame guessing
        // See the "Source Maps" guide for more details.
        "guess_uncaught_frames": false

      }
    },

    // Optional: custom
    // Any arbitrary metadata you want to send. "custom" itself should be an object.
    "custom": {},

    // Optional: fingerprint
    // A string controlling how this occurrence should be grouped. Occurrences with the same
    // fingerprint are grouped together. See the "Grouping" guide for more information.
    // Should be a string up to 40 characters long; if longer than 40 characters, we'll use its SHA1 hash.
    // If omitted, we'll determine this on the backend.
    "fingerprint": "50a5ef9dbcf9d0e0af2d4e25338da0d430f20e52",

    // Optional: title
    // A string that will be used as the title of the Item occurrences will be grouped into.
    // Max length 255 characters.
    // If omitted, we'll determine this on the backend.
    "title": "NameError when setting last project in views/project.py",

    // Optional: uuid
    // A string, up to 36 characters, that uniquely identifies this occurrence.
    // While it can now be any latin1 string, this may change to be a 16 byte field in the future.
    // We recommend using a UUID4 (16 random bytes).
    // The UUID space is unique to each project, and can be used to look up an occurrence later.
    // It is also used to detect duplicate requests. If you send the same UUID in two payloads, the second
    // one will be discarded.
    // While optional, it is recommended that all clients generate and provide this field
    "uuid": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",

    // Optional: notifier
    // Describes the library used to send this event.
    "notifier": {
      // Optional: name
      // Name of the library
      "name": "pyrollbar",

      // Optional: version
      // Library version string
      "version": "0.5.5"
    }

  }
}

Note that you can send us whatever data you want and we'll store it. Max payload size is 512kb. For best results, put custom data in request, server, client, person, or custom.

Suggest Edits

Get an item (by project counter)

 
gethttps://api.rollbar.com/api/1/item_by_counter/counter
curl --request GET \
  --url 'https://api.rollbar.com/api/1/item_by_counter/counter?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/item_by_counter/counter',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/item_by_counter/counter?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/item_by_counter/counter?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/item_by_counter/counter"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

counter
int32
required

item counter for an item in the project

Query Params

access_token
string
required

read project access token

 

counter must be an item counter for an item in the project. The counter can be found in URLs like https://rollbar.com/myaccount/myproject/items/456/ (456 is the counter).

The success response is a 301 redirect like this:

HTTP/1.1 301 Moved Permanently
Location: /api/1/item/272505123?access_token=abcd1234abcd1234abcd1234abcd1234

{
  "err": 0,
  "result": {
    "itemId": 272505123,
    "path": "/api/1/item/272505123",
    "uri": "/api/1/item/272505123?access_token=abcd1234abcd1234abcd1234abcd1234"
  }
}
Suggest Edits

Get an item (by ID)

 
gethttps://api.rollbar.com/api/1/item/itemid
curl --request GET \
  --url 'https://api.rollbar.com/api/1/item/itemid?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/item/itemid',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/item/itemid?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/item/itemid?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/item/itemid"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

itemid
int32
required

Unique ID of the item

Query Params

access_token
string
required

read project access token

 

itemid must be an item ID for an item in the project. These IDs are returned as the id field in other API calls.

Note that they are NOT found in in URLs like https://rollbar.com/myaccount/myproject/items/456/ – that is the "counter", which can be used in the following API call.

Suggest Edits

List all items

 
gethttps://api.rollbar.com/api/1/items
curl --request GET \
  --url 'https://api.rollbar.com/api/1/items?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/items',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/items?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/items?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/items"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

access_token
string
required

A read-scope project access token.

assigned_user
string

If not empty, only items assigned to the specified user will be returned. Must be a valid Rollbar username, or you can use the keywords assigned (items that are assigned to any owner) or unassigned (items with no owner).

environment
string

If not empty, only items in the specified environment will be returned. Specify multiple times to filter by multiple environments.

framework
string

If not empty, only items in the specified framework will be returned. Specify multiple times to filter by multiple frameworks.

ids
mixed type

(comma-separated list of integers) if not empty, list of item IDs to return, instead of using all items in the project

level
string

If not empty, only items with the specified level will be returned. Valid values: debug, info, warning, error, critical. Specifiy multiple times to filter by multiple levels.

page
int32

Page number, starting from 1. 100 items are returned per page.

query
string

A search string, using the same format as the search box on the Items page.

status
string

If not empty, only items with the specified status will be returned. Valid values: active, resolved, muted. Specify multiple times to filter by multiple statuses.

 

Examples

Get the 101st through 199th active items:

curl 'https://api.rollbar.com/api/1/items/?access_token=YOUR_READ_TOKEN&status=active&page=2'

Get the first page of items that are error or critical, in the production environment:

curl 'https://api.rollbar.com/api/1/items/?access_token=YOUR_READ_TOKEN&level=error&level=critical&environment=production'
Suggest Edits

Update an item

 
patchhttps://api.rollbar.com/api/1/item/item_id
curl --request PATCH \
  --url 'https://api.rollbar.com/api/1/item/item_id?access_token=access_token'
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.rollbar.com/api/1/item/item_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/item/item_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.rollbar.com/api/1/item/item_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/item/item_id"

querystring = {"access_token":"access_token"}

response = requests.request("PATCH", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

item_id
int32
required

System-wide id (not project counter) of the item to be modified.

Query Params

access_token
string
required

A write project access token.

Body Params

status
string

If present, the new status. Valid values: active, resolved, muted.

resolved_in_version
string

If not empty, a string up to 40 characters describing the version that the item was resolved in. Only used if status is set to resolved.

title
string

If present, the new title. Should be a string with length 1 to 255.

level
string

If present, the new level. Valid values: critical, error, warning, info, debug

assigned_user_id
int32

If present, the new assigned user ID. Valid values are null or any user ID with access to this item.

 

Used to modify an item's state. Currently supports:

  • setting the status, level, title, assigned user
  • when resolving, setting the "resolved in version"

Example -

curl -X PATCH 'https://api.rollbar.com/api/1/item/275123456?access_token=WRITE_ACCESS_TOKEN' \
  --header "Content-Type: application/json" \
  --data '{"status": "resolved", "resolved_in_version": "aabbcc1"}'
Suggest Edits

List all occurrences in an item

 
gethttps://api.rollbar.com/api/1/item/item_id/instances
curl --request GET \
  --url 'https://api.rollbar.com/api/1/item/item_id/instances?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/item/item_id/instances',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/item/item_id/instances?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/item/item_id/instances?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/item/item_id/instances"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

item_id
int32
required

System-wide identifier of the item

Query Params

access_token
string
required

read project access token

page
int32

Page number, starting from 1. 20 occurrences are returned per page.

 

Returns all occurrences of an item, in pages of 20. Order is descending by occurrence ID (which is approximately descending by timestamp).

Suggest Edits

List all occurrences in a project

 
gethttps://api.rollbar.com/api/1/instances/
curl --request GET \
  --url 'https://api.rollbar.com/api/1/instances/?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/instances/',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/instances/?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/instances/?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/instances/"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

access_token
string
required

read project access token

page
int32

Page number to return, starting at 1. 20 occurrences are returned per page.

 

Returns all occurrences in the project, in pages of 20. Order is descending by occurrence ID (which is approximately descending by timestamp).

Suggest Edits

Get an occurrence

 
gethttps://api.rollbar.com/api/1/instance/instance_id
curl --request GET \
  --url 'https://api.rollbar.com/api/1/instance/instance_id?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/instance/instance_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/instance/instance_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/instance/instance_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/instance/instance_id"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

instance_id
int32
required

Query Params

access_token
string
required

read project access token

 

Returns a JSON object describing the occurrence. This is similar to the "Raw JSON" section of the occurrence detail page.

instance_id must be an Occurrence ID for an occurrence in the project. These IDs are returned as the id field in other occurrence API calls, and can be found in the Rollbar UI on URLs like https://rollbar.com/Rollbar/demo/items/54/occurrences/3209095494/ (3209095494 is the Occurrence ID).

Suggest Edits

Delete an occurrence

 
deletehttps://api.rollbar.com/api/1/instance/instance_id
curl --request DELETE \
  --url 'https://api.rollbar.com/api/1/instance/instance_id?access_token=access_token'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.rollbar.com/api/1/instance/instance_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/instance/instance_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.rollbar.com/api/1/instance/instance_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/instance/instance_id"

querystring = {"access_token":"access_token"}

response = requests.request("DELETE", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

instance_id
int32
required

Query Params

access_token
string
required

write project access token

 

Permanently deletes an occurrence. This will make it unavailable in the Rollbar UI and API. Aggregate counts are not updated.

Suggest Edits

Report a deploy

 
posthttps://api.rollbar.com/api/1/deploy/
curl --request POST \
  --url https://api.rollbar.com/api/1/deploy/
var request = require("request");

var options = { method: 'POST', url: 'https://api.rollbar.com/api/1/deploy/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/deploy/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.rollbar.com/api/1/deploy/");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/deploy/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

access_token
string
required

Required - post_server_item access token

environment
string
required

Required - environment to which the revision was deployed

revision
string
required

Required - git SHA of revision being deployed

rollbar_username
string

Optional - Rollbar username of person who deployed

local_username
string

Optional - Local username of person who deployed. Displayed in web app if no rollbar_username was specified.

comment
string

Optional - Additional text to include with the deploy

 

For tool-specific instructions on reporting a deploy, see our Deploy Tracking docs.

Suggest Edits

List all deploys

 
gethttps://api.rollbar.com/api/1/deploys/
curl 'https://api.rollbar.com/api/1/deploys/?access_token=abcd5678'
curl 'https://api.rollbar.com/api/1/deploys/?access_token=abcd5678&page=2'
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

access_token
string
required

read project access token

page
int32

Page number, starting from 1. 20 deploys are returned per page.

 

Returns all deploys in the project, most recent first, in pages of 20.

Suggest Edits

Get a deploy

 
gethttps://api.rollbar.com/api/1/deploy/deploy_id
curl --request GET \
  --url 'https://api.rollbar.com/api/1/deploy/deploy_id?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/deploy/deploy_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/deploy/deploy_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/deploy/deploy_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/deploy/deploy_id"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

deploy_id
string
required

System-wide id of the deploy

Query Params

access_token
string
required

read project access token

 

deploy_id must be an ID for a deploy in the project. These IDs are returned as the id field in other API calls, and can be found in the Rollbar UI on URLs like https://rollbar.com/deploy/12345/ (12345 is the Deploy ID).

Suggest Edits

Upload a JS source map

 
posthttps://api.rollbar.com/api/1/sourcemap/
curl https://api.rollbar.com/api/1/sourcemap \
	-F access_token=aaaabbbbccccddddeeeeffff00001111 \
	-F version=version_string_here \
	-F minified_url=http://example.com/static/js/example.min.js \
	-F source_map=@static/js/example.min.map \
	-F static/js/site.js=@static/js/site.js \
	-F static/js/util.js=@static/js/util.js
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

access_token
string
required

post_server_item project access token.

version
string
required

Current code version (typically a git SHA)

minified_url
string
required

The full URL of the minified file, as it appears in the stack trace. This should start with http: or https:.

source_map
file
required

Your source map file.

source files
file

One or more source unminified files

 

In the above example, our website is http://example.com, we have a minified JavaScript file at http://example.com/js/example.min.js, and we have a source tree like this:

example/
example/static/js/example.min.js
example/static/js/example.min.map
example/static/js/site.js
example/static/js/util.js
Suggest Edits

Upload an iOS dSym file

 
posthttps://api.rollbar.com/api/1/dsym/
curl -X POST "https://api.rollbar.com/api/1/dsym"
	-F access_token=POST_SERVER_ITEM_ACCESS_TOKEN \
	-F version=0.1.2 \
	-F bundle_identifier="com.apple.xcode.dsym.org.rollbar.DelightfulApp" \
	-F dsym=@dsym.zip
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

access_token
string
required

post_server_item project access token.

bundle_identifier
string
required

fully-qualified identifier of the bundle (see example)

version
string
required

The current code version (typically a semantic version)

dsym
file
required

Your zipped dSYM file. See upload_dsym.py for an example

 

Note: For version, you should use the "Bundle version" from your plist which corresponds to the Build Number. This is not the Version Number which is found under the key "Bundle versions string, short" in your plist. See this technical note for more information. We use this to match up the dSYM with the same version of the code that caused the stack trace.

Suggest Edits

Upload an Android Proguard file

 
posthttps://api.rollbar.com/api/1/proguard/
curl 'https://api.rollbar.com/api/1/proguard' \
	-F access_token=POST_SERVER_ITEM_ACCESS_TOKEN \
	-F version=0.0.10 \
	-F mapping=@mapping.txt
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

access_token
string
required

post_server_item project access token.

version
string
required

The current code version. This must match the android:versionName in your app's AndroidManifest.xml, corresponding to the version the mapping.txt was generated for.

mapping
file
required

Your mapping.txt file.

 
Suggest Edits

Create an RQL job

 
posthttps://api.rollbar.com/api/1/rql/jobs/
curl --data "query_string=select * from item_occurrence where item.counter=1&access_token=[your read access token here]" https://api.rollbar.com/api/1/rql/jobs

A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

access_token
string
required

read project access token

query_string
string
required

The RQL query to run

force_refresh
boolean

Force job creation, 1/true or 0/false.

 

Response

The response will be a RQL Job resource, example:

{
  "err" 0,
  "result": {
    "id": 123,  // job id
    "project_id": 456,
    "query_string": "show tables",
    "status": "new", // One of "new", "running", "success", "failed", "cancelled", or "timed_out"
    "job_hash": "abcdefabcdefabcdef",
    "date_created": 1446598885,
    "date_modified": 1446598885
  }
}
Suggest Edits

Check an RQL job

 
gethttps://api.rollbar.com/api/1/rql/job/job_id
curl --request GET \
  --url 'https://api.rollbar.com/api/1/rql/job/job_id?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/rql/job/job_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/rql/job/job_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/rql/job/job_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/rql/job/job_id"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

job_id
int32
required

Query Params

access_token
string
required

read project access token

expand
string

If the value is result, the response will contain the job result

 

Response

The response will be a RQL Job resource, example:

{
  "err" 0,
  "result": {
    "id": 123,  // job id
    "project_id": 456,
    "query_string": "show tables",
    "status": "new", // One of "new", "running", "success", "failed", "cancelled", or "timed_out"
    "job_hash": "abcdefabcdefabcdef",
    "date_created": 1446598885,
    "date_modified": 1446598885,
    "result": {...} // A RQL job resource if expand=result is used in query string
  }
}
Suggest Edits

Get RQL job results

 
gethttps://api.rollbar.com/api/1/rql/job/job_id/result
curl --request GET \
  --url 'https://api.rollbar.com/api/1/rql/job/job_id/result?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/rql/job/job_id/result',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/rql/job/job_id/result?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/rql/job/job_id/result?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/rql/job/job_id/result"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

job_id
string
required

Query Params

access_token
string
required

read project access token

expand
string

If the value is job, the response will contain the RQL job resource

 

Response

The response will be a RQL job result resource, example:

{
  "err" 0,
  "result": {
    "job_id": 123,  // job id
    "result": {
      "rows": [{...}],
      "selectionColumns": [...],
      "columns": [...],
      "errors": [],
      "warnings": [],
      "rowcount": 1,
      "executionTime": 123
    },
    "job": {...} // A RQL job resource if expand=job is set in the query string
  }
}
Suggest Edits

List all RQL jobs

 
gethttps://api.rollbar.com/api/1/rql/jobs/
curl --request GET \
  --url 'https://api.rollbar.com/api/1/rql/jobs/?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/rql/jobs/',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/rql/jobs/?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/rql/jobs/?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/rql/jobs/"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

access_token
string
required

read project access token

page
int32

Page number starting from 1

 

Response

{
  "err" 0,
  "result": [
    { ... }, // RQL job resource
      ...
  ]
}
Suggest Edits

Cancel an RQL job

 
posthttps://api.rollbar.com/api/1/rql/job/job_id/cancel
curl --request POST \
  --url 'https://api.rollbar.com/api/1/rql/job/job_id/cancel?access_token=access_token'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.rollbar.com/api/1/rql/job/job_id/cancel',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/rql/job/job_id/cancel?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.rollbar.com/api/1/rql/job/job_id/cancel?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/rql/job/job_id/cancel"

querystring = {"access_token":"access_token"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

job_id
int32
required

system-wide ID of the job to be canceled

Query Params

access_token
string
required

read project access token

 

Response

The response will be a RQL Job resource, example:

{
  "err" 0,
  "result": {
    "id": 123,  // job id
    "project_id": 456,
    "query_string": "show tables",
    "status": "cancelled", // One of "new", "running", "success", "failed", "cancelled", or "timed_out"
    "job_hash": "abcdefabcdefabcdef",
    "date_created": 1446598885,
    "date_modified": 1446598885
  }
}
Suggest Edits

Get top active items

 
gethttps://api.rollbar.com/api/1/reports/top_active_items
curl --request GET \
  --url 'https://api.rollbar.com/api/1/reports/top_active_items?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/reports/top_active_items',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/reports/top_active_items?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/reports/top_active_items?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/reports/top_active_items"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

access_token
string
required

read project access token

hours
int32

Number of recent hours to consider. Min 1, max 168.

environments
string

Comma-separated list of environments to consider. If empty, then returns results for "any environment".

 

Response

{
  "err": 0,
  "result": [
    // each element in the list is an object with an "item" object and a "counts" list
    {
        // data describing the item (similar to that returned by GET /api/1/item/:id)
        "item": {
            "id": 2071,
            "counter": 1007,
            "environment": "production",
            "framework": 0,
            "last_occurrence_timestamp": 1408410581,
            "level": 40,
            "occurrences": 54,
            "project_id": 12345,
            "title": "Something went wrong",
            "unique_occurrences": 5
        },
        // list of occurrence counts in the past 24 hours. Oldest first.
        "counts": [12, 10, 7, 3, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 8, 5, 6]
    },
    { /* more elements ... */ }
  ]
}
Suggest Edits

Get occurrence counts

 
gethttps://api.rollbar.com/api/1/reports/occurrence_counts
curl --request GET \
  --url 'https://api.rollbar.com/api/1/reports/occurrence_counts?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/reports/occurrence_counts',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/reports/occurrence_counts?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/reports/occurrence_counts?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/reports/occurrence_counts"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

access_token
string
required

read project access token

bucket_size
string

Size of each bucket, in seconds. Valid values are 60 (minute), 3600 (hour), and 86400 (day). Timezone for all buckets is GMT.

environments
string

Comma-separated list of environments to filter by. Empty means "any environment".

min_level
string

Minimum item level to filter by. One of debug, info, warning, error, or critical.

max_level
string

Maximum item level to filter by. One of debug, info, warning, error, or critical

item_id
int32

Item ID to filter by.

 

Analogous to "Hourly Error/Critical Occurrences" and "Daily Error/Critical Occurrences" on the Dashboard.

Returns an array of recent counts as [timestamp, count] pairs, where each count is the number of matching occurrences in the time range [timestamp, timestamp + bucket_size - 1].

Timestamps are UNIX timestamps, in whole seconds.

Response

{
  "err": 0,
  "result": [
    [
      // timestamp
      1408561200,
      // count (number of occurrences from time 1408561200 until time 1408564799)
      0
    ],
    [
      1408564800,
      0
    ],
    [
      1408568400,
      0
    ],
    [
      1408572000,
      6
    ]
  ]
}
Suggest Edits

Get activated item counts

 
gethttps://api.rollbar.com/api/1/reports/activated_counts
curl --request GET \
  --url 'https://api.rollbar.com/api/1/reports/activated_counts?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/reports/activated_counts',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/reports/activated_counts?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/reports/activated_counts?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/reports/activated_counts"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

access_token
string
required

read project access token

bucket_size
int32

Size of each bucket, in seconds. Only valid value is 86400 (day). Data wil be returned in the project timezone.

buckets
int32

Number of buckets to return. Must be in range [2, 366].

environments
string

Comma-separated list of environments to filter by. Empty means "any environment".

 

Analogous to "Daily New/Reactivated Items" graph on the Dashboard.

Returns an array of recent counts as [timestamp, count] pairs, where each count is the number of items that were first seen or reactivated in the time range [timestamp, timestamp + bucket_size - 1].

Timestamps are UNIX timestamps, in whole seconds.

Response

{
  "err": 0,
  "result": [
    [
      // timestamp
      1408561200,
      // count (number of occurrences from time 1408561200 until time 1408564799)
      0
    ],
    [
      1408564800,
      0
    ],
    [
      1408568400,
      0
    ],
    [
      1408572000,
      6
    ]
  ]
}
Suggest Edits

Create a project

 
posthttps://api.rollbar.com/api/1/projects/
curl --request POST \
  --url https://api.rollbar.com/api/1/projects/
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.rollbar.com/api/1/projects/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/projects/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.rollbar.com/api/1/projects/");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/projects/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

access_token
string
required

write account access token

name
string
required

Name of the project. Must start with a letter; can contain letters, numbers, spaces, underscores, hyphens, periods, and commas. Max length 32 characters.

 
Suggest Edits

List all projects

 
gethttps://api.rollbar.com/api/1/projects/
curl --request GET \
  --url 'https://api.rollbar.com/api/1/projects/?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/projects/',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/projects/?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/projects/?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/projects/"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

access_token
string
required

read account access token

 
Suggest Edits

Get a project

 
gethttps://api.rollbar.com/api/1/project/project_id
curl --request GET \
  --url 'https://api.rollbar.com/api/1/project/project_id?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/project/project_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/project/project_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/project/project_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/project/project_id"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

project_id
int32
required

Query Params

access_token
string
required

read account access token

 
Suggest Edits

Delete a project

 
deletehttps://api.rollbar.com/api/1/project/project_id
curl --request DELETE \
  --url 'https://api.rollbar.com/api/1/project/project_id?access_token=access_token'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.rollbar.com/api/1/project/project_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/project/project_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.rollbar.com/api/1/project/project_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/project/project_id"

querystring = {"access_token":"access_token"}

response = requests.request("DELETE", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

project_id
int32
required

Query Params

access_token
string
required

write account access token

 
Suggest Edits

List all project access tokens

 
gethttps://api.rollbar.com/api/1/project/project_id/access_tokens
curl --request GET \
  --url 'https://api.rollbar.com/api/1/project/project_id/access_tokens?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/project/project_id/access_tokens',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/project/project_id/access_tokens?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/project/project_id/access_tokens?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/project/project_id/access_tokens"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

project_id
string
required

Query Params

access_token
string
required

read account access token

 
Suggest Edits

Update a rate limit

 
patchhttps://api.rollbar.com/api/1/project/project_id/access_token/project_access_token
curl --request PATCH \
  --url 'https://api.rollbar.com/api/1/project/project_id/access_token/project_access_token?access_token=access_token'
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.rollbar.com/api/1/project/project_id/access_token/project_access_token',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/project/project_id/access_token/project_access_token?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.rollbar.com/api/1/project/project_id/access_token/project_access_token?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/project/project_id/access_token/project_access_token"

querystring = {"access_token":"access_token"}

response = requests.request("PATCH", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

project_id
int32
required
project_access_token
string
required

Query Params

access_token
string
required

write account access token

Body Params

rate_limit_window_count
int32

Max number of calls the token is permitted within each window. Must be greater than -1. If set to 0,then no rate limit is applied.

rate_limit_window_size
int32

Window duration in seconds. Must be greater than -1. If set to 0, then no rate limit is applied.

 
Suggest Edits

Create a team

 
posthttps://api.rollbar.com/api/1/teams
curl --request POST \
  --url 'https://api.rollbar.com/api/1/teams?access_token=access_token'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.rollbar.com/api/1/teams',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/teams?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.rollbar.com/api/1/teams?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/teams"

querystring = {"access_token":"access_token"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

access_token
string
required

write account access token

Body Params

name
string
required

Name of the team. Max length 32 characters.

access_level
string
required

Can be standard, light, or view.

 

Access Levels

standard is the only access level you can choose in the UI.

light and view are API-only team access levels. light gives the team read and write access, but not to all settings. view gives the team read-only access.

Suggest Edits

List all teams

 
gethttps://api.rollbar.com/api/1/teams
curl --request GET \
  --url 'https://api.rollbar.com/api/1/teams?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/teams',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/teams?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/teams?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/teams"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

access_token
string
required

read account access token

 
Suggest Edits

Get a team

 
gethttps://api.rollbar.com/api/1/team/team_id
curl --request GET \
  --url 'https://api.rollbar.com/api/1/team/team_id?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/team/team_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/team/team_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
string
required

Query Params

access_token
string
required

read account access token

 
Suggest Edits

Delete a team

 
deletehttps://api.rollbar.com/api/1/team/team_id
curl --request DELETE \
  --url 'https://api.rollbar.com/api/1/team/team_id?access_token=access_token'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.rollbar.com/api/1/team/team_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.rollbar.com/api/1/team/team_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id"

querystring = {"access_token":"access_token"}

response = requests.request("DELETE", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
int32
required

Query Params

access_token
string
required

write account access token

 
Suggest Edits

List all users

List all users who are members of an account

 
gethttps://api.rollbar.com/api/1/users
curl --request GET \
  --url 'https://api.rollbar.com/api/1/users?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/users',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/users?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/users?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/users"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

access_token
string
required

read account access token

 

Response Format

{
  "err": 0,
  "result": {
    "users": [
      {
        "username": "brianr",
        "id": 1,
        "email": "brian@rollbar.com"
      },
      {
        "username": "coryvirok",
        "id": 2,
        "email": "cory@rollbar.com"
      }
    ]
  }
}
Suggest Edits

Get a user

Get user details for a given account

 
gethttps://api.rollbar.com/api/1/user/user_id
curl --request GET \
  --url 'https://api.rollbar.com/api/1/user/user_id?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/user/user_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/user/user_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/user/user_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/user/user_id"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

user_id
int32
required

Query Params

access_token
string
required

read account access token

 

Returns basic information about the user, as relevant to the account your access token is for. This is the same information available on the "Members" page in the Rollbar UI.

Sample Response

{
  "err": 0,
  "result": {
      "id": 14,
      "username": "brian",
      "email": "brian@rollbar.com",
      "email_enabled": 1
  }
}
Suggest Edits

List a team's users

 
gethttps://api.rollbar.com/api/1/team/team_id/users
curl --request GET \
  --url 'https://api.rollbar.com/api/1/team/team_id/users?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/team/team_id/users',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id/users?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/team/team_id/users?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id/users"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
string
required

Query Params

access_token
string
required

read account access token

page
int32

Results are returned in sets of 5000. Access more results by specifying page=2, etc.

 

Example response:

{
  "err": 0,
  "result": {
    "users": [
      {
        "username": "richard",
        "id": 46457,
        "email": "richard@piedpiper.com"
      },
      {
        "username": "gabe",
        "id": 112303,
        "email": "gabe@piedpiper.com"
      }
    ]
  }
}
Suggest Edits

Check if a user is assigned to a team

 
gethttps://api.rollbar.com/api/1/team/team_id/user/user_id
curl --request GET \
  --url 'https://api.rollbar.com/api/1/team/team_id/user/user_id?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/team/team_id/user/user_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id/user/user_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/team/team_id/user/user_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id/user/user_id"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
int32
required
user_id
int32
required

Query Params

access_token
string
required

read account access token

 

Returns 200 if the user belongs to the team, 404 if the user does not belong to the team.

Example responses

User is member of the team

{
  "err": 0,
  "result": {
    "team_id": 272686,
    "user_id": 112303
  }
}

User is not assigned to the team

{
  "err": 1,
  "message": "User is not on this Team."
}
Suggest Edits

Assign a user to team

 
puthttps://api.rollbar.com/api/1/team/team_id/user/user_id
curl --request PUT \
  --url 'https://api.rollbar.com/api/1/team/team_id/user/user_id?access_token=access_token'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.rollbar.com/api/1/team/team_id/user/user_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id/user/user_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.rollbar.com/api/1/team/team_id/user/user_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id/user/user_id"

querystring = {"access_token":"access_token"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
int32
required
user_id
int32
required

Query Params

access_token
string
required

write account access token

 
Suggest Edits

Remove a user from a team

 
deletehttps://api.rollbar.com/api/1/team/team_id/user/user_id
curl --request DELETE \
  --url 'https://api.rollbar.com/api/1/team/team_id/user/user_id?access_token=access_token'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.rollbar.com/api/1/team/team_id/user/user_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id/user/user_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.rollbar.com/api/1/team/team_id/user/user_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id/user/user_id"

querystring = {"access_token":"access_token"}

response = requests.request("DELETE", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
string
required
user_id
string
required

Query Params

access_token
string
required

write account access token

 
Suggest Edits

List a user's teams

 
gethttps://api.rollbar.com/api/1/user/user_id/teams
curl --request GET \
  --url 'https://api.rollbar.com/api/1/user/user_id/teams?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/user/user_id/teams',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/user/user_id/teams?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/user/user_id/teams?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/user/user_id/teams"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

user_id
string
required

Query Params

access_token
string
required

read account access token

 

Example response:

{
  "err": 0,
  "result": {
    "teams": [
      {
        "access_level": "owner",
        "id": 36,
        "name": "Owners",
        "account_id": 61
      },
      {
        "access_level": "standard",
        "id": 574,
        "name": "Developers",
        "account_id": 61
      }
    ]
  }
}
Suggest Edits

Invite an email address to a team

 
posthttps://api.rollbar.com/api/1/team/team_id/invites
curl --request POST \
  --url https://api.rollbar.com/api/1/team/team_id/invites
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.rollbar.com/api/1/team/team_id/invites' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id/invites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.rollbar.com/api/1/team/team_id/invites");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id/invites"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
string
required

Body Params

access_token
string
required

write account access token

email
string
required

Email address to invite to the team

 

Invites a user to the specific team, using the user's email address.

If the email address belongs to an existing Rollbar user, they will be immediately added to the team, and sent an email notification. Otherwise, an invite email will be sent, containing a signup link that will allow the recipient to join the specified team.

Example Response

{
  "err": 0,
  "result": {
    "id": 71328,
    "from_user_id": 5325,
    "team_id": 272686,
    "to_email": "gilfoyle@piedpiper.com",
    "status": "pending",
    "date_created": 1519946545,
    "date_redeemed": null
  }
}
Suggest Edits

List invitations to a team

 
gethttps://api.rollbar.com/api/1/team/team_id/invites
curl --request GET \
  --url 'https://api.rollbar.com/api/1/team/team_id/invites?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/team/team_id/invites',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id/invites?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/team/team_id/invites?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id/invites"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
int32
required

Query Params

access_token
string
required

read access token

Body Params

page
int32

Returns up to 5000 results. Add &page=2 to the URL to go to the next page.

 

Returns all invites ever sent for the team–pending, accepted, rejected, and canceled.

Example response

{
  "err": 0,
  "result": [
    {
      "id": 71328,
      "from_user_id": 5325,
      "team_id": 272686,
      "to_email": "gilfoyle@pidepiper.com",
      "status": "pending",
      "date_created": 1519946545,
      "date_redeemed": null
    }
  ]
}
Suggest Edits

Get invitation

 
gethttps://api.rollbar.com/api/1/invite/invite_id
curl --request GET \
  --url 'https://api.rollbar.com/api/1/invite/invite_id?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/invite/invite_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/invite/invite_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/invite/invite_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/invite/invite_id"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

invite_id
string
required

Query Params

access_token
string
required

read account access token

 

Example response

Example Response

{
  "err": 0,
  "result": {
    "id": 71328,
    "from_user_id": 5325,
    "team_id": 272686,
    "to_email": "gilfoyle@piedpiper.com",
    "status": "pending",
    "date_created": 1519946545,
    "date_redeemed": null
  }
}
Suggest Edits

Cancel invitation

 
deletehttps://api.rollbar.com/api/1/invite/invite_id
curl --request DELETE \
  --url 'https://api.rollbar.com/api/1/invite/invite_id?access_token=access_token'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.rollbar.com/api/1/invite/invite_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/invite/invite_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.rollbar.com/api/1/invite/invite_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/invite/invite_id"

querystring = {"access_token":"access_token"}

response = requests.request("DELETE", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

invite_id
int32
required

Query Params

access_token
string
required

write account access token

 

Returns a 200 if the invitation was successfully canceled.

Suggest Edits

List a team's projects

 
gethttps://api.rollbar.com/api/1/team/team_id/projects
curl --request GET \
  --url 'https://api.rollbar.com/api/1/team/team_id/projects?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/team/team_id/projects',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id/projects?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/team/team_id/projects?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id/projects"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
int32
required

Query Params

access_token
string
required

read account access token

 

Example Response

{
  "err": 0,
  "result": [
    {
      "team_id": 272686,
      "project_id": 178029
    },
    {
      "team_id": 272686,
      "project_id": 178030
    }
  ]
}
Suggest Edits

Assign a team to a project

 
puthttps://api.rollbar.com/api/1/team/team_id/project/project_id
curl --request PUT \
  --url 'https://api.rollbar.com/api/1/team/team_id/project/project_id?access_token=access_token'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.rollbar.com/api/1/team/team_id/project/project_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id/project/project_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.rollbar.com/api/1/team/team_id/project/project_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id/project/project_id"

querystring = {"access_token":"access_token"}

response = requests.request("PUT", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
int32
required
project_id
string
required

Query Params

access_token
string
required

write account access token

 

Example Response

{
  "err": 0,
  "result": {
    "team_id": 272686,
    "project_id": 165090
  }
}
Suggest Edits

Remove a team from a project

 
deletehttps://api.rollbar.com/api/1/team/team_id/project/project_id
curl --request DELETE \
  --url 'https://api.rollbar.com/api/1/team/team_id/project/project_id?access_token=access_token'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.rollbar.com/api/1/team/team_id/project/project_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id/project/project_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.rollbar.com/api/1/team/team_id/project/project_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id/project/project_id"

querystring = {"access_token":"access_token"}

response = requests.request("DELETE", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
int32
required
project_id
int32
required

Query Params

access_token
string
required

write account access token

 
Suggest Edits

Check if a team is assigned to a project

 
gethttps://api.rollbar.com/api/1/team/team_id/project/project_id
curl --request GET \
  --url 'https://api.rollbar.com/api/1/team/team_id/project/project_id?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/team/team_id/project/project_id',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/team/team_id/project/project_id?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/team/team_id/project/project_id?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/team/team_id/project/project_id"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

team_id
int32
required
project_id
int32
required

Query Params

access_token
string
required

read account access token

 

Returns 200 if the team is assigned to a project, 404 if the team is not assigned to the project.

Example responses

{
  "err": 0,
  "result": {
    "team_id": 272686,
    "project_id": 165090
  }
}
{
  "err": 1,
  "message": "Project is not in this Team."
}
Suggest Edits

List a user's projects

 
gethttps://api.rollbar.com/api/1/user/user_id/projects
curl --request GET \
  --url 'https://api.rollbar.com/api/1/user/user_id/projects?access_token=access_token'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.rollbar.com/api/1/user/user_id/projects',
  qs: { access_token: 'access_token' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.rollbar.com/api/1/user/user_id/projects?access_token=access_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.rollbar.com/api/1/user/user_id/projects?access_token=access_token");

xhr.send(data);
import requests

url = "https://api.rollbar.com/api/1/user/user_id/projects"

querystring = {"access_token":"access_token"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

user_id
int32
required

Query Params

access_token
string
required

read account access token

 

Example response:

{
  "err": 0,
  "result": {
    "projects": [
      {
        "status": 1,
        "slug": "mox",
        "id": 1,
        "account_id": 61
      },
      {
        "status": 1,
        "slug": "moxrts",
        "id": 25,
        "account_id": 61
      }
    ]
  }
}