--- title: Update datastore description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Actions Datastores --- # Update datastore{% #update-datastore %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------------- | | ap1.datadoghq.com | PATCH https://api.ap1.datadoghq.com/api/v2/actions-datastores/{datastore_id} | | ap2.datadoghq.com | PATCH https://api.ap2.datadoghq.com/api/v2/actions-datastores/{datastore_id} | | app.datadoghq.eu | PATCH https://api.datadoghq.eu/api/v2/actions-datastores/{datastore_id} | | app.ddog-gov.com | PATCH https://api.ddog-gov.com/api/v2/actions-datastores/{datastore_id} | | us2.ddog-gov.com | PATCH https://api.us2.ddog-gov.com/api/v2/actions-datastores/{datastore_id} | | app.datadoghq.com | PATCH https://api.datadoghq.com/api/v2/actions-datastores/{datastore_id} | | us3.datadoghq.com | PATCH https://api.us3.datadoghq.com/api/v2/actions-datastores/{datastore_id} | | us5.datadoghq.com | PATCH https://api.us5.datadoghq.com/api/v2/actions-datastores/{datastore_id} | ### Overview Updates an existing datastore's attributes. This endpoint requires the `apps_datastore_manage` 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 datastore identifier and the attributes to update. | | data | attributes | object | Attributes that can be updated on a datastore. | | attributes | description | string | A human-readable description about the datastore. | | attributes | name | string | The display name of the datastore. | | data | id | string | The unique identifier of the datastore to update. | | data | type [*required*] | enum | The resource type for datastores. Allowed enum values: `datastores` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "name": "updated name" }, "type": "datastores", "id": "string" } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} A datastore's complete configuration and metadata. | Parent field | Field | Type | Description | | ------------ | ------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | Core information about a datastore, including its unique identifier and attributes. | | data | attributes | object | Detailed information about a datastore. | | attributes | created_at | date-time | Timestamp when the datastore was created. | | attributes | creator_user_id | int64 | The numeric ID of the user who created the datastore. | | attributes | creator_user_uuid | string | The UUID of the user who created the datastore. | | attributes | description | string | A human-readable description about the datastore. | | attributes | modified_at | date-time | Timestamp when the datastore was last modified. | | attributes | name | string | The display name of the datastore. | | attributes | org_id | int64 | The ID of the organization that owns this datastore. | | attributes | primary_column_name | string | The name of the primary key column for this datastore. Primary column names: | | attributes | primary_key_generation_strategy | enum | Can be set to `uuid` to automatically generate primary keys when new items are added. Default value is `none`, which requires you to supply a primary key for each new item. Allowed enum values: `none,uuid` | | data | id | string | The unique identifier of the datastore. | | data | type [*required*] | enum | The resource type for datastores. Allowed enum values: `datastores` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "created_at": "2019-09-19T10:00:00.000Z", "creator_user_id": "integer", "creator_user_uuid": "string", "description": "string", "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", "org_id": "integer", "primary_column_name": "", "primary_key_generation_strategy": "string" }, "id": "string", "type": "datastores" } } ``` {% /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 PATCH "https://api.datadoghq.com/api/v2/actions-datastores/${datastore_id}" \ -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": { "type": "datastores" } } EOF ##### ```go // Update datastore 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.UpdateAppsDatastoreRequest{ Data: &datadogV2.UpdateAppsDatastoreRequestData{ Attributes: &datadogV2.UpdateAppsDatastoreRequestDataAttributes{ Name: datadog.PtrString("updated name"), }, Type: datadogV2.DATASTOREDATATYPE_DATASTORES, Id: datadog.PtrString(DatastoreDataID), }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewActionsDatastoresApi(apiClient) resp, r, err := api.UpdateDatastore(ctx, DatastoreDataID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ActionsDatastoresApi.UpdateDatastore`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ActionsDatastoresApi.UpdateDatastore`:\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 // Update datastore 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.Datastore; import com.datadog.api.client.v2.model.DatastoreDataType; import com.datadog.api.client.v2.model.UpdateAppsDatastoreRequest; import com.datadog.api.client.v2.model.UpdateAppsDatastoreRequestData; import com.datadog.api.client.v2.model.UpdateAppsDatastoreRequestDataAttributes; 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"); UpdateAppsDatastoreRequest body = new UpdateAppsDatastoreRequest() .data( new UpdateAppsDatastoreRequestData() .attributes(new UpdateAppsDatastoreRequestDataAttributes().name("updated name")) .type(DatastoreDataType.DATASTORES) .id(DATASTORE_DATA_ID)); try { Datastore result = apiInstance.updateDatastore(DATASTORE_DATA_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ActionsDatastoresApi#updateDatastore"); 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 """ Update datastore 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.datastore_data_type import DatastoreDataType from datadog_api_client.v2.model.update_apps_datastore_request import UpdateAppsDatastoreRequest from datadog_api_client.v2.model.update_apps_datastore_request_data import UpdateAppsDatastoreRequestData from datadog_api_client.v2.model.update_apps_datastore_request_data_attributes import ( UpdateAppsDatastoreRequestDataAttributes, ) # there is a valid "datastore" in the system DATASTORE_DATA_ID = environ["DATASTORE_DATA_ID"] body = UpdateAppsDatastoreRequest( data=UpdateAppsDatastoreRequestData( attributes=UpdateAppsDatastoreRequestDataAttributes( name="updated name", ), type=DatastoreDataType.DATASTORES, id=DATASTORE_DATA_ID, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = ActionsDatastoresApi(api_client) response = api_instance.update_datastore(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 # Update datastore 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::UpdateAppsDatastoreRequest.new({ data: DatadogAPIClient::V2::UpdateAppsDatastoreRequestData.new({ attributes: DatadogAPIClient::V2::UpdateAppsDatastoreRequestDataAttributes.new({ name: "updated name", }), type: DatadogAPIClient::V2::DatastoreDataType::DATASTORES, id: DATASTORE_DATA_ID, }), }) p api_instance.update_datastore(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 // Update datastore returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_actions_datastores::ActionsDatastoresAPI; use datadog_api_client::datadogV2::model::DatastoreDataType; use datadog_api_client::datadogV2::model::UpdateAppsDatastoreRequest; use datadog_api_client::datadogV2::model::UpdateAppsDatastoreRequestData; use datadog_api_client::datadogV2::model::UpdateAppsDatastoreRequestDataAttributes; #[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 = UpdateAppsDatastoreRequest::new().data( UpdateAppsDatastoreRequestData::new(DatastoreDataType::DATASTORES) .attributes( UpdateAppsDatastoreRequestDataAttributes::new().name("updated name".to_string()), ) .id(datastore_data_id.clone()), ); let configuration = datadog::Configuration::new(); let api = ActionsDatastoresAPI::with_config(configuration); let resp = api.update_datastore(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 /** * Update datastore 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.ActionsDatastoresApiUpdateDatastoreRequest = { body: { data: { attributes: { name: "updated name", }, type: "datastores", id: DATASTORE_DATA_ID, }, }, datastoreId: DATASTORE_DATA_ID, }; apiInstance .updateDatastore(params) .then((data: v2.Datastore) => { 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 %}