Protocol (HTTP)
Create a new new connector version.
API Reference
Connect API
- Introduction
- Endpoints
- Protocol (HTTP)
- Connectors
- Connector Versions
- Connections
- Actions
- Triggers
- Definitions
- Protocols
- Miscellaneous
Embedded API
- Introduction
- Endpoints
Organisations API
- Overview
- Signing Keys
Protocol (HTTP)
Create a new new connector version.
ImportHTTPConnectorVersion is used to create a new version for the connector.
This uses a new OpenAPI spec to create the new version.
POST
/
o
/
{organisation_id}
/
connector
/
{connector_id}
/
http
/
import
curl --request POST \
--url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connector/{connector_id}/http/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'metadata={
"format": "openapi",
"version": "<string>"
}'
{
"connector": {
"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>"
},
"definitions": [
{
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"description": "<string>",
"url": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
],
"actions": [
{
"id": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"severity": "error"
}
],
"type": "http",
"name": "<string>",
"summary": "<string>",
"description": "<string>",
"method": "GET",
"path": "<string>",
"parameters": [
{
"name": "<string>",
"in": "cookie",
"required": true,
"type": "string",
"default": "<any>",
"completion": {}
}
],
"requestBody": {
"required": true,
"definitions": [
{
"id": "<string>",
"definition": {
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"description": "<string>",
"url": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
}
]
},
"responses": [
{
"status": 123,
"id": "<string>",
"definitions": [
{
"id": "<string>",
"definition": {
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"description": "<string>",
"url": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
}
]
}
]
}
],
"triggers": [
{
"id": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"severity": "error"
}
],
"type": "http",
"name": "<string>",
"summary": "<string>",
"description": "<string>",
"method": "GET",
"parameters": [
{
"name": "<string>",
"in": "cookie",
"required": true,
"type": "string",
"default": "<any>"
}
],
"requestBody": {
"required": true,
"definitions": [
{
"id": "<string>",
"definition": {
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"description": "<string>",
"url": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
}
]
},
"responses": [
{
"status": 123,
"id": "<string>",
"definitions": [
{
"id": "<string>",
"definition": {
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"description": "<string>",
"url": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
}
]
}
]
}
],
"messages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}
Authorizations
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
ID is the unique identifier of the Connector.
Body
Response
201
application/json
Created
ImportHTTPConnectorResult defines the result of importing a Connector from an external format, such as OpenAPI.
curl --request POST \
--url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connector/{connector_id}/http/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'metadata={
"format": "openapi",
"version": "<string>"
}'
{
"connector": {
"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>"
},
"definitions": [
{
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"description": "<string>",
"url": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
],
"actions": [
{
"id": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"severity": "error"
}
],
"type": "http",
"name": "<string>",
"summary": "<string>",
"description": "<string>",
"method": "GET",
"path": "<string>",
"parameters": [
{
"name": "<string>",
"in": "cookie",
"required": true,
"type": "string",
"default": "<any>",
"completion": {}
}
],
"requestBody": {
"required": true,
"definitions": [
{
"id": "<string>",
"definition": {
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"description": "<string>",
"url": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
}
]
},
"responses": [
{
"status": 123,
"id": "<string>",
"definitions": [
{
"id": "<string>",
"definition": {
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"description": "<string>",
"url": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
}
]
}
]
}
],
"triggers": [
{
"id": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"severity": "error"
}
],
"type": "http",
"name": "<string>",
"summary": "<string>",
"description": "<string>",
"method": "GET",
"parameters": [
{
"name": "<string>",
"in": "cookie",
"required": true,
"type": "string",
"default": "<any>"
}
],
"requestBody": {
"required": true,
"definitions": [
{
"id": "<string>",
"definition": {
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"description": "<string>",
"url": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
}
]
},
"responses": [
{
"status": 123,
"id": "<string>",
"definitions": [
{
"id": "<string>",
"definition": {
"id": "<string>",
"name": "<string>",
"accept": [
"<string>"
],
"description": "<string>",
"url": "<string>",
"referencedBy": [
{
"type": "definition",
"id": "<string>",
"name": "<string>"
}
]
}
}
]
}
]
}
],
"messages": [
{
"text": "<string>",
"severity": "info",
"detail": [
"<string>"
]
}
]
}