Skip to main content

Zayo API python client

Project description

Python client for Zayo API

This package provides a python 3.8 asyncio based client to access the Zayo API system.

The following API functional areas are supported:

  • Service Inventory
  • Maintenance

This package also includes a CLI tool zayocli to retrieve and display information obtained via the API.


pip install pyzayo

Before You Begin

You must export two environment variables for use with this library:

  • ZAYO_CLIENT_ID - Your unique client ID value
  • ZAYO_CLIENT_SECRET - Your unique client secret value

You must obtain these values from Zayo.

Quick Start

from pyzayo import ZayoClient

# create a client to the Maintenace API authenticate using the ZAYO_ variables
zapi = ZayoClient()

# use the instance methods to retrieve data
cases = zapi.get_cases()

Usage Documentation


For now, please use the docstrings by doing:

from pyzayo import ZayoClient


CLI Tool

The zayocli tool supports the maintenance cases and service inventory features:

Usage: zayocli [OPTIONS] COMMAND [ARGS]...

  Zayo CLI tool to access information via the API.

  --version  Show the version and exit.
  --help     Show this message and exit.

  cases     Maintenance commands.
  services  Inventory Service commands.

cases subcommand

Usage: zayocli cases [OPTIONS] COMMAND [ARGS]...

  Maintenance commands.

  --help  Show this message and exit.

  list          Show listing of maintenance caess.
  show-details  Show specific case details.

services subcommand

Usage: zayocli services [OPTIONS] COMMAND [ARGS]...

  Inventory Service commands.

  --help  Show this message and exit.

  circuit  Show service record for given circuit ID.
  list     List service inventory.

Zayo API Documentation

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyzayo-0.5.0.tar.gz (13.4 kB view hashes)

Uploaded Source

Built Distribution

pyzayo-0.5.0-py3-none-any.whl (25.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page