--- title: Bulk write datastore items description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Actions Datastores --- # Bulk write datastore items{% #bulk-write-datastore-items %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items/bulk | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items/bulk | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/actions-datastores/{datastore_id}/items/bulk | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/actions-datastores/{datastore_id}/items/bulk | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/actions-datastores/{datastore_id}/items/bulk | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items/bulk | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items/bulk | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items/bulk | ### Overview Creates or replaces multiple items in a datastore by their keys in a single operation. This endpoint requires the `apps_datastore_write` permission. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------------ | ------ | --------------------------------------------------- | | datastore_id [*required*] | string | The unique identifier of the datastore to retrieve. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | data | object | Data wrapper containing the items to insert and their configuration for the bulk insert operation. | | data | attributes | object | Configuration for bulk inserting multiple items into a datastore. | | attributes | conflict_mode | enum | How to handle conflicts when inserting items that already exist in the datastore. Allowed enum values: `fail_on_conflict,overwrite_on_conflict` | | attributes | values [*required*] | [object] | An array of items to add to the datastore, where each item is a set of key-value pairs representing the item's data. Up to 100 items can be updated in a single request. | | data | type [*required*] | enum | The resource type for datastore items. Allowed enum values: `items` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "values": [ { "id": "cust_3141", "name": "Johnathan" }, { "id": "cust_3142", "name": "Mary" } ] }, "type": "items" } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Response after successfully inserting multiple items into a datastore, containing the identifiers of the created items. | Parent field | Field | Type | Description | | ------------ | ---------------------- | -------- | --------------------------------------------------------------------------------------- | | | data [*required*] | [object] | An array of data objects containing the identifiers of the successfully inserted items. | | data | id | string | The unique identifier assigned to the inserted item. | | data | type [*required*] | enum | The resource type for datastore items. Allowed enum values: `items` | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "id": "string", "type": "items" } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Path parameters export datastore_id="CHANGE_ME" \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/actions-datastores/${datastore_id}/items/bulk" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "conflict_mode": "overwrite_on_conflict", "values": [ { "data": "example data", "key": "value" }, { "data": "example data2", "key": "value2" } ] }, "type": "items" } } EOF ##### ```go // Bulk write datastore items returns "OK" response package main import ( "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" ) func main() { // there is a valid "datastore" in the system DatastoreDataID := os.Getenv("DATASTORE_DATA_ID") body := datadogV2.BulkPutAppsDatastoreItemsRequest{ Data: &datadogV2.BulkPutAppsDatastoreItemsRequestData{ Attributes: &datadogV2.BulkPutAppsDatastoreItemsRequestDataAttributes{ Values: []map[string]interface{}{ map[string]interface{}{ "id": "cust_3141", "name": "Johnathan", }, map[string]interface{}{ "id": "cust_3142", "name": "Mary", }, }, }, Type: datadogV2.DATASTOREITEMSDATATYPE_ITEMS, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewActionsDatastoresApi(apiClient) resp, r, err := api.BulkWriteDatastoreItems(ctx, DatastoreDataID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ActionsDatastoresApi.BulkWriteDatastoreItems`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ActionsDatastoresApi.BulkWriteDatastoreItems`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Bulk write datastore items returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.ActionsDatastoresApi; import com.datadog.api.client.v2.model.BulkPutAppsDatastoreItemsRequest; import com.datadog.api.client.v2.model.BulkPutAppsDatastoreItemsRequestData; import com.datadog.api.client.v2.model.BulkPutAppsDatastoreItemsRequestDataAttributes; import com.datadog.api.client.v2.model.DatastoreItemsDataType; import com.datadog.api.client.v2.model.PutAppsDatastoreItemResponseArray; import java.util.Arrays; import java.util.Map; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); ActionsDatastoresApi apiInstance = new ActionsDatastoresApi(defaultClient); // there is a valid "datastore" in the system String DATASTORE_DATA_ID = System.getenv("DATASTORE_DATA_ID"); BulkPutAppsDatastoreItemsRequest body = new BulkPutAppsDatastoreItemsRequest() .data( new BulkPutAppsDatastoreItemsRequestData() .attributes( new BulkPutAppsDatastoreItemsRequestDataAttributes() .values( Arrays.asList( Map.ofEntries( Map.entry("id", "cust_3141"), Map.entry("name", "Johnathan")), Map.ofEntries( Map.entry("id", "cust_3142"), Map.entry("name", "Mary"))))) .type(DatastoreItemsDataType.ITEMS)); try { PutAppsDatastoreItemResponseArray result = apiInstance.bulkWriteDatastoreItems(DATASTORE_DATA_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ActionsDatastoresApi#bulkWriteDatastoreItems"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Bulk write datastore items returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.actions_datastores_api import ActionsDatastoresApi from datadog_api_client.v2.model.bulk_put_apps_datastore_items_request import BulkPutAppsDatastoreItemsRequest from datadog_api_client.v2.model.bulk_put_apps_datastore_items_request_data import BulkPutAppsDatastoreItemsRequestData from datadog_api_client.v2.model.bulk_put_apps_datastore_items_request_data_attributes import ( BulkPutAppsDatastoreItemsRequestDataAttributes, ) from datadog_api_client.v2.model.datastore_items_data_type import DatastoreItemsDataType # there is a valid "datastore" in the system DATASTORE_DATA_ID = environ["DATASTORE_DATA_ID"] body = BulkPutAppsDatastoreItemsRequest( data=BulkPutAppsDatastoreItemsRequestData( attributes=BulkPutAppsDatastoreItemsRequestDataAttributes( values=[ dict([("id", "cust_3141"), ("name", "Johnathan")]), dict([("id", "cust_3142"), ("name", "Mary")]), ], ), type=DatastoreItemsDataType.ITEMS, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = ActionsDatastoresApi(api_client) response = api_instance.bulk_write_datastore_items(datastore_id=DATASTORE_DATA_ID, body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Bulk write datastore items returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::ActionsDatastoresAPI.new # there is a valid "datastore" in the system DATASTORE_DATA_ID = ENV["DATASTORE_DATA_ID"] body = DatadogAPIClient::V2::BulkPutAppsDatastoreItemsRequest.new({ data: DatadogAPIClient::V2::BulkPutAppsDatastoreItemsRequestData.new({ attributes: DatadogAPIClient::V2::BulkPutAppsDatastoreItemsRequestDataAttributes.new({ values: [ { "id": "cust_3141", "name": "Johnathan", }, { "id": "cust_3142", "name": "Mary", }, ], }), type: DatadogAPIClient::V2::DatastoreItemsDataType::ITEMS, }), }) p api_instance.bulk_write_datastore_items(DATASTORE_DATA_ID, body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Bulk write datastore items returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_actions_datastores::ActionsDatastoresAPI; use datadog_api_client::datadogV2::model::BulkPutAppsDatastoreItemsRequest; use datadog_api_client::datadogV2::model::BulkPutAppsDatastoreItemsRequestData; use datadog_api_client::datadogV2::model::BulkPutAppsDatastoreItemsRequestDataAttributes; use datadog_api_client::datadogV2::model::DatastoreItemsDataType; use serde_json::Value; use std::collections::BTreeMap; #[tokio::main] async fn main() { // there is a valid "datastore" in the system let datastore_data_id = std::env::var("DATASTORE_DATA_ID").unwrap(); let body = BulkPutAppsDatastoreItemsRequest::new().data( BulkPutAppsDatastoreItemsRequestData::new(DatastoreItemsDataType::ITEMS).attributes( BulkPutAppsDatastoreItemsRequestDataAttributes::new(vec![ BTreeMap::from([ ("id".to_string(), Value::from("cust_3141")), ("name".to_string(), Value::from("Johnathan")), ]), BTreeMap::from([ ("id".to_string(), Value::from("cust_3142")), ("name".to_string(), Value::from("Mary")), ]), ]), ), ); let configuration = datadog::Configuration::new(); let api = ActionsDatastoresAPI::with_config(configuration); let resp = api .bulk_write_datastore_items(datastore_data_id.clone(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Bulk write datastore items returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.ActionsDatastoresApi(configuration); // there is a valid "datastore" in the system const DATASTORE_DATA_ID = process.env.DATASTORE_DATA_ID as string; const params: v2.ActionsDatastoresApiBulkWriteDatastoreItemsRequest = { body: { data: { attributes: { values: [ { id: "cust_3141", name: "Johnathan", }, { id: "cust_3142", name: "Mary", }, ], }, type: "items", }, }, datastoreId: DATASTORE_DATA_ID, }; apiInstance .bulkWriteDatastoreItems(params) .then((data: v2.PutAppsDatastoreItemResponseArray) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}