Code42 API Documentation Viewer
Applies to:
- CrashPlan PROe
Overview
The API Documentation Viewer describes the resources and methods provided by the Code42 API. This article describes how to access and use the API Documentation Viewer.
Accessing the API documentation viewer
The API Documentation Viewer is hosted by the enterprise server. To access the API Documentation Viewer, use the appropriate URL for your Code42 environment as shown in the following table:
| Product | Master server Location | API Documentation Viewer URL |
|---|---|---|
|
CrashPlan PROe SharePlan |
On-premises |
Append /apidocviewer to the Website protocol, host and port of your master server. For example: |
|
CrashPlan PROe |
Cloud | https://www.crashplan.com/apidocviewer/ |
Searching the API documentation viewer
There are two ways to search the API documentation:
- To search for a Code42 API resource, type a search in Search API.
The list of resources is filtered based on the text of your search. - To search the resource descriptions, use the search functionality built into your web browser.
API documentation viewer reference
| Item | Description | |
|---|---|---|
| a | Search API | Filters the list of resources based on search text. |
| b | Resources |
Displays the Code42 API resources.
|
| c | Resource Description | Describes the resource and the methods it offers. Available methods vary by resource but may include get, put, post, and delete. |
| d | Refresh API | Loads the latest resources and descriptions from the master server instead of the browser's cache. You may need to click Refresh API after the master server is upgraded to see updated information. |
| e | Shortcut Controls | Displays keyboard shortcuts |
next to a resource to show links to the methods it offers.