com.datadog.api.client.v2.api

Class ThreatIntelligenceApi

java.lang.Object

com.datadog.api.client.v2.api.ThreatIntelligenceApi

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class ThreatIntelligenceApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters Manage optional parameters to addSTIXThreatIntel.

Constructor Summary

Constructors

Constructor and Description
ThreatIntelligenceApi()
ThreatIntelligenceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
STIXIngestResponse	addSTIXThreatIntel(String tiVendor, STIXBundleRequest body) Ingest STIX threat intelligence.
STIXIngestResponse	addSTIXThreatIntel(String tiVendor, STIXBundleRequest body, ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters parameters) Ingest STIX threat intelligence.
CompletableFuture<STIXIngestResponse>	addSTIXThreatIntelAsync(String tiVendor, STIXBundleRequest body) Ingest STIX threat intelligence.
CompletableFuture<STIXIngestResponse>	addSTIXThreatIntelAsync(String tiVendor, STIXBundleRequest body, ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters parameters) Ingest STIX threat intelligence.
ApiResponse<STIXIngestResponse>	addSTIXThreatIntelWithHttpInfo(String tiVendor, STIXBundleRequest body, ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters parameters) Ingest a STIX 2.1 bundle containing threat intelligence indicators.
CompletableFuture<ApiResponse<STIXIngestResponse>>	addSTIXThreatIntelWithHttpInfoAsync(String tiVendor, STIXBundleRequest body, ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters parameters) Ingest STIX threat intelligence.
ApiClient	getApiClient() Get the API client.
void	setApiClient(ApiClient apiClient) Set the API client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThreatIntelligenceApi

public ThreatIntelligenceApi()

ThreatIntelligenceApi

public ThreatIntelligenceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

addSTIXThreatIntel

public STIXIngestResponse addSTIXThreatIntel(String tiVendor,
                                             STIXBundleRequest body)
                                      throws ApiException

Ingest STIX threat intelligence.

See addSTIXThreatIntelWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.STIXBundleRequest, com.datadog.api.client.v2.api.ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters).

Parameters:

tiVendor - Vendor identifier for the feed. The value must not exceed 10 characters. Datadog normalizes the accepted value to lowercase, converts non-alphanumeric characters to underscores, and trims leading and trailing underscores. (required)

body - A STIX 2.1 bundle containing indicator objects. The request body must not exceed 50 MB as received or 100 MB after decompression. (required)

Returns:

STIXIngestResponse

Throws:

ApiException - if fails to make API call

addSTIXThreatIntelAsync

public CompletableFuture<STIXIngestResponse> addSTIXThreatIntelAsync(String tiVendor,
                                                                     STIXBundleRequest body)

Ingest STIX threat intelligence.

See addSTIXThreatIntelWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.STIXBundleRequest, com.datadog.api.client.v2.api.ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters).

Parameters:

tiVendor - Vendor identifier for the feed. The value must not exceed 10 characters. Datadog normalizes the accepted value to lowercase, converts non-alphanumeric characters to underscores, and trims leading and trailing underscores. (required)

body - A STIX 2.1 bundle containing indicator objects. The request body must not exceed 50 MB as received or 100 MB after decompression. (required)

Returns:

CompletableFuture<STIXIngestResponse>

addSTIXThreatIntel

public STIXIngestResponse addSTIXThreatIntel(String tiVendor,
                                             STIXBundleRequest body,
                                             ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters parameters)
                                      throws ApiException

Ingest STIX threat intelligence.

See addSTIXThreatIntelWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.STIXBundleRequest, com.datadog.api.client.v2.api.ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters).

Parameters:

tiVendor - Vendor identifier for the feed. The value must not exceed 10 characters. Datadog normalizes the accepted value to lowercase, converts non-alphanumeric characters to underscores, and trims leading and trailing underscores. (required)

body - A STIX 2.1 bundle containing indicator objects. The request body must not exceed 50 MB as received or 100 MB after decompression. (required)

parameters - Optional parameters for the request.

Returns:

STIXIngestResponse

Throws:

ApiException - if fails to make API call

addSTIXThreatIntelAsync

public CompletableFuture<STIXIngestResponse> addSTIXThreatIntelAsync(String tiVendor,
                                                                     STIXBundleRequest body,
                                                                     ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters parameters)

Ingest STIX threat intelligence.

See addSTIXThreatIntelWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.STIXBundleRequest, com.datadog.api.client.v2.api.ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters).

Parameters:

tiVendor - Vendor identifier for the feed. The value must not exceed 10 characters. Datadog normalizes the accepted value to lowercase, converts non-alphanumeric characters to underscores, and trims leading and trailing underscores. (required)

body - A STIX 2.1 bundle containing indicator objects. The request body must not exceed 50 MB as received or 100 MB after decompression. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<STIXIngestResponse>

addSTIXThreatIntelWithHttpInfo

public ApiResponse<STIXIngestResponse> addSTIXThreatIntelWithHttpInfo(String tiVendor,
                                                                      STIXBundleRequest body,
                                                                      ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters parameters)
                                                               throws ApiException

Ingest a STIX 2.1 bundle containing threat intelligence indicators. Only indicator objects are processed. Supported indicator patterns contain IPv4 addresses, IPv6 addresses, domain names, or SHA-256 file hashes.

Non-indicator objects are ignored and are not included in the response counters. Indicator objects with unsupported STIX versions or patterns that produce no supported observable values increment the unsupported counter. Patterns that cannot be parsed increment the invalid counter. Processing is best effort, so valid supported indicators in the same bundle are still added.

A successful response means ingestion has completed. Reference-table materialization and enrichment happen asynchronously. Requests are limited to 50 MB as received, 100 MB after decompression, and 10 requests per second per API key. Gzip-compressed request bodies are supported.

Parameters:

tiVendor - Vendor identifier for the feed. The value must not exceed 10 characters. Datadog normalizes the accepted value to lowercase, converts non-alphanumeric characters to underscores, and trims leading and trailing underscores. (required)

body - A STIX 2.1 bundle containing indicator objects. The request body must not exceed 50 MB as received or 100 MB after decompression. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<STIXIngestResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
413	The request body exceeds 50 MB as received or 100 MB after decompression.	-
429	Too many requests	-
502	The STIX ingestion service returned an error while processing the request.	-
503	The STIX ingestion service is temporarily unavailable.	-

addSTIXThreatIntelWithHttpInfoAsync

public CompletableFuture<ApiResponse<STIXIngestResponse>> addSTIXThreatIntelWithHttpInfoAsync(String tiVendor,
                                                                                              STIXBundleRequest body,
                                                                                              ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters parameters)

Ingest STIX threat intelligence.

See addSTIXThreatIntelWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.STIXBundleRequest, com.datadog.api.client.v2.api.ThreatIntelligenceApi.AddSTIXThreatIntelOptionalParameters).

Parameters:

tiVendor - Vendor identifier for the feed. The value must not exceed 10 characters. Datadog normalizes the accepted value to lowercase, converts non-alphanumeric characters to underscores, and trims leading and trailing underscores. (required)

body - A STIX 2.1 bundle containing indicator objects. The request body must not exceed 50 MB as received or 100 MB after decompression. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<STIXIngestResponse>>