Amazon Inspector Inspector Ondemand API

The Inspector Ondemand API from Amazon Inspector — 3 operation(s) for inspector ondemand.

GitHub OpenAPI

Operations 3

POST /ondemand/scan/status Get On Demand Scan Status #
POST /ondemand/scans List On Demand Scans #
POST /ondemand/scan Start On Demand Scan #

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/amazon-inspector:amazon-inspector-ondemand-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

amazon-inspector-ondemand-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Inspector2 Ondemand API
  version: '2020-06-08'
  description: Generated from AWS's published Smithy model for Inspector2. 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://inspector2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /ondemand/scan/status:
    post:
      operationId: GetOnDemandScanStatus
      summary: Get On Demand Scan Status
      description: Retrieves the status of a specific on-demand scan for a resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOnDemandScanStatusResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOnDemandScanStatusRequest'
      tags:
      - Ondemand
  /ondemand/scans:
    post:
      operationId: ListOnDemandScans
      summary: List On Demand Scans
      description: Lists the on-demand scans for a resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOnDemandScansResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListOnDemandScansRequest'
      tags:
      - Ondemand
  /ondemand/scan:
    post:
      operationId: StartOnDemandScan
      summary: Start On Demand Scan
      description: Starts an on-demand scan of the specified resource, such as an Amazon Machine Image (AMI).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartOnDemandScanResponse'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartOnDemandScanRequest'
      tags:
      - Ondemand
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: inspector2
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the conflicting resource.
        resourceType:
          type: string
          description: The type of the conflicting resource.
      required:
      - message
      - resourceId
      - resourceType
    GetOnDemandScanStatusRequest:
      type: object
      properties:
        resourceId:
          type: string
          description: The ID of the resource whose on-demand scan status is being requested.
        scanId:
          type: string
          description: The unique identifier of the on-demand scan whose status is being requested.
        resourceType:
          type: string
          enum:
          - AMI
          description: The type of the resource whose on-demand scan status is being requested.
      required:
      - resourceId
      - scanId
      - resourceType
    GetOnDemandScanStatusResponse:
      type: object
      properties:
        scanId:
          type: string
          description: The unique identifier of the on-demand scan.
        resourceId:
          type: string
          description: The ID of the resource that was scanned.
        resourceType:
          type: string
          enum:
          - AMI
          description: The type of the resource that was scanned.
        scanStatus:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESSFUL
          - FAILED
          description: The current status of the on-demand scan.
        scanStatusReason:
          type: string
          enum:
          - ACCESS_DENIED
          - INTERNAL_ERROR
          - STORAGE_LIMIT_EXCEEDED
          - EXTRACTION_COLLECTION_TIME_LIMIT_EXCEEDED
          - UNSUPPORTED_OS
          - RESOURCE_TERMINATED
          description: The reason associated with the current on-demand scan status.
        startedAt:
          type: string
          description: The date and time, in ISO 8601 format, when the on-demand scan started.
        completedAt:
          type: string
          description: The date and time, in ISO 8601 format, when the on-demand scan completed. This field is absent if the
            scan has not completed.
      required:
      - scanId
      - resourceId
      - resourceType
      - scanStatus
      - startedAt
    InternalServerException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the request.
      required:
      - message
    ListOnDemandScansRequest:
      type: object
      properties:
        resourceId:
          type: string
          description: The ID of the resource whose on-demand scans are being listed.
        resourceType:
          type: string
          enum:
          - AMI
          description: The type of the resource whose on-demand scans are being listed.
        maxResults:
          type: integer
          description: The maximum number of results to return in a single page of the response.
        nextToken:
          type: string
          description: A pagination token from a previous response used to retrieve the next page of results.
      required:
      - resourceId
      - resourceType
    ListOnDemandScansResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/OnDemandScan'
          description: The list of on-demand scans that match the request.
        nextToken:
          type: string
          description: A pagination token to use in a subsequent request to retrieve the next page of results. This field
            is absent when there are no more results.
      required:
      - items
    OnDemandScan:
      type: object
      properties:
        scanId:
          type: string
          description: The unique identifier of the on-demand scan.
        resourceId:
          type: string
          description: The ID of the resource that was scanned.
        resourceType:
          type: string
          enum:
          - AMI
          description: The type of the resource that was scanned.
        scanStatus:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESSFUL
          - FAILED
          description: The current status of the on-demand scan.
        scanStatusReason:
          type: string
          enum:
          - ACCESS_DENIED
          - INTERNAL_ERROR
          - STORAGE_LIMIT_EXCEEDED
          - EXTRACTION_COLLECTION_TIME_LIMIT_EXCEEDED
          - UNSUPPORTED_OS
          - RESOURCE_TERMINATED
          description: The reason associated with the current on-demand scan status.
        startedAt:
          type: string
          description: The date and time, in ISO 8601 format, when the on-demand scan started.
        completedAt:
          type: string
          description: The date and time, in ISO 8601 format, when the on-demand scan completed. This field is absent if the
            scan has not completed.
      required:
      - scanId
      - resourceId
      - resourceType
      - scanStatus
      - startedAt
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    StartOnDemandScanRequest:
      type: object
      properties:
        resourceId:
          type: string
          description: The ID of the resource to scan on demand.
        resourceType:
          type: string
          enum:
          - AMI
          description: The type of the resource to scan on demand.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - resourceId
      - resourceType
    StartOnDemandScanResponse:
      type: object
      properties:
        scanId:
          type: string
          description: The unique identifier assigned to the on-demand scan that was started.
      required:
      - scanId
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the request.
      required:
      - message
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: The reason for the validation failure.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The fields that failed validation.
      required:
      - message
      - reason
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the validation exception.
        message:
          type: string
          description: The validation exception message.
      required:
      - name
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/inspector2/service/2020-06-08/inspector2-2020-06-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)