APImetrics CLI

An easy way to interact with APImetrics, the unbiased SaaS Platform ensuring API products perform as agreed, are secure, meet business objectives, and comply with regulations.

• Install
• Usage
• Environment Variables
• Command Topics

Install

Requirements

Networking

The CLI will require an internet connection that allows access to the following domains in order to function properly. If you are adding firewall rules to allow this, we highly suggest that your firewall is configured to refresh the IP addresses for the domains on a regular basis as they may change without prior notice.

| Domain | Ports | |----------------------|---------| | client.apimetrics.io | 80, 443 | | auth.apimetrics.io | 80, 443 |

Supported OS and architectures

Both x64 and ARM architectures are supported with the following operating systems:

| OS | Supported | |------------|--------------------| | Windows 11 | :white_check_mark: | | Windows 10 | :white_check_mark: | | Windows 7 | :x: | | Linux | :white_check_mark: | | macOS | :white_check_mark: |

Supported Node.js Versions

We support all current and LTS versions of Node.js. When a version moves to end of life, we will drop support. If you are currently using a version of Node.js that is currently end of life, we suggest you upgrade to a newer version. More information about currently supported Node.js versions is published by the Node.js Release Working Group.

| Version | Supported | |---------|--------------------| | 21.x | :white_check_mark: | | 20.x | :white_check_mark: | | 18.x | :white_check_mark: | | 16.x | :x: |

Methods

With npm

The CLI is built with Node.js and can be installed using npm. In order to use this method, you must have node and npm installed on your system already.

$ npm install -g @apimetrics/cli

Using Tarballs

These are standalone distributions containing their own Node.js binary and the CLI. They do not require any other software to already be installed on your system.

The tarballs are available in both gz and xz formats. xz is much smaller so ideal for slow connections, however gz has wider support from decompression software. If you are unsure, use gz.

Once you have downloaded the tarball for your system, you should then extract to a location such as /usr/local/bin/apimetrics and ensure that this location is on your PATH.

Usage

$ npm install -g @apimetrics/cli
$ apimetrics COMMAND
running command...
$ apimetrics (--version)
@apimetrics/cli/0.3.0 linux-x64 node-v18.18.2
$ apimetrics --help [COMMAND]
USAGE
  $ apimetrics COMMAND
...

Environment Variables

| Name | Required | Description | |-----------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| | APIMETRICS_API_URL | :x: | Base URL for the API. Defaults to https://client.apimetrics.io/api/2/. | | APIMETRICS_TOKEN_URL | :x: | URL to use when requesting an access token for OAuth based login. Defaults to https://auth.apimetrics.io/oauth/token. | | APIMETRICS_CODE_URL | :x: | URL to use when requesting an authorization code for OAuth based login. Defaults to https://auth.apimetrics.io/oauth/device/code. | | APIMETRICS_REVOKE_URL | :x: | URL to use when revoking refresh tokens. Defaults to https://auth.apimetrics.io/oauth/revoke. | | APIMETRICS_USERINFO_URL | :x: | URL to use when fetching user info. Defaults to https://auth.apimetrics.io/userinfo. | | APIMETRICS_CLIENT_ID | :x: | Client ID to use for OAuth based login. | | APIMETRICS_CONFIG_DIR | :x: | Directory to store configuration for the CLI. Defaults to ~/.config/apimetrics on UNIX and %LOCALAPPDATA%\apimetrics on Windows. | | ~~XDG_CONFIG_HOME~~ | :x: | Directory to store configuration for the CLI. Not recommended for use. Use APIMETRICS_CONFIG_DIR instead. APIMETRICS_CONFIG_DIR takes priority if also set. |

Command Topics

• apimetrics auth - Manage authentication options.
• apimetrics calls - Manage monitoring calls.
• apimetrics config - Manage CLI configuration options.
• apimetrics help - Display help for apimetrics.
• apimetrics info - Information about APImetrics monitoring infrastructure.
• apimetrics org - Manage organization settings.
• apimetrics plugins - List installed plugins.
• apimetrics projects - Manage projects.
• apimetrics schedules - Manage project schedules.
• apimetrics webhooks - Manage project webhooks and alerts.
• apimetrics workflows - Manage project workflows.