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

APIs.io Engineering Platform IP Access Rules for a User API

The IP Access Rules for a User API from APIs.io Engineering Platform — 2 operation(s) for ip access rules for a user.

This API exposes 4 operations across 2 paths, and defines 19 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.

4 operations 2 paths 19 schemas 1 DELETE1 GET1 PATCH1 POST

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
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform IP Access Rules for a User 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 4

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

IP Access Rules for a User 4
GET
/user/firewall/access_rules/rules
APIs.io Engineering Platform List IP Access rules
ip-access-rules-for-a-user-list-ip-access-rules 9 params → 4XX200
POST
/user/firewall/access_rules/rules
APIs.io Engineering Platform Create an IP Access rule
ip-access-rules-for-a-user-create-an-ip-access-rule body → 4XX200
DELETE
/user/firewall/access_rules/rules/{identifier}
APIs.io Engineering Platform Delete an IP Access rule
ip-access-rules-for-a-user-delete-an-ip-access-rule 1 param body → 4XX200
PATCH
/user/firewall/access_rules/rules/{identifier}
APIs.io Engineering Platform Update an IP Access rule
ip-access-rules-for-a-user-update-an-ip-access-rule 1 param body → 4XX200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are firewall_rule (7 properties), firewall_api-response-common-failure (4 properties), firewall_api-response-common (4 properties), firewall_result_info (4 properties). Each schema is shown below with its type and property counts.

firewall_ip_configuration
object
2 properties
firewall_notes
string
An informative summary of the rule, typically used as a reminder or explanation.
firewall_ipv6_configuration
object
2 properties
firewall_rule_single_response
firewall_rule
object
7 properties 4 required
firewall_api-response-common
object
4 properties 4 required
firewall_schemas-mode
string
The action to apply to a matched request.
firewall_country_configuration
object
2 properties
firewall_messages
array
firewall_asn_configuration
object
2 properties
firewall_schemas-identifier
string
The unique identifier of the IP Access rule.
firewall_cidr_configuration
object
2 properties
firewall_result_info
object
4 properties
firewall_configuration
object
The rule configuration.
firewall_rule_collection_response
firewall_api-response-single
object
firewall_api-response-collection
object
firewall_rule_single_id_response
firewall_api-response-common-failure
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-ip-access-rules-for-a-user-api-openapi.yml Raw ↑