Purpose

Update the information for an On-Premises Connector. Only the Connector's owner can update the Connector's information. This endpoint can be used to update information for both an individual connector and a connector group.

A group Connector must include a members section. Using a members section in a simple Connector causes an error.

URL

https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>

Method

PUT

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

<connector-ID> is a unique value associated with the On-Premises Connector. The value is returned using the https://<myserver>:<port>/api/mgmt/connectors GET request.

Request Payload Parameters

The request payload specifies the new definition for the connector. The new definition includes the new Connector Group definition if the connector is a Connector Group and the list of Hybrid Data Pipeline users to add as authorized users. All parameters must be included. The request has the following format: 

{
  "connectorID": "abcdef01-fedc-abcd-bcde-0123456789ab",
  "owner": "Rick",
  "label": "Development",
  "connectorGroup": {
    "connectionTimeout": 15,
    "retryDelay": 120,
    "loadBalancing": "Round Robin",
    "members": [
      {
        "memberID": "00001000-0001-0001-0010-000010001001",
        "sequence": 1,
        "weight": 1
      },
      {
        "memberID": "00002000-0002-0002-0020-000020002002",
        "sequence": 2,
        "weight": 1
       }
    ]
  }
  "authUser": [
    "Joe",
    "Fred",
    "Tom"
  ]
}

where:

Parameter Description Valid Values
authUser

data type: Array

 Specifies the list of users who have been granted permission to use the On-Premises Connectors in the group. A comma-separated list of users who have been authorized by the owner of the group. Required; can be empty
connectorID

data type: String

 The Connector ID of the On-Premises Connector for which information is returned. The ID for the Connector. Required
connectorGroup

data type: Object

 Only present if the given connector is a group connector ID. GroupConnectors allow the user to have failover between multiple On-Premises Connectors. An object of type connector_group_object, with the following parameters:
  • connectionTimeout: The amount of time, in seconds, that the connectivity service waits for a connection to be established. Required.
  • retryDelay: indicates the number of seconds the connectivity service considers the connector disabled. Required.
  • loadBalancing: Specifies whether to enable load balancing. Optional.
  • members: Specifies the connector ID of each On-Premises Connector in the group, the sequence in which each On-Premises Connector will be tried, and the weight to be applied to the connector. Required.

For more information, see connectorGroup Object.
label A descriptive name for the Connector that can be used instead of the Connector ID. When not specified, the system name is used. Optional A string with a maximum length of 255 characters.

If two Connectors in the Group have the same label, the owner's name is appended, for example, Production and Production(SueS).

To delete an existing label, set the value to null.
owner

data type: String

 The user name of the owner of the Connector. Optional A user name. If owner is specified, its value must match the current owner of the Connector or Connector Group. Changing the owner of a Connector or Connector Group is not supported.

Response Definition

If the Update Connector operation requested is successful, the response is a JSON object defined as:


{
  "connectorID": <"connector-id">,
  "owner": <"owner">,
  "label": <"label">,
  "connectorGroup": {
    "connectionTimeout": 15,
    "retryDelay": 120,
    "loadBalancing": "Round Robin",
    "members": [
      {
        "memberID": <"member-id">,
        "sequence": 1,
        "weight": 1
      },
      {
        "memberID": <"member-id">,
        "sequence": 2,
        "weight": 1
       }
    ]
  }
  "authUser": [
    <"authorized-user">,
    <"authorized-user">,
    <"authorized-user">
  ]
}
Note: The Update Connector Information response will be the same as the Get Connector Information response. See Get Connector Information.

If the Update Connector operation is not successful, the response is a standard error response.

Sample Success Response 


{
  "connectorID": "abcdef01-fedc-abcd-bcde-0123456789ab",
  "owner": "Rick",
  "label": "Production",
  "connectorGroup": {
    "connectionTimeout": 15,
    "retryDelay": 120,
    "loadBalancing": "Round Robin",
    "members": [   
      {
        "memberID": "00001000-0001-0001-0010-000010001001",
        "sequence": 1,
        "weight": 1
      },
      {
        "memberID": "00002000-0002-0002-0020-000020002002",
        "sequence": 2,
        "weight": 1
       }
    ]
  }
  "authUser": [
    "Joe",
    "Fred",
    "Tom"
  ]
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

Any active Hybrid Data Pipeline user. The authenticated user must be the owner of the On-Premises Connector.