How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
UpCloud

UpCloud Firewall Ruleset API

UpCloud SDN Firewall API. Allows creation, management and deletion of Firewall rulesets and Firewall rules.

Documentation Provider Profile APIs.io OpenAPI GitHub

UpCloud Firewall Ruleset API is one of 29 APIs that UpCloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include firewall-ruleset. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 23 operations across 10 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1.3.

Requests are made against a single base URL, https://api.upcloud.com.

23 operations 10 paths 34 schemas 4 DELETE9 GET4 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3
Base URL
https://api.upcloud.com
Authentication
HTTP Bearer
Contact
UpCloud
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

UpCloud Firewall Ruleset API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiToken). By default, every request must be authenticated.

  • apiToken — UpCloud API uses HTTP Bearer authentication. An API token is required to authenticate. The API token can be created in the UpCloud control panel. Alternatively…

Paths & Operations 23

Across 10 paths, the API surfaces 23 operations — 4 DELETE, 9 GET, 4 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

firewall-ruleset 23

UpCloud SDN Firewall API. Allows creation, management and deletion of Firewall rulesets and Firewall rules.

GET
/1.3/firewall-ruleset
List firewall rulesets
listFirewallRulesets 3 params → 200default
POST
/1.3/firewall-ruleset
Create firewall ruleset
createFirewallRuleset body → 201default
GET
/1.3/firewall-ruleset/{ruleset-uuid}
Get firewall ruleset details
getFirewallRuleset 1 param → 200default
DELETE
/1.3/firewall-ruleset/{ruleset-uuid}
Delete firewall ruleset
deleteFirewallRuleset 1 param → 204default
PATCH
/1.3/firewall-ruleset/{ruleset-uuid}
Modify firewall ruleset
modifyFirewallRuleset 1 param body → 200default
PATCH
/1.3/firewall-ruleset/{ruleset-uuid}/restore/{ruleset-version}
Restore firewall ruleset
restoreFirewallRuleset 2 params → 200default
GET
/1.3/firewall-ruleset/{ruleset-uuid}/rule
List firewall ruleset rules
listFirewallRulesetRules 4 params → 200default
PUT
/1.3/firewall-ruleset/{ruleset-uuid}/rule
Create multiple firewall ruleset rules
createMultipleFirewallRulesetRule 1 param body → 200default
POST
/1.3/firewall-ruleset/{ruleset-uuid}/rule
Create firewall ruleset rule
createFirewallRulesetRule 1 param body → 201default
GET
/1.3/firewall-ruleset/{ruleset-uuid}/rule/{rule-id}
Get firewall ruleset rule details
getFirewallRulesetRule 2 params → 200default
DELETE
/1.3/firewall-ruleset/{ruleset-uuid}/rule/{rule-id}
Delete firewall ruleset rule
deleteFirewallRulesetRule 2 params → 204default
PATCH
/1.3/firewall-ruleset/{ruleset-uuid}/rule/{rule-id}
Modify firewall ruleset rule
modifyFirewallRulesetRule 2 params body → 200default
GET
/1.3/firewall-ruleset/{ruleset-uuid}/labels
List firewall ruleset labels
listFirewallRulesetLabels 1 param → 200default
POST
/1.3/firewall-ruleset/{ruleset-uuid}/labels
Create firewall ruleset label
createFirewallRulesetLabel 1 param body → 201default
GET
/1.3/firewall-ruleset/{ruleset-uuid}/servers
List servers attached to a firewall ruleset
listFirewallRulesetAttachedServers 1 param → 200default
GET
/1.3/firewall-ruleset/{ruleset-uuid}/labels/{label-key}
Get firewall ruleset label details
getFirewallRulesetLabel 2 params → 200default
DELETE
/1.3/firewall-ruleset/{ruleset-uuid}/labels/{label-key}
Delete firewall ruleset label
deleteFirewallRulesetLabel 2 params → 204default
PATCH
/1.3/firewall-ruleset/{ruleset-uuid}/labels/{label-key}
Modify firewall ruleset label
modifyFirewallRulesetLabel 2 params body → 200default
GET
/1.3/firewall-ruleset/server/{server-uuid}/firewall-rule
List server firewall rules
listServerFirewallRule 4 params → 200default
PUT
/1.3/firewall-ruleset/server/{server-uuid}/firewall-rule
Create multiple server firewall rules
createMultipleServerFirewallRules 1 param body → 200400403404409default
POST
/1.3/firewall-ruleset/server/{server-uuid}/firewall-rule
Create server firewall rule
createServerFirewallRule 1 param body → 201400403404409default
GET
/1.3/firewall-ruleset/server/{server-uuid}/firewall-rule/{position}
Get server firewall rule details
getServerFirewallRule 2 params → 200default
DELETE
/1.3/firewall-ruleset/server/{server-uuid}/firewall-rule/{position}
Delete server firewall rule
deleteServerFirewallRule 2 params → 204400403404409default

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are firewallRulesetRuleDetailResponse (19 properties), firewallRulesetFirewallRuleModify (18 properties), firewallRulesetFirewallRuleCreate (18 properties), firewallRulesetServerFirewallRule (16 properties). Each schema is shown below with its type and property counts.

firewallRulesetServerFirewallRuleDetail
object
Server firewall rule detail
1 property 1 required
firewallRulesetModify
object
Modify firewall ruleset
5 properties
firewallRulesetListResponse
array
Response schema for a list of firewall rulesets.
firewallRulesetServerMultipleFirewallRulesCreate
object
Creates multiple server firewall rules.
1 property 1 required
firewallRulesetServerUuid
string
The unique identifier for the server.
firewallRulesetFirewallRuleCreate
object
18 properties 3 required
firewallRulesetLabelModify
object
Schema for modifying a label with a key-value pair.
2 properties
firewallRulesetLabelListResponse
array
Response schema for listing labels.
firewallRulesetQueryParamOffset
integer
Schema for a query parameter specifying the offset for pagination.
firewallRulesetLabelKey
string
The key of a label.
firewallRulesetRuleFamily
string
Rule family.
firewallRulesetVersion
integer
The firewall ruleset version.
firewallRulesetDetailResponse
object
Response schema for firewall ruleset details, including UUID, name, description, stateful, enabled, labels and serverUUID.
11 properties
firewallRulesetRuleProtocol
string
Rule protocol.
firewallRulesetServerFirewallRules
object
Server firewall rules.
1 property 1 required
firewallRulesetIcmpType
integer
ICMP type.
firewallRulesetServerFirewallRule
object
Server firewall rule
16 properties 2 required
firewallRulesetLabelValue
string
Schema for a label value property, allowing a string or null with specific character constraints.
firewallRulesetServerFirewallDetailResponse
object
Server firewall detail response.
1 property 1 required
firewallRulesetServerFirewallRuleCreate
object
1 property 1 required
firewallRulesetErrorResponse
object
Schema for error responses from the API.
5 properties 4 required
firewallRulesetFirewallRuleListResponse
object
Response schema for a list of firewall ruleset rules.
1 property 1 required
firewallRulesetQueryParamLimit
integer
Schema for a query parameter specifying the maximum number of entries to return (limit).
firewallRulesetServerFirewallRulePosition
integer
The server firewall rule position.
firewallRulesetFirewallRuleModify
object
18 properties
firewallRulesetLabelDetailResponse
object
Schema for label details including key-value pairs.
2 properties
firewallRulesetRuleAction
string
Rule action.
firewallRulesetCreateLabel
object
UpCloud firewall ruleset Label
2 properties 2 required
firewallRulesetQueryParamSort
string
Schema for a query parameter specifying the sort field.
firewallRulesetFirewallMultipleRuleCreate
object
1 property 1 required
firewallRulesetRuleDirection
string
Rule direction.
createFirewallRuleset
object
Create firewall ruleset
6 properties 1 required
firewallRulesetErrorLegacyResponse
object
Schema for legacy error responses from API.
1 property 1 required
firewallRulesetRuleDetailResponse
object
Response schema for firewall ruleset rule details.
19 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upcloud-firewall-ruleset-api-openapi.yml Raw ↑

Other APIs UpCloud publishes across the network.

UpCloud Account API
AE Profile APIs.io
UpCloud Account Tokens API
AE Profile APIs.io
UpCloud Audit Logs API
AE Profile APIs.io
UpCloud Currency API
AE Profile APIs.io
UpCloud Database API
AE Profile APIs.io
UpCloud Device API
AE Profile APIs.io
UpCloud Events API
AE Profile APIs.io
UpCloud File Storage API
AE Profile APIs.io
UpCloud Gateway API
AE Profile APIs.io
UpCloud Ip Address API
AE Profile APIs.io
UpCloud Kubernetes API
AE Profile APIs.io
UpCloud Load Balancer API
AE Profile APIs.io
#firewall-ruleset
← Back to U APIs
API Details
ID
upcloud:upcloud-firewall-ruleset-api
Base URL
https://api.upcloud.com
Docs
https://developers.upcloud.com/api/1.3
Provider
UpCloud
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=upcloud-firewall-ruleset-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/upcloud-firewall-ruleset-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of UpCloud Firewall Ruleset API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.