Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wallarm Rules API

Security rules and virtual patch management

Wallarm Rules API is one of 9 APIs that Wallarm publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 4.0.0.

Requests are made against 2 base URLs: https://us1.api.wallarm.com, https://api.wallarm.com.

4 operations 4 paths 7 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.0.0
Base URL
https://us1.api.wallarm.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Wallarm Rules API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-WallarmApi-Token (ApiTokenAuth). By default, every request must be authenticated.

  • ApiTokenAuth — API token obtained from Wallarm Console under Settings → API Tokens.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Rules 4

Security rules and virtual patch management

POST
/v1/objects/hint
List Security Rules
listRules body → 200401
POST
/v1/objects/hint/create
Create Security Rule
createRule body → 200400401
POST
/v1/objects/hint/delete
Delete Security Rule
deleteRule body → 200401404
POST
/v1/objects/action
List Rule Conditions
listRuleConditions body → 200401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ObjectQueryRequest (6 properties), Rule (6 properties), CreateRuleRequest (5 properties), ActionListResponse (2 properties). Each schema is shown below with its type and property counts.

RuleListResponse
object
2 properties
CreateRuleRequest
object
5 properties 2 required
Rule
object
6 properties
DeleteRuleRequest
object
2 properties 2 required
ObjectQueryRequest
object
6 properties
RuleResponse
object
2 properties
ActionListResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wallarm-rules-api-openapi.yml Raw ↑

Other APIs Wallarm publishes across the network.

Wallarm Applications API
Wallarm Attacks API
Wallarm Integrations API
Wallarm IP Lists API
Wallarm Nodes API
Wallarm Triggers API
Wallarm User API
Wallarm Vulnerabilities API