Deleting Information

You can delete the specified Relay Authorization Settings information.

Request Interface

HTTP Request

DELETE /relay/permission/{connectionId}/{remoteConnectionId}/{direction}

Parameter

Path Parameter

Value

Required

Description

Default Value

connectionId

string

true

Connection ID of the local machine to be deleted

 

remoteConnectionId

string

true

Connection ID of the remote machine to be deleted

 

direction

string

true

Transfer direction to be deleted

 

Authorization

In the API Key Management screen in Management Console, 'Relay Auth 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

public static void main(String[] args) {
    String host = "https://www.webconnect.hulft.com";
    String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    String connectionId = "xxxxxxxx";
    String remoteConnectionId = "xxxxxxxx";
    String direction = "send";
    try {
        URL url = new URL(host + "/api/v2/relay/permission/" + connectionId + "/" + remoteConnectionId + "/" + direction);
        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';
var remoteConnectionId = 'xxxxxxxx';
var direction = 'send';
$.ajax({
  type: 'DELETE',
  url: host + '/api/v2/relay/permission/' + connectionId + '/' + remoteConnectionId + '/' + direction,
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});