Aptible

Aptible Metric Drains API

The MetricDrains API from Aptible — 2 operation(s) for metricdrains.

GitHub OpenAPI
Business capability
Observability Management BC-4220.20

Operations 3

GET /accounts/{account_id}/metric_drains list metric_drains #
POST /accounts/{account_id}/metric_drains create metric_drain #
GET /metric_drains/{id} show metric_drain #

Documentation

📖
Documentation
https://www.aptible.com/docs/getting-started/home

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aptible/refs/heads/main/openapi/aptible-metricdrains-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/aptible/cloud-api-clients
🔗
SourceCode
https://github.com/aptible/tool-server-openapi-spec

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aptible-metricdrains-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aptible-metricdrains-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Aptible Metric Drains API
  version: v1
  contact:
    email: support@aptible.com
  description: 'Operations tagged MetricDrains across 2 of this provider''s published API definitions: aptible-deploy-openapi-original.yml, aptible-metricdrains-api-openapi.yml. Each path carries the servers of the definition it was published in.'
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
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
  /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
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
components:
  schemas:
    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:
      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
    ListAccountsForStack_200_response__links_stack:
      properties:
        href:
          format: uri
          type: string
      type: object
    ListMetricDrainsForAccount_200_response__embedded:
      properties:
        metric_drains:
          items:
            $ref: '#/components/schemas/metric_drain'
          type: array
      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_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
    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
    error:
      properties:
        code:
          type: integer
        error:
          type: string
        message:
          type: string
      required:
      - code
      - error
      - message
      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
    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
  securitySchemes:
    token:
      in: header
      name: Authorization
      type: apiKey
x-refined-from:
- aptible-deploy-openapi-original.yml
- aptible-metricdrains-api-openapi.yml