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

Tackle Metering API

The Metering API from Tackle — 2 operation(s) for metering.

Tackle Metering API is one of 25 APIs that Tackle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metering. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 2 paths, and defines 46 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.tackle.io.

5 operations 2 paths 46 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.tackle.io
Authentication
HTTP Bearer, HTTP Basic, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Tackle Metering API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). It accepts HTTP basic authentication (BasicAuthCallback). An API key is passed in the header as subscription-key (HeaderApiKeyAuthCallback). It supports OAuth 2.0 (Oauth2AuthCallback) using the clientCredentials flow.

  • BearerAuth — The Tackle API requires a JWT for authentication. You can get this by [getting your API credentials](https://developers.tackle.io/docs/how-to-get-an-m2m-client…
  • BasicAuthCallback — Use basic for [basic HTTP authentication](https://en.wikipedia.org/wiki/Basicaccessauthentication); this is only used for callbacks
  • HeaderApiKeyAuthCallback — Use headerapikey to specify a custom HTTP request header for authentication. Requests from Tackle will use the specified HTTP header for outbound requests to y…
  • Oauth2AuthCallback — This auth-type is for oauth2 client credentials flow. We will use the clientid and clientsecret to call the tokenurl to get an access token; this is only used…

Paths & Operations 5

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

Metering 5
POST
/v1/metering/usage-records
Create Usage Records
v1-create-metering-usage-records body → 200400401404
PUT
/v1/metering/usage-records
Create or Update Usage Records
v1-create-update-metering-usage-records body → 200400401404409
GET
/v1/metering/usage-records
List Usage Records
v1-list-metering-usage-records 13 params → 200401
GET
/v1/metering/usage-records/{usage_record_id}
Get a Usage Record
v1-get-metering-usage-record 1 param → 200400401404
DELETE
/v1/metering/usage-records/{usage_record_id}
Delete a Usage Record
v1-delete-metering-usage-record 1 param → 200400401404

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are UsageRecord (15 properties), GcpUsageRecordRequestByProductAndCustomer (8 properties), GcpUsageRecordRequestBySubscription (7 properties), AzureUsageRecordRequestByProductAndCustomer (7 properties). Each schema is shown below with its type and property counts.

UsageRecordLink
string
Url for one or more metering usage records
TimestampNotNull
string
ISO format timestamp with UTC offset
AwsUsageRecordRequestBySubscription
object
6 properties 4 required
TimestampZeroUtcOffsetOptional
string
Optional ISO format timestamp with zero UTC offset
AwsCustomerId
string
AWS Account Reference ID
AwsDimension
object
Product Dimension
4 properties 2 required
UsageRecordTest
string
Specifies if the Usage Record is a test. When NOT null, the record is a test and is not sent to the marketplace
CustomerId
AwsUsageRecordRequest
UsageRecord
object
Metering Usage Record
15 properties
TimestampZeroUtcOffset
string
ISO format timestamp with zero UTC offset
RedHatCustomerId
string
Red Hat Customer Id
SubscriptionId
string
Subscription Id
RedHatCloud
string
Red Hat Cloud
AzureUsageRecordRequest
AwsCloud
string
AWS Cloud
NextPageToken
string
A page token to fetch the next page of results using the associated "page" query parameter
AzureDimension
object
Product Dimension
2 properties 2 required
AzureUsageRecordRequestBySubscription
object
6 properties 4 required
UsageRecordMetadata
object
Usage Record Metadata
1 property
Uuid
string
UUID
AzureCustomerId
string
Azure Subscription ID
UsageRecordsMetadata
object
Usage Record Metadata
2 properties
Error
object
4 properties 3 required
UsageRecordListResponse
object
Get All Usage Records Response
2 properties
UsageRecordResponse
object
Usage Record Response
2 properties
AwsProductId
string
AWS Product Code
Clouds
A string identifying a cloud marketplace
GcpUsageRecordRequest
AzureCloud
string
Azure Cloud
UsageRecordReason
string
Explanation of Status
GcpUsageRecordRequestByProductAndCustomer
object
8 properties 6 required
UsageRecordDelete
object
Delete Usage Record Response
1 property
UsageRecordStatus
string
Status of usage record
GcpUsageRecordRequestBySubscription
object
7 properties 4 required
ProductId
Cloud Marketplace issued ID for a product
AzureProductId
string
Azure Offer ID
GcpProductId
string
GCP Solution ID
GcpDimension
object
3 properties 2 required
AwsUsageRecordRequestByProductAndCustomer
object
7 properties 5 required
Timestamp
string
ISO format timestamp with UTC offset
AzureUsageRecordRequestByProductAndCustomer
object
7 properties 5 required
GcpCloud
string
GCP Cloud
GcpCustomerId
string
GCP External Account ID
RedHatProductId
string
Red Hat Product Id
Spec_prod_Error
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tackle-metering-api-openapi.yml Raw ↑

Other APIs Tackle publishes across the network.

Tackle Authentication API
Tackle Contracts API
Tackle Currencies API
Tackle Disbursements API
Tackle Entitlements API
Tackle Groups API
Tackle Invitations API
Tackle Invoices API
Tackle Marketplace API
Tackle Notifications API
Tackle Opportunities API
Tackle Partners API