Skip to main content
PUT
/
organisations
/
{organisationId}
/
connections
/
{connectionId}
cURL
curl --request PUT \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/connections/{connectionId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "data": {
    "apiKey": "<string>"
  }
}
'
{
  "id": "<string>",
  "orgId": "<string>",
  "name": "<string>",
  "app": {
    "id": "<string>",
    "orgId": "<string>",
    "name": "<string>",
    "public": true,
    "server": {
      "name": "<string>",
      "url": "<string>"
    },
    "schemaMetadata": {
      "type": "<string>",
      "version": "<string>",
      "url": "<string>"
    },
    "schema": {
      "id": "<string>",
      "type": "<string>",
      "version": "<string>",
      "sourceUrl": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "supportedAuthConfigs": [
      {
        "type": "<string>",
        "isValid": true,
        "data": {
          "discoveryUrl": "<string>",
          "clientId": "<string>",
          "clientSecret": "<string>",
          "scopes": {}
        }
      }
    ],
    "imageUrl": "<string>",
    "schemaId": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "credentialId": "<string>",
  "authConfig": {
    "type": "<string>",
    "isValid": true,
    "data": {
      "discoveryUrl": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "scopes": {}
    }
  },
  "usedByBoards": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisationId
string
required
​
connectionId
string
required

Body

application/json

UpdateConnectionRequest is the payload for updating an existing Connection.

UpdateConnectionRequestBody is the request body to update an existing connection. This will replace the existing connection details.

​
name
string
required
​
data
object
required

ConnectionDataAPIKey is the data element of a connection which is using an apikey authentication type.

Response

A single Connection result.

​
id
string
required
​
orgId
string
required
​
name
string
required
​
app
object
required
​
credentialId
string
required
​
authConfig
object

AppAuthConfig describes how an organisation can authenticate with an app.

​
usedByBoards
object[]