kowabunga.AgentApi

All URIs are relative to https://raw.githubusercontent.com/api/v1

Method	HTTP request	Description
create_agent	POST /agent
delete_agent	DELETE /agent/{agentId}
list_agents	GET /agent
read_agent	GET /agent/{agentId}
set_agent_api_token	PATCH /agent/{agentId}/token
update_agent	PUT /agent/{agentId}

create_agent

Agent create_agent(agent)

Creates a new Kowabunga remote agent.

Example

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

import kowabunga
from kowabunga.models.agent import Agent
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/api/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: 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 = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.AgentApi(api_client)
    agent = kowabunga.Agent() # Agent | Agent payload.

    try:
        api_response = api_instance.create_agent(agent)
        print("The response of AgentApi->create_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->create_agent: %s\n" % e)

Parameters

Name	Type	Description	Notes
agent	Agent	Agent payload.

Return type

Agent

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Returns the newly created Kowabunga remote agent object.	-
400	BadRequest error: Bad request (wrong input parameters).	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
409	Conflict error: A similar resource already exists or resource is still being referenced somewhere.	-
422	UnprocessableEntity error: Server can't process request.	-
507	InsufficientResource error: Server can't allocate resources (logical quotas or physical limits hit).	-

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

delete_agent

delete_agent(agent_id)

Deletes an existing Kowabunga remote agent.

Example

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

import kowabunga
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/api/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: 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 = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.AgentApi(api_client)
    agent_id = 'agent_id_example' # str | The ID of the Kowabunga remote agent.

    try:
        api_instance.delete_agent(agent_id)
    except Exception as e:
        print("Exception when calling AgentApi->delete_agent: %s\n" % e)

Parameters

Name	Type	Description	Notes
agent_id	str	The ID of the Kowabunga remote agent.

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The Kowabunga remote agent has been successfully removed.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
409	Conflict error: A similar resource already exists or resource is still being referenced somewhere.	-
422	UnprocessableEntity error: Server can't process request.	-

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

list_agents

List[str] list_agents()

Returns the IDs of Kowabunga remote agent objects.

Example

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

import kowabunga
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/api/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: 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 = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.AgentApi(api_client)

    try:
        api_response = api_instance.list_agents()
        print("The response of AgentApi->list_agents:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->list_agents: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[str]

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns an array of Kowabunga remote agent IDs.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-

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

read_agent

Agent read_agent(agent_id)

Returns a Kowabunga remote agent.

Example

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

import kowabunga
from kowabunga.models.agent import Agent
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/api/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: 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 = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.AgentApi(api_client)
    agent_id = 'agent_id_example' # str | The ID of the Kowabunga remote agent.

    try:
        api_response = api_instance.read_agent(agent_id)
        print("The response of AgentApi->read_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->read_agent: %s\n" % e)

Parameters

Name	Type	Description	Notes
agent_id	str	The ID of the Kowabunga remote agent.

Return type

Agent

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the Kowabunga remote agent object.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-

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

set_agent_api_token

ApiToken set_agent_api_token(agent_id, expire=expire, expiration_date=expiration_date)

Performs a Kowabunga remote agent setting of API token (will replace any existing one).

Example

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

import kowabunga
from kowabunga.models.api_token import ApiToken
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/api/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: 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 = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.AgentApi(api_client)
    agent_id = 'agent_id_example' # str | The ID of the Kowabunga remote agent.
    expire = True # bool | Whether or not the token should expire. (optional)
    expiration_date = '2013-10-20' # date | Token's expiration date (YYYY-MM-DD format). (optional)

    try:
        api_response = api_instance.set_agent_api_token(agent_id, expire=expire, expiration_date=expiration_date)
        print("The response of AgentApi->set_agent_api_token:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->set_agent_api_token: %s\n" % e)

Parameters

Name	Type	Description	Notes
agent_id	str	The ID of the Kowabunga remote agent.
expire	bool	Whether or not the token should expire.	[optional]
expiration_date	date	Token's expiration date (YYYY-MM-DD format).	[optional]

Return type

ApiToken

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Returns the Kowabunga remote agent object.	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
422	UnprocessableEntity error: Server can't process request.	-

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

update_agent

Agent update_agent(agent_id, agent)

Updates a Kowabunga remote agent configuration.

Example

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

import kowabunga
from kowabunga.models.agent import Agent
from kowabunga.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://raw.githubusercontent.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = kowabunga.Configuration(
    host = "https://raw.githubusercontent.com/api/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: 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 = kowabunga.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kowabunga.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kowabunga.AgentApi(api_client)
    agent_id = 'agent_id_example' # str | The ID of the Kowabunga remote agent.
    agent = kowabunga.Agent() # Agent | Agent payload.

    try:
        api_response = api_instance.update_agent(agent_id, agent)
        print("The response of AgentApi->update_agent:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AgentApi->update_agent: %s\n" % e)

Parameters

Name	Type	Description	Notes
agent_id	str	The ID of the Kowabunga remote agent.
agent	Agent	Agent payload.

Return type

Agent

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Returns the Kowabunga remote agent object.	-
400	BadRequest error: Bad request (wrong input parameters).	-
401	Unauthorized error: Unauthorized resource access (wrong auth/credentials).	-
403	Forbidden error: Forbidden resource access (restricted access control).	-
404	NotFound error: Specified resource does not exist.	-
422	UnprocessableEntity error: Server can't process request.	-
507	InsufficientResource error: Server can't allocate resources (logical quotas or physical limits hit).	-

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

FilesExpand file tree

AgentApi.md

Latest commit

History

AgentApi.md

File metadata and controls

kowabunga.AgentApi

create_agent

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_agent

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_agents

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

read_agent

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_agent_api_token

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_agent

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details