Networks API
Project description
pnap-network-api
Create, list, edit and delete public/private networks with the Network API. Use public networks to place multiple
servers on the same network or VLAN. Assign new servers with IP addresses from the same CIDR range. Use private
networks to avoid unnecessary egress data charges. Model your networks according to your business needs.
Helpful knowledge base articles are available for
multi-private backend networks
and public networks.
All URLs are relative to (https://api.phoenixnap.com/networks/v1/)
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0 For more information, please visit https://phoenixnap.com/
Requirements.
Python >=3.6
Installation & Usage
pip install
You can install this package directly from the Python Package Index using:
$ pip install pnap_network_api
Then import the package:
import pnap_network_api
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import pnap_network_api
Getting Started
Please follow the installation procedure and then run the following:
import time
import pnap_network_api
from pprint import pprint
from pnap_network_api.api import private_networks_api
from pnap_network_api.model.error import Error
from pnap_network_api.model.private_network import PrivateNetwork
from pnap_network_api.model.private_network_create import PrivateNetworkCreate
from pnap_network_api.model.private_network_modify import PrivateNetworkModify
# Defining the host is optional and defaults to https://api.phoenixnap.com/networks/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pnap_network_api.Configuration(
host = "https://api.phoenixnap.com/networks/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure OAuth2 access token for authorization: OAuth2
configuration = pnap_network_api.Configuration(
host = "https://api.phoenixnap.com/networks/v1"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Enter a context with an instance of the API client
with pnap_network_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = private_networks_api.PrivateNetworksApi(api_client)
location = "PHX" # str | If present will filter the result by the given location of the Private Networks. (optional)
try:
# List Private Networks.
api_response = api_instance.private_networks_get(location=location)
pprint(api_response)
except pnap_network_api.ApiException as e:
print("Exception when calling PrivateNetworksApi->private_networks_get: %s\n" % e)
To generate a token using the python-keycloak library:
from keycloak import KeycloakOpenID
clientId = "YOUR_CLIENT_ID"
clientSecret = "YOUR_CLIENT_SECRET"
serverUrl = "https://auth.phoenixnap.com/auth/"
realmName = "BMC"
grantType = "client_credentials"
keycloakOpenId = KeycloakOpenID(server_url=serverUrl,
realm_name=realmName,
client_id=clientId,
client_secret_key=clientSecret)
ACCESS_TOKEN = keycloakOpenId.token(grant_type=grantType)['access_token']
Documentation for API Endpoints
All URIs are relative to https://api.phoenixnap.com/networks/v1
Class | Method | HTTP request | Description |
---|---|---|---|
PrivateNetworksApi | private_networks_get | GET /private-networks | List Private Networks. |
PrivateNetworksApi | private_networks_network_id_delete | DELETE /private-networks/{privateNetworkId} | Delete a Private Network. |
PrivateNetworksApi | private_networks_network_id_get | GET /private-networks/{privateNetworkId} | Get a Private Network. |
PrivateNetworksApi | private_networks_network_id_put | PUT /private-networks/{privateNetworkId} | Update a Private Network. |
PrivateNetworksApi | private_networks_post | POST /private-networks | Create a Private Network. |
PublicNetworksApi | public_networks_get | GET /public-networks | List Public Networks. |
PublicNetworksApi | public_networks_network_id_delete | DELETE /public-networks/{publicNetworkId} | Delete a Public Network. |
PublicNetworksApi | public_networks_network_id_get | GET /public-networks/{publicNetworkId} | Get a Public Network. |
PublicNetworksApi | public_networks_network_id_ip_blocks_ip_block_id_delete | DELETE /public-networks/{publicNetworkId}/ip-blocks/{ipBlockId} | Removes the IP Block from the Public Network. |
PublicNetworksApi | public_networks_network_id_ip_blocks_post | POST /public-networks/{publicNetworkId}/ip-blocks | Adds an IP block to this public network. |
PublicNetworksApi | public_networks_network_id_patch | PATCH /public-networks/{publicNetworkId} | Update Public Network's Details. |
PublicNetworksApi | public_networks_post | POST /public-networks | Create a public network. |
Documentation For Models
- Error
- NetworkMembership
- PrivateNetwork
- PrivateNetworkCreate
- PrivateNetworkModify
- PrivateNetworkServer
- PublicNetwork
- PublicNetworkCreate
- PublicNetworkIpBlock
- PublicNetworkModify
Documentation For Authorization
OAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes:
- bmc: Grants full access to bmc-api.
- bmc.read: Grants read only access to bmc-api.
Author
Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in pnap_network_api.apis and pnap_network_api.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1: Use specific imports for apis and models like:
from pnap_network_api.api.default_api import DefaultApi
from pnap_network_api.model.pet import Pet
Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:
import sys
sys.setrecursionlimit(1500)
import pnap_network_api
from pnap_network_api.apis import *
from pnap_network_api.models import *
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pnap_network_api-1.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e014564358cef9e53234aa7390b7f173a38d1772ea1d90f439f718e95ebf389b |
|
MD5 | ecff3d1b92891a905cc8e60fac344d43 |
|
BLAKE2b-256 | 29941a79479542d4081b14f3d3b251667f4a3398a349cb1f77c1010a74664f7c |