portainer_ce_api.StacksApi

All URIs are relative to http://localhost/api

Method	HTTP request	Description
stack_create	POST /stacks	Deploy a new stack
stack_delete	DELETE /stacks/{id}	Remove a stack
stack_file_inspect	GET /stacks/{id}/file	Retrieve the content of the Stack file for the specified stack
stack_inspect	GET /stacks/{id}	Inspect a stack
stack_list	GET /stacks	List stacks
stack_migrate	POST /stacks/{id}/migrate	Migrate a stack to another endpoint
stack_start	POST /stacks/{id}/start	Starts a stopped Stack
stack_stop	POST /stacks/{id}/stop	Stops a stopped Stack
stack_update	PUT /stacks/{id}	Update a stack

stack_create

PortainerCustomTemplate stack_create(type, method, endpoint_id, body_swarm_string=body_swarm_string, body_swarm_repository=body_swarm_repository, body_compose_string=body_compose_string, body_compose_repository=body_compose_repository, name=name, swarm_id=swarm_id, env=env, file=file)

Deploy a new stack

Deploy a new stack into a Docker environment specified via the endpoint identifier. Access policy: restricted

Example

from __future__ import print_function
import time
import portainer_ce_api
from portainer_ce_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: jwt
configuration = portainer_ce_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = portainer_ce_api.StacksApi(portainer_ce_api.ApiClient(configuration))
type = 56 # int | Stack deployment type. Possible values: 1 (Swarm stack) or 2 (Compose stack).
method = 'method_example' # str | Stack deployment method. Possible values: file, string or repository.
endpoint_id = 56 # int | Identifier of the endpoint that will be used to deploy the stack
body_swarm_string = portainer_ce_api.StacksSwarmStackFromFileContentPayload() # StacksSwarmStackFromFileContentPayload | Required when using method=string and type=1 (optional)
body_swarm_repository = portainer_ce_api.StacksSwarmStackFromGitRepositoryPayload() # StacksSwarmStackFromGitRepositoryPayload | Required when using method=repository and type=1 (optional)
body_compose_string = portainer_ce_api.StacksComposeStackFromFileContentPayload() # StacksComposeStackFromFileContentPayload | Required when using method=string and type=2 (optional)
body_compose_repository = portainer_ce_api.StacksComposeStackFromGitRepositoryPayload() # StacksComposeStackFromGitRepositoryPayload | Required when using method=repository and type=2 (optional)
name = 'name_example' # str | Name of the stack. required when method is file (optional)
swarm_id = 'swarm_id_example' # str | Swarm cluster identifier. Required when method equals file and type equals 1. required when method is file (optional)
env = 'env_example' # str | Environment variables passed during deployment, represented as a JSON array [{'name': 'name', 'value': 'value'}]. Optional, used when method equals file and type equals 1. (optional)
file = '/path/to/file.txt' # file | Stack file. required when method is file (optional)

try:
    # Deploy a new stack
    api_response = api_instance.stack_create(type, method, endpoint_id, body_swarm_string=body_swarm_string, body_swarm_repository=body_swarm_repository, body_compose_string=body_compose_string, body_compose_repository=body_compose_repository, name=name, swarm_id=swarm_id, env=env, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stack_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
type	int	Stack deployment type. Possible values: 1 (Swarm stack) or 2 (Compose stack).
method	str	Stack deployment method. Possible values: file, string or repository.
endpoint_id	int	Identifier of the endpoint that will be used to deploy the stack
body_swarm_string	StacksSwarmStackFromFileContentPayload	Required when using method=string and type=1	[optional]
body_swarm_repository	StacksSwarmStackFromGitRepositoryPayload	Required when using method=repository and type=1	[optional]
body_compose_string	StacksComposeStackFromFileContentPayload	Required when using method=string and type=2	[optional]
body_compose_repository	StacksComposeStackFromGitRepositoryPayload	Required when using method=repository and type=2	[optional]
name	str	Name of the stack. required when method is file	[optional]
swarm_id	str	Swarm cluster identifier. Required when method equals file and type equals 1. required when method is file	[optional]
env	str	Environment variables passed during deployment, represented as a JSON array [{'name': 'name', 'value': 'value'}]. Optional, used when method equals file and type equals 1.	[optional]
file	file	Stack file. required when method is file	[optional]

Return type

PortainerCustomTemplate

Authorization

jwt

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

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

stack_delete

stack_delete(id, external=external, endpoint_id=endpoint_id)

Remove a stack

Remove a stack. Access policy: restricted

Example

from __future__ import print_function
import time
import portainer_ce_api
from portainer_ce_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: jwt
configuration = portainer_ce_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = portainer_ce_api.StacksApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | Stack identifier
external = true # bool | Set to true to delete an external stack. Only external Swarm stacks are supported (optional)
endpoint_id = 56 # int | Endpoint identifier used to remove an external stack (required when external is set to true) (optional)

try:
    # Remove a stack
    api_instance.stack_delete(id, external=external, endpoint_id=endpoint_id)
except ApiException as e:
    print("Exception when calling StacksApi->stack_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Stack identifier
external	bool	Set to true to delete an external stack. Only external Swarm stacks are supported	[optional]
endpoint_id	int	Endpoint identifier used to remove an external stack (required when external is set to true)	[optional]

Return type

void (empty response body)

Authorization

jwt

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

stack_file_inspect

StacksStackFileResponse stack_file_inspect(id)

Retrieve the content of the Stack file for the specified stack

Get Stack file content. Access policy: restricted

Example

from __future__ import print_function
import time
import portainer_ce_api
from portainer_ce_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: jwt
configuration = portainer_ce_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = portainer_ce_api.StacksApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | Stack identifier

try:
    # Retrieve the content of the Stack file for the specified stack
    api_response = api_instance.stack_file_inspect(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stack_file_inspect: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Stack identifier

Return type

StacksStackFileResponse

Authorization

jwt

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

stack_inspect

PortainerStack stack_inspect(id)

Inspect a stack

Retrieve details about a stack. Access policy: restricted

Example

from __future__ import print_function
import time
import portainer_ce_api
from portainer_ce_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: jwt
configuration = portainer_ce_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = portainer_ce_api.StacksApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | Stack identifier

try:
    # Inspect a stack
    api_response = api_instance.stack_inspect(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stack_inspect: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Stack identifier

Return type

PortainerStack

Authorization

jwt

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

stack_list

list[PortainerStack] stack_list(filters=filters)

List stacks

List all stacks based on the current user authorizations. Will return all stacks if using an administrator account otherwise it will only return the list of stacks the user have access to. Access policy: restricted

Example

from __future__ import print_function
import time
import portainer_ce_api
from portainer_ce_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: jwt
configuration = portainer_ce_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = portainer_ce_api.StacksApi(portainer_ce_api.ApiClient(configuration))
filters = 'filters_example' # str | Filters to process on the stack list. Encoded as JSON (a map[string]string). For example, { (optional)

try:
    # List stacks
    api_response = api_instance.stack_list(filters=filters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stack_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
filters	str	Filters to process on the stack list. Encoded as JSON (a map[string]string). For example, {	[optional]

Return type

list[PortainerStack]

Authorization

jwt

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

stack_migrate

PortainerStack stack_migrate(id, body, endpoint_id=endpoint_id)

Migrate a stack to another endpoint

Migrate a stack from an endpoint to another endpoint. It will re-create the stack inside the target endpoint before removing the original stack. Access policy: restricted

Example

from __future__ import print_function
import time
import portainer_ce_api
from portainer_ce_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: jwt
configuration = portainer_ce_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = portainer_ce_api.StacksApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | Stack identifier
body = portainer_ce_api.StacksStackMigratePayload() # StacksStackMigratePayload | Stack migration details
endpoint_id = 56 # int | Stacks created before version 1.18.0 might not have an associated endpoint identifier. Use this optional parameter to set the endpoint identifier used by the stack. (optional)

try:
    # Migrate a stack to another endpoint
    api_response = api_instance.stack_migrate(id, body, endpoint_id=endpoint_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stack_migrate: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Stack identifier
body	StacksStackMigratePayload	Stack migration details
endpoint_id	int	Stacks created before version 1.18.0 might not have an associated endpoint identifier. Use this optional parameter to set the endpoint identifier used by the stack.	[optional]

Return type

PortainerStack

Authorization

jwt

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

stack_start

PortainerStack stack_start(id)

Starts a stopped Stack

Starts a stopped Stack. Access policy: restricted

Example

from __future__ import print_function
import time
import portainer_ce_api
from portainer_ce_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: jwt
configuration = portainer_ce_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = portainer_ce_api.StacksApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | Stack identifier

try:
    # Starts a stopped Stack
    api_response = api_instance.stack_start(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stack_start: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Stack identifier

Return type

PortainerStack

Authorization

jwt

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

stack_stop

PortainerStack stack_stop(id)

Stops a stopped Stack

Stops a stopped Stack. Access policy: restricted

Example

from __future__ import print_function
import time
import portainer_ce_api
from portainer_ce_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: jwt
configuration = portainer_ce_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = portainer_ce_api.StacksApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | Stack identifier

try:
    # Stops a stopped Stack
    api_response = api_instance.stack_stop(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stack_stop: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Stack identifier

Return type

PortainerStack

Authorization

jwt

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

stack_update

PortainerStack stack_update(id, body, endpoint_id=endpoint_id)

Update a stack

Update a stack. Access policy: restricted

Example

from __future__ import print_function
import time
import portainer_ce_api
from portainer_ce_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: jwt
configuration = portainer_ce_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = portainer_ce_api.StacksApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | Stack identifier
body = portainer_ce_api.StacksUpdateSwarmStackPayload() # StacksUpdateSwarmStackPayload | Stack details
endpoint_id = 56 # int | Stacks created before version 1.18.0 might not have an associated endpoint identifier. Use this optional parameter to set the endpoint identifier used by the stack. (optional)

try:
    # Update a stack
    api_response = api_instance.stack_update(id, body, endpoint_id=endpoint_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StacksApi->stack_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Stack identifier
body	StacksUpdateSwarmStackPayload	Stack details
endpoint_id	int	Stacks created before version 1.18.0 might not have an associated endpoint identifier. Use this optional parameter to set the endpoint identifier used by the stack.	[optional]

Return type

PortainerStack

Authorization

jwt

HTTP request headers

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

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

Files

StacksApi.md

Latest commit

History

StacksApi.md

File metadata and controls

portainer_ce_api.StacksApi

stack_create

Example

Parameters

Return type

Authorization

HTTP request headers

stack_delete

Example

Parameters

Return type

Authorization

HTTP request headers

stack_file_inspect

Example

Parameters

Return type

Authorization

HTTP request headers

stack_inspect

Example

Parameters

Return type

Authorization

HTTP request headers

stack_list

Example

Parameters

Return type

Authorization

HTTP request headers

stack_migrate

Example

Parameters

Return type

Authorization

HTTP request headers

stack_start

Example

Parameters

Return type

Authorization

HTTP request headers

stack_stop

Example

Parameters

Return type

Authorization

HTTP request headers

stack_update

Example

Parameters

Return type

Authorization

HTTP request headers