pnap-network-storage-api 2.0.5

Network Storage API

pnap-network-storage-api

Create, list, edit, and delete storage networks with the Network Storage API. Use storage networks to expand storage capacity on a private network.
Knowledge base articles to help you can be found here
All URLs are relative to (https://api.phoenixnap.com/network-storage/v1/)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 2.0.5
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://phoenixnap.com/

Requirements.

Python 3.9+

Installation & Usage

pip install

You can install this package directly from the Python Package Index using:

$ pip install pnap_network_storage_api

Then import the package:

import pnap_network_storage_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_storage_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pnap_network_storage_api
from pnap_network_storage_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.phoenixnap.com/network-storage/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pnap_network_storage_api.Configuration(
    host = "https://api.phoenixnap.com/network-storage/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.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with pnap_network_storage_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pnap_network_storage_api.StorageNetworksApi(api_client)
    location = 'PHX' # str | If present will filter the result by the given location. (optional)

    try:
        # List all storage networks.
        api_response = api_instance.storage_networks_get(location=location)
        print("The response of StorageNetworksApi->storage_networks_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling StorageNetworksApi->storage_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/network-storage/v1

Class	Method	HTTP request	Description
StorageNetworksApi	storage_networks_get	GET /storage-networks	List all storage networks.
StorageNetworksApi	storage_networks_id_delete	DELETE /storage-networks/{storageId}	Delete a storage network and its volume.
StorageNetworksApi	storage_networks_id_get	GET /storage-networks/{storageId}	Get storage network details.
StorageNetworksApi	storage_networks_id_patch	PATCH /storage-networks/{storageId}	Update storage network details.
StorageNetworksApi	storage_networks_post	POST /storage-networks	Create a storage network and volume.
StorageNetworksApi	storage_networks_storage_network_id_volumes_get	GET /storage-networks/{storageId}/volumes	Display one or more volumes belonging to a storage network.
StorageNetworksApi	storage_networks_storage_network_id_volumes_post	POST /storage-networks/{storageId}/volumes	Create a volume belonging to a storage network.
StorageNetworksApi	storage_networks_storage_network_id_volumes_volume_id_delete	DELETE /storage-networks/{storageId}/volumes/{volumeId}	Delete a Storage Network's Volume
StorageNetworksApi	storage_networks_storage_network_id_volumes_volume_id_get	GET /storage-networks/{storageId}/volumes/{volumeId}	Get a storage network's volume details.
StorageNetworksApi	storage_networks_storage_network_id_volumes_volume_id_patch	PATCH /storage-networks/{storageId}/volumes/{volumeId}	Update a storage network's volume details.
StorageNetworksApi	storage_networks_storage_network_id_volumes_volume_id_tags_put	PUT /storage-networks/{storageId}/volumes/{volumeId}/tags	Overwrites tags assigned for the volume.

Documentation For Models

• Error
• NfsPermissions
• NfsPermissionsCreate
• NfsPermissionsUpdate
• Permissions
• PermissionsCreate
• PermissionsUpdate
• Status
• StorageNetwork
• StorageNetworkCreate
• StorageNetworkUpdate
• StorageNetworkVolumeCreate
• TagAssignment
• TagAssignmentRequest
• Volume
• VolumeCreate
• VolumeUpdate

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• networkstorage: Grants full access to Network Storage API.
• networkstorage.read: Grants read only access to Network Storage API.

Author

[e-mail]