Skip to content

Latest commit

 

History

History
392 lines (277 loc) · 12.5 KB

EndpointGroupsApi.md

File metadata and controls

392 lines (277 loc) · 12.5 KB

portainer_ce_api.EndpointGroupsApi

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

Method HTTP request Description
endpoint_group_add_endpoint PUT /endpoint_groups/{id}/endpoints/{endpointId} Add an endpoint to an endpoint group
endpoint_group_delete DELETE /endpoint_groups/{id} Remove an endpoint group
endpoint_group_delete_endpoint DELETE /endpoint_groups/{id}/endpoints/{endpointId} Removes endpoint from an endpoint group
endpoint_group_list GET /endpoint_groups List Endpoint groups
endpoint_group_update PUT /endpoint_groups/:id Update an endpoint group
endpoint_groups_post POST /endpoint_groups Create an Endpoint Group
endpoint_groupsid_get GET /endpoint_groups/:id Inspect an Endpoint group

endpoint_group_add_endpoint

endpoint_group_add_endpoint(id, endpoint_id)

Add an endpoint to an endpoint group

Add an endpoint to an endpoint group Access policy: administrator

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.EndpointGroupsApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | EndpointGroup identifier
endpoint_id = 56 # int | Endpoint identifier

try:
    # Add an endpoint to an endpoint group
    api_instance.endpoint_group_add_endpoint(id, endpoint_id)
except ApiException as e:
    print("Exception when calling EndpointGroupsApi->endpoint_group_add_endpoint: %s\n" % e)

Parameters

Name Type Description Notes
id int EndpointGroup identifier
endpoint_id int Endpoint identifier

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]

endpoint_group_delete

endpoint_group_delete(id)

Remove an endpoint group

Remove an endpoint group. Access policy: administrator

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.EndpointGroupsApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | EndpointGroup identifier

try:
    # Remove an endpoint group
    api_instance.endpoint_group_delete(id)
except ApiException as e:
    print("Exception when calling EndpointGroupsApi->endpoint_group_delete: %s\n" % e)

Parameters

Name Type Description Notes
id int EndpointGroup identifier

Return type

void (empty response body)

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]

endpoint_group_delete_endpoint

endpoint_group_delete_endpoint(id, endpoint_id)

Removes endpoint from an endpoint group

Access policy: administrator

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.EndpointGroupsApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | EndpointGroup identifier
endpoint_id = 56 # int | Endpoint identifier

try:
    # Removes endpoint from an endpoint group
    api_instance.endpoint_group_delete_endpoint(id, endpoint_id)
except ApiException as e:
    print("Exception when calling EndpointGroupsApi->endpoint_group_delete_endpoint: %s\n" % e)

Parameters

Name Type Description Notes
id int EndpointGroup identifier
endpoint_id int Endpoint identifier

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]

endpoint_group_list

list[PortainerEndpointGroup] endpoint_group_list()

List Endpoint groups

List all endpoint groups based on the current user authorizations. Will return all endpoint groups if using an administrator account otherwise it will only return authorized endpoint groups. 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.EndpointGroupsApi(portainer_ce_api.ApiClient(configuration))

try:
    # List Endpoint groups
    api_response = api_instance.endpoint_group_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointGroupsApi->endpoint_group_list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[PortainerEndpointGroup]

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]

endpoint_group_update

PortainerEndpointGroup endpoint_group_update(id, body)

Update an endpoint group

Update an endpoint group. Access policy: administrator

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.EndpointGroupsApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | EndpointGroup identifier
body = portainer_ce_api.EndpointgroupsEndpointGroupUpdatePayload() # EndpointgroupsEndpointGroupUpdatePayload | EndpointGroup details

try:
    # Update an endpoint group
    api_response = api_instance.endpoint_group_update(id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointGroupsApi->endpoint_group_update: %s\n" % e)

Parameters

Name Type Description Notes
id int EndpointGroup identifier
body EndpointgroupsEndpointGroupUpdatePayload EndpointGroup details

Return type

PortainerEndpointGroup

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]

endpoint_groups_post

PortainerEndpointGroup endpoint_groups_post(body)

Create an Endpoint Group

Create a new endpoint group. Access policy: administrator

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.EndpointGroupsApi(portainer_ce_api.ApiClient(configuration))
body = portainer_ce_api.EndpointgroupsEndpointGroupCreatePayload() # EndpointgroupsEndpointGroupCreatePayload | Endpoint Group details

try:
    # Create an Endpoint Group
    api_response = api_instance.endpoint_groups_post(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointGroupsApi->endpoint_groups_post: %s\n" % e)

Parameters

Name Type Description Notes
body EndpointgroupsEndpointGroupCreatePayload Endpoint Group details

Return type

PortainerEndpointGroup

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]

endpoint_groupsid_get

PortainerEndpointGroup endpoint_groupsid_get(id)

Inspect an Endpoint group

Retrieve details abont an endpoint group. Access policy: administrator

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.EndpointGroupsApi(portainer_ce_api.ApiClient(configuration))
id = 56 # int | Endpoint group identifier

try:
    # Inspect an Endpoint group
    api_response = api_instance.endpoint_groupsid_get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointGroupsApi->endpoint_groupsid_get: %s\n" % e)

Parameters

Name Type Description Notes
id int Endpoint group identifier

Return type

PortainerEndpointGroup

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]