FirewallApi.md

FirewallApi

All URIs are relative to https://api.upcloud.com/1.2

Method	HTTP request	Description
createFirewallRule	POST /server/{serverId}/firewall_rule	Create firewall rule
deleteFirewallRule	DELETE /server/{serverId}/firewall_rule/{firewallRuleNumber}	Remove firewall rule
getFirewallRule	GET /server/{serverId}/firewall_rule/{firewallRuleNumber}	Get firewall rule details
serverServerIdFirewallRuleGet	GET /server/{serverId}/firewall_rule	List firewall rules

createFirewallRule

FirewallRuleCreateResponse createFirewallRule(serverId, firewallRule)

Create firewall rule

Creates a new firewall rule

Example

// Import classes:
//import com.upcloud.client.ApiClient;
//import com.upcloud.client.ApiException;
//import com.upcloud.client.Configuration;
//import com.upcloud.client.auth.*;
//import com.upcloud.client.api.FirewallApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: baseAuth
HttpBasicAuth baseAuth = (HttpBasicAuth) defaultClient.getAuthentication("baseAuth");
baseAuth.setUsername("YOUR USERNAME");
baseAuth.setPassword("YOUR PASSWORD");

FirewallApi apiInstance = new FirewallApi();
UUID serverId = new UUID(); // UUID | Server id
FirewallRuleRequest firewallRule = new FirewallRuleRequest(); // FirewallRuleRequest | 
try {
    FirewallRuleCreateResponse result = apiInstance.createFirewallRule(serverId, firewallRule);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FirewallApi#createFirewallRule");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
serverId	UUID	Server id
firewallRule	FirewallRuleRequest

Return type

FirewallRuleCreateResponse

Authorization

baseAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteFirewallRule

deleteFirewallRule(serverId, firewallRuleNumber)

Remove firewall rule

Removes a firewall rule from a server. Firewall rules must be removed individually. The positions of remaining firewall rules will be adjusted after a rule is removed.

Example

// Import classes:
//import com.upcloud.client.ApiClient;
//import com.upcloud.client.ApiException;
//import com.upcloud.client.Configuration;
//import com.upcloud.client.auth.*;
//import com.upcloud.client.api.FirewallApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: baseAuth
HttpBasicAuth baseAuth = (HttpBasicAuth) defaultClient.getAuthentication("baseAuth");
baseAuth.setUsername("YOUR USERNAME");
baseAuth.setPassword("YOUR PASSWORD");

FirewallApi apiInstance = new FirewallApi();
UUID serverId = new UUID(); // UUID | Server id
BigDecimal firewallRuleNumber = new BigDecimal(); // BigDecimal | Denotes the index of the firewall rule in the server's firewall rule list
try {
    apiInstance.deleteFirewallRule(serverId, firewallRuleNumber);
} catch (ApiException e) {
    System.err.println("Exception when calling FirewallApi#deleteFirewallRule");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
serverId	UUID	Server id
firewallRuleNumber	BigDecimal	Denotes the index of the firewall rule in the server's firewall rule list

Return type

null (empty response body)

Authorization

baseAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

getFirewallRule

FirewallRuleCreateResponse getFirewallRule(serverId, firewallRuleNumber)

Get firewall rule details

Returns detailed information about a specific firewall rule

Example

// Import classes:
//import com.upcloud.client.ApiClient;
//import com.upcloud.client.ApiException;
//import com.upcloud.client.Configuration;
//import com.upcloud.client.auth.*;
//import com.upcloud.client.api.FirewallApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: baseAuth
HttpBasicAuth baseAuth = (HttpBasicAuth) defaultClient.getAuthentication("baseAuth");
baseAuth.setUsername("YOUR USERNAME");
baseAuth.setPassword("YOUR PASSWORD");

FirewallApi apiInstance = new FirewallApi();
UUID serverId = new UUID(); // UUID | Server id
BigDecimal firewallRuleNumber = new BigDecimal(); // BigDecimal | Denotes the index of the firewall rule in the server's firewall rule list
try {
    FirewallRuleCreateResponse result = apiInstance.getFirewallRule(serverId, firewallRuleNumber);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FirewallApi#getFirewallRule");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
serverId	UUID	Server id
firewallRuleNumber	BigDecimal	Denotes the index of the firewall rule in the server's firewall rule list

Return type

FirewallRuleCreateResponse

Authorization

baseAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

serverServerIdFirewallRuleGet

FirewallRuleListResponse serverServerIdFirewallRuleGet(serverId)

List firewall rules

Returns a list of firewall rules for a specific server.

Example

// Import classes:
//import com.upcloud.client.ApiClient;
//import com.upcloud.client.ApiException;
//import com.upcloud.client.Configuration;
//import com.upcloud.client.auth.*;
//import com.upcloud.client.api.FirewallApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: baseAuth
HttpBasicAuth baseAuth = (HttpBasicAuth) defaultClient.getAuthentication("baseAuth");
baseAuth.setUsername("YOUR USERNAME");
baseAuth.setPassword("YOUR PASSWORD");

FirewallApi apiInstance = new FirewallApi();
UUID serverId = new UUID(); // UUID | Server id
try {
    FirewallRuleListResponse result = apiInstance.serverServerIdFirewallRuleGet(serverId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FirewallApi#serverServerIdFirewallRuleGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
serverId	UUID	Server id

Return type

FirewallRuleListResponse

Authorization

baseAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json