pnap-location-api 1.0.0

Locations API

pnap-location-api

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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_location_api

Then import the package:

import pnap_location_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_location_api

Getting Started

Please follow the installation procedure and then run the following:

import time
import pnap_location_api
from pprint import pprint
from pnap_location_api.api import locations_api
from pnap_location_api.model.error import Error
from pnap_location_api.model.location import Location
from pnap_location_api.model.location_enum import LocationEnum
from pnap_location_api.model.product_category_enum import ProductCategoryEnum
# Defining the host is optional and defaults to https://api.phoenixnap.com/location-api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pnap_location_api.Configuration(
    host = "https://api.phoenixnap.com/location-api/v1"
)



# Enter a context with an instance of the API client
with pnap_location_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = locations_api.LocationsApi(api_client)
    location = LocationEnum("ASH") # LocationEnum | Location of interest (optional)
    product_category = ProductCategoryEnum("SERVER") # ProductCategoryEnum | Product category of interest (optional)

    try:
        # Get All Locations
        api_response = api_instance.get_locations(location=location, product_category=product_category)
        pprint(api_response)
    except pnap_location_api.ApiException as e:
        print("Exception when calling LocationsApi->get_locations: %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/location-api/v1

Class	Method	HTTP request	Description
LocationsApi	get_locations	GET /locations	Get All Locations

Documentation For Models

• Error
• Location
• LocationEnum
• ProductCategory
• ProductCategoryEnum

Documentation For Authorization

All endpoints do not require authorization.

Author

[e-mail]

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in pnap_location_api.apis and pnap_location_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_location_api.api.default_api import DefaultApi
• from pnap_location_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_location_api
from pnap_location_api.apis import *
from pnap_location_api.models import *