Code42 API documentation viewers
Who is this article for?
Incydr Professional and Enterprise, no.
Incydr Basic and Advanced, no.
CrashPlan Cloud, no.
Other product plans, yes.
CrashPlan for Small Business, no.
This article applies to on-premises authority servers.
Overview
API documentation viewers describe the resources and methods provided by the Code42 API. This article describes how to access and use the two API documentation viewers: one for API version 1 (https://<authority-server-address>/apidocviewer), the other for API versions 3 and later (https://<authority-server-address>/swagger). A new version of the API is created whenever there is a breaking change that prevents backward compatibility.
Considerations
Use version 1 and version 4 API resources with either token authentication or name:password authentication. For version 3, however, you must use token authentication. See Code42 API authentication methods for details.
Find API documentation
A authority server hosts two API documentation viewers for several versions of the API.
Version 1
Go to https://<authority-server-address>:4285/apidocviewer.
Versions 3 and later
Go to https://<authority-server-address>:4285/swagger and select a version in the API Version menu in the upper-right.
API documentation reference
Version 1
| Item | Description | |
|---|---|---|
| a | Search API | Filters the list of resources based on search text. |
| b | Resources |
Lists the version 1 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 authority server, instead of from the browser's cache. When the authority server gets updated, you may need to click Refresh API to see new API information. |
| e | Shortcut Controls | Displays keyboard shortcuts. |
Versions 3 and later
| Item | Description | |
|---|---|---|
| a | URL | Version 3 and later documentation resides at https://<authority-server-address>:4285/swagger. |
| b | API Version | Select a version. |
| c | Links and controls |
|
| d | Category | API resources are categorized according to their functions. Click the heading to expand or collapse a category. |
| e | Resource | Click on a resource to see details about its use. |
Details
| Item | Description | |
|---|---|---|
| a | Description details |
The documentation may further describe a resource here. Three kinds of notes are common: Parameter Specification Options:
Associated License:
This states when a resource requires specific licensing. A common example:
Authority Server Only:
Such notes apply only to on-premises Code42 environments, where administrators may control multiple Code42 servers. |
| b | Query Parameters |
Describes valid parameters and values, and whether they are required. Unless stated otherwise, provide parameters as name=value pairs at the end of a URL, after a question mark (?), and separated by ampersands (&). |
| c | Request body | When parameters can or must be provided as body data, the documentation describes that request body. |
| d | application/json |
For most resources, format body parameters as JSON data.
For some resources, you may format data as
Note: The documentation viewer does not display examples of such data. Regardless of your menu selection, the display shows JSON data. |
| e | Example Value | Model |
For data in request bodies and in responses, the documentation displays either example values for you to imitate, or the precise specifications of the data model.
The viewer also provides a complete list and description of data models at the end, following the descriptions of resources. |
| f | Responses |
Describes the value and meaning of the possible HTTP response codes.
Some resources respond with additional data. Such data is always in JSON format. |