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

APIs.io Engineering Platform Account Rulesets API

The Account Rulesets API from APIs.io Engineering Platform — 10 operation(s) for account rulesets.

APIs.io Engineering Platform Account Rulesets API is one of 471 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 16 operations across 10 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against the base URL https://{bucketname}.s3.amazonaws.com.

16 operations 10 paths 40 schemas 3 DELETE8 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key, API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

APIs.io Engineering Platform Account Rulesets API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Email (api_email). An API key is passed in the header as X-Auth-Key (api_key). It accepts HTTP bearer tokens (api_token). An API key is passed in the header as X-Auth-User-Service-Key (user_service_key).

Paths & Operations 16

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

Account Rulesets 16
GET
/accounts/{account_id}/rulesets
APIs.io Engineering Platform List account rulesets
listAccountRulesets 1 param → 4XX200
POST
/accounts/{account_id}/rulesets
APIs.io Engineering Platform Create an account ruleset
createAccountRuleset 1 param body → 4XX200
DELETE
/accounts/{account_id}/rulesets/{ruleset_id}
APIs.io Engineering Platform Delete an account ruleset
deleteAccountRuleset 2 params → 4XX204
GET
/accounts/{account_id}/rulesets/{ruleset_id}
APIs.io Engineering Platform Get an account ruleset
getAccountRuleset 2 params → 4XX200
PUT
/accounts/{account_id}/rulesets/{ruleset_id}
APIs.io Engineering Platform Update an account ruleset
updateAccountRuleset 2 params body → 4XX200
POST
/accounts/{account_id}/rulesets/{ruleset_id}/rules
APIs.io Engineering Platform Create an account ruleset rule
createAccountRulesetRule 2 params body → 4XX200
DELETE
/accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}
APIs.io Engineering Platform Delete an account ruleset rule
deleteAccountRulesetRule 3 params → 4XX200
PATCH
/accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}
APIs.io Engineering Platform Update an account ruleset rule
updateAccountRulesetRule 3 params body → 4XX200
GET
/accounts/{account_id}/rulesets/{ruleset_id}/versions
APIs.io Engineering Platform List an account ruleset's versions
listAccountRulesetVersions 2 params → 4XX200
DELETE
/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}
APIs.io Engineering Platform Delete an account ruleset version
deleteAccountRulesetVersion 3 params → 4XX204
GET
/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}
APIs.io Engineering Platform Get an account ruleset version
getAccountRulesetVersion 3 params → 4XX200
GET
/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}
APIs.io Engineering Platform List an account ruleset version's rules by tag
listAccountRulesetVersionRulesByTag 4 params → 4XX200
GET
/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint
APIs.io Engineering Platform Get an account entry point ruleset
getAccountEntrypointRuleset 2 params → 4XX200
PUT
/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint
APIs.io Engineering Platform Update an account entry point ruleset
updateAccountEntrypointRuleset 2 params body → 4XX200
GET
/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions
APIs.io Engineering Platform List an account entry point ruleset's versions
listAccountEntrypointRulesetVersions 2 params → 4XX200
GET
/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}
APIs.io Engineering Platform Get an account entry point ruleset version
getAccountEntrypointRulesetVersion 3 params → 4XX200

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are rulesets_Rule (11 properties), rulesets_Ruleset (5 properties), rulesets_Response (4 properties), rulesets_Message (3 properties). Each schema is shown below with its type and property counts.

rulesets_LogCustomFieldRule
rulesets_RuleCategory
string
A category of the rule.
rulesets_CompressResponseRule
rulesets_ResponseRules
array
The list of rules in the ruleset.
rulesets_RewriteRule
rulesets_ExecuteRule
rulesets_AccountId
string
The unique ID of the account.
rulesets_Response
object
A response object.
4 properties 4 required
rulesets_ForceConnectionCloseRule
rulesets_ResponseRule
rulesets_RedirectRule
rulesets_ExecuteSensitivityLevel
string
rulesets_RuleId
string
The unique ID of the rule.
rulesets_SetCacheSettingsRule
rulesets_RouteRule
rulesets_LogRule
rulesets_JsChallengeRule
rulesets_RulesetPhase
string
The phase of the ruleset.
rulesets_DDoSDynamicRule
rulesets_RulesetId
string
The unique ID of the ruleset.
rulesets_SkipRule
rulesets_ScoreRule
rulesets_ManagedChallengeRule
rulesets_RequestRule
rulesets_SetConfigRule
rulesets_Ruleset
object
A ruleset object.
5 properties 3 required
rulesets_Message
object
A message.
3 properties 1 required
rulesets_Messages
array
A list of warning messages.
rulesets_RewriteUriPart
rulesets_RulesetKind
string
The kind of the ruleset.
rulesets_RequestRules
array
The list of rules in the ruleset.
rulesets_RuleAction
string
The action to perform when the rule matches.
rulesets_RuleEnabled
boolean
Whether the rule should be executed.
rulesets_Errors
array
A list of error messages.
rulesets_ServeErrorRule
rulesets_RulesetVersion
string
The version of the ruleset.
rulesets_ChallengeRule
rulesets_RulePosition
object
An object configuring where the rule will be placed.
rulesets_Rule
object
11 properties 2 required
rulesets_BlockRule

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-account-rulesets-api-openapi.yml Raw ↑

Other APIs APIs.io Engineering Platform publishes across the network.

EasyCron
APIs.io Engineering Platform 2014 11 13 API
APIs.io Engineering Platform 2015 03 31 API
APIs.io Engineering Platform 2016 08 19 API
APIs.io Engineering Platform 2017 03 31 API
APIs.io Engineering Platform 2017 10 31 API
APIs.io Engineering Platform 2018 10 31 API
APIs.io Engineering Platform 2019 09 25 API
APIs.io Engineering Platform 2019 09 30 API
APIs.io Engineering Platform 2020 04 22 API
APIs.io Engineering Platform 2020 06 30 API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Account Rulesets 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.