Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Custom Indicator Feeds API

The Custom Indicator Feeds API from APIs.io Engineering Platform — 8 operation(s) for custom indicator feeds.

This API exposes 10 operations across 8 paths, and defines 29 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

10 operations 8 paths 29 schemas 5 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Custom Indicator Feeds API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 5 GET, 1 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Indicator Feeds 10
GET
/accounts/{account_id}/intel/indicator-feeds
APIs.io Engineering Platform Get indicator feeds owned by this account
custom-indicator-feeds-get-indicator-feeds 1 param → 4XX200
POST
/accounts/{account_id}/intel/indicator-feeds
APIs.io Engineering Platform Create new indicator feed
custom-indicator-feeds-create-indicator-feeds 1 param body → 4XX200
GET
/accounts/{account_id}/intel/indicator-feeds/{feed_id}
APIs.io Engineering Platform Get indicator feed metadata
custom-indicator-feeds-get-indicator-feed-metadata 2 params → 4XX200
PUT
/accounts/{account_id}/intel/indicator-feeds/{feed_id}
APIs.io Engineering Platform Update indicator feed metadata
custom-indicator-feeds-update-indicator-feed-metadata 2 params body → 4XX200
GET
/accounts/{account_id}/intel/indicator-feeds/{feed_id}/data
APIs.io Engineering Platform Get indicator feed data
custom-indicator-feeds-get-indicator-feed-data 2 params → 4XX200
PUT
/accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot
APIs.io Engineering Platform Update indicator feed data
custom-indicator-feeds-update-indicator-feed-data 2 params body → 4XX200
PUT
/accounts/{account_id}/intel/indicator-feeds/permissions/add
APIs.io Engineering Platform Grant permission to indicator feed
custom-indicator-feeds-add-permission 1 param body → 4XX200
PUT
/accounts/{account_id}/intel/indicator-feeds/permissions/remove
APIs.io Engineering Platform Revoke permission to indicator feed
custom-indicator-feeds-remove-permission 1 param body → 4XX200
GET
/accounts/{account_id}/intel/indicator-feeds/permissions/view
APIs.io Engineering Platform List indicator feed permissions
custom-indicator-feeds-view-permissions 1 param → 4XX200
GET
/accounts/{account_id}/intel/indicator_feeds/{feed_id}/download
APIs.io Engineering Platform Download indicator feed data
custom-indicator-feeds-download-indicator-feed-data 2 params → 4XX200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are custom-indicator-feeds_indicator_feed_metadata (11 properties), custom-indicator-feeds_indicator_feed_item (8 properties), custom-indicator-feeds_permission_list_item (6 properties), custom-indicator-feeds_update_public_field_request (5 properties). Each schema is shown below with its type and property counts.

custom-indicator-feeds_indicator_feed_item
object
8 properties
custom-indicator-feeds_indicator_feed_metadata_response
custom-indicator-feeds_name
string
The name of the indicator feed
custom-indicator-feeds_api-response-common
object
3 properties 3 required
custom-indicator-feeds_indicator_feed_metadata
object
11 properties
custom-indicator-feeds_id
integer
The unique identifier for the indicator feed
custom-indicator-feeds_is_attributable
boolean
Whether the indicator feed can be attributed to a provider
custom-indicator-feeds_create_feed
object
2 properties
custom-indicator-feeds_is_public
boolean
Whether the indicator feed is exposed to customers
custom-indicator-feeds_update_feed
object
3 properties
custom-indicator-feeds_indicator_feed_response
custom-indicator-feeds_provider_id
string
The unique identifier for the provider
custom-indicator-feeds_update_public_field_request
object
5 properties
custom-indicator-feeds_description
string
The description of the example test
custom-indicator-feeds_api-response-single
object
custom-indicator-feeds_provider_name
string
The provider of the indicator feed
custom-indicator-feeds_create_feed_response
custom-indicator-feeds_permissions_response
custom-indicator-feeds_messages
array
custom-indicator-feeds_permission_list_item_response
custom-indicator-feeds_permissions_request
object
2 properties
custom-indicator-feeds_identifier
string
Identifier
custom-indicator-feeds_feed_id
integer
Indicator feed ID
custom-indicator-feeds_api_response_common_failure
object
4 properties 4 required
custom-indicator-feeds_is_downloadable
boolean
Whether the indicator feed can be downloaded
custom-indicator-feeds_update_public_field_response
custom-indicator-feeds_permissions_update
object
1 property
custom-indicator-feeds_permission_list_item
object
6 properties
custom-indicator-feeds_update_feed_response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-custom-indicator-feeds-api-openapi.yml Raw ↑