customData.get

Retrieve a custom data record based on unique reference and key pair, or ID.

Facts


Method	`GET https://yourinstance.getdx.net/api/customData.get`

Arguments

If looking up by reference and key pair:

Name	Type	Description
`token`	`Token`	Auth token passed as an HTTP header.
`reference`	`Text`	The domain reference.
`key`	`Text`	The domain key.

If looking up by ID:

Name	Type	Description
`token`	`Token`	Auth token passed as an HTTP header.
`id`	`Text`	Generated unique ID for the record.

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 https://yourinstance.getdx.net/api/customData.get?reference=orgname/repo&key=example \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx'