Publish a new version of connector

curl --request POST \
  --url https://api.getmembrane.com/connectors/{key}/publish-version \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.getmembrane.com/connectors/{key}/publish-version"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getmembrane.com/connectors/{key}/publish-version', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmembrane.com/connectors/{key}/publish-version",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmembrane.com/connectors/{key}/publish-version"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getmembrane.com/connectors/{key}/publish-version")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmembrane.com/connectors/{key}/publish-version")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "version": "<string>",
  "id": "<string>",
  "connectorId": "<string>",
  "changelog": "<string>",
  "baseUri": "<string>",
  "revision": "<string>",
  "hasTest": true,
  "hasAuthTest": true,
  "isReadOnly": true,
  "credentialsSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceDataTable": {
      "dataTableId": "<string>",
      "value": "<string>",
      "label": "<string>",
      "filter": [
        {
          "field": "<string>",
          "value": {}
        }
      ]
    },
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "customCredentialsSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceDataTable": {
      "dataTableId": "<string>",
      "value": "<string>",
      "label": "<string>",
      "filter": [
        {
          "field": "<string>",
          "value": {}
        }
      ]
    },
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "inputSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceDataTable": {
      "dataTableId": "<string>",
      "value": "<string>",
      "label": "<string>",
      "filter": [
        {
          "field": "<string>",
          "value": {}
        }
      ]
    },
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "parametersSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceDataTable": {
      "dataTableId": "<string>",
      "value": "<string>",
      "label": "<string>",
      "filter": [
        {
          "field": "<string>",
          "value": {}
        }
      ]
    },
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "getCredentialsFromConnectionParameters": {
    "description": "<string>"
  },
  "refreshCredentials": {
    "description": "<string>"
  },
  "makeApiClient": {
    "description": "<string>"
  },
  "getOAuthConfig": {
    "description": "<string>"
  },
  "getTokenData": {
    "description": "<string>"
  },
  "getCredentialsFromAccessTokenResponse": {
    "description": "<string>"
  },
  "getCredentialsFromRefreshTokenResponse": {
    "description": "<string>"
  },
  "test": {
    "description": "<string>"
  },
  "disconnect": {
    "description": "<string>"
  },
  "proxyKey": "<string>",
  "options": {}
}

POST

connectors

{key}

publish-version

Publish a new version of connector

curl --request POST \
  --url https://api.getmembrane.com/connectors/{key}/publish-version \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.getmembrane.com/connectors/{key}/publish-version"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getmembrane.com/connectors/{key}/publish-version', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmembrane.com/connectors/{key}/publish-version",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmembrane.com/connectors/{key}/publish-version"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getmembrane.com/connectors/{key}/publish-version")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmembrane.com/connectors/{key}/publish-version")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "version": "<string>",
  "id": "<string>",
  "connectorId": "<string>",
  "changelog": "<string>",
  "baseUri": "<string>",
  "revision": "<string>",
  "hasTest": true,
  "hasAuthTest": true,
  "isReadOnly": true,
  "credentialsSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceDataTable": {
      "dataTableId": "<string>",
      "value": "<string>",
      "label": "<string>",
      "filter": [
        {
          "field": "<string>",
          "value": {}
        }
      ]
    },
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "customCredentialsSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceDataTable": {
      "dataTableId": "<string>",
      "value": "<string>",
      "label": "<string>",
      "filter": [
        {
          "field": "<string>",
          "value": {}
        }
      ]
    },
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "inputSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceDataTable": {
      "dataTableId": "<string>",
      "value": "<string>",
      "label": "<string>",
      "filter": [
        {
          "field": "<string>",
          "value": {}
        }
      ]
    },
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "parametersSchema": {
    "type": "<string>",
    "title": "<string>",
    "description": "<string>",
    "format": "<string>",
    "properties": {},
    "items": "<unknown>",
    "additionalProperties": true,
    "enum": [
      "<string>"
    ],
    "referenceRecords": [
      {}
    ],
    "referenceCollection": {
      "key": {},
      "parameters": {}
    },
    "referenceDataTable": {
      "dataTableId": "<string>",
      "value": "<string>",
      "label": "<string>",
      "filter": [
        {
          "field": "<string>",
          "value": {}
        }
      ]
    },
    "default": {},
    "allowCustom": true,
    "required": [
      "<string>"
    ],
    "minLength": 123,
    "maxLength": 123,
    "minimum": 123,
    "maximum": 123,
    "maxItems": 123,
    "readOnly": true,
    "writeOnly": true,
    "examples": [
      {}
    ],
    "anyOf": "<array>",
    "isImplied": true,
    "isSensitive": true,
    "referenceCollectionPath": "<string>",
    "referenceCollectionUri": "<string>"
  },
  "getCredentialsFromConnectionParameters": {
    "description": "<string>"
  },
  "refreshCredentials": {
    "description": "<string>"
  },
  "makeApiClient": {
    "description": "<string>"
  },
  "getOAuthConfig": {
    "description": "<string>"
  },
  "getTokenData": {
    "description": "<string>"
  },
  "getCredentialsFromAccessTokenResponse": {
    "description": "<string>"
  },
  "getCredentialsFromRefreshTokenResponse": {
    "description": "<string>"
  },
  "test": {
    "description": "<string>"
  },
  "disconnect": {
    "description": "<string>"
  },
  "proxyKey": "<string>",
  "options": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

key

string

required

Response

200 - application/json

version

string

required

string

required

connectorId

string

required

changelog

string

required

baseUri

string

revision

string

hasTest

boolean

hasAuthTest

boolean

isReadOnly

boolean

credentialsSchema

object

Show child attributes

type

enum<string>

Authentication protocol used by the connector.

Available options:

integration-app-token,

membrane-token,

oauth2,

oauth1,

client-credentials,

proxy

customCredentialsSchema

object

Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).

Show child attributes

inputSchema

object

JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).

Show child attributes

parametersSchema

object

Show child attributes

getCredentialsFromConnectionParameters

object

Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.

Show child attributes

refreshCredentials

object

Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.

Show child attributes

makeApiClient

object

Function that configures the authenticated HTTP client used by connector API requests and actions. Typically a mapping type with baseUri and auth header wiring.

Show child attributes

getOAuthConfig

object

OAuth2: function returning { authorizeUri, tokenUri, scopes, noRefreshToken? } — the authorize/token endpoint URLs and requested scopes.

Show child attributes

getTokenData

object

OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.

Show child attributes

getCredentialsFromAccessTokenResponse

object

OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.

Show child attributes

getCredentialsFromRefreshTokenResponse

object

OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.

Show child attributes

test

object

Function that verifies the connection by making a lightweight authenticated API call (typically a rest-api-mapping against a /me-style endpoint).

Show child attributes

disconnect

object

Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.

Show child attributes

proxyKey

string

For type: "proxy" — identifies which proxy configuration the workspace should use.

options

object

Show child attributes

list-connector-versions replace-connector