Aptible Metric Drains API
The MetricDrains API from Aptible — 2 operation(s) for metricdrains.
OpenAPI Specification
openapi: 3.2.0
info:
contact:
email: support@aptible.com
description: REST API for the core Aptible platform.
title: Aptible API v1 Metric Drains API
version: v1
servers:
- url: '{baseUrl}'
variables:
baseUrl:
default: https://api.aptible.com
description: Override for local or test environments
security:
- token: []
tags:
- name: MetricDrains
paths:
/accounts/{account_id}/metric_drains:
get:
description: Returns a paginated list of metric drains for the specified account.
operationId: ListMetricDrainsForAccount
parameters:
- description: account_id
explode: false
in: path
name: account_id
required: true
schema:
type: integer
style: simple
- description: Current page of paginated results
explode: true
in: query
name: page
required: false
schema:
type: integer
style: form
- description: Number of results to return per page
explode: true
in: query
name: per_page
required: false
schema:
type: integer
style: form
- description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
explode: true
in: query
name: no_embed
required: false
schema:
type: boolean
style: form
- description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
explode: false
in: header
name: Prefer
required: false
schema:
enum:
- no_sensitive_extras=true
type: string
style: simple
responses:
'200':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ListMetricDrainsForAccount_200_response'
description: successful
default:
content:
application/hal+json:
schema:
$ref: '#/components/schemas/error'
description: Error response. Often a 4xx or 5xx status code
summary: list metric_drains
tags:
- MetricDrains
post:
description: Creates a new metric drain for the specified account.
operationId: CreateMetricDrain
parameters:
- description: account_id
explode: false
in: path
name: account_id
required: true
schema:
type: integer
style: simple
- description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
explode: true
in: query
name: no_embed
required: false
schema:
type: boolean
style: form
- description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
explode: false
in: header
name: Prefer
required: false
schema:
enum:
- no_sensitive_extras=true
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMetricDrain_request'
responses:
'201':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/metric_drain'
description: successful
default:
content:
application/hal+json:
schema:
$ref: '#/components/schemas/error'
description: Error response. Often a 4xx or 5xx status code
summary: create metric_drain
tags:
- MetricDrains
/metric_drains/{id}:
get:
description: Returns the details of a specific metric drain by ID.
operationId: GetMetricDrain
parameters:
- description: id
explode: false
in: path
name: id
required: true
schema:
type: integer
style: simple
- description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
explode: true
in: query
name: no_embed
required: false
schema:
type: boolean
style: form
- description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
explode: false
in: header
name: Prefer
required: false
schema:
enum:
- no_sensitive_extras=true
type: string
style: simple
responses:
'200':
content:
application/hal+json:
schema:
$ref: '#/components/schemas/metric_drain'
description: successful
default:
content:
application/hal+json:
schema:
$ref: '#/components/schemas/error'
description: Error response. Often a 4xx or 5xx status code
summary: show metric_drain
tags:
- MetricDrains
components:
schemas:
ListMetricDrainsForAccount_200_response:
properties:
_embedded:
$ref: '#/components/schemas/ListMetricDrainsForAccount_200_response__embedded'
total_count:
type: integer
per_page:
type: integer
current_page:
type: integer
_links:
$ref: '#/components/schemas/ListActivityReportsForAccount_200_response__links'
required:
- _embedded
- _links
- current_page
- per_page
- total_count
type: object
metric_drain:
properties:
id:
type: integer
_type:
type: string
handle:
type: string
created_at:
format: dateTime
type: string
updated_at:
format: dateTime
type: string
status:
type: string
drain_type:
type: string
drain_configuration:
$ref: '#/components/schemas/metric_drain_drain_configuration'
aggregator_ca_certificate:
type: string
x-nullable: true
aggregator_ca_private_key_blob:
type: string
x-nullable: true
aggregator_host:
type: string
x-nullable: true
aggregator_port_mapping:
items:
items:
type: integer
type: array
type: array
aggregator_instance_id:
type: string
x-nullable: true
aggregator_docker_name:
type: string
x-nullable: true
aggregator_allocation:
items:
type: string
type: array
_links:
$ref: '#/components/schemas/metric_drain__links'
required:
- _type
- aggregator_allocation
- aggregator_ca_certificate
- aggregator_ca_private_key_blob
- aggregator_docker_name
- aggregator_host
- aggregator_instance_id
- aggregator_port_mapping
- created_at
- drain_type
- handle
- id
- status
- updated_at
error:
properties:
code:
type: integer
error:
type: string
message:
type: string
required:
- code
- error
- message
type: object
CreateMetricDrain_request:
properties:
handle:
type: string
drain_type:
type: string
drain_configuration:
$ref: '#/components/schemas/CreateMetricDrain_request_drain_configuration'
database:
description: For Deploy-hosted InfluxDB instances
format: uri
type: string
database_id:
description: For Deploy-hosted InfluxDB instances
type: integer
required:
- drain_type
- handle
type: object
CreateMetricDrain_request_drain_configuration:
description: For external metric drain hosts
properties:
address:
format: uri
type: string
username:
type: string
password:
type: string
database:
type: string
api_key:
type: string
series_url:
format: uri
type: string
authToken:
type: string
bucket:
type: string
org:
type: string
type: object
ListActivityReportsForAccount_200_response__links:
properties:
account:
$ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack'
next:
$ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack'
prev:
$ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack'
self:
$ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack'
type: object
metric_drain__links:
properties:
account:
$ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack'
database:
$ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack'
operations:
$ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack'
containers:
$ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack'
self:
$ref: '#/components/schemas/ListAccountsForStack_200_response__links_stack'
type: object
metric_drain_drain_configuration:
properties:
address:
format: uri
type: string
username:
type: string
password:
type: string
database:
type: string
api_key:
type: string
series_url:
format: uri
type: string
type: object
ListMetricDrainsForAccount_200_response__embedded:
properties:
metric_drains:
items:
$ref: '#/components/schemas/metric_drain'
type: array
type: object
ListAccountsForStack_200_response__links_stack:
properties:
href:
format: uri
type: string
type: object
securitySchemes:
token:
in: header
name: Authorization
type: apiKey