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>"
}
]
}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>"
}
]
}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.
For the RQL query syntax, visit our RQL query documentation in the RQL Format tab
ok
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
body of the authentication request. The format is the same as in the getBodyParams function in the pkg/oauth folder
Show child attributes
value of the content type header
whether this request should ignore SSL in http requests
type of the http method (GET, POST ...)
the full url of the authentication request (api address + auth endpoint)
list of connection params to use in the 2 legged process
Show child attributes
the path to the access key attribute in the response
Show child attributes
the default expiry time for the token in seconds
the key path of the expiry attribute in the response
the type of the expiry attribute in the response
is the token returned in a header, the access path should be the header's name
is the response type is jwt or not
[optional] whether to ignore SSL errors in http
Show child attributes
pagination method type
Show child attributes
[optional] expected content type
[optional] the JSON path for extracting user errors
[optional] regex for verifying url correctness
a range of HTTP status codes that are considered valid, e.g "200-399"
test connection type
Show child attributes
[optional] expected content type
[optional] the JSON path for extracting user errors
[optional] regex for verifying url correctness
a range of HTTP status codes that are considered valid, e.g "200-399"
Show child attributes
Was this page helpful?