Skip to content

DeploymentApi.md

Latest commit

 

History

History
333 lines (230 loc) · 9.98 KB

DeploymentApi.md

File metadata and controls

333 lines (230 loc) · 9.98 KB

hyperstack.DeploymentApi

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

Method HTTP request Description
delete_deployment DELETE /core/marketplace/deployments/{id} Delete Deployment
get_deployment GET /core/marketplace/deployments/{id} Details of Deployment by ID
list_deployments GET /core/marketplace/deployments List Deployments
start_deployment POST /core/marketplace/deployments Start Deployment

delete_deployment

ResponseModel delete_deployment(id)

Delete Deployment

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.DeploymentApi(api_client)
    id = 56 # int | 

    try:
        # Delete Deployment
        api_response = api_instance.delete_deployment(id)
        print("The response of DeploymentApi->delete_deployment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeploymentApi->delete_deployment: %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
202 Success -
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_deployment

StartDeployment get_deployment(id)

Details of Deployment by ID

Example

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

    try:
        # Details of Deployment by ID
        api_response = api_instance.get_deployment(id)
        print("The response of DeploymentApi->get_deployment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeploymentApi->get_deployment: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

StartDeployment

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Getting deployment detail success -
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_deployments

Deployments list_deployments()

List Deployments

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.deployments import Deployments
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.DeploymentApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

Deployments

Authorization

apiKey

HTTP request headers

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

HTTP response details

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

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

start_deployment

StartDeployment start_deployment(payload)

Start Deployment

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.start_deployment import StartDeployment
from hyperstack.models.start_deployment_payload import StartDeploymentPayload
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.DeploymentApi(api_client)
    payload = hyperstack.StartDeploymentPayload() # StartDeploymentPayload | 

    try:
        # Start Deployment
        api_response = api_instance.start_deployment(payload)
        print("The response of DeploymentApi->start_deployment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeploymentApi->start_deployment: %s\n" % e)

Parameters

Name Type Description Notes
payload StartDeploymentPayload

Return type

StartDeployment

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Deployment created successfully -
400 Bad Request -
401 Unauthorized -
404 Not Found -
409 Conflict -
500 Internal Server Error -

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