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 Zero Trust Audit SSH Settings API

The Zero Trust Audit SSH Settings API from APIs.io Engineering Platform — 1 operation(s) for zero trust audit ssh settings.

This API exposes 2 operations across 1 path, and defines 10 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.

2 operations 1 paths 10 schemas 1 GET1 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 Zero Trust Audit SSH Settings 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 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Zero Trust Audit SSH Settings 2
GET
/accounts/{account_id}/gateway/audit_ssh_settings
APIs.io Engineering Platform Get Zero Trust Audit SSH settings
zero-trust-get-audit-ssh-settings 1 param → 4XX200
PUT
/accounts/{account_id}/gateway/audit_ssh_settings
APIs.io Engineering Platform Update Zero Trust Audit SSH settings
zero-trust-update-audit-ssh-settings 1 param body → 4XX200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are zero-trust-gateway_settings (4 properties), zero-trust-gateway_api-response-common-failure (4 properties), zero-trust-gateway_api-response-common (3 properties). Each schema is shown below with its type and property counts.

zero-trust-gateway_messages
array
zero-trust-gateway_audit_ssh_settings_components-schemas-uuid
string
Seed ID
zero-trust-gateway_api-response-common-failure
object
4 properties 4 required
zero-trust-gateway_timestamp
string
zero-trust-gateway_api-response-common
object
3 properties 3 required
zero-trust-gateway_identifier
string
zero-trust-gateway_api-response-single
object
zero-trust-gateway_public_key
string
SSH encryption public key
zero-trust-gateway_audit_ssh_settings_components-schemas-single_response
zero-trust-gateway_settings
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-zero-trust-audit-ssh-settings-api-openapi.yml Raw ↑