Skip to Content
kosemdocs
ReferenceAPIConnection types

Get connection type

Gets a connection type.

GET
/v1/connectionTypes/{connectionType}

Gets a connection type.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

connectionType*string

The type's ID, such as github.

Match^[a-z][a-z0-9-]{0,62}$

Response Body

OK

application/json
  1. response
available*boolean

Whether 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*string

How 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*string

What the type is.

displayName*string

Name shown in user interfaces.

issuesCredentials*boolean

Whether its connections issue short-lived credentials, which dynamic secrets give.

name*string

Resource name, such as connectionTypes/github.

Example Request
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"
}