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

AWS Security Hub Insights API

The Insights API from AWS Security Hub — 4 operation(s) for insights.

AWS Security Hub Insights API is one of 12 APIs that AWS Security Hub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Insights. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths. It is described by OpenAPI 3.1.0, at version 2018-10-26.

Requests are made against a single base URL, https://securityhub.{region}.amazonaws.com.

5 operations 4 paths 0 schemas 1 DELETE1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2018-10-26
Base URL
https://securityhub.us-east-1.amazonaws.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

AWS Security Hub Insights API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (SigV4). By default, every request must be authenticated.

  • SigV4 — AWS Signature Version 4 signed Authorization header

Paths & Operations 5

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

Insights 5
POST
/insights
Create an insight
CreateInsight body → 200
POST
/insights/get
Get insights
GetInsights body → 200
GET
/insights/results/{InsightArn}
Get insight results
GetInsightResults 1 param → 200
PATCH
/insights/{InsightArn}
Update an insight
UpdateInsight 1 param body → 200
DELETE
/insights/{InsightArn}
Delete an insight
DeleteInsight 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-security-hub-insights-api-openapi.yml Raw ↑

Other APIs AWS Security Hub publishes across the network.

AWS Security Hub CSPM API
AWS Security Hub Action Targets API
AWS Security Hub Automation Rules API
AWS Security Hub Configuration Policies API
AWS Security Hub Controls API
AWS Security Hub Findings API
AWS Security Hub Hub API
AWS Security Hub Invitations API
AWS Security Hub Members API
AWS Security Hub Standards API
AWS Security Hub Tags API