Cloudforce One

CloudforceOne

Cloudforce One

Binary Storage

CloudforceOne.BinaryStorage

Methods

get(, , ): void
get/accounts/{account_id}/cloudforce-one/binary/{hash}

Retrieves a file from Binary Storage

create(, ):
post/accounts/{account_id}/cloudforce-one/binary

Posts a file to Binary Storage

CloudforceOne.Requests

Methods

list(, ): <>
post/accounts/{account_id}/cloudforce-one/requests

List Requests

get(, , ):
get/accounts/{account_id}/cloudforce-one/requests/{request_id}

Get a Request

create(, ):
post/accounts/{account_id}/cloudforce-one/requests/new

Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided, a default will be assigned.

update(, , ):
put/accounts/{account_id}/cloudforce-one/requests/{request_id}

Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body.

delete(, , ):
delete/accounts/{account_id}/cloudforce-one/requests/{request_id}

Delete a Request

quota(, ):
get/accounts/{account_id}/cloudforce-one/requests/quota

Get Request Quota

types(, ): <>
get/accounts/{account_id}/cloudforce-one/requests/types

Get Request Types

constants(, ):
get/accounts/{account_id}/cloudforce-one/requests/constants

Get Request Priority, Status, and TLP constants

Domain types

Item{…}
ListItem{…}
Quota{…}
RequestConstants{…}
RequestTypes = Array<>

CloudforceOne.Requests.Assets

Methods

get(, , , ): <>
get/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}

Get a Request Asset

create(, , ): <>
post/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset

List Request Assets

update(, , , ):
put/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}

Update a Request Asset

delete(, , , ):
delete/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}

Delete a Request Asset

CloudforceOne.Requests.MessageResource

Methods

get(, , ): <>
post/accounts/{account_id}/cloudforce-one/requests/{request_id}/message

List Request Messages

create(, , ):
post/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/new

Create a New Request Message

update(, , , ):
put/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id}

Update a Request Message

delete(, , , ):
delete/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id}

Delete a Request Message

Domain types

Message{…}

CloudforceOne.Requests.PriorityResource

Methods

get(, , ):
get/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}

Get a Priority Intelligence Requirement

create(, ):
post/accounts/{account_id}/cloudforce-one/requests/priority/new

Create a New Priority Intelligence Requirement

update(, , ):
put/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}

Update a Priority Intelligence Requirement

delete(, , ):
delete/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}

Delete a Priority Intelligence Requirement

quota(, ):
get/accounts/{account_id}/cloudforce-one/requests/priority/quota

Get Priority Intelligence Requirement Quota

Domain types

Label = string
Priority{…}
PriorityEdit{…}

CloudforceOne.Scans

CloudforceOne.Scans.Config

Methods

list(, ): <>
get/accounts/{account_id}/cloudforce-one/scans/config

List Scan Configs

create(, ):
post/accounts/{account_id}/cloudforce-one/scans/config

Create a new Scan Config

edit(, , ):
patch/accounts/{account_id}/cloudforce-one/scans/config/{config_id}

Update an existing Scan Config

delete(, , ):
delete/accounts/{account_id}/cloudforce-one/scans/config/{config_id}

Delete a Scan Config

CloudforceOne.Scans.Results

Methods

get(, , ):
get/accounts/{account_id}/cloudforce-one/scans/results/{config_id}

Get the Latest Scan Result

Domain types

ScanResult{…}
Cloudforce One

Threat Events

CloudforceOne.ThreatEvents

Methods

list(, ):
get/accounts/{account_id}/cloudforce-one/events

When datasetId is unspecified, events will be listed from the Cloudforce One Threat Events dataset. To list existing datasets (and their IDs), use the List Datasets endpoint). Also, must provide query parameters.

get(, , ):
Deprecated
get/accounts/{account_id}/cloudforce-one/events/{event_id}

This Method is deprecated. Please use /events/dataset/:dataset_id/events/:event_id instead.

create(, ):
post/accounts/{account_id}/cloudforce-one/events/create

To create a dataset, see the Create Dataset endpoint. When datasetId parameter is unspecified, it will be created in a default dataset named Cloudforce One Threat Events.

edit(, , ):
patch/accounts/{account_id}/cloudforce-one/events/{event_id}

Updates an event

delete(, , ):
delete/accounts/{account_id}/cloudforce-one/events/{event_id}

The datasetId parameter must be defined. To list existing datasets (and their IDs) in your account, use the List Datasets endpoint.

bulkCreate(, ):
post/accounts/{account_id}/cloudforce-one/events/create/bulk

The datasetId parameter must be defined. To list existing datasets (and their IDs) in your account, use the List Datasets endpoint.

CloudforceOne.ThreatEvents.Attackers

Methods

list(, ):
get/accounts/{account_id}/cloudforce-one/events/attackers

Lists attackers across multiple datasets

CloudforceOne.ThreatEvents.Categories

Methods

list(, ):
get/accounts/{account_id}/cloudforce-one/events/categories

Lists categories across multiple datasets

get(, , ):
get/accounts/{account_id}/cloudforce-one/events/categories/{category_id}

Reads a category

create(, ):
post/accounts/{account_id}/cloudforce-one/events/categories/create

Creates a new category

edit(, , ):
patch/accounts/{account_id}/cloudforce-one/events/categories/{category_id}

Updates a category

delete(, , ):
delete/accounts/{account_id}/cloudforce-one/events/categories/{category_id}

Deletes a category

CloudforceOne.ThreatEvents.Countries

Methods

list(, ):
get/accounts/{account_id}/cloudforce-one/events/countries

Retrieves countries information for all countries

CloudforceOne.ThreatEvents.Crons

CloudforceOne.ThreatEvents.Datasets

Methods

list(, ):
get/accounts/{account_id}/cloudforce-one/events/dataset

Lists all datasets in an account

get(, , ):
get/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}

Reads a dataset

create(, ):
post/accounts/{account_id}/cloudforce-one/events/dataset/create

Creates a dataset

edit(, , ):
patch/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}

Updates an existing dataset

raw(, , , ):
get/accounts/{account_id}/cloudforce-one/events/raw/{dataset_id}/{event_id}

Reads data for a raw event

CloudforceOne.ThreatEvents.Datasets.Health

CloudforceOne.ThreatEvents.EventTags

Methods

create(, , ):
post/accounts/{account_id}/cloudforce-one/events/event_tag/{event_id}/create

Adds a tag to an event

delete(, , ):
delete/accounts/{account_id}/cloudforce-one/events/event_tag/{event_id}

Removes a tag from an event

CloudforceOne.ThreatEvents.IndicatorTypes

Methods

list(, ):
Deprecated
get/accounts/{account_id}/cloudforce-one/events/indicatorTypes

This Method is deprecated. Please use /events/dataset/:dataset_id/indicatorTypes instead.

CloudforceOne.ThreatEvents.Insights

CloudforceOne.ThreatEvents.Raw

Methods

get(, , , ):
get/accounts/{account_id}/cloudforce-one/events/{event_id}/raw/{raw_id}

Reads data for a raw event

edit(, , , ):
patch/accounts/{account_id}/cloudforce-one/events/{event_id}/raw/{raw_id}

Updates a raw event

CloudforceOne.ThreatEvents.Relate

Methods

delete(, , ):
delete/accounts/{account_id}/cloudforce-one/events/relate/{event_id}

Removes an event reference

CloudforceOne.ThreatEvents.Tags

Methods

create(, ):
post/accounts/{account_id}/cloudforce-one/events/tags/create

Creates a new tag to be used accross threat events.

CloudforceOne.ThreatEvents.TargetIndustries

Methods

list(, ):
get/accounts/{account_id}/cloudforce-one/events/targetIndustries

Lists target industries across multiple datasets