Sign in

v1

latestOpenAPI 3.0.22026-07-174950145.6 KB
Manage Connectors

Update a connector

Updates a connector.

patch/connectors/{connectorId}

Path parameters

connectorIdstring required

The unique identifier of the connector.

Request body

idstring

The unique identifier of the connector.

activeboolean

Whether this connector is activated. If this flag is set to false, no connector client will be available for it. That means no requests can be performed to the connector.

skipAutoDisableboolean

Whether to skip the automatic disabling of this connector even when being not healthy.

trustedboolean

Whether the connector is a trusted connector. Trusted connectors will receive more information than normal connectors.

paramsobject

Arbitrary parameters to be provided to the remote function with the event.

remoteFunctionsobject

A map with Cluster-IDs as keys (cluster-id-1 & cluster-id-1) and a 'RemoteFunctionConfig' as value.

defaultEventTypesstring[]

The default event types to register the connector for. Can be overridden in the space definition by the owner. The value of one individual array element is a composition of the event type and the phase, separated by a dot. For example "ModifySpaceEvent" as the event type plus "." plus "response" as phase.

contactEmailsstring[]

A list of email addresses of responsible owners for this connector. These email addresses will be used to send potential health warnings and other notifications.

Example request

{
  "capabilities": {
    "clusteringTypes": [
      "hexbin",
      "quad",
      "quadbin"
    ],
    "preserializedResponseSupport": true,
    "propertySearch": true,
    "relocationSupport": true,
    "searchablePropertiesConfiguration": true
  },
  "contactEmails": [
    "MY_TEAM_E-MAIL@here.com",
    "DEVELOPER_E-MAIL@here.com"
  ],
  "id": "my-custom-unique-id",
  "params": {
    "ecps": "myEncryptedAndVeryLongEcpsString",
    "autoIndexing": true,
    "propertySearch": true,
    "mvtSupport": true
  },
  "remoteFunctions": {
    "eu-west-1": {
      "id": "test1",
      "lambdaARN": "arn:aws:lambda:eu-west-1:<myAwsAccountId>:function:test1",
      "roleARN": null,
      "type": "AWSLambda"
    }
  }
}

Response

The connector

idstring

The unique identifier of the connector.

activeboolean

Whether this connector is activated. If this flag is set to false, no connector client will be available for it. That means no requests can be performed to the connector.

skipAutoDisableboolean

Whether to skip the automatic disabling of this connector even when being not healthy.

trustedboolean

Whether the connector is a trusted connector. Trusted connectors will receive more information than normal connectors.

paramsobject

Arbitrary parameters to be provided to the remote function with the event.

remoteFunctionsobject

A map with Cluster-IDs as keys (cluster-id-1 & cluster-id-1) and a 'RemoteFunctionConfig' as value.

defaultEventTypesstring[]

The default event types to register the connector for. Can be overridden in the space definition by the owner. The value of one individual array element is a composition of the event type and the phase, separated by a dot. For example "ModifySpaceEvent" as the event type plus "." plus "response" as phase.

contactEmailsstring[]

A list of email addresses of responsible owners for this connector. These email addresses will be used to send potential health warnings and other notifications.

Example response

{
  "capabilities": {
    "clusteringTypes": [
      "hexbin",
      "quad",
      "quadbin"
    ],
    "preserializedResponseSupport": true,
    "propertySearch": true,
    "relocationSupport": true,
    "searchablePropertiesConfiguration": true
  },
  "contactEmails": [
    "MY_TEAM_E-MAIL@here.com",
    "DEVELOPER_E-MAIL@here.com"
  ],
  "id": "my-custom-unique-id",
  "params": {
    "ecps": "myEncryptedAndVeryLongEcpsString",
    "autoIndexing": true,
    "propertySearch": true,
    "mvtSupport": true
  },
  "remoteFunctions": {
    "eu-west-1": {
      "id": "test1",
      "lambdaARN": "arn:aws:lambda:eu-west-1:<myAwsAccountId>:function:test1",
      "roleARN": null,
      "type": "AWSLambda"
    }
  }
}