Skip to content

RegionApi.md

Latest commit

 

History

History
87 lines (58 loc) · 2.6 KB

RegionApi.md

File metadata and controls

87 lines (58 loc) · 2.6 KB

hyperstack.RegionApi

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Method HTTP request Description
list_regions GET /core/regions List Regions

list_regions

Regions list_regions()

List Regions

Lists the currently available regions, each representing a distinct geographic location housing a data center. For additional information on regions, click here.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.regions import Regions
from hyperstack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
    host = "https://infrahub-api.nexgencloud.com/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 API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.RegionApi(api_client)

    try:
        # List Regions
        api_response = api_instance.list_regions()
        print("The response of RegionApi->list_regions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RegionApi->list_regions: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Regions

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful retrieval of regions list. -
400 Bad Request -
401 Unauthorized -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]