Skip to main content

This article applies to version 6.

Other available versions:

Cloud | Version 5 | Version 4icon.qnmark.png

Available in:

StandardPremiumEnterprise
Small Business
Code42 Support

Code42 API Documentation Viewer

This article applies to version 6.

Other available versions:

Cloud | Version 5 | Version 4icon.qnmark.png

Available in:

StandardPremiumEnterprise
Small Business

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, the other for API versions 3 and 4.

Considerations

The Code42 API documentation viewers are publicly available. You can see them in a browser without signing in. But the API resources themselves only work for you under these conditions:

  • You have a premium or enterprise product plan.
  • Your credentials rely on local authentication. SSO or authentication through any third-party provider will not work.
  • Your role provides permission to access the data necessary to a given API resource. For example, if you do not have permission to change device settings in the administration console, then you don't have permission to change device settings with the API.

If your API calls fail because you do not have permission to use them, you will see reply messages like these:

  • HTTP 401 Unauthorized
  • HTTP 401 Could not authenticate user
  • Your Code42 product plan does not permit use of the Code42 API.

Authentication
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 the article about authentication.

Find API documentation

A authority server hosts two API documentation viewers for three versions of the API. The three versions provide different resources to the same users. If you have access to one version, you have access to all three.

Version 4

Go to https:/./authority-server.example.com:4285/swagger/
In the menu at the upper-right, select v4.
You will see information about resources to:

Version 3

Go to https:/./authority-server.example.com:4285/swagger/
You will see information about resources to:

Version 1

Go to https:/./authority-server.example.com:4285/apidocviewer/

The version 1 API provides a wide range of functions, about 120 resources in all. Most are unique to v1. Some are duplicated and improved on by v4 resources.

Versions 3 and 4 API documentation reference

Code42 v3 v4 API Documentation Viewer

Item Description
a URL Version 3 and 4 API documentation resides at https:/./authority-server.example.com:4285/swagger.
b API Version Select version 3 or version 4.
c Links and controls
  • Base URL: When you create API requests, direct them to the Base URL, followed by the resource name, for example: https:/./authority-server.example.com:4285/c42api/v3/ping
  • /v3/apispec, /docs/v4: Get this API documentation as a single JSON object.
  • Code42 Server API License: The Code42 API is available to administrators with Premium, Enterprise, or Classic product plans. In Code42 product plans, look for Tools and integration.
  • Code42 API authentication: Get instructions for both name:password and token-based authentication.
  • V1 API Documentation: See the documentation viewer for additional API resources.
  • Code42 Support - Website: A link to this support page.
  • Send email to Code42 Support: Send questions to csmsupport@code42.com
  • Schemes: The only possible value is HTTPS.
  • Authorize: Controls a currently unsupported feature of the documentation viewer.
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.

 Versions 3 and 4 API details

Code42 v3 v4 API documentation details

Item Description
a Description details

The documentation may further describe a resource here. Three kinds of notes are common:

 
Parameter Specification Options:
  • For most resources, and unless otherwise stated, provide parameters as name=value pairs at the end of a URL, after a question mark (?), and separated by ampersands (&).
  • Other parameters, especially complex data for POST and PUT methods, use parameters defined in the body of a request.
  • Some parameters can be defined in either form.
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 application/x-www-form-urlencoded.

 

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. 

Version 1 API documentation reference

Code42 v1 API documentation viewer

Item Description
a Search API Filters the list of resources based on search text.
b Resources

Lists the version 1 Code42 API resources.

  • Click a resource to view its description.
  • Click API resource chevron next to a resource to show links to the methods it offers.
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.
  • Was this article helpful?