onepanel.core.api.SecretServiceApi

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

Method	HTTP request	Description
add_secret_key_value	POST /apis/v1beta1/{namespace}/secrets/{secret.name}
create_secret	POST /apis/v1beta1/{namespace}/secrets
delete_secret	DELETE /apis/v1beta1/{namespace}/secrets/{name}
delete_secret_key	DELETE /apis/v1beta1/{namespace}/secrets/{secretName}/keys/{key}
get_secret	GET /apis/v1beta1/{namespace}/secrets/{name}
list_secrets	GET /apis/v1beta1/{namespace}/secrets
secret_exists	GET /apis/v1beta1/{namespace}/secrets/{name}/exists
update_secret_key_value	PATCH /apis/v1beta1/{namespace}/secrets/{secret.name}

add_secret_key_value

AddSecretKeyValueResponse add_secret_key_value(namespace, secret_name, body)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# 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.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.SecretServiceApi(api_client)
    namespace = 'namespace_example' # str | 
secret_name = 'secret_name_example' # str | 
body = onepanel.core.api.Secret() # Secret | 

    try:
        api_response = api_instance.add_secret_key_value(namespace, secret_name, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SecretServiceApi->add_secret_key_value: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
secret_name	str
body	Secret

Return type

AddSecretKeyValueResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

create_secret

object create_secret(namespace, body)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# 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.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.SecretServiceApi(api_client)
    namespace = 'namespace_example' # str | 
body = onepanel.core.api.Secret() # Secret | 

    try:
        api_response = api_instance.create_secret(namespace, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SecretServiceApi->create_secret: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
body	Secret

Return type

object

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

delete_secret

DeleteSecretResponse delete_secret(namespace, name)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# 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.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.SecretServiceApi(api_client)
    namespace = 'namespace_example' # str | 
name = 'name_example' # str | 

    try:
        api_response = api_instance.delete_secret(namespace, name)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SecretServiceApi->delete_secret: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
name	str

Return type

DeleteSecretResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

delete_secret_key

DeleteSecretKeyResponse delete_secret_key(namespace, secret_name, key)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# 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.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.SecretServiceApi(api_client)
    namespace = 'namespace_example' # str | 
secret_name = 'secret_name_example' # str | 
key = 'key_example' # str | 

    try:
        api_response = api_instance.delete_secret_key(namespace, secret_name, key)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SecretServiceApi->delete_secret_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
secret_name	str
key	str

Return type

DeleteSecretKeyResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

get_secret

Secret get_secret(namespace, name)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# 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.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.SecretServiceApi(api_client)
    namespace = 'namespace_example' # str | 
name = 'name_example' # str | 

    try:
        api_response = api_instance.get_secret(namespace, name)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SecretServiceApi->get_secret: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
name	str

Return type

Secret

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

list_secrets

ListSecretsResponse list_secrets(namespace)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# 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.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.SecretServiceApi(api_client)
    namespace = 'namespace_example' # str | 

    try:
        api_response = api_instance.list_secrets(namespace)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SecretServiceApi->list_secrets: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str

Return type

ListSecretsResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

secret_exists

SecretExistsResponse secret_exists(namespace, name)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# 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.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.SecretServiceApi(api_client)
    namespace = 'namespace_example' # str | 
name = 'name_example' # str | 

    try:
        api_response = api_instance.secret_exists(namespace, name)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SecretServiceApi->secret_exists: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
name	str

Return type

SecretExistsResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

update_secret_key_value

UpdateSecretKeyValueResponse update_secret_key_value(namespace, secret_name, body)

Example

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import onepanel.core.api
from onepanel.core.api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8888
# See configuration.py for a list of all supported configuration parameters.
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888"
)

# 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.

# If inside Onepanel you do not need to pass any parameters to `get_access_token`
access_token = onepanel.core.auth.get_access_token(username='<username>', token='<token>', host='<host>')

# Configure API key authorization: Bearer
configuration = onepanel.core.api.Configuration(
    host = "http://localhost:8888",
    api_key = {
        'authorization': access_token
    }
)
configuration.api_key_prefix['authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with onepanel.core.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onepanel.core.api.SecretServiceApi(api_client)
    namespace = 'namespace_example' # str | 
secret_name = 'secret_name_example' # str | 
body = onepanel.core.api.Secret() # Secret | 

    try:
        api_response = api_instance.update_secret_key_value(namespace, secret_name, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SecretServiceApi->update_secret_key_value: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str
secret_name	str
body	Secret

Return type

UpdateSecretKeyValueResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, application/octet-stream

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

Files

SecretServiceApi.md

Latest commit

History

SecretServiceApi.md

File metadata and controls

onepanel.core.api.SecretServiceApi

add_secret_key_value

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_secret

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_secret

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_secret_key

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_secret

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_secrets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

secret_exists

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_secret_key_value

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details