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 an Account API

The IP Access Rules for an Account API from APIs.io Engineering Platform — 2 operation(s) for ip access rules for an account.

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

5 operations 2 paths 24 schemas 1 DELETE2 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 an Account 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 5

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

IP Access Rules for an Account 5
GET
/accounts/{account_identifier}/firewall/access_rules/rules
APIs.io Engineering Platform List IP Access rules
ip-access-rules-for-an-account-list-ip-access-rules 10 params → 4XX200
POST
/accounts/{account_identifier}/firewall/access_rules/rules
APIs.io Engineering Platform Create an IP Access rule
ip-access-rules-for-an-account-create-an-ip-access-rule 1 param body → 4XX200
DELETE
/accounts/{account_identifier}/firewall/access_rules/rules/{identifier}
APIs.io Engineering Platform Delete an IP Access rule
ip-access-rules-for-an-account-delete-an-ip-access-rule 2 params body → 4XX200
GET
/accounts/{account_identifier}/firewall/access_rules/rules/{identifier}
APIs.io Engineering Platform Get an IP Access rule
ip-access-rules-for-an-account-get-an-ip-access-rule 2 params → 4XX200
PATCH
/accounts/{account_identifier}/firewall/access_rules/rules/{identifier}
APIs.io Engineering Platform Update an IP Access rule
ip-access-rules-for-an-account-update-an-ip-access-rule 2 params body → 4XX200

Schemas 24

The contract defines 24 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_components-schemas-identifier
string
The unique identifier of the resource.
firewall_identifier
string
Identifier
firewall_notes
string
An informative summary of the rule, typically used as a reminder or explanation.
firewall_ipv6_configuration
object
2 properties
firewall_schemas-rule
object
5 required
firewall_response_single
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_api-response-single-id
object
firewall_schemas-identifier
string
The unique identifier of the IP Access rule.
firewall_cidr_configuration
object
2 properties
firewall_email
string
The contact email address of the user.
firewall_result_info
object
4 properties
firewall_configuration
object
The rule configuration.
firewall_account_identifier
string
Identifier
firewall_api-response-single
object
firewall_response_collection
firewall_api-response-collection
object
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-an-account-api-openapi.yml Raw ↑