Documentation | Custom Properties › List Custom Properties

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

query Parameters

resourceType:

Optional

Filter properties matching a resource type

"device"

Response fields

id: string

ID of the custom property

Request example

curl https://api.foxglove.dev/v1/custom-properties \
    -H "Authorization: Bearer $FOXGLOVE_API_KEY"

200Example

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

Create A Custom Property ->

post/custom-properties

Create a custom property

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... }