Skip to main content

Who is this article for?

CrashPlan Cloud
CrashPlan for Small Business

Find your product plan in the Code42 console on the Account menu.
Not a CrashPlan Cloud customer? Search or browse CrashPlan for Small Business or Incydr and Instructor.

Instructor, no.

Incydr Professional, Enterprise, Horizon, and Gov F2, no.

Incydr Basic, Advanced, and Gov F1, no.

CrashPlan Cloud, yes.

CrashPlan for Small Business, no.

HOME
GETTING STARTED
RELEASE NOTES
FAQs
APIs
SYSTEM STATUS
Code42 Support

CrashPlan API documentation viewer reference

Overview

The CrashPlan APIs are a powerful set of tools you can use for everything from performing automated actions to integrating CrashPlan with your company's applications. This page lists resources for using the CrashPlan API documentation viewer, which comprehensively lists API queries, parameters, and usage.

To access the CrashPlan API documentation viewer, use the URL that corresponds with your cloud instance:

Learn about CrashPlan API syntax and usage
If you're looking for detailed information on how to use CrashPlan APIs, check out our CrashPlan API syntax and usage article.

Reference

API Doc Viewer 6-23-22.png

API documentation responses 6-23-22.png

Item Description
a Search You can use the search feature to find a specific resource, query, or parameter.
b API resource

The resources provide information about various components of the CrashPlan platform. For example:

  • The Computer resource provides access to your users' devices.
  • The Org resource provides access to your organizations.
  • The User resource provides access to your users.

Click on the expandable arrow to show all queries that can be used with that resource. The page will jump to the resource you select.

c Query description

Gives a short description of available queries, such as "Get a list of computers".

Clicking the description will jump to it on the page.

d Parameters Parameters further specify the action of a method and resource.
e Deprecated parameter The yellow "deprecated" icon appears if a parameter has been deprecated. Check the description of the parameter for an alternative.
f Path Shows the path of the selected resource.

Clicking the downward arrow opens a text box allowing you to copy the full path to your clipboard.
g Response samples Some API requests simply return an HTTPS response code: 200, for example, indicates success. Other requests also return JSON data

The documentation viewer provides a sample response based on the query selected, with options to copy, expand, or collapse the window.
h Responses Lists possible responses and default error codes.

 

  • Was this article helpful?