APIs.io Engineering Platform Sinkhole Config API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Sinkhole Config 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: Sinkhole Config
paths:
  /accounts/{account_id}/intel/sinkholes:
    get:
      operationId: sinkhole-config-get-sinkholes
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/intel-sinkholes_identifier'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/intel-sinkholes_get_sinkholes_response'
          description: Successful Response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List sinkholes owned by this account
      tags:
      - Sinkhole Config
      x-api-token-group:
      - Intel Read
components:
  schemas:
    intel-sinkholes_id:
      description: The unique identifier for the sinkhole
      type: integer
    intel-sinkholes_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    intel-sinkholes_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    intel-sinkholes_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/intel-sinkholes_messages'
        messages:
          $ref: '#/components/schemas/intel-sinkholes_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    intel-sinkholes_get_sinkholes_response:
      allOf:
      - $ref: '#/components/schemas/intel-sinkholes_api-response-common'
      - properties:
          result:
            example:
            - account_tag: 233f45e61fd1f7e21e1e154ede4q2859
              created_on: '2023-05-12T12:21:56.777653Z'
              description: user specified description 1
              id: 1
              modified_on: '2023-06-18T03:13:34.123321Z'
              name: sinkhole_1
              r2_bucket: my_bucket
              r2_id: <r2_id>
            - account_tag: 233f45e61fd1f7e21e1e154ede4q2859
              created_on: '2023-05-21T21:43:52.867525Z'
              description: user specified description 2
              id: 2
              modified_on: '2023-06-28T18:46:18.764425Z'
              name: sinkhole_1
              r2_bucket: my_bucket
              r2_id: <r2_id>
            items:
              $ref: '#/components/schemas/intel-sinkholes_sinkhole_item'
            type: array
    intel-sinkholes_sinkhole_item:
      example:
        account_tag: 233f45e61fd1f7e21e1e154ede4q2859
        created_on: '2023-05-12T12:21:56.777653Z'
        description: user specified description 1
        id: 1
        modified_on: '2023-06-18T03:13:34.123321Z'
        name: sinkhole_1
        r2_bucket: my_bucket
        r2_id: <r2_id>
      properties:
        account_tag:
          description: The account tag that owns this sinkhole
          type: string
        created_on:
          description: The date and time when the sinkhole was created
          format: date-time
          type: string
        id:
          $ref: '#/components/schemas/intel-sinkholes_id'
        modified_on:
          description: The date and time when the sinkhole was last modified
          format: date-time
          type: string
        name:
          $ref: '#/components/schemas/intel-sinkholes_name'
        r2_bucket:
          description: The name of the R2 bucket to store results
          type: string
        r2_id:
          description: The id of the R2 instance
          type: string
    intel-sinkholes_name:
      description: The name of the sinkhole
      type: string
  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