Coro Cybersecurity Public API (v1)


This is the Coro Cybersecurity platform API specification reference.

This section provides a complete reference listing for the Coro Cybersecurity REST API resource model.

About the resource reference

This reference lists all the resources available through the Coro REST API.

Each section relates to a specific resource and provides its name, description, unique URI path, and the list of operations you can perform on it.

For each operation, you can find:

  • A complete description of the action
  • Request parameters
  • A list of potential responses
  • Security (authentication) requirements

The portal also provides code samples and examples for making requests in a number of programming languages, together with samples of the possible response bodies.

In addition to this, Coro provides a Try It feature where you can interact with the API directly through the portal. To use Try It, you'll need to first obtain Client ID and Secret credentials; for more information, see Authentication.

Languages
Servers
Coro mock API server

https://docs.coro.net/_mock/api/api-docs/

Coro US API server target URL

https://api.secure.coro.net/

audit-logs

This is the audit log resource.

Operations

authentication

This is the resource for API authentication requests.

Use this resource to validate your identify and to obtain a bearer token to use when accessing other API resources.

Operations

devices

This is the Devices resource.

Use this resource to get details of all protected devices for a particular workspace.

Operations

Retrieve supported actions for a device

Request

Retrieve all the supported actions that can be performed on a device through its enrollment code.

Security
JWT
Path
enrollmentCodestringrequired
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
curl -i -X GET \
  'https://docs.coro.net/_mock/api/api-docs/v1/devices/{enrollmentCode}/actions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

Bodyapplication/json
actionobject(SupportedDeviceAction)

The supported device actions. These include:
tamperProtection - Tamper protection prevents users and certain types of malware from tampering with important security features or disabling protection.
deviceProtection - Remove a device from protection.
malwareScan - Malware scans conduct a thorough scan of specified drives, detecting malware.
dataGovernanceScan - Data governance scans conduct a thorough scan of specified drives for sensitive data.
updateAgent - Update the device’s Coro Agent to the latest version.
driveEncryption - Drive encryption protects the data on that drive from unauthorized access.
deviceState - The state of the device, which can be shut down or restarted.

supportedValuesArray of strings
Example: ["encrypt"]
Response
application/json
{ "action": {}, "supportedValues": [ "encrypt" ] }

Perform an action on a device

Request

Perform a supported action on a device through its enrollment code.

Security
JWT
Path
enrollmentCodestringrequired
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
Bodyapplication/jsonrequired
actionobject(SupportedDeviceAction)required

The supported device actions. These include:
tamperProtection - Tamper protection prevents users and certain types of malware from tampering with important security features or disabling protection.
deviceProtection - Remove a device from protection.
malwareScan - Malware scans conduct a thorough scan of specified drives, detecting malware.
dataGovernanceScan - Data governance scans conduct a thorough scan of specified drives for sensitive data.
updateAgent - Update the device’s Coro Agent to the latest version.
driveEncryption - Drive encryption protects the data on that drive from unauthorized access.
deviceState - The state of the device, which can be shut down or restarted.

valuestringrequired

The values of the device actions. These include, for the different actions:
tamperProtection - enable, disable
deviceProtection - remove
malwareScan - start, stop
dataGovernanceScan - startFullScan, startPartialScan, stop. Full scans can take a long time. A partial scan ends if a significant amount of sensitive data is found.
updateAgent - updateToLatest
driveEncryption - encrypt
deviceState - shutdown, restart

Example: "enable"
metadataobject

Additional data required for drive encryption.

Example: {"driveLetter":"C://"}
curl -i -X POST \
  'https://docs.coro.net/_mock/api/api-docs/v1/devices/{enrollmentCode}/actions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u' \
  -d '{
    "action": {},
    "value": "enable",
    "metadata": {
      "driveLetter": "C://"
    }
  }'

Responses

Success

Bodyapplication/json
deviceStatusobject

The status of the device action.

Response
application/json
{ "deviceStatus": {} }

Retrieve protected devices

Request

Retrieve the protected devices in a workspace. This call supports pagination; default page size includes 20 devices.

Security
JWT
Query
enrollmentCodestring

Filter by Coro’s unique enrollment code for a device.

pagestring>= 0

API responses use pagination to reduce loading time. Return a specific page of results, using a zero-based page index (0..N).

Default "0"
Example: page=0
pageSizestring[ 10 .. 500 ]

API responses use pagination to reduce loading time. Return a maximum of this many items per page.

Default "20"
Example: pageSize=50
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
curl -i -X GET \
  'https://docs.coro.net/_mock/api/api-docs/v1/devices?enrollmentCode=string&page=0&pageSize=50' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

Bodyapplication/json
itemsArray of objects(DeviceResponse)
totalElementsinteger(int64)

The total number of records that exist for the request.

Response
application/json
{ "items": [ {} ], "totalElements": 0 }

Retrieve latest Coro Agents

Request

Retrieve a list of the latest Coro Agent versions available for supported device operating systems. Each URL is specific to the workspace.

Security
JWT
Headers
Workspacestringrequired

The workspace identifier, which isolates API requests inside the provided workspace scope.

Example: corodevonmicrosoftcom_TX7T_u
curl -i -X GET \
  https://docs.coro.net/_mock/api/api-docs/v1/devices/agents/latest \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Workspace: corodevonmicrosoftcom_TX7T_u'

Responses

Success

Bodyapplication/json
deviceAgentsArray of objects(DeviceAgent)

A list of the latest Coro Agent versions for each supported device operating system.

Response
application/json
{ "deviceAgents": [ {} ] }

portal-users

This is the portal user resource.

Use this resource to get details of all portal users added to the specified workspace.

Operations

subscriptions

This is the subscriptions resource.

Use this resource to view and manage workspace subscriptions.

Operations

tickets

This is the Tickets resource.

Use this resource to get details of all tickets stored in the Coro platform for a particular workspace.

Operations

tickets-summary

This is the Tickets Summary resource.

Use this resource to get details of tickets for a particular workspace, grouped by protection component.

Operations

usage

This is the resource for Coro usage.

Use this resource to obtain information about usage

Operations

users

This is the protected user resource.

Use this resource to get details of all protected users added to the specified workspace.

Operations

webhook-configuration

Use this resource to manage or view details of existing webhooks configurations, or to create new webhook configurations.

Operations

workspaces

Use this resource to view details of provisioned workspaces, or to create new workspaces.

Operations