Updates the configuration field in the connector document

Updates the configuration field in the connector document Beta

PUT /_connector/{connector_id}/_configuration

Path parameters

connector_id string Required

The unique identifier of the connector to be updated

application/json

Body Required

configuration object
Hide configuration attributes Show configuration attributes object
- Additional properties
- category string
- default_value number | string | boolean | null Required
  
  A scalar value.
  
  One of:
  _types:ScalarValue number _types:ScalarValue number _types:ScalarValue string _types:ScalarValue boolean _types:ScalarValue string | null
- depends_on array[object] Required
  Hide depends_on attributes Show depends_on attributes object
  
  field string Required
  
  value number | string | boolean | null Required
  
  A scalar value.
  
  One of:
  _types:ScalarValue number _types:ScalarValue number _types:ScalarValue string _types:ScalarValue boolean _types:ScalarValue string | null
- display string Required
  
  Values are textbox, textarea, numeric, toggle, or dropdown.
- label string Required
- options array[object] Required
  Hide options attributes Show options attributes object
  
  label string Required
  
  value number | string | boolean | null Required
  
  A scalar value.
  
  One of:
  _types:ScalarValue number _types:ScalarValue number _types:ScalarValue string _types:ScalarValue boolean _types:ScalarValue string | null
- order number
- placeholder string
- required boolean Required
- sensitive boolean Required
- tooltip string | null
  
  One of:
  string-1 string string-2 string | null
- type string
  
  Values are str, int, list, or bool.
- ui_restrictions array[string]
- validations array[object]
  One of:
  _types:LessThanValidation object _types:GreaterThanValidation object _types:ListTypeValidation object _types:IncludedInValidation object _types:RegexValidation object
- value object Required
values object
Hide values attributes Show values attributes object
- Additional properties
- key object

Responses

200 application/json
Hide response attribute Show response attribute object
- result string Required
  
  Values are created, updated, deleted, not_found, or noop.

PUT /_connector/{connector_id}/_configuration

curl \
 -X PUT http://api.example.com/_connector/{connector_id}/_configuration \
 -H "Content-Type: application/json" \
 -d '{"":{"category":"string","":42.0,"depends_on":[{"field":"string","":42.0}],"display":"textbox","label":"string","options":[{"label":"string","":42.0}],"order":42.0,"placeholder":"string","required":true,"sensitive":true,"tooltip":"string","type":"str","ui_restrictions":["string"],"validations":[{"type":"less_than","constraint":42.0}],"value":{}},"values":{"key":{}}}'

Updates the configuration field in the connector document Beta

Path parameters

Body Required

default_value number | string | boolean | null Required

value number | string | boolean | null Required

value number | string | boolean | null Required

tooltip string | null

Responses