pnap-bmc-api

Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API. Deprovision servers, get or edit SSH key details, assign public IPs, assign servers to networks and a lot more. Manage your infrastructure more efficiently using just a few simple API calls.

Knowledge base articles to help you can be found here

All URLs are relative to (https://api.phoenixnap.com/bmc/v1/)

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

• API version: 0.1
• Package version: 2.4.0
• 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_bmc_api

Then import the package:

import pnap_bmc_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_bmc_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pnap_bmc_api
from pnap_bmc_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.phoenixnap.com/bmc/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = pnap_bmc_api.Configuration(
    host = "https://api.phoenixnap.com/bmc/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_bmc_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pnap_bmc_api.QuotasApi(api_client)

    try:
        # List quotas
        api_response = api_instance.quotas_get()
        print("The response of QuotasApi->quotas_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling QuotasApi->quotas_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/bmc/v1

Documentation For Models

• ActionResult
• DeleteResult
• DeleteSshKeyResult
• Error
• EsxiDatastoreConfiguration
• EsxiOsConfiguration
• GpuConfiguration
• IpBlocksConfiguration
• NetworkConfiguration
• OsConfiguration
• OsConfigurationCloudInit
• OsConfigurationIPXE
• OsConfigurationIPXENativeVlanConfiguration
• OsConfigurationMap
• OsConfigurationMapEsxi
• OsConfigurationMapProxmox
• OsConfigurationNetrisController
• OsConfigurationNetrisSoftgate
• OsConfigurationWindows
• PrivateNetworkConfiguration
• PublicNetworkConfiguration
• Quota
• QuotaEditLimitRequest
• QuotaEditLimitRequestDetails
• RebootRequest
• RelinquishIpBlock
• ReservationTransferDetails
• ResetResult
• Server
• ServerCreate
• ServerIpBlock
• ServerNetworkUpdate
• ServerPatch
• ServerPrivateNetwork
• ServerProvision
• ServerPublicNetwork
• ServerReserve
• ServerReset
• SshKey
• SshKeyCreate
• SshKeyUpdate
• StorageConfiguration
• StorageConfigurationRootPartition
• TagAssignment
• TagAssignmentRequest

Documentation For Authorization

Authentication schemes defined for the API:

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

support@phoenixnap.com