Mackerel API ドキュメント（v0）

概要

  • ベースURLは https://api.mackerelio.com/です。(Mackerel for KCPS利用の場合はhttps://kcps-mackerel.io)
  • POST/PUT時の入力および成功時の出力は JSON (application/json)です。
  • RFCに準拠したJSONを指定してください。
  • X-Api-Key ヘッダ（必須）: 対象とするホストやサービスが所属するオーガニゼーションのAPIキーです。
    • APIキーはダッシュボードのAPIキータブで確認できます。
    • APIキーの権限は Read権限と Write権限を設定できます。
      • Read権限のみを持つAPIキーでは、Write権限が必要なAPIを使用できません。

目次

サービス

サービスの一覧

GET /api/v0/services

サービスの登録

POST /api/v0/services

サービスの削除

DELETE /api/v0/services/<serviceName>

ロールの一覧

GET /api/v0/services/<serviceName>/roles

ロールの登録

POST /api/v0/services/<serviceName>/roles

ロールの削除

DELETE /api/v0/services/<serviceName>/roles/<roleName>

メトリック名の一覧

GET /api/v0/services/<serviceName>/metric-names

ホスト

ホスト情報の登録

POST /api/v0/hosts

ホスト情報の取得

GET /api/v0/hosts/<hostId>

customIdentifier を指定したホスト情報の取得

GET /api/v0/hosts-by-custom-identifier/<customIdentifier>

ホスト情報の更新

PUT /api/v0/hosts/<hostId>

ホストのステータスの更新

POST /api/v0/hosts/<hostId>/status

ホストの一括ステータス更新

POST /api/v0/hosts/bulk-update-statuses

ホストのロールの更新

PUT /api/v0/hosts/<hostId>/role-fullnames

ホストの退役

POST /api/v0/hosts/<hostId>/retire

ホストの一括退役

POST /api/v0/hosts/bulk-retire

ホストの一覧

GET /api/v0/hosts

メトリック名の一覧

GET /api/v0/hosts/<hostId>/metric-names

監視ステータスの一覧

GET /api/v0/hosts/<hostId>/monitored-statuses

ホストメトリック

メトリックの投稿

POST /api/v0/tsdb

ホストのメトリックの値の取得

GET /api/v0/hosts/<hostId>/metrics

メトリックの最新値の取得

GET /api/v0/tsdb/latest

グラフ定義の投稿

POST /api/v0/graph-defs/create

グラフ定義の削除

DELETE /api/v0/graph-defs

サービスメトリック

サービスメトリックの投稿

POST /api/v0/services/<serviceName>/tsdb

サービスメトリックの値の取得

GET /api/v0/services/<serviceName>/metrics

チェック監視

チェック監視結果の投稿

POST /api/v0/monitoring/checks/report

メタデータ

ホストメタデータの取得

GET /api/v0/hosts/<hostId>/metadata/<namespace>

ホストメタデータの登録・更新

PUT /api/v0/hosts/<hostId>/metadata/<namespace>

ホストメタデータの削除

DELETE /api/v0/hosts/<hostId>/metadata/<namespace>

ホストメタデータの一覧

GET /api/v0/hosts/<hostId>/metadata

サービスメタデータの取得

GET /api/v0/services/<serviceName>/metadata/<namespace>

サービスメタデータの登録・更新

PUT /api/v0/services/<serviceName>/metadata/<namespace>

サービスメタデータの削除

DELETE /api/v0/services/<serviceName>/metadata/<namespace>

サービスメタデータの一覧

GET /api/v0/services/<serviceName>/metadata

ロールメタデータの取得

GET /api/v0/services/<serviceName>/roles/<roleName>/metadata/<namespace>

ロールメタデータの登録・更新

PUT /api/v0/services/<serviceName>/roles/<roleName>/metadata/<namespace>

ロールメタデータの削除

DELETE /api/v0/services/<serviceName>/roles/<roleName>/metadata/<namespace>

ロールメタデータの一覧

GET /api/v0/services/<serviceName>/roles/<roleName>/metadata

監視ルール

監視ルールの登録

POST /api/v0/monitors

監視ルールの一覧

GET /api/v0/monitors

監視ルールの取得

GET /api/v0/monitors/<monitorId>

監視ルールの更新

PUT /api/v0/monitors/<monitorId>

監視ルールの削除

DELETE /api/v0/monitors/<monitorId>

ダウンタイム

ダウンタイムの登録

POST /api/v0/downtimes

ダウンタイムの一覧

GET /api/v0/downtimes

ダウンタイムの更新

PUT /api/v0/downtimes/<downtimeId>

ダウンタイムの削除

DELETE /api/v0/downtimes/<downtimeId>

通知チャンネル

通知チャンネルの一覧取得

GET /api/v0/channels

通知チャンネルの登録

POST /api/v0/channels

通知チャンネルの削除

DELETE /api/v0/channels/<channelId>

通知グループ

通知グループの登録

POST /api/v0/notification-groups

通知グループの一覧取得

GET /api/v0/notification-groups

通知グループの更新

PUT /api/v0/notification-groups/<notificationGroupId>

通知グループの削除

DELETE /api/v0/notification-groups/<notificationGroupId>

アラート

アラートの一覧

GET /api/v0/alerts

アラートの取得

GET /api/v0/alerts/<alertId>

アラート更新

PUT /api/v0/alerts/<alertId>

アラートを閉じる

POST /api/v0/alerts/<alertId>/close

アラートグループ設定

アラートグループ設定の一覧

GET /api/v0/alert-group-settings

アラートグループ設定の作成

POST /api/v0/alert-group-settings

アラートグループ設定の取得

GET /api/v0/alert-group-settings/<alertGroupSettingId>

アラートグループ設定の更新

PUT /api/v0/alert-group-settings/<alertGroupSettingId>

アラートグループ設定の削除

DELETE /api/v0/alert-group-settings/<alertGroupSettingId>

ダッシュボード

ダッシュボードの作成

POST /api/v0/dashboards

ダッシュボードの取得

GET /api/v0/dashboards/<dashboardId>

ダッシュボードの更新

PUT /api/v0/dashboards/<dashboardId>

ダッシュボードの削除

DELETE /api/v0/dashboards/<dashboardId>

ダッシュボードの一覧

GET /api/v0/dashboards

グラフアノテーション

グラフアノテーションの作成

POST /api/v0/graph-annotations

グラフアノテーションの取得

GET /api/v0/graph-annotations

グラフアノテーションの更新

PUT /api/v0/graph-annotations/<annotationId>

グラフアノテーションの削除

DELETE /api/v0/graph-annotations/<annotationId>

ユーザー

オーガニゼーションメンバーに所属するユーザーの一覧

GET /api/v0/users

オーガニゼーションメンバーに所属するユーザーの削除

DELETE /api/v0/users/<userId>

招待

招待の一覧

GET /api/v0/invitations

招待の作成

POST /api/v0/invitations

招待の取り消し

POST /api/v0/invitations/revoke

オーガニゼーション

オーガニゼーションの情報を取得

GET /api/v0/org

AWSインテグレーション

AWSインテグレーション設定の一覧

GET /api/v0/aws-integrations

AWSインテグレーション設定の取得

GET /api/v0/aws-integrations/<awsIntegrationId>

AWSインテグレーション設定の登録

POST /api/v0/aws-integrations

AWSインテグレーション設定の更新

PUT /api/v0/aws-integrations/<awsIntegrationId>

AWSインテグレーション設定の削除

DELETE /api/v0/aws-integrations/<awsIntegrationId>

AWSインテグレーション外部IDの生成

POST /api/v0/aws-integrations-external-id

AWSインテグレーションの除外可能なメトリック名一覧

GET /api/v0/aws-integrations-excludable-metrics

データの種類

  • ホスト ID <hostId>
    • ホスト登録時にMackerelから与えられる文字列。エージェントが稼動しているホストを一意に識別する。
  • サービス名 <serviceName>
    • Mackerelに登録したサービス名

なにかお困りですか？

このヘルプサイトの内容だけでは解決できない問題を抱えている場合はMackerelサポートチームへご連絡ください。

サポートチームへ連絡

このページについて/about

このページにはMackerel <https://mackerel.io> 及び、KDDIクラウドプラットフォームサービス（略称：KCPS）を対象に構築された <https://kcps-mackerel.io> に関するAPIドキュメントを記載しています。