List connection types
Returns a list of connection types by a filter
curl --request GET \
--url https://app.blinkops.com/api/v1/connection_types \
--header 'BLINK-API-KEY: <api-key>'{
"limit": 123,
"offset": 123,
"total": 123,
"results": [
{
"attributes": {},
"created_at": 123,
"created_by": "<string>",
"display_name": "<string>",
"documentation_link": "<string>",
"icon_uri": "<string>",
"id": "<string>",
"metadata": {
"authentication": {
"keys": [
{
"format": "<string>",
"name": "<string>"
}
],
"staticHeaders": {},
"twoLeggedValues": {
"actionToRunParamValues": {
"body": {},
"contentType": "<string>",
"headers": {},
"ignoreSSL": true,
"method": "<string>",
"url": "<string>"
},
"connectionParams": [
"<string>"
],
"extractor": {
"accessKeyPath": "<string>",
"expiry": {
"defaultExpiry": 123,
"path": "<string>",
"type": "<string>"
},
"isInHeader": true,
"isJWT": true
}
},
"type": "<string>"
},
"defaultAPIAddress": "<string>",
"ignoreSSL": true,
"pagination": {
"descriptor": {},
"type": "<string>"
},
"testConnection": {
"body": {},
"endpoint": "<string>",
"expected": {
"contentType": "<string>",
"errorPath": "<string>",
"formatURL": "<string>",
"payload": {},
"statusCodes": "<string>"
},
"type": "<string>"
},
"validation": {
"contentType": "<string>",
"errorPath": "<string>",
"formatURL": "<string>",
"payload": {},
"statusCodes": "<string>"
},
"variables": {}
},
"methods": [
{
"attributes": [
"<string>"
],
"description": "<string>",
"display_name": "<string>",
"documentation_link": "<string>",
"hidden": true,
"is_recommended": true,
"name": "<string>",
"oauth_supported": true
}
],
"name": "<string>",
"oauth_supported": true,
"plugin_name": "<string>",
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>"
}
]
}Authorizations
Use your API key to access BlinkOps API. To generate an API key, please log in to your BlinkOps account and navigate to the API Keys section in the user settings page. Add the generated key to your request headers as BLINK-API-KEY.
Query Parameters
For the RQL query syntax, visit our RQL query documentation in the RQL Format tab
Response
optional: the default value
optional: "description text"
required: the display name of the attribute.
is this a global variable
optional: "input"|"checkbox"|"dropdown"|"textarea" - default "input"
optional: format of the field for example -> type: date, format: date_epoch
"basic"|"advanced"
the height of the input parameter box in pixels
optional: is the field visible in the UI?
optional: the ordinal number of the parameter in the parameter list
optional: "text"|"password"|email"|"number"|"url" in case of input component - default "text"
optional: is this a multi-select field
optional: custom delimiter for linked fields
optional: linked version of hidden field, this exists because hidden is bool so we cannot "abuse" it with a delimited string
optional: the option list in case of dropdown\checkbox
optional: regex to validate in case of input component
optional: "placeholder text"
true|false
optional: link the input type to a dropdown input by specifying its index
optional: "url source for options"
[optional] list of static header key, value pairs
authentication type enum
[optional] whether to ignore SSL errors in http
[optional] body for the request in the case of type http.post
pagination method type
[optional] expected content type
[optional] the JSON path for extracting user errors
[optional] regex for verifying url correctness
[optional] expected payload for successful request. key, value pairs of json path and expected value of type numeric, bool, string or regex.
a range of HTTP status codes that are considered valid, e.g "200-399"
test connection type
[optional] expected content type
[optional] the JSON path for extracting user errors
[optional] regex for verifying url correctness
[optional] expected payload for successful request. key, value pairs of json path and expected value of type numeric, bool, string or regex.
a range of HTTP status codes that are considered valid, e.g "200-399"
Was this page helpful?
curl --request GET \
--url https://app.blinkops.com/api/v1/connection_types \
--header 'BLINK-API-KEY: <api-key>'{
"limit": 123,
"offset": 123,
"total": 123,
"results": [
{
"attributes": {},
"created_at": 123,
"created_by": "<string>",
"display_name": "<string>",
"documentation_link": "<string>",
"icon_uri": "<string>",
"id": "<string>",
"metadata": {
"authentication": {
"keys": [
{
"format": "<string>",
"name": "<string>"
}
],
"staticHeaders": {},
"twoLeggedValues": {
"actionToRunParamValues": {
"body": {},
"contentType": "<string>",
"headers": {},
"ignoreSSL": true,
"method": "<string>",
"url": "<string>"
},
"connectionParams": [
"<string>"
],
"extractor": {
"accessKeyPath": "<string>",
"expiry": {
"defaultExpiry": 123,
"path": "<string>",
"type": "<string>"
},
"isInHeader": true,
"isJWT": true
}
},
"type": "<string>"
},
"defaultAPIAddress": "<string>",
"ignoreSSL": true,
"pagination": {
"descriptor": {},
"type": "<string>"
},
"testConnection": {
"body": {},
"endpoint": "<string>",
"expected": {
"contentType": "<string>",
"errorPath": "<string>",
"formatURL": "<string>",
"payload": {},
"statusCodes": "<string>"
},
"type": "<string>"
},
"validation": {
"contentType": "<string>",
"errorPath": "<string>",
"formatURL": "<string>",
"payload": {},
"statusCodes": "<string>"
},
"variables": {}
},
"methods": [
{
"attributes": [
"<string>"
],
"description": "<string>",
"display_name": "<string>",
"documentation_link": "<string>",
"hidden": true,
"is_recommended": true,
"name": "<string>",
"oauth_supported": true
}
],
"name": "<string>",
"oauth_supported": true,
"plugin_name": "<string>",
"tenant_id": "<string>",
"updated_at": 123,
"updated_by": "<string>"
}
]
}