---
title: "List connection types"
method: GET
path: "/connection_types"
tags: ["Connections"]
---

# List connection types

`GET /connection_types`

Returns a list of connection types by a filter

## Query parameters

- `q` string, required

## Response `200`

ok

- object
  - `limit` integer
  - `offset` integer
  - `total` integer
  - `results` ModelsConnectionType[]
    - `attributes` ModelsFormAttributes
    - `created_at` integer
    - `created_by` string
    - `display_name` string
    - `documentation_link` string
    - `icon_uri` string
    - `id` string
    - `metadata` ModelsConnectionMetadata
      - `authentication` ModelsAuthentication
        - `keys` ModelsHTTPAuthHeader[] — [optional] array of http header keys
          - `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
        - `twoLeggedValues` ModelsTwoLeggedGenericProvider
          - `actionToRunParamValues` ModelsTwoLeggedActionToRunParamValues
            - `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
            - `ignoreSSL` object — 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` ModelsTwoLeggedExtractor
            - `accessKeyPath` string — the path to the access key attribute in the response
            - `expiry` ModelsTwoLeggedExpiry
              - …
            - `isInHeader` boolean — is the token returned in a header, the access path should be the header's name
            - `isJWT` object — is the response type is jwt or not
        - `type` string — # authentication type enum
      - `createdWithOAuth` boolean
      - `defaultAPIAddress` string
      - `ignoreSSL` boolean — [optional] whether to ignore SSL errors in http
      - `methods` ModelsConnectionTypeMethod[]
        - `attributes` string[]
        - `description` string
        - `display_name` string
        - `documentation_link` string
        - `hidden` boolean
        - `is_recommended` boolean
        - `keys` ModelsHTTPAuthHeader[]
          - `format` string — format for building the authentication string
          - `name` string — the name of the header key
        - `name` string
        - `oauth_supported` boolean
        - `two_legged_values` ModelsTwoLeggedGenericProvider
          - `actionToRunParamValues` ModelsTwoLeggedActionToRunParamValues
            - `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
            - `ignoreSSL` object — 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` ModelsTwoLeggedExtractor
            - `accessKeyPath` string — the path to the access key attribute in the response
            - `expiry` ModelsTwoLeggedExpiry
              - …
            - `isInHeader` boolean — is the token returned in a header, the access path should be the header's name
            - `isJWT` object — is the response type is jwt or not
        - `type` string
      - `pagination` ModelsPagination
        - `descriptor` object — pagination descriptor
        - `type` string — pagination method type
      - `testConnection` ModelsTestConnection
        - `body` object — [optional] body for the request in the case of type http.post
        - `endpoint` string — pagination method type
        - `expected` ModelsValidation
          - `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"
        - `headers` object — [optional] special headers to send with the request
        - `type` string — test connection type
      - `urlwhitelist` string[]
      - `validation` ModelsValidation
        - `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
    - `methods` ModelsConnectionTypeMethod[]
      - `attributes` string[]
      - `description` string
      - `display_name` string
      - `documentation_link` string
      - `hidden` boolean
      - `is_recommended` boolean
      - `keys` ModelsHTTPAuthHeader[]
        - `format` string — format for building the authentication string
        - `name` string — the name of the header key
      - `name` string
      - `oauth_supported` boolean
      - `two_legged_values` ModelsTwoLeggedGenericProvider
        - `actionToRunParamValues` ModelsTwoLeggedActionToRunParamValues
          - `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
          - `ignoreSSL` object — 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` ModelsTwoLeggedExtractor
          - `accessKeyPath` string — the path to the access key attribute in the response
          - `expiry` ModelsTwoLeggedExpiry
            - `defaultExpiry` object — 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` object — is the response type is jwt or not
      - `type` string
    - `name` string
    - `oauth_supported` boolean
    - `plugin_name` string
    - `tenant_id` string
    - `updated_at` integer
    - `updated_by` string

## Other responses

- `400` — Can not retrieve the list of connection types
- `404` — Can not find Connection Types

---

[API](https://skmtc.dev/blinkops/apis/blink-rest-api.md) · [All operations](https://skmtc.dev/blinkops/apis/blink-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/blinkops/blink-rest-api/revisions/f043409736b2/schema)