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

Zoho RuleGroup API

The RuleGroup API from Zoho — 2 operation(s) for rulegroup.

Zoho RuleGroup API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include RuleGroup. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and code examples.

This API exposes 3 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

3 operations 2 paths 13 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Authentication
custom
Resource Areas
1

Authentication & Security 1

Zoho RuleGroup API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 3

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

RuleGroup 3
GET
/api/v1/rulegroups
Get All RuleGroups
getRuleGroups 8 params → 200
POST
/api/v1/rulegroups
Create RuleGroup
createRuleGroup 1 param body → 200
PUT
/api/v1/rulegroups/{id}
Update RuleGroup
updateRuleGroup 2 params body → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are RuleGroup (12 properties), RuleGroupResponse (12 properties), RuleGroupUpdateRequest (8 properties), Node (8 properties). Each schema is shown below with its type and property counts.

Module
object
3 properties
RuleGroup
object
12 properties
RuleGroupResponse
object
Rulegroup Response template
12 properties
DepartmentProperty
object
4 properties
GetAllRuleGroupsResponse
object
1 property
RuleGroupCreateRequest
object
7 properties 4 required
Rule
object
4 properties
RuleGroupEvent
object
5 properties
Agent
object
3 properties
Node
object
8 properties
Cluster
object
4 properties
Engine
object
2 properties
RuleGroupUpdateRequest
object
8 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-rulegroup-api-openapi.yml Raw ↑

Other APIs Zoho publishes across the network.

Zoho Inventory
Zoho Books
Zoho Invoice
Zoho Billing
Zoho Expense
Zoho People
Zoho Recruit
Zoho Projects
Zoho Mail
Zoho Sign
Zoho Campaigns
Zoho SalesIQ