Skip to content

ProfileApi.md

Latest commit

 

History

History
340 lines (233 loc) · 10.8 KB

ProfileApi.md

File metadata and controls

340 lines (233 loc) · 10.8 KB

hyperstack.ProfileApi

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

Method HTTP request Description
create_profile POST /core/profiles Create profile
delete_profile DELETE /core/profiles/{id} Delete profile
get_profile GET /core/profiles/{id} Retrieve profile details
list_profiles GET /core/profiles List profiles

create_profile

CreateProfileResponse create_profile(payload)

Create profile

Creates a provisioning profile to save the configuration of a virtual machinefor future use. Include the profile name, description, and virtual machine configuration details in the request body. For more information about virtual machine profiles,click here.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.create_profile_payload import CreateProfilePayload
from hyperstack.models.create_profile_response import CreateProfileResponse
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.ProfileApi(api_client)
    payload = hyperstack.CreateProfilePayload() # CreateProfilePayload | 

    try:
        # Create profile
        api_response = api_instance.create_profile(payload)
        print("The response of ProfileApi->create_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProfileApi->create_profile: %s\n" % e)

Parameters

Name Type Description Notes
payload CreateProfilePayload

Return type

CreateProfileResponse

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Profile created successfully -
400 Bad Request -
401 Unauthorized -
409 Conflict -
500 Internal Server Error -

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

delete_profile

ResponseModel delete_profile(id)

Delete profile

Permanently deletes a provisioning profile. Supply the profile ID in the path to delete the specified profile.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.response_model import ResponseModel
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.ProfileApi(api_client)
    id = 56 # int | 

    try:
        # Delete profile
        api_response = api_instance.delete_profile(id)
        print("The response of ProfileApi->delete_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProfileApi->delete_profile: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Profile deleted successfully. -
400 Bad Request -
401 Unauthorized -
404 Not Found -
500 Internal Server Error -

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

get_profile

CreateProfileResponse get_profile(id)

Retrieve profile details

Retrieves details for an existing provisioning profile by supplying the profile ID in the request path. For more information about profiles, click here.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.create_profile_response import CreateProfileResponse
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.ProfileApi(api_client)
    id = 56 # int | 

    try:
        # Retrieve profile details
        api_response = api_instance.get_profile(id)
        print("The response of ProfileApi->get_profile:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProfileApi->get_profile: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

CreateProfileResponse

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Profile details retrieved successfully. -
400 Bad Request -
401 Unauthorized -
404 Not Found -
500 Internal Server Error -

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

list_profiles

ProfileListResponse list_profiles()

List profiles

Returns a list of your existing provisioning profiles, providing virtual machine configuration details for each. For additional information about profiles,click here.

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.profile_list_response import ProfileListResponse
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.ProfileApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

ProfileListResponse

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Getting profiles success. -
400 Bad Request -
401 Unauthorized -
500 Internal Server Error -

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