customData.set

Create or update custom data by key or reference.

Facts


Method	`POST https://yourinstance.getdx.net/api/customData.set`

Arguments

Required arguments

Name	Type	Description
`token`	`Token`	Auth token passed as an HTTP header.
`reference`	`Text`	The domain reference.
`key`	`Text`	The domain key.
`value`	`JSON`	The object to be stored.

Optional arguments

Name	Type	Description
`timestamp`	`ISO8601`	Defaults to time of request if not specified.

Usage info

Custom data APIs allow you to add arbitrary JSON data to your DX database. The records are stored in the custom_data table that is queryable alongside all of your other DX data.

For more information about the supported SQL operators and functions available for querying the JSON values please reference the PostgreSQL documentation.

Example request

This is a typical request:

curl -X POST https://yourinstance.getdx.net/api/customData.set \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx' \
  -H 'Content-Type: application/json' \
  --data '{
    "reference": "orgname/repo",
    "key": "example",
    "value": { "version": "1.2.3" },
    "timestamp": "2024-01-01T11:22:33"
  }'