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

Authenticate users

Request

Authenticate the user before making other API calls. The token is valid for 24 hours.

Bodyapplication/jsonrequired
client_idstringrequired

The unique identifier for the client. This value is provided by Coro support.

Example: "2qDgzSrZxnUCs4jqmfdEP5MVkEmA3Uak"
client_secretstringrequired

The secret for the client. This value is provided by Coro support.

Example: "9c9Dabz5nQT65LXfYt_61wxb9UssT7tpzTM-gVB4RJZB9gKDf1_TjO6o3eLcBaba"
audiencestringrequired

The URL for the Coro API server

Example: "https://secure.coro.net/api"
grant_typestringrequired

The method by which you want to request a bearer token for authentication. At this time, Coro only supports client_credentials.

Example: "client_credentials"
curl -i -X POST \
  https://docs.coro.net/_mock/api/api-docs/oauth/token \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": "2qDgzSrZxnUCs4jqmfdEP5MVkEmA3Uak",
    "client_secret": "9c9Dabz5nQT65LXfYt_61wxb9UssT7tpzTM-gVB4RJZB9gKDf1_TjO6o3eLcBaba",
    "audience": "https://secure.coro.net/api",
    "grant_type": "client_credentials"
  }'

Responses

Success

Bodyapplication/json
access_tokenstringrequired

The access token used to access API resources

Example: "eyJz93a...k4laUWw"
token_typestringrequired

Bearer token.

Example: "Bearer"
expires_ininteger(int64)required

The expiration time of the token, in seconds. The token is valid for 24 hours.

Example: 86400
Response
application/json
{ "access_token": "eyJz93a...k4laUWw", "token_type": "Bearer", "expires_in": 86400 }

devices

This is the Devices resource.

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

Operations

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