PUT
/
o
/
{organisation_id}
/
connectors
/
{connector_id}
curl --request PUT \
  --url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors/{connector_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "organisationId": "<string>",
  "name": "<string>",
  "tags": {},
  "protocol": "http",
  "authSchemeConfigIds": [
    "<string>"
  ],
  "public": true,
  "documentationURL": "<string>",
  "imageURL": "<string>",
  "baseUrl": "<string>",
  "connectionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}'
{
  "id": "<string>",
  "organisationId": "<string>",
  "name": "<string>",
  "public": true,
  "documentationURL": "<string>",
  "imageURL": "<string>",
  "tags": {},
  "protocol": "http",
  "authSchemeConfigs": [
    {
      "id": "<string>",
      "description": "<string>",
      "validationMessages": [
        {
          "text": "<string>",
          "severity": "info",
          "detail": [
            "<string>"
          ]
        }
      ],
      "schemeType": "<string>"
    }
  ],
  "connectionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "connections": [
    {
      "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"
    }
  ],
  "versions": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "isLatest": true,
      "isDefault": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "publishedAt": "2023-11-07T05:31:56Z",
      "messages": [
        {
          "text": "<string>",
          "severity": "info",
          "detail": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "baseUrl": "<string>"
}

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.

Body

application/json

ConnectorUpdate is the input to the UpdateConnector endpoint.

Response

200
application/json
OK

Connector represents a connector to an external system.