Search the Cloud SIEM entity context store for entities that match a query, and return the historical
revisions of each entity in the requested time range. The endpoint can either return revisions across an
interval (from / to) or the snapshot of each entity at a single point in time (as_of); the two modes
are mutually exclusive.
This endpoint requires the siem_entities_read permission.
OAuth apps require the siem_entities_read authorization scope to access this endpoint.
Arguments
Query Strings
Name
Type
Description
query
string
A free-text query (for example, an email address or principal ID) used to filter the entities returned.
entity_type
enum
The type of entity to retrieve. Only siem_entity_identity is currently supported.
Defaults to siem_entity_identity. Allowed enum values: siem_entity_identity
from
string
The start of the time range to query, as an RFC3339 timestamp or a relative time (for example, now-7d).
Defaults to now-7d. Ignored when as_of is set.
to
string
The end of the time range to query, as an RFC3339 timestamp or a relative time (for example, now).
Defaults to now. Ignored when as_of is set.
as_of
string
A point in time at which to query the entity revisions, as an RFC3339 timestamp, a Unix timestamp
(in seconds), or a relative time (for example, now-1d). When set, from and to are ignored.
Cannot be combined with custom from / to values.
limit
integer
The maximum number of entities to return.
page_token
string
An opaque token used to fetch the next page of results, as returned in meta.page.next_token of a previous response.
Response from the entity context endpoint, containing the matching entities and pagination metadata.
Expand All
Field
Type
Description
data [required]
[object]
The list of entities matching the query.
attributes [required]
object
The attributes of an entity context entry, grouping all the historical revisions of the entity.
revisions [required]
[object]
The historical revisions of the entity, ordered chronologically.
attributes [required]
object
The set of attributes recorded for the entity at this revision. The keys depend on the kind of entity.
first_seen_at [required]
date-time
The first time the entity was observed at this revision.
last_seen_at [required]
date-time
The last time the entity was observed at this revision.
id [required]
string
The unique identifier of the entity.
type [required]
string
The type of the entity. Reflects the underlying entity kind from the entity context store
(for example, siem_entity_identity for identities). Defaults to entity when the kind is unknown.
default: entity
meta [required]
object
Metadata returned alongside the entity context response.
page [required]
object
Pagination metadata for the entity context response.
next_token [required]
string
An opaque token to pass as page_token in a subsequent request to retrieve the next page of results. Empty when there are no more results.
total_count [required]
int32
The total number of entities matching the query, irrespective of pagination.
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"python3"example.py"
# Get entity context returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.access_token=ENV["DD_BEARER_TOKEN"]config.unstable_operations["v2.get_entity_context".to_sym]=trueendapi_instance=DatadogAPIClient::V2::SecurityMonitoringAPI.newpapi_instance.get_entity_context()
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"rb"example.rb"
// Get entity context returns "OK" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())ctx=context.WithValue(ctx,datadog.ContextAccessToken,os.Getenv("DD_BEARER_TOKEN"))configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.GetEntityContext",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewSecurityMonitoringApi(apiClient)resp,r,err:=api.GetEntityContext(ctx,*datadogV2.NewGetEntityContextOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `SecurityMonitoringApi.GetEntityContext`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `SecurityMonitoringApi.GetEntityContext`:\n%s\n",responseContent)}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"go run"main.go"
// Get entity context returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.SecurityMonitoringApi;importcom.datadog.api.client.v2.model.EntityContextResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));defaultClient.setUnstableOperationEnabled("v2.getEntityContext",true);SecurityMonitoringApiapiInstance=newSecurityMonitoringApi(defaultClient);try{EntityContextResponseresult=apiInstance.getEntityContext();System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling SecurityMonitoringApi#getEntityContext");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"java"Example.java"
// Get entity context returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_security_monitoring::GetEntityContextOptionalParams;usedatadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;#[tokio::main]asyncfnmain(){letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.GetEntityContext",true);letapi=SecurityMonitoringAPI::with_config(configuration);letresp=api.get_entity_context(GetEntityContextOptionalParams::default()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get entity context returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration({authMethods:{AuthZ:{accessToken: process.env.DD_BEARER_TOKENasstring,},},});configuration.unstableOperations["v2.getEntityContext"]=true;constapiInstance=newv2.SecurityMonitoringApi(configuration);apiInstance.getEntityContext().then((data: v2.EntityContextResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"tsc"example.ts"
Request a personalized demo
Get Started with Datadog
Ask AI
AI-generated responses may be inaccurate. Verify important info.