Skip to main content
PUT
/
api
/
service-bridges
/
{id}
Update ServiceBridgeMetadata
curl --request PUT \
  --url https://platform.kodexa.ai/api/service-bridges/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "auth": {
      "clientId": "<string>",
      "clientSecret": "<string>",
      "headerName": "<string>",
      "headerPrefix": "<string>",
      "requestBody": {},
      "requestFormat": "<string>",
      "responseMapping": {
        "accessToken": "<string>",
        "expiresIn": "<string>"
      },
      "tokenCacheBufferSeconds": 123,
      "tokenUrl": "<string>",
      "type": "<string>"
    },
    "baseUrl": "<string>",
    "checksum": "<string>",
    "defaultHeaders": [
      {
        "name": "<string>",
        "secretRef": "<string>",
        "value": "<string>"
      }
    ],
    "deleteProtection": true,
    "description": "<string>",
    "endpoints": [
      {
        "cacheEnabled": true,
        "cacheTtlSeconds": 123,
        "cacheableVerbs": [
          "<string>"
        ],
        "description": "<string>",
        "headers": [
          {
            "name": "<string>",
            "secretRef": "<string>",
            "value": "<string>"
          }
        ],
        "initScope": "<string>",
        "initScript": "<string>",
        "method": "<string>",
        "name": "<string>",
        "path": "<string>",
        "postReplyScript": "<string>",
        "preSendScript": "<string>",
        "requestSchema": {},
        "responseSchema": {}
      }
    ],
    "icon": "<string>",
    "imageUrl": "<string>",
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerImageUrl": "<string>",
    "providerUrl": "<string>"
  },
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}
'
import requests

url = "https://platform.kodexa.ai/api/service-bridges/{id}"

payload = {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "deleteUserEmail": "<string>",
    "deleteUserId": "<string>",
    "deleted": True,
    "deletedDate": "2023-11-07T05:31:56Z",
    "deprecated": True,
    "extensionPackRef": "<string>",
    "id": "<string>",
    "metadata": {
        "auth": {
            "clientId": "<string>",
            "clientSecret": "<string>",
            "headerName": "<string>",
            "headerPrefix": "<string>",
            "requestBody": {},
            "requestFormat": "<string>",
            "responseMapping": {
                "accessToken": "<string>",
                "expiresIn": "<string>"
            },
            "tokenCacheBufferSeconds": 123,
            "tokenUrl": "<string>",
            "type": "<string>"
        },
        "baseUrl": "<string>",
        "checksum": "<string>",
        "defaultHeaders": [
            {
                "name": "<string>",
                "secretRef": "<string>",
                "value": "<string>"
            }
        ],
        "deleteProtection": True,
        "description": "<string>",
        "endpoints": [
            {
                "cacheEnabled": True,
                "cacheTtlSeconds": 123,
                "cacheableVerbs": ["<string>"],
                "description": "<string>",
                "headers": [
                    {
                        "name": "<string>",
                        "secretRef": "<string>",
                        "value": "<string>"
                    }
                ],
                "initScope": "<string>",
                "initScript": "<string>",
                "method": "<string>",
                "name": "<string>",
                "path": "<string>",
                "postReplyScript": "<string>",
                "preSendScript": "<string>",
                "requestSchema": {},
                "responseSchema": {}
            }
        ],
        "icon": "<string>",
        "imageUrl": "<string>",
        "overviewMarkdown": "<string>",
        "provider": "<string>",
        "providerImageUrl": "<string>",
        "providerUrl": "<string>"
    },
    "name": "<string>",
    "organizationId": "<string>",
    "publicAccess": True,
    "slug": "<string>",
    "template": True,
    "type": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "yamlSource": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    changeSequence: 123,
    createdOn: '2023-11-07T05:31:56Z',
    deleteUserEmail: '<string>',
    deleteUserId: '<string>',
    deleted: true,
    deletedDate: '2023-11-07T05:31:56Z',
    deprecated: true,
    extensionPackRef: '<string>',
    id: '<string>',
    metadata: {
      auth: {
        clientId: '<string>',
        clientSecret: '<string>',
        headerName: '<string>',
        headerPrefix: '<string>',
        requestBody: {},
        requestFormat: '<string>',
        responseMapping: {accessToken: '<string>', expiresIn: '<string>'},
        tokenCacheBufferSeconds: 123,
        tokenUrl: '<string>',
        type: '<string>'
      },
      baseUrl: '<string>',
      checksum: '<string>',
      defaultHeaders: [{name: '<string>', secretRef: '<string>', value: '<string>'}],
      deleteProtection: true,
      description: '<string>',
      endpoints: [
        {
          cacheEnabled: true,
          cacheTtlSeconds: 123,
          cacheableVerbs: ['<string>'],
          description: '<string>',
          headers: [{name: '<string>', secretRef: '<string>', value: '<string>'}],
          initScope: '<string>',
          initScript: '<string>',
          method: '<string>',
          name: '<string>',
          path: '<string>',
          postReplyScript: '<string>',
          preSendScript: '<string>',
          requestSchema: {},
          responseSchema: {}
        }
      ],
      icon: '<string>',
      imageUrl: '<string>',
      overviewMarkdown: '<string>',
      provider: '<string>',
      providerImageUrl: '<string>',
      providerUrl: '<string>'
    },
    name: '<string>',
    organizationId: '<string>',
    publicAccess: true,
    slug: '<string>',
    template: true,
    type: '<string>',
    updatedOn: '2023-11-07T05:31:56Z',
    uuid: '<string>',
    yamlSource: '<string>'
  })
};

fetch('https://platform.kodexa.ai/api/service-bridges/{id}', 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://platform.kodexa.ai/api/service-bridges/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'changeSequence' => 123,
    'createdOn' => '2023-11-07T05:31:56Z',
    'deleteUserEmail' => '<string>',
    'deleteUserId' => '<string>',
    'deleted' => true,
    'deletedDate' => '2023-11-07T05:31:56Z',
    'deprecated' => true,
    'extensionPackRef' => '<string>',
    'id' => '<string>',
    'metadata' => [
        'auth' => [
                'clientId' => '<string>',
                'clientSecret' => '<string>',
                'headerName' => '<string>',
                'headerPrefix' => '<string>',
                'requestBody' => [
                                
                ],
                'requestFormat' => '<string>',
                'responseMapping' => [
                                'accessToken' => '<string>',
                                'expiresIn' => '<string>'
                ],
                'tokenCacheBufferSeconds' => 123,
                'tokenUrl' => '<string>',
                'type' => '<string>'
        ],
        'baseUrl' => '<string>',
        'checksum' => '<string>',
        'defaultHeaders' => [
                [
                                'name' => '<string>',
                                'secretRef' => '<string>',
                                'value' => '<string>'
                ]
        ],
        'deleteProtection' => true,
        'description' => '<string>',
        'endpoints' => [
                [
                                'cacheEnabled' => true,
                                'cacheTtlSeconds' => 123,
                                'cacheableVerbs' => [
                                                                '<string>'
                                ],
                                'description' => '<string>',
                                'headers' => [
                                                                [
                                                                                                                                'name' => '<string>',
                                                                                                                                'secretRef' => '<string>',
                                                                                                                                'value' => '<string>'
                                                                ]
                                ],
                                'initScope' => '<string>',
                                'initScript' => '<string>',
                                'method' => '<string>',
                                'name' => '<string>',
                                'path' => '<string>',
                                'postReplyScript' => '<string>',
                                'preSendScript' => '<string>',
                                'requestSchema' => [
                                                                
                                ],
                                'responseSchema' => [
                                                                
                                ]
                ]
        ],
        'icon' => '<string>',
        'imageUrl' => '<string>',
        'overviewMarkdown' => '<string>',
        'provider' => '<string>',
        'providerImageUrl' => '<string>',
        'providerUrl' => '<string>'
    ],
    'name' => '<string>',
    'organizationId' => '<string>',
    'publicAccess' => true,
    'slug' => '<string>',
    'template' => true,
    'type' => '<string>',
    'updatedOn' => '2023-11-07T05:31:56Z',
    'uuid' => '<string>',
    'yamlSource' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://platform.kodexa.ai/api/service-bridges/{id}"

	payload := strings.NewReader("{\n  \"changeSequence\": 123,\n  \"createdOn\": \"2023-11-07T05:31:56Z\",\n  \"deleteUserEmail\": \"<string>\",\n  \"deleteUserId\": \"<string>\",\n  \"deleted\": true,\n  \"deletedDate\": \"2023-11-07T05:31:56Z\",\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {\n    \"auth\": {\n      \"clientId\": \"<string>\",\n      \"clientSecret\": \"<string>\",\n      \"headerName\": \"<string>\",\n      \"headerPrefix\": \"<string>\",\n      \"requestBody\": {},\n      \"requestFormat\": \"<string>\",\n      \"responseMapping\": {\n        \"accessToken\": \"<string>\",\n        \"expiresIn\": \"<string>\"\n      },\n      \"tokenCacheBufferSeconds\": 123,\n      \"tokenUrl\": \"<string>\",\n      \"type\": \"<string>\"\n    },\n    \"baseUrl\": \"<string>\",\n    \"checksum\": \"<string>\",\n    \"defaultHeaders\": [\n      {\n        \"name\": \"<string>\",\n        \"secretRef\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"deleteProtection\": true,\n    \"description\": \"<string>\",\n    \"endpoints\": [\n      {\n        \"cacheEnabled\": true,\n        \"cacheTtlSeconds\": 123,\n        \"cacheableVerbs\": [\n          \"<string>\"\n        ],\n        \"description\": \"<string>\",\n        \"headers\": [\n          {\n            \"name\": \"<string>\",\n            \"secretRef\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"initScope\": \"<string>\",\n        \"initScript\": \"<string>\",\n        \"method\": \"<string>\",\n        \"name\": \"<string>\",\n        \"path\": \"<string>\",\n        \"postReplyScript\": \"<string>\",\n        \"preSendScript\": \"<string>\",\n        \"requestSchema\": {},\n        \"responseSchema\": {}\n      }\n    ],\n    \"icon\": \"<string>\",\n    \"imageUrl\": \"<string>\",\n    \"overviewMarkdown\": \"<string>\",\n    \"provider\": \"<string>\",\n    \"providerImageUrl\": \"<string>\",\n    \"providerUrl\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"organizationId\": \"<string>\",\n  \"publicAccess\": true,\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://platform.kodexa.ai/api/service-bridges/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"changeSequence\": 123,\n  \"createdOn\": \"2023-11-07T05:31:56Z\",\n  \"deleteUserEmail\": \"<string>\",\n  \"deleteUserId\": \"<string>\",\n  \"deleted\": true,\n  \"deletedDate\": \"2023-11-07T05:31:56Z\",\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {\n    \"auth\": {\n      \"clientId\": \"<string>\",\n      \"clientSecret\": \"<string>\",\n      \"headerName\": \"<string>\",\n      \"headerPrefix\": \"<string>\",\n      \"requestBody\": {},\n      \"requestFormat\": \"<string>\",\n      \"responseMapping\": {\n        \"accessToken\": \"<string>\",\n        \"expiresIn\": \"<string>\"\n      },\n      \"tokenCacheBufferSeconds\": 123,\n      \"tokenUrl\": \"<string>\",\n      \"type\": \"<string>\"\n    },\n    \"baseUrl\": \"<string>\",\n    \"checksum\": \"<string>\",\n    \"defaultHeaders\": [\n      {\n        \"name\": \"<string>\",\n        \"secretRef\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"deleteProtection\": true,\n    \"description\": \"<string>\",\n    \"endpoints\": [\n      {\n        \"cacheEnabled\": true,\n        \"cacheTtlSeconds\": 123,\n        \"cacheableVerbs\": [\n          \"<string>\"\n        ],\n        \"description\": \"<string>\",\n        \"headers\": [\n          {\n            \"name\": \"<string>\",\n            \"secretRef\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"initScope\": \"<string>\",\n        \"initScript\": \"<string>\",\n        \"method\": \"<string>\",\n        \"name\": \"<string>\",\n        \"path\": \"<string>\",\n        \"postReplyScript\": \"<string>\",\n        \"preSendScript\": \"<string>\",\n        \"requestSchema\": {},\n        \"responseSchema\": {}\n      }\n    ],\n    \"icon\": \"<string>\",\n    \"imageUrl\": \"<string>\",\n    \"overviewMarkdown\": \"<string>\",\n    \"provider\": \"<string>\",\n    \"providerImageUrl\": \"<string>\",\n    \"providerUrl\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"organizationId\": \"<string>\",\n  \"publicAccess\": true,\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/service-bridges/{id}")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"changeSequence\": 123,\n  \"createdOn\": \"2023-11-07T05:31:56Z\",\n  \"deleteUserEmail\": \"<string>\",\n  \"deleteUserId\": \"<string>\",\n  \"deleted\": true,\n  \"deletedDate\": \"2023-11-07T05:31:56Z\",\n  \"deprecated\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {\n    \"auth\": {\n      \"clientId\": \"<string>\",\n      \"clientSecret\": \"<string>\",\n      \"headerName\": \"<string>\",\n      \"headerPrefix\": \"<string>\",\n      \"requestBody\": {},\n      \"requestFormat\": \"<string>\",\n      \"responseMapping\": {\n        \"accessToken\": \"<string>\",\n        \"expiresIn\": \"<string>\"\n      },\n      \"tokenCacheBufferSeconds\": 123,\n      \"tokenUrl\": \"<string>\",\n      \"type\": \"<string>\"\n    },\n    \"baseUrl\": \"<string>\",\n    \"checksum\": \"<string>\",\n    \"defaultHeaders\": [\n      {\n        \"name\": \"<string>\",\n        \"secretRef\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"deleteProtection\": true,\n    \"description\": \"<string>\",\n    \"endpoints\": [\n      {\n        \"cacheEnabled\": true,\n        \"cacheTtlSeconds\": 123,\n        \"cacheableVerbs\": [\n          \"<string>\"\n        ],\n        \"description\": \"<string>\",\n        \"headers\": [\n          {\n            \"name\": \"<string>\",\n            \"secretRef\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"initScope\": \"<string>\",\n        \"initScript\": \"<string>\",\n        \"method\": \"<string>\",\n        \"name\": \"<string>\",\n        \"path\": \"<string>\",\n        \"postReplyScript\": \"<string>\",\n        \"preSendScript\": \"<string>\",\n        \"requestSchema\": {},\n        \"responseSchema\": {}\n      }\n    ],\n    \"icon\": \"<string>\",\n    \"imageUrl\": \"<string>\",\n    \"overviewMarkdown\": \"<string>\",\n    \"provider\": \"<string>\",\n    \"providerImageUrl\": \"<string>\",\n    \"providerUrl\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"organizationId\": \"<string>\",\n  \"publicAccess\": true,\n  \"slug\": \"<string>\",\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "auth": {
      "clientId": "<string>",
      "clientSecret": "<string>",
      "headerName": "<string>",
      "headerPrefix": "<string>",
      "requestBody": {},
      "requestFormat": "<string>",
      "responseMapping": {
        "accessToken": "<string>",
        "expiresIn": "<string>"
      },
      "tokenCacheBufferSeconds": 123,
      "tokenUrl": "<string>",
      "type": "<string>"
    },
    "baseUrl": "<string>",
    "checksum": "<string>",
    "defaultHeaders": [
      {
        "name": "<string>",
        "secretRef": "<string>",
        "value": "<string>"
      }
    ],
    "deleteProtection": true,
    "description": "<string>",
    "endpoints": [
      {
        "cacheEnabled": true,
        "cacheTtlSeconds": 123,
        "cacheableVerbs": [
          "<string>"
        ],
        "description": "<string>",
        "headers": [
          {
            "name": "<string>",
            "secretRef": "<string>",
            "value": "<string>"
          }
        ],
        "initScope": "<string>",
        "initScript": "<string>",
        "method": "<string>",
        "name": "<string>",
        "path": "<string>",
        "postReplyScript": "<string>",
        "preSendScript": "<string>",
        "requestSchema": {},
        "responseSchema": {}
      }
    ],
    "icon": "<string>",
    "imageUrl": "<string>",
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerImageUrl": "<string>",
    "providerUrl": "<string>"
  },
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json
​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
deleteUserEmail
string | null
​
deleteUserId
string | null
​
deleted
boolean
​
deletedDate
string<date-time> | null
​
deprecated
boolean
​
extensionPackRef
string
​
id
string
​
metadata
object
​
name
string
​
organizationId
string
​
publicAccess
boolean
​
slug
string
​
template
boolean
​
type
string
​
updatedOn
string<date-time>
​
uuid
string
​
yamlSource
string | null

Response

Updated ServiceBridgeMetadata

​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
deleteUserEmail
string | null
​
deleteUserId
string | null
​
deleted
boolean
​
deletedDate
string<date-time> | null
​
deprecated
boolean
​
extensionPackRef
string
​
id
string
​
metadata
object
​
name
string
​
organizationId
string
​
publicAccess
boolean
​
slug
string
​
template
boolean
​
type
string
​
updatedOn
string<date-time>
​
uuid
string
​
yamlSource
string | null