- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
Language
Datadog Site
Leverage the Actions Datastore API to create, modify, and delete items in datastores owned by your organization.
GET https://api.ap1.datadoghq.com/api/v2/actions-datastoreshttps://api.ap2.datadoghq.com/api/v2/actions-datastoreshttps://api.datadoghq.eu/api/v2/actions-datastoreshttps://api.ddog-gov.com/api/v2/actions-datastoreshttps://api.datadoghq.com/api/v2/actions-datastoreshttps://api.us3.datadoghq.com/api/v2/actions-datastoreshttps://api.us5.datadoghq.com/api/v2/actions-datastores
Lists all datastores for the organization.
This endpoint requires the apps_datastore_read permission.
OK
A collection of datastores returned by list operations.
항목
유형
설명
data [required]
[object]
An array of datastore objects containing their configurations and metadata.
attributes
object
Detailed information about a datastore.
created_at
date-time
Timestamp when the datastore was created.
creator_user_id
int64
The numeric ID of the user who created the datastore.
creator_user_uuid
string
The UUID of the user who created the datastore.
description
string
A human-readable description about the datastore.
modified_at
date-time
Timestamp when the datastore was last modified.
name
string
The display name of the datastore.
org_id
int64
The ID of the organization that owns this datastore.
primary_column_name
string
The name of the primary key column for this datastore. Primary column names:
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
id
string
The unique identifier of the datastore.
type [required]
enum
The resource type for datastores.
Allowed enum values: datastores
default: datastores
{
"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"
}
]
}Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/actions-datastores" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
POST https://api.ap1.datadoghq.com/api/v2/actions-datastoreshttps://api.ap2.datadoghq.com/api/v2/actions-datastoreshttps://api.datadoghq.eu/api/v2/actions-datastoreshttps://api.ddog-gov.com/api/v2/actions-datastoreshttps://api.datadoghq.com/api/v2/actions-datastoreshttps://api.us3.datadoghq.com/api/v2/actions-datastoreshttps://api.us5.datadoghq.com/api/v2/actions-datastores
Creates a new datastore.
This endpoint requires the apps_datastore_manage permission.
항목
유형
설명
data
object
Data wrapper containing the configuration needed to create a new datastore.
attributes
object
Configuration and metadata to create a new datastore.
description
string
A human-readable description about the datastore.
name [required]
string
The display name for the new datastore.
org_access
enum
The organization access level for the datastore. For example, 'contributor'.
Allowed enum values: contributor,viewer,manager
primary_column_name [required]
string
The name of the primary key column for this datastore. Primary column names:
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
id
string
Optional ID for the new datastore. If not provided, one will be generated automatically.
type [required]
enum
The resource type for datastores.
Allowed enum values: datastores
default: datastores
{
"data": {
"attributes": {
"name": "datastore-name",
"primary_column_name": "primaryKey"
},
"type": "datastores"
}
}OK
Response after successfully creating a new datastore, containing the datastore’s assigned ID.
항목
유형
설명
data
object
The newly created datastore's data.
id
string
The unique identifier assigned to the newly created datastore.
type [required]
enum
The resource type for datastores.
Allowed enum values: datastores
default: datastores
{
"data": {
"id": "string",
"type": "datastores"
}
}Bad Request
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/actions-datastores" \
-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": {
"name": "datastore-name",
"primary_column_name": "primaryKey"
},
"type": "datastores"
}
}
EOF
GET https://api.ap1.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.ap2.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.datadoghq.eu/api/v2/actions-datastores/{datastore_id}https://api.ddog-gov.com/api/v2/actions-datastores/{datastore_id}https://api.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.us3.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.us5.datadoghq.com/api/v2/actions-datastores/{datastore_id}
Retrieves a specific datastore by its ID.
This endpoint requires the apps_datastore_read permission.
이름
유형
설명
datastore_id [required]
string
The unique identifier of the datastore to retrieve.
OK
A datastore’s complete configuration and metadata.
항목
유형
설명
data
object
Core information about a datastore, including its unique identifier and attributes.
attributes
object
Detailed information about a datastore.
created_at
date-time
Timestamp when the datastore was created.
creator_user_id
int64
The numeric ID of the user who created the datastore.
creator_user_uuid
string
The UUID of the user who created the datastore.
description
string
A human-readable description about the datastore.
modified_at
date-time
Timestamp when the datastore was last modified.
name
string
The display name of the datastore.
org_id
int64
The ID of the organization that owns this datastore.
primary_column_name
string
The name of the primary key column for this datastore. Primary column names:
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
id
string
The unique identifier of the datastore.
type [required]
enum
The resource type for datastores.
Allowed enum values: datastores
default: datastores
{
"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"
}
}Bad Request
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Not Found
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export datastore_id="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/actions-datastores/${datastore_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
PATCH https://api.ap1.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.ap2.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.datadoghq.eu/api/v2/actions-datastores/{datastore_id}https://api.ddog-gov.com/api/v2/actions-datastores/{datastore_id}https://api.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.us3.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.us5.datadoghq.com/api/v2/actions-datastores/{datastore_id}
Updates an existing datastore’s attributes.
This endpoint requires the apps_datastore_manage permission.
이름
유형
설명
datastore_id [required]
string
The unique identifier of the datastore to retrieve.
항목
유형
설명
data
object
Data wrapper containing the datastore identifier and the attributes to update.
attributes
object
Attributes that can be updated on a datastore.
description
string
A human-readable description about the datastore.
name
string
The display name of the datastore.
id
string
The unique identifier of the datastore to update.
type [required]
enum
The resource type for datastores.
Allowed enum values: datastores
default: datastores
{
"data": {
"attributes": {
"name": "updated name"
},
"type": "datastores",
"id": "string"
}
}OK
A datastore’s complete configuration and metadata.
항목
유형
설명
data
object
Core information about a datastore, including its unique identifier and attributes.
attributes
object
Detailed information about a datastore.
created_at
date-time
Timestamp when the datastore was created.
creator_user_id
int64
The numeric ID of the user who created the datastore.
creator_user_uuid
string
The UUID of the user who created the datastore.
description
string
A human-readable description about the datastore.
modified_at
date-time
Timestamp when the datastore was last modified.
name
string
The display name of the datastore.
org_id
int64
The ID of the organization that owns this datastore.
primary_column_name
string
The name of the primary key column for this datastore. Primary column names:
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
id
string
The unique identifier of the datastore.
type [required]
enum
The resource type for datastores.
Allowed enum values: datastores
default: datastores
{
"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"
}
}Bad Request
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Not Found
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export datastore_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.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": {
"attributes": {
"name": "updated name"
},
"type": "datastores",
"id": "string"
}
}
EOF
DELETE https://api.ap1.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.ap2.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.datadoghq.eu/api/v2/actions-datastores/{datastore_id}https://api.ddog-gov.com/api/v2/actions-datastores/{datastore_id}https://api.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.us3.datadoghq.com/api/v2/actions-datastores/{datastore_id}https://api.us5.datadoghq.com/api/v2/actions-datastores/{datastore_id}
Deletes a datastore by its unique identifier.
This endpoint requires the apps_datastore_manage permission.
이름
유형
설명
datastore_id [required]
string
The unique identifier of the datastore to retrieve.
OK
Bad Request
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export datastore_id="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/actions-datastores/${datastore_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
GET https://api.ap1.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.ap2.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.datadoghq.eu/api/v2/actions-datastores/{datastore_id}/itemshttps://api.ddog-gov.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.us3.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.us5.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items
Lists items from a datastore. You can filter the results by specifying either an item key or a filter query parameter, but not both at the same time. Supports server-side pagination for large datasets.
This endpoint requires the apps_datastore_read permission.
이름
유형
설명
datastore_id [required]
string
The unique identifier of the datastore to retrieve.
이름
유형
설명
item_key
string
Optional primary key value to retrieve a specific item. Cannot be used together with the filter parameter.
page[limit]
integer
Optional field to limit the number of items to return per page for pagination. Up to 100 items can be returned per page.
page[offset]
integer
Optional field to offset the number of items to skip from the beginning of the result set for pagination.
sort
string
Optional field to sort results by. Prefix with ‘-’ for descending order (e.g., ‘-created_at’).
OK
A collection of datastore items with pagination and schema metadata.
항목
유형
설명
data [required]
[object]
An array of datastore items with their content and metadata.
attributes
object
Metadata and content of a datastore item.
created_at
date-time
Timestamp when the item was first created.
modified_at
date-time
Timestamp when the item was last modified.
org_id
int64
The ID of the organization that owns this item.
primary_column_name
string
The name of the primary key column for this datastore. Primary column names:
signature
string
A unique signature identifying this item version.
store_id
string
The unique identifier of the datastore containing this item.
value
object
The data content (as key-value pairs) of a datastore item.
id
string
The unique identifier of the datastore.
type [required]
enum
The resource type for datastore items.
Allowed enum values: items
default: items
meta
object
Metadata about the included items, including pagination info and datastore schema.
page
object
Pagination information for a collection of datastore items.
hasMore
boolean
Whether there are additional pages of items beyond the current page.
totalCount
int64
The total number of items in the datastore, ignoring any filters.
totalFilteredCount
int64
The total number of items that match the current filter criteria.
schema
object
Schema information about the datastore, including its primary key and field definitions.
fields
[object]
An array describing the columns available in this datastore.
name [required]
string
The name of this column in the datastore.
type [required]
string
The data type of this column. For example, 'string', 'number', or 'boolean'.
primary_key
string
The name of the primary key column for this datastore.
{
"data": [
{
"attributes": {
"created_at": "2019-09-19T10:00:00.000Z",
"modified_at": "2019-09-19T10:00:00.000Z",
"org_id": "integer",
"primary_column_name": "",
"signature": "string",
"store_id": "string",
"value": {}
},
"id": "string",
"type": "items"
}
],
"meta": {
"page": {
"hasMore": false,
"totalCount": "integer",
"totalFilteredCount": "integer"
},
"schema": {
"fields": [
{
"name": "",
"type": ""
}
],
"primary_key": "string"
}
}
}Bad Request
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Not Found
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export datastore_id="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/actions-datastores/${datastore_id}/items" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
DELETE https://api.ap1.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.ap2.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.datadoghq.eu/api/v2/actions-datastores/{datastore_id}/itemshttps://api.ddog-gov.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.us3.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.us5.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items
Deletes an item from a datastore by its key.
This endpoint requires the apps_datastore_write permission.
이름
유형
설명
datastore_id [required]
string
The unique identifier of the datastore to retrieve.
항목
유형
설명
data
object
Data wrapper containing the information needed to identify and delete a specific datastore item.
attributes
object
Attributes specifying which datastore item to delete by its primary key.
id
string
Optional unique identifier of the item to delete.
item_key [required]
string
The primary key value that identifies the item to delete. Cannot exceed 256 characters.
type [required]
enum
The resource type for datastore items.
Allowed enum values: items
default: items
{
"data": {
"attributes": {
"item_key": "test-key"
},
"type": "items"
}
}OK
Response from successfully deleting a datastore item.
항목
유형
설명
data
object
Data containing the identifier of the datastore item that was successfully deleted.
id
string
The unique identifier of the item that was deleted.
type [required]
enum
The resource type for datastore items.
Allowed enum values: items
default: items
{
"data": {
"id": "string",
"type": "items"
}
}Bad Request
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Not Found
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export datastore_id="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/actions-datastores/${datastore_id}/items" \
-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": {
"item_key": "test-key"
},
"type": "items"
}
}
EOF
PATCH https://api.ap1.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.ap2.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.datadoghq.eu/api/v2/actions-datastores/{datastore_id}/itemshttps://api.ddog-gov.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.us3.datadoghq.com/api/v2/actions-datastores/{datastore_id}/itemshttps://api.us5.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items
Partially updates an item in a datastore by its key.
This endpoint requires the apps_datastore_write permission.
이름
유형
설명
datastore_id [required]
string
The unique identifier of the datastore to retrieve.
항목
유형
설명
data
object
Data wrapper containing the item identifier and the changes to apply during the update operation.
attributes
object
Attributes for updating a datastore item, including the item key and changes to apply.
id
string
The unique identifier of the item being updated.
item_changes [required]
object
Changes to apply to a datastore item using set operations.
ops_set
object
Set operation that contains key-value pairs to set on the datastore item.
item_key [required]
string
The primary key that identifies the item to update. Cannot exceed 256 characters.
id
string
The unique identifier of the datastore item.
type [required]
enum
The resource type for datastore items.
Allowed enum values: items
default: items
{
"data": {
"attributes": {
"item_changes": {},
"item_key": "test-key"
},
"type": "items"
}
}OK
A single datastore item with its content and metadata.
항목
유형
설명
data
object
Core data and metadata for a single datastore item.
attributes
object
Metadata and content of a datastore item.
created_at
date-time
Timestamp when the item was first created.
modified_at
date-time
Timestamp when the item was last modified.
org_id
int64
The ID of the organization that owns this item.
primary_column_name
string
The name of the primary key column for this datastore. Primary column names:
signature
string
A unique signature identifying this item version.
store_id
string
The unique identifier of the datastore containing this item.
value
object
The data content (as key-value pairs) of a datastore item.
id
string
The unique identifier of the datastore.
type [required]
enum
The resource type for datastore items.
Allowed enum values: items
default: items
{
"data": {
"attributes": {
"created_at": "2019-09-19T10:00:00.000Z",
"modified_at": "2019-09-19T10:00:00.000Z",
"org_id": "integer",
"primary_column_name": "",
"signature": "string",
"store_id": "string",
"value": {}
},
"id": "string",
"type": "items"
}
}Bad Request
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Not Found
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export datastore_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/actions-datastores/${datastore_id}/items" \
-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": {
"item_changes": {},
"item_key": "test-key"
},
"type": "items"
}
}
EOF
POST https://api.ap1.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items/bulkhttps://api.ap2.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items/bulkhttps://api.datadoghq.eu/api/v2/actions-datastores/{datastore_id}/items/bulkhttps://api.ddog-gov.com/api/v2/actions-datastores/{datastore_id}/items/bulkhttps://api.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items/bulkhttps://api.us3.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items/bulkhttps://api.us5.datadoghq.com/api/v2/actions-datastores/{datastore_id}/items/bulk
Creates or replaces multiple items in a datastore by their keys in a single operation.
This endpoint requires the apps_datastore_write permission.
이름
유형
설명
datastore_id [required]
string
The unique identifier of the datastore to retrieve.
항목
유형
설명
data
object
Data wrapper containing the items to insert and their configuration for the bulk insert operation.
attributes
object
Configuration for bulk inserting multiple items into a datastore.
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
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.
type [required]
enum
The resource type for datastore items.
Allowed enum values: items
default: items
{
"data": {
"attributes": {
"values": [
{
"id": "cust_3141",
"name": "Johnathan"
},
{
"id": "cust_3142",
"name": "Mary"
}
]
},
"type": "items"
}
}OK
Response after successfully inserting multiple items into a datastore, containing the identifiers of the created items.
항목
유형
설명
data [required]
[object]
An array of data objects containing the identifiers of the successfully inserted items.
id
string
The unique identifier assigned to the inserted item.
type [required]
enum
The resource type for datastore items.
Allowed enum values: items
default: items
{
"data": [
{
"id": "string",
"type": "items"
}
]
}Bad Request
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Not Found
API error response.
항목
유형
설명
errors [required]
[object]
A list of errors.
detail
string
A human-readable explanation specific to this occurrence of the error.
meta
object
Non-standard meta-information about the error
source
object
References to the source of the error.
header
string
A string indicating the name of a single request header which caused the error.
parameter
string
A string indicating which URI query parameter caused the error.
pointer
string
A JSON pointer to the value in the request document that caused the error.
status
string
Status code of the response.
title
string
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export datastore_id="CHANGE_ME"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.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": {
"values": [
{
"id": "cust_3141",
"name": "Johnathan"
},
{
"id": "cust_3142",
"name": "Mary"
}
]
},
"type": "items"
}
}
EOF