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 Infrastructure Access Targets API

The Infrastructure Access Targets API from APIs.io Engineering Platform — 2 operation(s) for infrastructure access targets.

This API exposes 5 operations across 2 paths, and defines 11 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 11 schemas 1 DELETE2 GET1 POST1 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
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Infrastructure Access Targets 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 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Infrastructure Access Targets 5
GET
/accounts/{account_id}/infrastructure/targets
APIs.io Engineering Platform List all targets
infra-targets-list 10 params → 4XX200
POST
/accounts/{account_id}/infrastructure/targets
APIs.io Engineering Platform Create new target
infra-targets-post 1 param body → 4XX200
DELETE
/accounts/{account_id}/infrastructure/targets/{target_id}
APIs.io Engineering Platform Delete target
infra-targets-delete 2 params → 4XX200
GET
/accounts/{account_id}/infrastructure/targets/{target_id}
APIs.io Engineering Platform Get target
infra-targets-get 2 params → 4XX200
PUT
/accounts/{account_id}/infrastructure/targets/{target_id}
APIs.io Engineering Platform Update target
infra-targets-put 2 params body → 4XX200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are infra_Target (5 properties), infra_api-response-common-failure (4 properties), infra_result_info (4 properties), infra_api-response-common (3 properties). Each schema is shown below with its type and property counts.

infra_api-response-common
object
3 properties 3 required
infra_result_info
object
4 properties
infra_Target
object
5 properties 5 required
infra_api-response-single
object
infra_api-response-collection
object
infra_messages
array
infra_TargetArray
array
infra_IPInfo
object
The IPv4/IPv6 address that identifies where to reach a target
2 properties
infra_api-response-common-failure
object
4 properties 4 required
infra_TargetId
string
Target identifier
infra_AccountTag
string
Account identifier

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-infrastructure-access-targets-api-openapi.yml Raw ↑