APIs.io Engineering Platform Custom Indicator Feeds API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Custom Indicator Feeds API
  version: 4.0.0
tags:
- name: Custom Indicator Feeds
paths:
  /accounts/{account_id}/intel/indicator-feeds:
    get:
      operationId: custom-indicator-feeds-get-indicator-feeds
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_response'
          description: Get indicator feeds response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get indicator feeds owned by this account
      tags:
      - Custom Indicator Feeds
      x-api-token-group:
      - Intel Read
    post:
      operationId: custom-indicator-feeds-create-indicator-feeds
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_create_feed'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_create_feed_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds failure response
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_create_feed_response'
          description: Create indicator feed response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create new indicator feed
      tags:
      - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/{feed_id}:
    get:
      operationId: custom-indicator-feeds-get-indicator-feed-metadata
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      - in: path
        name: feed_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_metadata_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_metadata_response'
          description: Get indicator feed metadata
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get indicator feed metadata
      tags:
      - Custom Indicator Feeds
    put:
      operationId: custom-indicator-feeds-update-indicator-feed-metadata
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      - in: path
        name: feed_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_update_public_field_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_update_public_field_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get update public field response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_update_public_field_response'
          description: Get update public field response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update indicator feed metadata
      tags:
      - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/{feed_id}/data:
    get:
      operationId: custom-indicator-feeds-get-indicator-feed-data
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      - in: path
        name: feed_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        '200':
          content:
            text/csv:
              schema:
                type: string
          description: Get indicator feed metadata
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get indicator feed data
      tags:
      - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot:
    put:
      operationId: custom-indicator-feeds-update-indicator-feed-data
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      - in: path
        name: feed_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                source:
                  description: The file to upload
                  example: '@/Users/me/test.stix2'
                  type: string
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_update_feed_response'
          description: Get indicator feed metadata
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update indicator feed data
      tags:
      - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/permissions/add:
    put:
      operationId: custom-indicator-feeds-add-permission
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_permissions_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
          description: Get indicator feed metadata
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Grant permission to indicator feed
      tags:
      - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/permissions/remove:
    put:
      operationId: custom-indicator-feeds-remove-permission
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_permissions_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
          description: Get indicator feed metadata
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Revoke permission to indicator feed
      tags:
      - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator-feeds/permissions/view:
    get:
      operationId: custom-indicator-feeds-view-permissions
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_permission_list_item_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_permission_list_item_response'
          description: Get indicator feed metadata
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List indicator feed permissions
      tags:
      - Custom Indicator Feeds
  /accounts/{account_id}/intel/indicator_feeds/{feed_id}/download:
    get:
      operationId: custom-indicator-feeds-download-indicator-feed-data
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      - in: path
        name: feed_id
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
          description: Get indicator feeds response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_update_feed_response'
          description: Get indicator feed metadata
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Download indicator feed data
      tags:
      - Custom Indicator Feeds
components:
  schemas:
    custom-indicator-feeds_indicator_feed_metadata:
      example:
        created_on: '2023-05-12T12:21:56.777653Z'
        description: example feed description
        id: 1
        is_attributable: false
        is_downloadable: false
        is_public: false
        latest_upload_status: Complete
        modified_on: '2023-06-18T03:13:34.123321Z'
        name: example_feed_1
      properties:
        created_on:
          description: The date and time when the data entry was created
          format: date-time
          type: string
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        id:
          $ref: '#/components/schemas/custom-indicator-feeds_id'
        is_attributable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_attributable'
        is_downloadable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_downloadable'
        is_public:
          $ref: '#/components/schemas/custom-indicator-feeds_is_public'
        latest_upload_status:
          description: Status of the latest snapshot uploaded
          enum:
          - Mirroring
          - Unifying
          - Loading
          - Provisioning
          - Complete
          - Error
          type: string
        modified_on:
          description: The date and time when the data entry was last modified
          format: date-time
          type: string
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
        provider_id:
          $ref: '#/components/schemas/custom-indicator-feeds_provider_id'
        provider_name:
          $ref: '#/components/schemas/custom-indicator-feeds_provider_name'
    custom-indicator-feeds_update_feed:
      properties:
        file_id:
          description: Feed id
          example: 1
          type: integer
        filename:
          description: Name of the file unified in our system
          example: snapshot_file.unified
          type: string
        status:
          description: Current status of upload, should be unified
          example: unified
          type: string
    custom-indicator-feeds_create_feed:
      example:
        description: example feed description
        name: example_feed_1
      properties:
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
    custom-indicator-feeds_is_attributable:
      description: Whether the indicator feed can be attributed to a provider
      type: boolean
    custom-indicator-feeds_name:
      description: The name of the indicator feed
      type: string
    custom-indicator-feeds_indicator_feed_item:
      example:
        created_on: '2023-05-12T12:21:56.777653Z'
        description: example feed description
        id: 1
        is_attributable: false
        is_downloadable: false
        is_public: false
        modified_on: '2023-06-18T03:13:34.123321Z'
        name: example_feed_1
      properties:
        created_on:
          description: The date and time when the data entry was created
          format: date-time
          type: string
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        id:
          $ref: '#/components/schemas/custom-indicator-feeds_id'
        is_attributable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_attributable'
        is_downloadable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_downloadable'
        is_public:
          $ref: '#/components/schemas/custom-indicator-feeds_is_public'
        modified_on:
          description: The date and time when the data entry was last modified
          format: date-time
          type: string
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
    custom-indicator-feeds_create_feed_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_item'
    custom-indicator-feeds_id:
      description: The unique identifier for the indicator feed
      type: integer
    custom-indicator-feeds_provider_name:
      description: The provider of the indicator feed
      type: string
    custom-indicator-feeds_update_public_field_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_item'
    custom-indicator-feeds_permissions_request:
      properties:
        account_tag:
          description: The Cloudflare account tag of the account to change permissions on
          example: 823f45f16fd2f7e21e1e054aga4d2859
          type: string
        feed_id:
          description: The ID of the feed to add/remove permissions on
          example: 1
          type: integer
    custom-indicator-feeds_permissions_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_permissions_update'
    custom-indicator-feeds_api_response_common_failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/custom-indicator-feeds_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/custom-indicator-feeds_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    custom-indicator-feeds_provider_id:
      description: The unique identifier for the provider
      type: string
    custom-indicator-feeds_description:
      description: The description of the example test
      type: string
    custom-indicator-feeds_is_downloadable:
      description: Whether the indicator feed can be downloaded
      type: boolean
    custom-indicator-feeds_permissions_update:
      properties:
        success:
          description: Whether the update succeeded or not
          type: boolean
    custom-indicator-feeds_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/custom-indicator-feeds_messages'
        messages:
          $ref: '#/components/schemas/custom-indicator-feeds_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    custom-indicator-feeds_feed_id:
      description: Indicator feed ID
      example: 12
      type: integer
    custom-indicator-feeds_indicator_feed_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common'
      - properties:
          result:
            example:
            - created_on: '2023-05-12T12:21:56.777653Z'
              description: user specified description 1
              id: 1
              modified_on: '2023-06-18T03:13:34.123321Z'
              name: user_specified_name_1
            - created_on: '2023-05-21T21:43:52.867525Z'
              description: User specified description 2
              id: 2
              modified_on: '2023-06-28T18:46:18.764425Z'
              name: user_specified_name_2
            items:
              $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_item'
            type: array
    custom-indicator-feeds_permission_list_item:
      properties:
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        id:
          $ref: '#/components/schemas/custom-indicator-feeds_id'
        is_attributable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_attributable'
        is_downloadable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_downloadable'
        is_public:
          $ref: '#/components/schemas/custom-indicator-feeds_is_public'
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
    custom-indicator-feeds_indicator_feed_metadata_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_metadata'
    custom-indicator-feeds_update_public_field_request:
      properties:
        description:
          description: The new description of the feed
          example: This is an example description
          type: string
        is_attributable:
          description: The new is_attributable value of the feed
          example: true
          type: boolean
        is_downloadable:
          description: The new is_downloadable value of the feed
          example: true
          type: boolean
        is_public:
          description: The new is_public value of the feed
          example: true
          type: boolean
        name:
          description: The new name of the feed
          example: indicator_list
          type: string
    custom-indicator-feeds_is_public:
      description: Whether the indicator feed is exposed to customers
      type: boolean
    custom-indicator-feeds_api-response-single:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common'
      type: object
    custom-indicator-feeds_permission_list_item_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common'
      - properties:
          result:
            example:
            - description: An important indicator list
              id: 1
              is_attributable: false
              is_downloadable: false
              is_public: false
              name: indicator_list_1
            - description: An even more important indicator list
              id: 2
              is_attributable: true
              is_downloadable: false
              is_public: true
              name: indicator_list_2
            items:
              $ref: '#/components/schemas/custom-indicator-feeds_permission_list_item'
            type: array
    custom-indicator-feeds_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    custom-indicator-feeds_update_feed_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_update_feed'
    custom-indicator-feeds_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey