APIs.io Engineering Platform Security Center Insights API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Security Center Insights API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Security Center Insights
paths:
  /accounts/{account_id}/intel/attack-surface-report/{issue_id}/dismiss:
    put:
      operationId: archive-security-center-insight
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/security-center_identifier'
      - in: path
        name: issue_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                dismiss:
                  default: true
                  type: boolean
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/security-center_api-response-single'
          description: OK
      security:
      - api_email: []
        api_key: []
      - api_token: []
      summary: APIs.io Engineering Platform Archive Security Center Insight
      tags:
      - Security Center Insights
  /accounts/{account_id}/intel/attack-surface-report/issue-types:
    get:
      operationId: get-security-center-issue-types
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/security-center_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/security-center_api-response-common'
                - properties:
                    result:
                      anyOf:
                      - items:
                          type: string
                        type: array
          description: OK
      security:
      - api_email: []
        api_key: []
      - api_token: []
      summary: APIs.io Engineering Platform Get Security Center Issues Types
      tags:
      - Security Center Insights
  /accounts/{account_id}/intel/attack-surface-report/issues:
    get:
      operationId: get-security-center-issues
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/security-center_identifier'
      - in: query
        name: dismissed
        schema:
          $ref: '#/components/schemas/security-center_dismissed'
      - in: query
        name: issue_class
        schema:
          $ref: '#/components/schemas/security-center_issueClasses'
      - in: query
        name: issue_type
        schema:
          $ref: '#/components/schemas/security-center_issueTypes'
      - in: query
        name: product
        schema:
          $ref: '#/components/schemas/security-center_products'
      - in: query
        name: severity
        schema:
          $ref: '#/components/schemas/security-center_severityQueryParam'
      - in: query
        name: subject
        schema:
          $ref: '#/components/schemas/security-center_subjects'
      - in: query
        name: issue_class~neq
        schema:
          $ref: '#/components/schemas/security-center_issueClasses'
      - in: query
        name: issue_type~neq
        schema:
          $ref: '#/components/schemas/security-center_issueTypes'
      - in: query
        name: product~neq
        schema:
          $ref: '#/components/schemas/security-center_products'
      - in: query
        name: severity~neq
        schema:
          $ref: '#/components/schemas/security-center_severityQueryParam'
      - in: query
        name: subject~neq
        schema:
          $ref: '#/components/schemas/security-center_subjects'
      - in: query
        name: page
        schema:
          allOf:
          - $ref: '#/components/schemas/security-center_page'
          default: 1
      - in: query
        name: per_page
        schema:
          allOf:
          - $ref: '#/components/schemas/security-center_perPage'
          default: 25
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/security-center_api-response-common'
                - properties:
                    result:
                      anyOf:
                      - properties:
                          count:
                            $ref: '#/components/schemas/security-center_count'
                          issues:
                            items:
                              $ref: '#/components/schemas/security-center_issue'
                            type: array
                          page:
                            $ref: '#/components/schemas/security-center_page'
                          per_page:
                            $ref: '#/components/schemas/security-center_perPage'
                        type: object
          description: OK
      security:
      - api_email: []
        api_key: []
      - api_token: []
      summary: APIs.io Engineering Platform Get Security Center Issues
      tags:
      - Security Center Insights
  /accounts/{account_id}/intel/attack-surface-report/issues/class:
    get:
      operationId: get-security-center-issue-counts-by-class
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/security-center_identifier'
      - in: query
        name: dismissed
        schema:
          $ref: '#/components/schemas/security-center_dismissed'
      - in: query
        name: issue_class
        schema:
          $ref: '#/components/schemas/security-center_issueClasses'
      - in: query
        name: issue_type
        schema:
          $ref: '#/components/schemas/security-center_issueTypes'
      - in: query
        name: product
        schema:
          $ref: '#/components/schemas/security-center_products'
      - in: query
        name: severity
        schema:
          $ref: '#/components/schemas/security-center_severityQueryParam'
      - in: query
        name: subject
        schema:
          $ref: '#/components/schemas/security-center_subjects'
      - in: query
        name: issue_class~neq
        schema:
          $ref: '#/components/schemas/security-center_issueClasses'
      - in: query
        name: issue_type~neq
        schema:
          $ref: '#/components/schemas/security-center_issueTypes'
      - in: query
        name: product~neq
        schema:
          $ref: '#/components/schemas/security-center_products'
      - in: query
        name: severity~neq
        schema:
          $ref: '#/components/schemas/security-center_severityQueryParam'
      - in: query
        name: subject~neq
        schema:
          $ref: '#/components/schemas/security-center_subjects'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_valueCountsResponse'
          description: OK
      security:
      - api_email: []
        api_key: []
      - api_token: []
      summary: APIs.io Engineering Platform Get Security Center Issue Counts by Class
      tags:
      - Security Center Insights
  /accounts/{account_id}/intel/attack-surface-report/issues/severity:
    get:
      operationId: get-security-center-issue-counts-by-severity
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/security-center_identifier'
      - in: query
        name: dismissed
        schema:
          $ref: '#/components/schemas/security-center_dismissed'
      - in: query
        name: issue_class
        schema:
          $ref: '#/components/schemas/security-center_issueClasses'
      - in: query
        name: issue_type
        schema:
          $ref: '#/components/schemas/security-center_issueTypes'
      - in: query
        name: product
        schema:
          $ref: '#/components/schemas/security-center_products'
      - in: query
        name: severity
        schema:
          $ref: '#/components/schemas/security-center_severityQueryParam'
      - in: query
        name: subject
        schema:
          $ref: '#/components/schemas/security-center_subjects'
      - in: query
        name: issue_class~neq
        schema:
          $ref: '#/components/schemas/security-center_issueClasses'
      - in: query
        name: issue_type~neq
        schema:
          $ref: '#/components/schemas/security-center_issueTypes'
      - in: query
        name: product~neq
        schema:
          $ref: '#/components/schemas/security-center_products'
      - in: query
        name: severity~neq
        schema:
          $ref: '#/components/schemas/security-center_severityQueryParam'
      - in: query
        name: subject~neq
        schema:
          $ref: '#/components/schemas/security-center_subjects'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_valueCountsResponse'
          description: OK
      security:
      - api_email: []
        api_key: []
      - api_token: []
      summary: APIs.io Engineering Platform Get Security Center Issue Counts by Severity
      tags:
      - Security Center Insights
  /accounts/{account_id}/intel/attack-surface-report/issues/type:
    get:
      operationId: get-security-center-issue-counts-by-type
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/security-center_identifier'
      - in: query
        name: dismissed
        schema:
          $ref: '#/components/schemas/security-center_dismissed'
      - in: query
        name: issue_class
        schema:
          $ref: '#/components/schemas/security-center_issueClasses'
      - in: query
        name: issue_type
        schema:
          $ref: '#/components/schemas/security-center_issueTypes'
      - in: query
        name: product
        schema:
          $ref: '#/components/schemas/security-center_products'
      - in: query
        name: severity
        schema:
          $ref: '#/components/schemas/security-center_severityQueryParam'
      - in: query
        name: subject
        schema:
          $ref: '#/components/schemas/security-center_subjects'
      - in: query
        name: issue_class~neq
        schema:
          $ref: '#/components/schemas/security-center_issueClasses'
      - in: query
        name: issue_type~neq
        schema:
          $ref: '#/components/schemas/security-center_issueTypes'
      - in: query
        name: product~neq
        schema:
          $ref: '#/components/schemas/security-center_products'
      - in: query
        name: severity~neq
        schema:
          $ref: '#/components/schemas/security-center_severityQueryParam'
      - in: query
        name: subject~neq
        schema:
          $ref: '#/components/schemas/security-center_subjects'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_api-response-common-failure'
          description: Client Error
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/security-center_valueCountsResponse'
          description: OK
      security:
      - api_email: []
        api_key: []
      - api_token: []
      summary: APIs.io Engineering Platform Get Security Center Issue Counts by Type
      tags:
      - Security Center Insights
components:
  schemas:
    security-center_count:
      description: Total number of results
      example: 1
      type: integer
    security-center_issueTypes:
      example:
      - compliance_violation
      - email_security
      items:
        $ref: '#/components/schemas/security-center_issueType'
      type: array
    security-center_subject:
      example: example.com
      type: string
    security-center_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    security-center_valueCountsResponse:
      allOf:
      - $ref: '#/components/schemas/security-center_api-response-common'
      - properties:
          result:
            anyOf:
            - items:
                properties:
                  count:
                    example: 1
                    type: integer
                  value:
                    type: string
                type: object
              type: array
    security-center_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/security-center_messages'
        messages:
          $ref: '#/components/schemas/security-center_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    security-center_issueClasses:
      example:
      - a_record_dangling
      - always_use_https_not_enabled
      items:
        $ref: '#/components/schemas/security-center_issueClass'
      type: array
    security-center_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    security-center_products:
      example:
      - access
      - dns
      items:
        type: string
      type: array
    security-center_subjects:
      items:
        $ref: '#/components/schemas/security-center_subject'
      type: array
    security-center_perPage:
      description: Number of results per page of results
      example: 25
      maximum: 1000
      minimum: 1
      type: integer
    security-center_issueType:
      enum:
      - compliance_violation
      - email_security
      - exposed_infrastructure
      - insecure_configuration
      - weak_authentication
      type: string
    security-center_dismissed:
      example: false
      type: boolean
    security-center_issueClass:
      example: always_use_https_not_enabled
      type: string
    security-center_api-response-single:
      allOf:
      - $ref: '#/components/schemas/security-center_api-response-common'
      type: object
    security-center_severityQueryParam:
      example:
      - low
      - moderate
      items:
        enum:
        - low
        - moderate
        - critical
        type: string
      type: array
    security-center_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/security-center_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/security-center_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    security-center_page:
      description: Current page within paginated list of results
      example: 1
      type: integer
    security-center_issue:
      properties:
        dismissed:
          example: false
          type: boolean
        id:
          type: string
        issue_class:
          $ref: '#/components/schemas/security-center_issueClass'
        issue_type:
          $ref: '#/components/schemas/security-center_issueType'
        payload:
          type: object
        resolve_link:
          type: string
        resolve_text:
          type: string
        severity:
          enum:
          - Low
          - Moderate
          - Critical
          type: string
        since:
          format: date-time
          type: string
        subject:
          $ref: '#/components/schemas/security-center_subject'
        timestamp:
          format: date-time
          type: string
      type: object
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true