Deleting Information

You can delete the specified Connection Settings information.

Note

Note that when a Connection ID is deleted, the related items in the Relay Authorization Settings and the Browser Transfer Settings are also deleted.

Request Interface

HTTP Request

DELETE /connections/definition/{connectionId}

Parameter

Path Parameter	Value	Required	Description
connectionId	string	true	Connection ID to be deleted

Authorization

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

Response Interface

If the request is processed successfully, the response body is not returned.

Examples

Java JavaScript

public static void main(String[] args) {
    String host = "https://www.webconnect.hulft.com";
    String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    try {
        String connectionId = "xxxxxxxx";
        URL url = new URL(host + "/api/v2/connections/definition/" + connectionId);
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();

        connection.setRequestMethod("DELETE");
        connection.setRequestProperty("Authorization", "Bearer " + apiKey);
        System.out.println(connection.getResponseMessage()); // The response does not contain the response body. 
    } catch (IOException ex) {
        // error
    }
}

// load jquery 
var host = 'https://www.webconnect.hulft.com';
var apiKey = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
var connectionId = 'xxxxxxxx';
$.ajax({
  type: 'DELETE',
  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);
});