firewall-ruleset

List firewall rulesets

Returns a list of firewall rulesets.

get/1.3/firewall-ruleset

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/firewall-ruleset
  • Auth: HTTP bearer

Query parameters

limitinteger

Schema for a query parameter specifying the maximum number of entries to return (limit).

Example:10

Number of entries to receive at most.

offsetinteger

Schema for a query parameter specifying the offset for pagination.

Offset for retrieved results.

sortstring

Schema for a query parameter specifying the sort field.

Example:name

Order of returned results.

Response

OK

uuidstring uuid

The unique identifier for the server.

namestring

Name of the firewall ruleset

descriptionstring

Description of the firewall ruleset

statefulboolean
versioninteger

The firewall ruleset version.

enabledboolean
default_dns_rules_enabledboolean
server_uuidstring uuid

The unique identifier for the server.

created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "uuid": "1200ecde-db95-4d1c-9133-6508f3232567",
    "name": "example_stateless_firewall_ruleset",
    "description": "Example stateless firewall ruleset",
    "stateful": false,
    "enabled": true,
    "default_dns_rules_enabled": false,
    "labels": [
      {
        "key": "example-key",
        "value": "example-value"
      }
    ],
    "server_uuid": "03aa7245-2ff9-49c8-9f0e-7ca0270d71a4"
  },
  {
    "uuid": "1200ecde-db95-4d1c-9133-6508f3232445",
    "name": "example_stateful_firewall_ruleset",
    "description": "Example stateful firewall ruleset",
    "stateful": true,
    "enabled": true,
    "default_dns_rules_enabled": false,
    "labels": [
      {
        "key": "example-key",
        "value": "example-value"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.