qovery.DeploymentStageMainCallsApi

All URIs are relative to https://api.qovery.com

Method	HTTP request	Description
attach_service_to_deployment_stage	PUT /deploymentStage/{deploymentStageId}/service/{serviceId}	Attach service to deployment stage
create_environment_deployment_stage	POST /environment/{environmentId}/deploymentStage	Create environment deployment stage
delete_deployment_stage	DELETE /deploymentStage/{deploymentStageId}	Delete deployment stage
edit_deployment_stage	PUT /deploymentStage/{deploymentStageId}	Edit deployment stage
get_deployment_stage	GET /deploymentStage/{deploymentStageId}	Get Deployment Stage
get_service_deployment_stage	GET /service/{serviceId}/deploymentStage	Get Service Deployment Stage
list_environment_deployment_stage	GET /environment/{environmentId}/deploymentStage	List environment deployment stage
move_after_deployment_stage	PUT /deploymentStage/{deploymentStageId}/moveAfter/{stageId}	Move deployment stage after requested stage
move_before_deployment_stage	PUT /deploymentStage/{deploymentStageId}/moveBefore/{stageId}	Move deployment stage before requested stage

attach_service_to_deployment_stage

DeploymentStageResponseList attach_service_to_deployment_stage(deployment_stage_id, service_id)

Attach service to deployment stage

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (bearerAuth):

import time
import os
import qovery
from qovery.models.deployment_stage_response_list import DeploymentStageResponseList
from qovery.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qovery.com
# See configuration.py for a list of all supported configuration parameters.
configuration = qovery.Configuration(
    host = "https://api.qovery.com"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = qovery.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with qovery.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qovery.DeploymentStageMainCallsApi(api_client)
    deployment_stage_id = 'deployment_stage_id_example' # str | Deployment Stage ID
    service_id = 'service_id_example' # str | Service ID of an application/job/container/database

    try:
        # Attach service to deployment stage
        api_response = api_instance.attach_service_to_deployment_stage(deployment_stage_id, service_id)
        print("The response of DeploymentStageMainCallsApi->attach_service_to_deployment_stage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeploymentStageMainCallsApi->attach_service_to_deployment_stage: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_stage_id	str	Deployment Stage ID
service_id	str	Service ID of an application/job/container/database

Return type

DeploymentStageResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of deployment stages for the env	-
401	Access token is missing or invalid	-
403	Access forbidden	-
404	Resource not found	-

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

create_environment_deployment_stage

DeploymentStageResponse create_environment_deployment_stage(environment_id, deployment_stage_request=deployment_stage_request)

Create environment deployment stage

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (bearerAuth):

import time
import os
import qovery
from qovery.models.deployment_stage_request import DeploymentStageRequest
from qovery.models.deployment_stage_response import DeploymentStageResponse
from qovery.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qovery.com
# See configuration.py for a list of all supported configuration parameters.
configuration = qovery.Configuration(
    host = "https://api.qovery.com"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = qovery.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with qovery.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qovery.DeploymentStageMainCallsApi(api_client)
    environment_id = 'environment_id_example' # str | Environment ID
    deployment_stage_request = qovery.DeploymentStageRequest() # DeploymentStageRequest |  (optional)

    try:
        # Create environment deployment stage
        api_response = api_instance.create_environment_deployment_stage(environment_id, deployment_stage_request=deployment_stage_request)
        print("The response of DeploymentStageMainCallsApi->create_environment_deployment_stage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeploymentStageMainCallsApi->create_environment_deployment_stage: %s\n" % e)

Parameters

Name	Type	Description	Notes
environment_id	str	Environment ID
deployment_stage_request	DeploymentStageRequest		[optional]

Return type

DeploymentStageResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	created deployment stage	-
401	Access token is missing or invalid	-
403	Access forbidden	-
404	Resource not found	-

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

delete_deployment_stage

delete_deployment_stage(deployment_stage_id)

Delete deployment stage

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (bearerAuth):

import time
import os
import qovery
from qovery.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qovery.com
# See configuration.py for a list of all supported configuration parameters.
configuration = qovery.Configuration(
    host = "https://api.qovery.com"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = qovery.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with qovery.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qovery.DeploymentStageMainCallsApi(api_client)
    deployment_stage_id = 'deployment_stage_id_example' # str | Deployment Stage ID

    try:
        # Delete deployment stage
        api_instance.delete_deployment_stage(deployment_stage_id)
    except Exception as e:
        print("Exception when calling DeploymentStageMainCallsApi->delete_deployment_stage: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_stage_id	str	Deployment Stage ID

Return type

void (empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	no content	-
401	Access token is missing or invalid	-
403	Access forbidden	-
404	Resource not found	-

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

edit_deployment_stage

DeploymentStageResponse edit_deployment_stage(deployment_stage_id, deployment_stage_request=deployment_stage_request)

Edit deployment stage

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (bearerAuth):

import time
import os
import qovery
from qovery.models.deployment_stage_request import DeploymentStageRequest
from qovery.models.deployment_stage_response import DeploymentStageResponse
from qovery.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qovery.com
# See configuration.py for a list of all supported configuration parameters.
configuration = qovery.Configuration(
    host = "https://api.qovery.com"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = qovery.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with qovery.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qovery.DeploymentStageMainCallsApi(api_client)
    deployment_stage_id = 'deployment_stage_id_example' # str | Deployment Stage ID
    deployment_stage_request = qovery.DeploymentStageRequest() # DeploymentStageRequest |  (optional)

    try:
        # Edit deployment stage
        api_response = api_instance.edit_deployment_stage(deployment_stage_id, deployment_stage_request=deployment_stage_request)
        print("The response of DeploymentStageMainCallsApi->edit_deployment_stage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeploymentStageMainCallsApi->edit_deployment_stage: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_stage_id	str	Deployment Stage ID
deployment_stage_request	DeploymentStageRequest		[optional]

Return type

DeploymentStageResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	created deployment stage	-
401	Access token is missing or invalid	-
403	Access forbidden	-
404	Resource not found	-

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

get_deployment_stage

DeploymentStageResponse get_deployment_stage(deployment_stage_id)

Get Deployment Stage

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (bearerAuth):

import time
import os
import qovery
from qovery.models.deployment_stage_response import DeploymentStageResponse
from qovery.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qovery.com
# See configuration.py for a list of all supported configuration parameters.
configuration = qovery.Configuration(
    host = "https://api.qovery.com"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = qovery.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with qovery.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qovery.DeploymentStageMainCallsApi(api_client)
    deployment_stage_id = 'deployment_stage_id_example' # str | Deployment Stage ID

    try:
        # Get Deployment Stage
        api_response = api_instance.get_deployment_stage(deployment_stage_id)
        print("The response of DeploymentStageMainCallsApi->get_deployment_stage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeploymentStageMainCallsApi->get_deployment_stage: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_stage_id	str	Deployment Stage ID

Return type

DeploymentStageResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Get Deployment Stage	-
401	Access token is missing or invalid	-
403	Access forbidden	-
404	Resource not found	-

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

get_service_deployment_stage

DeploymentStageResponse get_service_deployment_stage(service_id)

Get Service Deployment Stage

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (bearerAuth):

import time
import os
import qovery
from qovery.models.deployment_stage_response import DeploymentStageResponse
from qovery.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qovery.com
# See configuration.py for a list of all supported configuration parameters.
configuration = qovery.Configuration(
    host = "https://api.qovery.com"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = qovery.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with qovery.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qovery.DeploymentStageMainCallsApi(api_client)
    service_id = 'service_id_example' # str | Service ID of an application/job/container/database

    try:
        # Get Service Deployment Stage
        api_response = api_instance.get_service_deployment_stage(service_id)
        print("The response of DeploymentStageMainCallsApi->get_service_deployment_stage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeploymentStageMainCallsApi->get_service_deployment_stage: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_id	str	Service ID of an application/job/container/database

Return type

DeploymentStageResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Get Service Deployment Stage	-
401	Access token is missing or invalid	-
403	Access forbidden	-
404	Resource not found	-

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

list_environment_deployment_stage

DeploymentStageResponseList list_environment_deployment_stage(environment_id)

List environment deployment stage

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (bearerAuth):

import time
import os
import qovery
from qovery.models.deployment_stage_response_list import DeploymentStageResponseList
from qovery.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qovery.com
# See configuration.py for a list of all supported configuration parameters.
configuration = qovery.Configuration(
    host = "https://api.qovery.com"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = qovery.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with qovery.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qovery.DeploymentStageMainCallsApi(api_client)
    environment_id = 'environment_id_example' # str | Environment ID

    try:
        # List environment deployment stage
        api_response = api_instance.list_environment_deployment_stage(environment_id)
        print("The response of DeploymentStageMainCallsApi->list_environment_deployment_stage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeploymentStageMainCallsApi->list_environment_deployment_stage: %s\n" % e)

Parameters

Name	Type	Description	Notes
environment_id	str	Environment ID

Return type

DeploymentStageResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List deployment stage	-
401	Access token is missing or invalid	-
403	Access forbidden	-
404	Resource not found	-

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

move_after_deployment_stage

DeploymentStageResponseList move_after_deployment_stage(deployment_stage_id, stage_id)

Move deployment stage after requested stage

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (bearerAuth):

import time
import os
import qovery
from qovery.models.deployment_stage_response_list import DeploymentStageResponseList
from qovery.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qovery.com
# See configuration.py for a list of all supported configuration parameters.
configuration = qovery.Configuration(
    host = "https://api.qovery.com"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = qovery.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with qovery.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qovery.DeploymentStageMainCallsApi(api_client)
    deployment_stage_id = 'deployment_stage_id_example' # str | Deployment Stage ID
    stage_id = 'stage_id_example' # str | Deployment Stage ID

    try:
        # Move deployment stage after requested stage
        api_response = api_instance.move_after_deployment_stage(deployment_stage_id, stage_id)
        print("The response of DeploymentStageMainCallsApi->move_after_deployment_stage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeploymentStageMainCallsApi->move_after_deployment_stage: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_stage_id	str	Deployment Stage ID
stage_id	str	Deployment Stage ID

Return type

DeploymentStageResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List deployment stage	-
401	Access token is missing or invalid	-
403	Access forbidden	-
404	Resource not found	-

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

move_before_deployment_stage

DeploymentStageResponseList move_before_deployment_stage(deployment_stage_id, stage_id)

Move deployment stage before requested stage

Example

Api Key Authentication (ApiKeyAuth):
Bearer (JWT) Authentication (bearerAuth):

import time
import os
import qovery
from qovery.models.deployment_stage_response_list import DeploymentStageResponseList
from qovery.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qovery.com
# See configuration.py for a list of all supported configuration parameters.
configuration = qovery.Configuration(
    host = "https://api.qovery.com"
)

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Configure Bearer authorization (JWT): bearerAuth
configuration = qovery.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with qovery.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = qovery.DeploymentStageMainCallsApi(api_client)
    deployment_stage_id = 'deployment_stage_id_example' # str | Deployment Stage ID
    stage_id = 'stage_id_example' # str | Deployment Stage ID

    try:
        # Move deployment stage before requested stage
        api_response = api_instance.move_before_deployment_stage(deployment_stage_id, stage_id)
        print("The response of DeploymentStageMainCallsApi->move_before_deployment_stage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DeploymentStageMainCallsApi->move_before_deployment_stage: %s\n" % e)

Parameters

Name	Type	Description	Notes
deployment_stage_id	str	Deployment Stage ID
stage_id	str	Deployment Stage ID

Return type

DeploymentStageResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List deployment stage	-
401	Access token is missing or invalid	-
403	Access forbidden	-
404	Resource not found	-

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

Files

DeploymentStageMainCallsApi.md

Latest commit

History

DeploymentStageMainCallsApi.md

File metadata and controls

qovery.DeploymentStageMainCallsApi

attach_service_to_deployment_stage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_environment_deployment_stage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_deployment_stage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

edit_deployment_stage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_deployment_stage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_service_deployment_stage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_environment_deployment_stage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

move_after_deployment_stage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

move_before_deployment_stage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details