Skip to main content

List connection types

GET 
/connection_types

Returns a list of connection types by a filter

Request​

Query Parameters

Responses​

ok

Schema
    limit integer
    offset integer
    total integer
    results object[]
  • Array [
    • attributes object
    property name* object
    addOptionText string
    autofill object
    fetcher string
    inputs object
    property name* object
    maps_to string
    required boolean
    options object[]
  • Array [
    • name string
    value string
  • ]
    • default_value

    optional: the default value

    description string

    optional: "description text"

    disable_custom_values boolean
    disable_key_value_action boolean
    disabled boolean
    display_name string

    required: the display name of the attribute.

    dynamic boolean

    is this a global variable

    error string
    field_type integer

    optional: "input"|"checkbox"|"dropdown"|"textarea" - default "input"

    file_identifier string
    format string

    optional: format of the field for example -> type: date, format: date_epoch

    group_type string

    "basic"|"advanced"

    has_select_all boolean
    height string

    the height of the input parameter box in pixels

    hidden boolean

    optional: is the field visible in the UI?

    icon_name string
    index integer

    optional: the ordinal number of the parameter in the parameter list

    input_type string

    optional: "text"|"password"|email"|"number"|"url" in case of input component - default "text"

    is_multi boolean

    optional: is this a multi-select field

    linked_fields_delimiter string

    optional: custom delimiter for linked fields

    linked_hidden string

    optional: linked version of hidden field, this exists because hidden is bool so we cannot "abuse" it with a delimited string

    onlyValue boolean
    options string[]

    optional: the option list in case of dropdown\checkbox

    output_type string
    pattern string

    optional: regex to validate in case of input component

    placeholder string

    optional: "placeholder text"

    required boolean

    true|false

    source_linked_param string

    optional: link the input type to a dropdown input by specifying its index

    source_url string

    optional: "url source for options"

    var_picker_sections string[]
    created_at integer
    created_by string
    display_name string
    documentation_link string
    icon_uri string
    id string
    metadata object
    authentication object
    keys object[]

    [optional] array of http header keys

  • Array [
    • format string

    format for building the authentication string

    name string

    the name of the header key

  • ]
    • staticHeaders object

    [optional] list of static header key, value pairs

    property name* string
    twoLeggedValues object

    [optional] if the connection type is two_legged, then populate this object

    actionToRunParamValues object
    body object

    body of the authentication request. The format is the same as in the getBodyParams function in the pkg/oauth folder

    contentType string

    value of the content type header

    headers object

    additional headers for the request

    property name* string
    ignoreSSL boolean

    whether this request should ignore SSL in http requests

    method string

    type of the http method (GET, POST ...)

    url string

    the full url of the authentication request (api address + auth endpoint)

    connectionParams string[]

    list of connection params to use in the 2 legged process

    extractor object
    accessKeyPath string

    the path to the access key attribute in the response

    expiry object

    the path to the expiry attribute in the response

    defaultExpiry integer

    the default expiry time for the token in seconds

    path string

    the key path of the expiry attribute in the response

    type string

    the type of the expiry attribute in the response

    isInHeader boolean

    is the token returned in a header, the access path should be the header's name

    isJWT boolean

    is the response type is jwt or not

    type string

    authentication type enum

    defaultAPIAddress string
    ignoreSSL boolean

    [optional] whether to ignore SSL errors in http

    pagination object
    descriptor object

    pagination descriptor

    type string

    pagination method type

    testConnection object
    body object

    [optional] body for the request in the case of type http.post

    endpoint string

    pagination method type

    expected object

    the expected response, based on the Validation struct

    contentType string

    [optional] expected content type

    errorPath string

    [optional] the JSON path for extracting user errors

    formatURL string

    [optional] regex for verifying url correctness

    payload object

    [optional] expected payload for successful request. key, value pairs of json path and expected value of type numeric, bool, string or regex.

    statusCodes string

    a range of HTTP status codes that are considered valid, e.g "200-399"

    type string

    test connection type

    validation object
    contentType string

    [optional] expected content type

    errorPath string

    [optional] the JSON path for extracting user errors

    formatURL string

    [optional] regex for verifying url correctness

    payload object

    [optional] expected payload for successful request. key, value pairs of json path and expected value of type numeric, bool, string or regex.

    statusCodes string

    a range of HTTP status codes that are considered valid, e.g "200-399"

    variables object
    property name* string
    methods object[]
  • Array [
    • attributes string[]
    description string
    display_name string
    documentation_link string
    hidden boolean
    is_recommended boolean
    name string
    oauth_supported boolean
  • ]
    • name string
    oauth_supported boolean
    plugin_name string
    tenant_id string
    updated_at integer
    updated_by string
  • ]
Loading...