Skip to content

PartnerConfigApi.md

Latest commit

 

History

History
169 lines (113 loc) · 5.12 KB

PartnerConfigApi.md

File metadata and controls

169 lines (113 loc) · 5.12 KB

hyperstack.PartnerConfigApi

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

Method HTTP request Description
get_partner_config GET /auth/partner-config Get partner config
get_partner_config_by_domain GET /auth/partner-config/docs

get_partner_config

PartnerConfig get_partner_config()

Get partner config

Fetch the customised customer configuration for Hyperstack.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.partner_config import PartnerConfig
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.PartnerConfigApi(api_client)

    try:
        # Get partner config
        api_response = api_instance.get_partner_config()
        print("The response of PartnerConfigApi->get_partner_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PartnerConfigApi->get_partner_config: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

PartnerConfig

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Internal Server Error -

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

get_partner_config_by_domain

PartnerConfig get_partner_config_by_domain(domain=domain)

Fetch the partner config for a given domain.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.partner_config import PartnerConfig
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.PartnerConfigApi(api_client)
    domain = 'domain_example' # str | The domain to look up the partner config for. (optional)

    try:
        api_response = api_instance.get_partner_config_by_domain(domain=domain)
        print("The response of PartnerConfigApi->get_partner_config_by_domain:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PartnerConfigApi->get_partner_config_by_domain: %s\n" % e)

Parameters

Name Type Description Notes
domain str The domain to look up the partner config for. [optional]

Return type

PartnerConfig

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
404 Not Found -
500 Internal Server Error -

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