Get connection type
Gets a connection type.
GET
Gets a connection type.
bearerheader
AuthorizationBearer <token>An access token, or an API key.
connectionType*stringThe type's ID, such as github.
Match
^[a-z][a-z0-9-]{0,62}$OK
application/json- response
available*booleanWhether this kosem can connect it: GitHub needs kosem's GitHub App, and Google Cloud and AWS kosem's identity tokens, which a deployment may not have.
configFields*array<>The settings its connections take in their config.
connectedBy*stringHow a connection of it is made: APP_INSTALLATION, by installing kosem's app on an account, which StartGitHubConnection begins; WORKLOAD_IDENTITY, by CreateConnection, then, once the service trusts the connection's trust, UpdateConnection with its settings.
Value in
"APP_INSTALLATION""WORKLOAD_IDENTITY"description*stringWhat the type is.
displayName*stringName shown in user interfaces.
issuesCredentials*booleanWhether its connections issue short-lived credentials, which dynamic secrets give.
name*stringResource name, such as connectionTypes/github.
curl -X GET 'https://api.kosem.ai/v1/connectionTypes/string'Example Response
{
"available": true,
"configFields": [
{
"default": "string",
"description": "string",
"displayName": "string",
"key": "string",
"placeholder": "string",
"required": true,
"type": "TEXT"
}
],
"connectedBy": "APP_INSTALLATION",
"description": "string",
"displayName": "string",
"issuesCredentials": true,
"name": "string"
}