APIs.io Engineering Platform Account Rulesets API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 16 operations across 10 paths, and defines 40 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

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.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Account Rulesets API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

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_ResponseRules

array

The list of rules in the ruleset.

rulesets_RulesetId

string

The unique ID of the ruleset.

rulesets_ExecuteRule

rulesets_Messages

array

A list of warning messages.

rulesets_Ruleset

object

A ruleset object.

5 properties 3 required

rulesets_DDoSDynamicRule

rulesets_RuleCategory

string

A category of the rule.

rulesets_SkipRule

rulesets_RequestRules

array

The list of rules in the ruleset.

rulesets_RuleId

string

The unique ID of the rule.

rulesets_Rule

object

11 properties 2 required

rulesets_RulePosition

object

An object configuring where the rule will be placed.

rulesets_Errors

array

A list of error messages.

rulesets_ManagedChallengeRule

rulesets_RequestRule

rulesets_RuleAction

string

The action to perform when the rule matches.

rulesets_SetConfigRule

rulesets_Response

object

A response object.

4 properties 4 required

rulesets_CompressResponseRule

rulesets_ServeErrorRule

rulesets_RuleEnabled

boolean

Whether the rule should be executed.

rulesets_LogCustomFieldRule

rulesets_LogRule

rulesets_ResponseRule

rulesets_RulesetVersion

string

The version of the ruleset.

rulesets_Message

object

A message.

3 properties 1 required

rulesets_SetCacheSettingsRule

rulesets_RewriteRule

rulesets_RulesetKind

string

The kind of the ruleset.

rulesets_RulesetPhase

string

The phase of the ruleset.

rulesets_ScoreRule

rulesets_ExecuteSensitivityLevel

string

rulesets_ChallengeRule

rulesets_JsChallengeRule

rulesets_BlockRule

rulesets_RewriteUriPart

rulesets_RedirectRule

rulesets_RouteRule

rulesets_AccountId

string

The unique ID of the account.

rulesets_ForceConnectionCloseRule

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Account Rulesets

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Account Rulesets API

Metadata

Authentication & Security 1

Paths & Operations 16

Schemas 40

Specification

Source

API Details

Provider

Explore more