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

WSO2 Rulesets API

for managing rulesets.

WSO2 Rulesets API is one of 90 APIs that WSO2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://apis.wso2.com/api/am/admin/v4.

7 operations 4 paths 5 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v4
Base URL
https://apis.wso2.com
Authentication
OAuth 2.0
Contact
License
Resource Areas
1

Authentication & Security 1

WSO2 Rulesets API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the password flow, exposing 41 scopes.

Paths & Operations 7

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

Rulesets 7

for managing rulesets.

GET
/rulesets
Retrieves a list of rulesets.
getRulesets 3 params → 200400401403500
POST
/rulesets
Create a new ruleset.
createRuleset body → 201400401403500
GET
/rulesets/{rulesetId}
Retrieves details of a specific ruleset.
getRulesetById 1 param → 200400401403500
PUT
/rulesets/{rulesetId}
Updates a specific ruleset.
updateRulesetById 1 param body → 200400401403500
DELETE
/rulesets/{rulesetId}
Deletes a specific ruleset.
deleteRuleset 1 param → 204400401403500
GET
/rulesets/{rulesetId}/content
Retrieves the content of a specific ruleset.
getRulesetContent 1 param → 200400401403500
GET
/rulesets/{rulesetId}/usage
Retrieves the policy usage of a specific ruleset.
getRulesetUsage 1 param → 200400401403500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are RulesetInfo (12 properties), RulesetInput (8 properties), Pagination (5 properties), RulesetList (3 properties). Each schema is shown below with its type and property counts.

RulesetInfo
object
Detailed information about a ruleset.
12 properties 4 required
RulesetInput
object
Detailed information about a ruleset.
8 properties 4 required
Pagination
object
5 properties
Error
object
3 properties 2 required
RulesetList
object
A list of rulesets.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wso2-rulesets-api-openapi.yml Raw ↑

Other APIs WSO2 publishes across the network.

WSO2 Advanced Policy (Collection) API
WSO2 Advanced Policy (Individual) API
WSO2 AIServiceProvider API
WSO2 AIServiceProviders API
WSO2 Alert Subscriptions API
WSO2 Alerts API
WSO2 Api Artifact API
WSO2 API Categories API
WSO2 API Category (Collection) API
WSO2 API Category (Individual) API
WSO2 API Chat API
WSO2 API Documents API