Getting Information by Specifying Connection ID

You can get the Connection Settings information by specifying Connection ID.

Request Interface

HTTP Request

GET /connections/definition/{connectionId}

Parameter

Path Parameter	Value	Required	Description
connectionId	string	true	Connection ID

For details on common request parameters for Site API, refer to Common Parameter.

Authorization

In the API Key Management screen in Management Console, 'Connection Settings' under the 'Scopes' field must be selected as 'Get'.

Response Interface

If the request is processed successfully, the following response is returned in JSON format.

{
    "connectionId":"id1",
    "connectableClientType":["hulft"],
    "ipFilterGroupName":"group1",
    "memo":"memo1"
}

Property Name	Value	Description
connectionId	string	Connection ID
connectableClientType	array	Client type that can be used with Connection ID
ipFilterGroupName	string	IP Filter Group Name that is linked to the account. This parameter contains null in this response if an IP Filter Group Name is not set to the Connection ID
memo	string	Note for the settings

Examples

Java JavaScript

public static void main(String[] args) {
    String host = "https://www.webconnect.hulft.com";
    String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    String connectionId = "xxxxxxxx";
    try {
        URL url = new URL(host + "/api/v2/connections/definition/" + connectionId);
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        connection.setRequestMethod("GET");
        connection.setRequestProperty("Authorization", "Bearer " + apiKey);
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
            String line;
            while((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        }
    } catch (IOException ex) {
        // error
    }
}

// load jquery 
var host = 'https://www.webconnect.hulft.com';
var apiKey = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
var connectionId = 'xxxxxxxx';
$.ajax({
  type: 'GET',
  url: host + '/api/v2/connections/definition/' + connectionId,
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});