Documentation | Custom Properties › Create A Custom Property

API Reference

Custom Properties

List custom properties

Create a custom property

Get a custom property

Edit a custom property

Delete a custom property

Custom Properties

custom_properties

Methods

List Custom Properties -> Array<

>

get/custom-properties

List custom properties

Create A Custom Property ->

post/custom-properties

Create a custom property

Response fields

Request example

curl https://api.foxglove.dev/v1/custom-properties \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $FOXGLOVE_API_KEY" \
    -d '{
          "key": "key",
          "label": "x",
          "resourceType": "device",
          "valueType": "string"
        }'

200Example

{
  "key": "key",
  "label": "x",
  "resourceType": "device",
  "valueType": "string",
  "values": [
    "string"
  ],
  "id": "id"
}

Get A Custom Property ->

get/custom-properties/{id}

Get a custom property

Edit A Custom Property ->

patch/custom-properties/{id}

Edit a custom property

Delete A Custom Property -> { id }

delete/custom-properties/{id}

Delete a custom property

Domain types

CustomProperty =

NewCustomProperty

NewCustomProperty = { key, label, resourceType, 2 more... }