Introduction to Enterprise API

Overview

Cloudlocks Enterprise API enables you to:

  • Integrate Cloudlock's detection and response into your security workflows
  • Keep your on-premise or cloud-based incident management systems in sync
  • Interact with incidents

The Cloudlock Enterprise API is a REST API with JSON responses. For best practice and future consistency all requests should use the Accept header passing the application/json value and the Content-Type header with the same value.

GET /resources HTTP/1.1
 Accept: application/json
 Content-type: application/json

URL for Cloudlock APIs

Please contact support@cloudlock.com for the URL you should use to make calls to the Cloudlock APIs (e.g. https://<provided-by-Cloudlock-support>.cloudlock.com).
If you have a support issue, please contact: support@cloudlock.com.

Example URL

The calls in this document to callapi.cloudlock.com are for example only.

Authentication

All endpoints require authentication unless stated otherwise.

  1. To interact with the API, you need an OAuth2 access token. Generate an access token in the Cloudlock application by selecting the Authentication & API tab in the Settings page.
  2. Click Generate to create your own token.
    When making a request to any resource include the Authorization header with a value of Bearer followed by a single space and the token.
GET /resources HTTP/1.1
 Authorization: Bearer <Your Token Here>

All API requests must be made over HTTPS. Calls made over plain HTTP will be redirected to HTTPS.

Pagination

All list-based endpoints support pagination.
Control pagination parameters using:

Field ID
Type
Description
Default

offset

integer

Indicates the item number to start the result set from

0

limit

integer

Determines the quantity of results to return

20 max=100

Filtering

Filtering a collection is achieved by adding a field (e.g. "incidents") to the querystring, along with the filter value. For example:
https://callapi.cloudlock.com/incidents?severity=ALERT
You can use muliple filters by separating them with the & operator. For eample:
https://callapi.cloudlock.com/incidents?severity=ALERT&incident_type=COMPLIANCE

Sorting

Use the order parameter along with the sort-by field to indicate the order for your request list result. For multiple sort orders, use a comma-delimted list of sort parameters. Default sort direction is ascending. Use a leading "-" character to denote descending.
Example:
Ascending: https://callapi.cloudlock.com/resources?order=created_at
Descending: https://callapi.cloudlock.com/resources?order=-created_at

Options Help

To get the the full list of options available for a field, use the field name as the ID when querying an end point.

Rate Limit

Cloudlock's API has both a rate limit and a quota based upon your license.
Exceeding the rate limit results in a 429 error.

Errors

Cloudlock uses standard HTTP response codes to indicate success or failure of an API request. Codes in the 2xx range indicate success, while codes in the 4xx range indicate an error and include an error response object:

Example Error Response:


Response 400 (application/json)
{
   "status": "error",
   "message": "The server cannot process the request due to a syntax error"
   "additional_info": null,
}

Confidentiality and Rights

© 2018 Cisco and/or its affiliates. All rights reserved. Cloudlock is a registered trademark of Cisco. All other trademarks or other third party brand or product names included herein are the trademarks or registered trademarks of their respective companies or organizations and are used only for identification or explanation. Cisco Cloudlock and related documentation are protected by contract law, intellectual property laws and international treaties, and are authorized for use only by customers for internal purposes in accordance with the applicable subscription agreement or terms of service. This documentation may not be distributed to third parties.
This documentation is provided “as is” and all express or implied conditions, representations and warranties, including implied warranty of merchantability, fitness for a particular purpose or non-infringement are hereby disclaimed, except to the extent that such disclaimers are held to be legally invalid.
The information contained in this documentation is subject to change without notice. Cisco recommends you periodically check this site to ensure you are utilizing the most current version of this documentation.

Introduction to Enterprise API


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.