- Notifications
You must be signed in to change notification settings - Fork0
Python API client library for IX-API
License
peering-manager/pyixapi
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Python API client library forIX-API.
Supported versions are:
To install runpip install pyixapi.
To begin, import pyixapi and instantiate the API.
importpyixapiixapi=pyixapi.api("https://api.de-cix.net/api/v1/","3LH3G72VH7H1SGogEsFeQOPsGjOQotMUZQRt2pK7YbH","cEtrt8s0vR0CsG0vpAmcaxtnolzZj7DEG0B7izvwPlV",)ixapi.authenticate()
The first argument the.api() method takes is the IX-API URL. The second andthird arguments are the API key and secret used for authentication.
Authenticating will generate a pair of access and refresh tokens that can bepassed as argument to the.api() method.
The pyixapi API is setup so that IX-API's endpoints are attributes of the.api() object. Each endpoint has a handful of methods available to carry outactions on the endpoint. For example, in order to query all the objects in thenetwork-service-configs endpoint you would do the following:
>>>nsc=ixapi.network_service_configs.all()>>>foriinnsc:...print(i)...DXDB:PAS:00001DXDB:PAS:00002DXDB:PAS:00003DXDB:PAS:00004DXDB:PAS:00005DXDB:PAS:00006DXDB:PAS:00007DXDB:PAS:00008>>>
Write queries are not implemented yet.
About
Python API client library for IX-API