AWS Security Hub Security Hub Softwarev2 API

The Security Hub Softwarev2 API from AWS Security Hub — 3 operation(s) for security hub softwarev2.

GitHub OpenAPI

Operations 3

POST /softwarev2/resources Get Software Resources V2 #
POST /softwarev2/statistics Get Software Statistics V2 #
POST /softwarev2 Get Software V2 #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/aws-security-hub:aws-security-hub-softwarev2-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aws-security-hub-softwarev2-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS SecurityHub Softwarev2 API
  version: '2018-10-26'
  description: Generated from AWS's published Smithy model for AWS SecurityHub. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://securityhub.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /softwarev2/resources:
    post:
      operationId: GetSoftwareResourcesV2
      summary: Get Software Resources V2
      description: Returns a list of resources that contain a specific software package. You identify the package with PackageName
        and PackageType. To narrow the results to one version of the package, include PackageVersion. You can use the Scopes
        parameter to define the data boundary for the query. Currently, Scopes supports AwsOrganizations, which lets you retrieve
        resources from your entire organization or from specific organizational units. Only the delegated administrator account
        can use Scopes. You can use the Filters parameter to further refine results based on resource attributes, such as
        ResourceType or Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSoftwareResourcesV2Response'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: OrganizationalUnitNotFoundException; OrganizationNotFoundException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationalUnitNotFoundException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSoftwareResourcesV2Request'
      tags:
      - Softwarev2
  /softwarev2/statistics:
    post:
      operationId: GetSoftwareStatisticsV2
      summary: Get Software Statistics V2
      description: Retrieves aggregated counts of software packages installed on your resources, grouped by a field that you
        specify. For example, you can return the most common package types or the accounts with the most installed packages.
        Each count is the number of package-to-resource pairs that match the grouping value. A package installed on three
        resources contributes three to the count. You can use the Scopes parameter to define the data boundary for the query.
        Currently, Scopes supports AwsOrganizations, which lets you aggregate software from your entire organization or from
        specific organizational units. Only the delegated administrator account can use Scopes. This operation doesn't paginate.
        Use MaxStatisticResults to control how many grouping values are returned.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSoftwareStatisticsV2Response'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: OrganizationalUnitNotFoundException; OrganizationNotFoundException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationalUnitNotFoundException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSoftwareStatisticsV2Request'
      tags:
      - Softwarev2
  /softwarev2:
    post:
      operationId: GetSoftwareV2
      summary: Get Software V2
      description: Returns a list of software packages installed on your resources. Each result identifies a package by name,
        version, and type, and includes the number of resources that contain that package. You can use the Scopes parameter
        to define the data boundary for the query. Currently, Scopes supports AwsOrganizations, which lets you retrieve software
        from your entire organization or from specific organizational units. Only the delegated administrator account can
        use Scopes. You can use the Filters parameter to refine results based on package and resource attributes. You can
        use Scopes and Filters independently or together. When both are provided, Scopes narrows the data set first, and then
        Filters refines results within that scoped data set. To list the resources that contain a specific package, use GetSoftwareResourcesV2.
        To get counts of software grouped by a field, use GetSoftwareStatisticsV2.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSoftwareV2Response'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: OrganizationalUnitNotFoundException; OrganizationNotFoundException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationalUnitNotFoundException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSoftwareV2Request'
      tags:
      - Softwarev2
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: securityhub
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    AwsOrganizationScope:
      type: object
      properties:
        OrganizationId:
          type: string
          description: The unique identifier (ID) of the organization (for example, o-abcd1234567890). The organization must
            be the delegated administrator's own organization. If you omit this value and provide OrganizationalUnitId, Security
            Hub uses the caller's organization ID.
        OrganizationalUnitId:
          type: string
          description: The unique identifier (ID) of the organizational unit (OU) (for example, ou-ab12-cd345678). The OU
            must exist within the delegated administrator's own organization. When specified, the results include only data
            from accounts in this OU.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    GetSoftwareResourcesV2Request:
      type: object
      properties:
        PackageName:
          type: string
          description: The name of the software package, for example openssl. This value must match the PackageName returned
            by GetSoftwareV2.
        PackageType:
          type: string
          description: The type of the software package, for example operating-system, application, or library. This value
            must match the PackageType returned by GetSoftwareV2.
        PackageVersion:
          type: string
          description: The version of the software package, for example 3.0.8. If you omit this value, the response includes
            resources that contain any version of the package.
        Filters:
          $ref: '#/components/schemas/SoftwareFilters'
        Scopes:
          $ref: '#/components/schemas/SoftwareScopes'
        SortCriteria:
          type: array
          items:
            $ref: '#/components/schemas/SortCriterion'
          description: The resource attribute used to sort the list of returned resources, for example Region or ResourceType.
            You can specify one sort criterion.
        NextToken:
          type: string
          description: The token required for pagination. On your first call, set the value of this parameter to NULL. For
            subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous
            response. A token expires one hour after it's issued. If you change the request parameters between calls, the
            token is no longer valid and the request fails with a ValidationException.
        MaxResults:
          type: integer
          description: The maximum number of results to return. Valid values are 1–100. The default is 100.
      required:
      - PackageName
      - PackageType
    GetSoftwareResourcesV2Response:
      type: object
      properties:
        SoftwareResources:
          type: array
          items:
            $ref: '#/components/schemas/SoftwareResourceResult'
          description: An array of resources that contain the specified software package.
        NextToken:
          type: string
          description: The pagination token to use to request the next page of results. Otherwise, this parameter is null.
      required:
      - SoftwareResources
    GetSoftwareStatisticsV2Request:
      type: object
      properties:
        GroupByRules:
          type: array
          items:
            $ref: '#/components/schemas/SoftwareGroupByRule'
          description: How software statistics should be aggregated and organized in the response.
        Scopes:
          $ref: '#/components/schemas/SoftwareScopes'
        SortOrder:
          type: string
          enum:
          - asc
          - desc
          description: Sorts aggregated statistics by count. The default is descending, which returns the values with the
            highest counts first.
        MaxStatisticResults:
          type: integer
          description: The maximum number of grouping values to return. Valid values are 1–400. The default is 400.
      required:
      - GroupByRules
    GetSoftwareStatisticsV2Response:
      type: object
      properties:
        GroupByResults:
          type: array
          items:
            $ref: '#/components/schemas/GroupByResult'
          description: The aggregated statistics about software based on the specified grouping rule.
      required:
      - GroupByResults
    GetSoftwareV2Request:
      type: object
      properties:
        Filters:
          $ref: '#/components/schemas/SoftwareFilters'
        Scopes:
          $ref: '#/components/schemas/SoftwareScopes'
        SortCriteria:
          type: array
          items:
            $ref: '#/components/schemas/SortCriterion'
          description: The software attributes used to sort the list of returned software packages. You can't sort by ResourceCount.
        NextToken:
          type: string
          description: The token required for pagination. On your first call, set the value of this parameter to NULL. For
            subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous
            response. A token expires one hour after it's issued. If you change Filters or SortCriteria between calls, the
            token is no longer valid and the request fails with a ValidationException.
        MaxResults:
          type: integer
          description: The maximum number of results to return. Valid values are 1–100. The default is 100.
    GetSoftwareV2Response:
      type: object
      properties:
        Software:
          type: array
          items:
            $ref: '#/components/schemas/SoftwareResult'
          description: An array of software packages returned by the operation.
        NextToken:
          type: string
          description: The pagination token to use to request the next page of results. Otherwise, this parameter is null.
      required:
      - Software
    GroupByResult:
      type: object
      properties:
        GroupByField:
          type: string
          description: The attribute by which filtered security findings should be grouped.
        GroupByValues:
          type: array
          items:
            $ref: '#/components/schemas/GroupByValue'
          description: An array of grouped values and their respective counts for each GroupByField.
    GroupByValue:
      type: object
      properties:
        FieldValue:
          type: string
          description: The value of the field by which findings are grouped.
        Count:
          type: integer
          description: The number of findings for a specific FieldValue and GroupByField.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    OrganizationalUnitNotFoundException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    SoftwareCompositeFilter:
      type: object
      properties:
        StringFilters:
          type: array
          items:
            $ref: '#/components/schemas/SoftwareStringFilter'
          description: Enables filtering based on string field values.
        NestedCompositeFilters:
          type: array
          items:
            $ref: '#/components/schemas/SoftwareCompositeFilter'
          description: Provides an additional level of filtering, creating a three-layer nested structure. The first layer
            is a CompositeFilters array with a CompositeOperator (AND/OR). The second layer is a CompositeFilter object that
            contains direct filters and NestedCompositeFilters. The third layer is NestedCompositeFilters, which contains
            additional filter conditions.
        Operator:
          type: string
          enum:
          - AND
          - OR
          description: The logical operator used to combine multiple filter conditions.
    SoftwareFilters:
      type: object
      properties:
        CompositeFilters:
          type: array
          items:
            $ref: '#/components/schemas/SoftwareCompositeFilter'
          description: A collection of complex filtering conditions that can be applied to software packages.
        CompositeOperator:
          type: string
          enum:
          - AND
          - OR
          description: The logical operator used to combine multiple filter conditions in the structure.
    SoftwareGroupByRule:
      type: object
      properties:
        GroupByField:
          type: string
          enum:
          - AccountId
          - PackageName
          - PackageVersion
          - PackageType
          - Region
          - ResourceRegion
          - ResourceType
          - ResourceId
          - ResourceProvider
          - ResourceOwnerAccountId
          - ResourceOwnerOrgId
          - ResourceCloudPartition
          description: Specifies the attribute that software statistics should be grouped by.
        Filters:
          $ref: '#/components/schemas/SoftwareFilters'
      required:
      - GroupByField
    SoftwareResourceResult:
      type: object
      properties:
        AccountId:
          type: string
          description: The Amazon Web Services account that recorded the resource data in Security Hub.
        ResourceType:
          type: string
          description: The type of resource, for example AWS::EC2::Instance or AWS::Lambda::Function.
        Region:
          type: string
          description: The Amazon Web Services Region that recorded the resource data in Security Hub.
        ResourceId:
          type: string
          description: The unique identifier for a resource.
        ResourceProvider:
          type: string
          description: The cloud provider where the resource exists. Valid values are AWS and Azure.
        ResourceOwnerOrgId:
          type: string
          description: The identifier of the cloud organization that owns the resource. For Amazon Web Services resources,
            this is the Organizations ID. For Azure resources, this is the Azure tenant ID.
        ResourceOwnerAccountId:
          type: string
          description: The identifier of the cloud account that owns the resource. For Amazon Web Services resources, this
            is the Amazon Web Services account ID. For Azure resources, this is the Azure subscription ID.
        ResourceCloudPartition:
          type: string
          description: The cloud partition where the resource exists. For Amazon Web Services, valid values include aws, aws-cn,
            and aws-us-gov. This field isn't returned for cloud providers that don't use partitions.
        ResourceRegion:
          type: string
          description: The native cloud region where the resource is located. For Amazon Web Services, this is an Amazon Web
            Services Region (for example, us-east-1). For Azure resources, this is the Azure region (for example, westus2).
      required:
      - AccountId
      - ResourceType
      - Region
      - ResourceId
    SoftwareResult:
      type: object
      properties:
        PackageName:
          type: string
          description: The name of the software package.
        PackageVersion:
          type: string
          description: The version of the software package.
        PackageType:
          type: string
          description: The type of the software package, for example operating-system, application, or library.
        ResourceCount:
          type: integer
          description: The number of resources that contain this software package. To list these resources, call GetSoftwareResourcesV2.
      required:
      - PackageName
      - PackageType
      - ResourceCount
    SoftwareScopes:
      type: object
      properties:
        AwsOrganizations:
          type: array
          items:
            $ref: '#/components/schemas/AwsOrganizationScope'
          description: A list of Organizations scopes to include in the query results. Each entry in the list specifies an
            organization or organizational unit to include for the delegated administrator's account. If the list specifies
            multiple entries, the entries are combined using OR logic.
    SoftwareStringFilter:
      type: object
      properties:
        FieldName:
          type: string
          enum:
          - AccountId
          - PackageName
          - PackageVersion
          - PackageType
          - Region
          - ResourceRegion
          - ResourceType
          - ResourceId
          - ResourceProvider
          - ResourceOwnerAccountId
          - ResourceOwnerOrgId
          - ResourceCloudPartition
          description: The name of the field.
        Filter:
          $ref: '#/components/schemas/StringFilter'
    SortCriterion:
      type: object
      properties:
        Field:
          type: string
          description: The finding attribute used to sort findings.
        SortOrder:
          type: string
          enum:
          - asc
          - desc
          description: The order used to sort findings.
    StringFilter:
      type: object
      properties:
        Value:
          type: string
          description: The string filter value. Filter values are case sensitive. For example, the product name for control-based
            findings is Security Hub CSPM. If you provide security hub as the filter value, there's no match.
        Comparison:
          type: string
          enum:
          - EQUALS
          - PREFIX
          - NOT_EQUALS
          - PREFIX_NOT_EQUALS
          - CONTAINS
          - NOT_CONTAINS
          - CONTAINS_WORD
          description: 'The condition to apply to a string value when filtering Security Hub CSPM findings. To search for
            values that have the filter value, use one of the following comparison operators: To search for values that include
            the filter value, use CONTAINS. For example, the filter Title CONTAINS CloudFront matches findings that have a
            Title that includes the string CloudFront. To search for values that contain a word matching the filter value,
            regardless of case, use CONTAINS_WORD. For example, the filter Title CONTAINS_WORD lambda matches a finding whose
            Title is GuardDuty Lambda Protection, because the '
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/securityhub/service/2018-10-26/securityhub-2018-10-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)