Skip to main content
POST
/
api
/
service-bridges
Create ServiceBridgeMetadata
curl --request POST \
  --url https://platform.kodexa.ai/api/service-bridges \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "baseUrl": "<string>",
    "checksum": "<string>",
    "defaultHeaders": [
      {
        "name": "<string>",
        "secretRef": "<string>",
        "value": "<string>"
      }
    ],
    "deleteProtection": true,
    "description": "<string>",
    "endpoints": [
      {
        "cacheEnabled": true,
        "cacheTtlSeconds": 123,
        "description": "<string>",
        "headers": [
          {
            "name": "<string>",
            "secretRef": "<string>",
            "value": "<string>"
          }
        ],
        "method": "<string>",
        "name": "<string>",
        "path": "<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,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "baseUrl": "<string>",
    "checksum": "<string>",
    "defaultHeaders": [
      {
        "name": "<string>",
        "secretRef": "<string>",
        "value": "<string>"
      }
    ],
    "deleteProtection": true,
    "description": "<string>",
    "endpoints": [
      {
        "cacheEnabled": true,
        "cacheTtlSeconds": 123,
        "description": "<string>",
        "headers": [
          {
            "name": "<string>",
            "secretRef": "<string>",
            "value": "<string>"
          }
        ],
        "method": "<string>",
        "name": "<string>",
        "path": "<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,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

x-api-key
string
header
required

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

Body

application/json
changeSequence
integer<int32>
createdOn
string<date-time>
deprecated
boolean
extensionPackRef
string
id
string
metadata
object
name
string
organizationId
string
publicAccess
boolean
slug
string
template
boolean
updatedOn
string<date-time>
uuid
string

Response

Created ServiceBridgeMetadata

changeSequence
integer<int32>
createdOn
string<date-time>
deprecated
boolean
extensionPackRef
string
id
string
metadata
object
name
string
organizationId
string
publicAccess
boolean
slug
string
template
boolean
updatedOn
string<date-time>
uuid
string