16 KiB
endpoint_test_results.LocalNetworkTestsResultsApi
All URIs are relative to https://api.thousandeyes.com
| Method | HTTP request | Description |
|---|---|---|
| get_endpoint_local_network_topology_details | GET /v7/endpoint/test-results/local-networks/topologies/{networkTopologyId} | Retrieve endpoint local network topology |
| get_endpoint_local_networks | GET /v7/endpoint/test-results/local-networks | List local networks |
| get_endpoint_local_networks_topologies | POST /v7/endpoint/test-results/local-networks/topologies/filter | List endpoint network topologies probes |
get_endpoint_local_network_topology_details
GetEndpointLocalNetworkTopologyDetails200Response get_endpoint_local_network_topology_details(network_topology_id, aid=aid)
Retrieve endpoint local network topology
Returns detailed data of a local network topology.
Example
- Bearer Authentication (BearerAuth):
import endpoint_test_results
from endpoint_test_results.models.get_endpoint_local_network_topology_details200_response import GetEndpointLocalNetworkTopologyDetails200Response
from endpoint_test_results.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = endpoint_test_results.Configuration(
host = "https://api.thousandeyes.com"
)
# 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 = endpoint_test_results.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with endpoint_test_results.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = endpoint_test_results.LocalNetworkTestsResultsApi(api_client)
network_topology_id = '00160:39c518560de9:1491651900:236e6f18' # str | The network topology ID.
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:
# Retrieve endpoint local network topology
api_response = api_instance.get_endpoint_local_network_topology_details(network_topology_id, aid=aid)
print("The response of LocalNetworkTestsResultsApi->get_endpoint_local_network_topology_details:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling LocalNetworkTestsResultsApi->get_endpoint_local_network_topology_details: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| network_topology_id | str | The network topology ID. | |
| aid | 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] |
Return type
GetEndpointLocalNetworkTopologyDetails200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/hal+json, application/problem+json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Insufficient permissions to query endpoint | - |
| 404 | Not found | - |
| 429 | Exhausted rate limit for the organization | - |
| 500 | Internal server error | - |
| 502 | Bad Gateway | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_endpoint_local_networks
GetEndpointLocalNetworks200Response get_endpoint_local_networks(aid=aid)
List local networks
Returns a list of all the networks used by endpoint agents. Sends back a localNetworks array.
Example
- Bearer Authentication (BearerAuth):
import endpoint_test_results
from endpoint_test_results.models.get_endpoint_local_networks200_response import GetEndpointLocalNetworks200Response
from endpoint_test_results.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = endpoint_test_results.Configuration(
host = "https://api.thousandeyes.com"
)
# 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 = endpoint_test_results.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with endpoint_test_results.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = endpoint_test_results.LocalNetworkTestsResultsApi(api_client)
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:
# List local networks
api_response = api_instance.get_endpoint_local_networks(aid=aid)
print("The response of LocalNetworkTestsResultsApi->get_endpoint_local_networks:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling LocalNetworkTestsResultsApi->get_endpoint_local_networks: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| aid | 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] |
Return type
GetEndpointLocalNetworks200Response
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/hal+json, application/problem+json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Insufficient permissions to query endpoint | - |
| 404 | Not found | - |
| 429 | Exhausted rate limit for the organization | - |
| 500 | Internal server error | - |
| 502 | Bad Gateway | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_endpoint_local_networks_topologies
GetEndpointLocalNetworksTopologies200Response get_endpoint_local_networks_topologies(aid=aid, window=window, start_date=start_date, end_date=end_date, cursor=cursor, get_endpoint_local_networks_topologies_request=get_endpoint_local_networks_topologies_request)
List endpoint network topologies probes
Returns a list of all endpoint local network topologies probes. Results from the last round are provided unless an explicit start and end is provided with startDate, endDate or window optional parameters. ## Request body filters This endpoint supports complex filtering using the request body. It is important these filters remain unaltered when making use of pagination, otherwise the results will not be coherent with the original request. ### Multiple filter fields When multiple filter fields are provided, a logical AND is applied between the filters. curl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/local-networks/topologies/filter' --header 'Authorization: Bearer $token' --header 'Content-Type: application/json' --data-raw '{ \"searchFilters\": { \"platform\": [ \"mac\" ], \"domain\": [ \"thousandeyes.com\" ] }}' ### Filter field with multiple values When a filter field contains multiple values, a logical OR is applied between the filter values. curl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/local-networks/topologies/filter' --header 'Authorization: Bearer $token' --header 'Content-Type: application/json' --data-raw '{ \"searchFilters\": { \"networkId\": [ \"660b34109d12\", \"660b34109d15\" ] }}' ### Combination of request parameters and body filters curl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/local-networks/topologies/filter?window=12h' --header 'Authorization: Bearer $token' --header 'Content-Type: application/json' --data-raw '{ \"searchFilters\": { \"platform\": [ \"mac\" ], \"domain\": [ \"thousandeyes.com\" ], \"networkId\": [ \"660b34109d12\", \"660b34109d15\" ] }}' ### Warning Note that a maximum of 12h worth of data can be retrieved at once. If you need more, you need to make multiple requests. Returns a results array of network topology probes. Network topology probes shown are from the latest round, or based on the time range specified.
Example
- Bearer Authentication (BearerAuth):
import endpoint_test_results
from endpoint_test_results.models.get_endpoint_local_networks_topologies200_response import GetEndpointLocalNetworksTopologies200Response
from endpoint_test_results.models.get_endpoint_local_networks_topologies_request import GetEndpointLocalNetworksTopologiesRequest
from endpoint_test_results.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = endpoint_test_results.Configuration(
host = "https://api.thousandeyes.com"
)
# 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 = endpoint_test_results.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with endpoint_test_results.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = endpoint_test_results.LocalNetworkTestsResultsApi(api_client)
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)
window = '12h' # str | A dynamic time interval up to the current time of the request. Specify the interval as a number followed by an optional type: `s` for seconds (default if no type is specified), `m` for minutes, `h` for hours, `d` for days, and `w` for weeks. For a precise date range, use `startDate` and `endDate`. (optional)
start_date = '2022-07-17T22:00:54Z' # datetime | Use with the `endDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. (optional)
end_date = '2022-07-18T22:00:54Z' # datetime | Defaults to current time the request is made. Use with the `startDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. (optional)
cursor = 'cursor_example' # str | (Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter. (optional)
get_endpoint_local_networks_topologies_request = endpoint_test_results.GetEndpointLocalNetworksTopologiesRequest() # GetEndpointLocalNetworksTopologiesRequest | (optional)
try:
# List endpoint network topologies probes
api_response = api_instance.get_endpoint_local_networks_topologies(aid=aid, window=window, start_date=start_date, end_date=end_date, cursor=cursor, get_endpoint_local_networks_topologies_request=get_endpoint_local_networks_topologies_request)
print("The response of LocalNetworkTestsResultsApi->get_endpoint_local_networks_topologies:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling LocalNetworkTestsResultsApi->get_endpoint_local_networks_topologies: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| aid | 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] |
| window | str | A dynamic time interval up to the current time of the request. Specify the interval as a number followed by an optional type: `s` for seconds (default if no type is specified), `m` for minutes, `h` for hours, `d` for days, and `w` for weeks. For a precise date range, use `startDate` and `endDate`. | [optional] |
| start_date | datetime | Use with the `endDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. | [optional] |
| end_date | datetime | Defaults to current time the request is made. Use with the `startDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. | [optional] |
| cursor | str | (Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter. | [optional] |
| get_endpoint_local_networks_topologies_request | GetEndpointLocalNetworksTopologiesRequest | [optional] |
Return type
GetEndpointLocalNetworksTopologies200Response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/hal+json, application/problem+json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Insufficient permissions to query endpoint | - |
| 404 | Not found | - |
| 429 | Exhausted rate limit for the organization | - |
| 500 | Internal server error | - |
| 502 | Bad Gateway | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]