PUT
/
o
/
{organisation_id}
/
connectors
/
{connector_id}
/
connections
/
{connection_id}
curl --request PUT \
  --url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id}/connections/{connection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "name": "<string>",
  "credentials": {
    "action": [
      {
        "id": "<string>",
        "authSchemeConfig": {
          "id": "<string>",
          "description": "<string>",
          "validationMessages": [
            {
              "text": "<string>",
              "severity": "info",
              "detail": [
                "<string>"
              ]
            }
          ],
          "schemeType": "<string>"
        }
      }
    ],
    "trigger": [
      {
        "id": "<string>",
        "authSchemeConfig": {
          "id": "<string>",
          "description": "<string>",
          "validationMessages": [
            {
              "text": "<string>",
              "severity": "info",
              "detail": [
                "<string>"
              ]
            }
          ],
          "schemeType": "<string>"
        }
      }
    ]
  },
  "variables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}'
{
  "id": "<string>",
  "name": "<string>",
  "credentials": {
    "action": [
      {
        "id": "<string>",
        "authSchemeConfig": {
          "id": "<string>",
          "description": "<string>",
          "validationMessages": [
            {
              "text": "<string>",
              "severity": "info",
              "detail": [
                "<string>"
              ]
            }
          ],
          "schemeType": "<string>"
        },
        "credential": {
          "id": "<string>",
          "organisationId": "<string>",
          "type": "none",
          "name": "<string>",
          "usages": [
            {
              "connection": {
                "id": "<string>",
                "name": "<string>",
                "connector": {
                  "id": "<string>",
                  "organisationId": "<string>",
                  "name": "<string>",
                  "protocol": "http",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                },
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z"
              }
            }
          ],
          "errors": [
            "<string>"
          ],
          "data": {},
          "expiresAt": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "trigger": [
      {
        "id": "<string>",
        "authSchemeConfig": {
          "id": "<string>",
          "description": "<string>",
          "validationMessages": [
            {
              "text": "<string>",
              "severity": "info",
              "detail": [
                "<string>"
              ]
            }
          ],
          "schemeType": "<string>"
        },
        "credential": {
          "id": "<string>",
          "organisationId": "<string>",
          "type": "none",
          "name": "<string>",
          "usages": [
            {
              "connection": {
                "id": "<string>",
                "name": "<string>",
                "connector": {
                  "id": "<string>",
                  "organisationId": "<string>",
                  "name": "<string>",
                  "protocol": "http",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                },
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z"
              }
            }
          ],
          "errors": [
            "<string>"
          ],
          "data": {},
          "expiresAt": "2023-11-07T05:31:56Z"
        }
      }
    ]
  },
  "variables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

​
organisation_id
string
required
​
connector_id
string
required

ID is the unique identifier of the Connector.

​
connection_id
string
required

Body

application/json

ConnectionUpdate defines the updates to apply to an existing Connection.

This supports renaming the Connection, editing variables, and updating the order and AuthSchemeConfig of each ConnectionCredential.

Response

200
application/json

OK

Connection defines the Action and Trigger credentials for the owning Connector, and additional variables which can be used to customize the Connector in a particular connection.