thousandeyes-sdk-python/thousandeyes-sdk-connectors

thousandeyes-sdk-connectors

Note: The Webhook Operations APIs are not available for ThousandEyes for Government instance.

Manage connectors and operations.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 7.0.96
• Generator version: 7.6.0
• Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

Requirements.

Python 3.9+

Installation & Usage

pip install

Install directly via PyPi:

pip install thousandeyes-sdk-connectors

(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-connectors)

Then import the package:

import thousandeyes_sdk.connectors

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import thousandeyes_sdk.connectors

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import thousandeyes_sdk.core
import thousandeyes_sdk.connectors
from thousandeyes_sdk.core.exceptions import ApiException
from pprint import pprint

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

# 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 Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with thousandeyes_sdk.core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.connectors.CredentialVaultOperationsApi(api_client)
    credential_vault_operation = thousandeyes_sdk.connectors.CredentialVaultOperation() # CredentialVaultOperation | 
    aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)

    try:
        # Create Credential Vault operation
        api_response = api_instance.create_credential_vault_operation(credential_vault_operation, aid=aid)
        print("The response of CredentialVaultOperationsApi->create_credential_vault_operation:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CredentialVaultOperationsApi->create_credential_vault_operation: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.thousandeyes.com/v7

Class	Method	HTTP request	Description
CredentialVaultOperationsApi	create_credential_vault_operation	POST /operations/credential-vault	Create Credential Vault operation
CredentialVaultOperationsApi	delete_credential_vault_operation	DELETE /operations/credential-vault/{id}	Delete Credential Vault operation
CredentialVaultOperationsApi	get_credential_vault_operation	GET /operations/credential-vault/{id}	Get Credential Vault operation
CredentialVaultOperationsApi	get_credential_vault_operations	GET /operations/credential-vault	List Credential Vault operations
CredentialVaultOperationsApi	update_credential_vault_operation	PUT /operations/credential-vault/{id}	Update Credential Vault operation
CyberArkConjurConnectorsApi	create_conjur_connector	POST /connectors/conjur	Create Conjur connector
CyberArkConjurConnectorsApi	delete_conjur_connector	DELETE /connectors/conjur/{id}	Delete a Conjur connector
CyberArkConjurConnectorsApi	get_conjur_connector	GET /connectors/conjur/{id}	Retrieve a Conjur connector
CyberArkConjurConnectorsApi	get_conjur_connector_operations	GET /connectors/conjur/{id}/operations	List operation IDs for a Conjur connector
CyberArkConjurConnectorsApi	get_conjur_connectors	GET /connectors/conjur	List Conjur connectors
CyberArkConjurConnectorsApi	set_conjur_connector_operations	PUT /connectors/conjur/{id}/operations	Assign operations to a Conjur connector
CyberArkConjurConnectorsApi	update_conjur_connector	PUT /connectors/conjur/{id}	Update a Conjur connector
GenericConnectorsApi	create_generic_connector	POST /connectors/generic	Create connector
GenericConnectorsApi	delete_generic_connector	DELETE /connectors/generic/{id}	Delete connector
GenericConnectorsApi	get_generic_connector	GET /connectors/generic/{id}	Retrieve connector
GenericConnectorsApi	get_generic_connectors	GET /connectors/generic	List connectors
GenericConnectorsApi	list_generic_connector_operations	GET /connectors/generic/{id}/operations	List operation IDs for a connector
GenericConnectorsApi	set_generic_connector_operations	PUT /connectors/generic/{id}/operations	Assign operations to a connector
GenericConnectorsApi	update_generic_connector	PUT /connectors/generic/{id}	Update connector
OperationConnectorsApi	get_operation_connectors	GET /operations/{type}/{id}/connectors	Retrieve connectors assigned to an operation
OperationConnectorsApi	set_operation_connectors	PUT /operations/{type}/{id}/connectors	Assign connectors to an operation
WebhookOperationsApi	create_webhook_operation	POST /operations/webhooks	Create webhook operation
WebhookOperationsApi	delete_webhook_operation	DELETE /operations/webhooks/{id}	Delete webhook operation
WebhookOperationsApi	get_webhook_operation	GET /operations/webhooks/{id}	Retrieve webhook operation
WebhookOperationsApi	get_webhook_operations	GET /operations/webhooks	List webhook operations
WebhookOperationsApi	update_webhook_operation	PUT /operations/webhooks/{id}	Update webhook operation

Documentation For Models

• Assignments
• AuthenticationType
• BasicAuthentication
• BearerTokenAuthentication
• ConjurConnector
• ConjurConnectors
• ConjurHostAuthentication
• ConnectorType
• CredentialVaultOperation
• CredentialVaultOperations
• CredentialVaultSecret
• Error
• GenericConnector
• GenericConnectorAuth
• GenericConnectors
• Header
• Link
• OauthClientCredentialsAuthentication
• OauthCodeAuthentication
• OperationCategory
• OperationStatus
• OperationType
• OtherTokenAuthentication
• SelfLinks
• UnauthorizedError
• ValidationError
• ValidationErrorItem
• WebhookOperation
• WebhookOperations

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author

ThousandEyes API Team