wordlift_client.DefaultApi

All URIs are relative to https://api.wordlift.io

Method	HTTP request	Description
abort_run_accounts_account_id_monitoring_runs_run_id_delete	DELETE /accounts/{account_id}/monitoring/runs/{run_id}	Abort Run
add_monitor_accounts_account_id_monitoring_monitors_post	POST /accounts/{account_id}/monitoring/monitors	Add Monitor
delete_monitor_accounts_account_id_monitoring_monitors_monitor_id_delete	DELETE /accounts/{account_id}/monitoring/monitors/{monitor_id}	Delete Monitor
get_check_timeseries_accounts_account_id_monitoring_monitors_monitor_id_checks_check_name_get	GET /accounts/{account_id}/monitoring/monitors/{monitor_id}/checks/{check_name}	Get Check Timeseries
get_monitor_accounts_account_id_monitoring_monitors_monitor_id_get	GET /accounts/{account_id}/monitoring/monitors/{monitor_id}	Get Monitor
get_monitor_status_accounts_account_id_monitoring_monitors_monitor_id_status_get	GET /accounts/{account_id}/monitoring/monitors/{monitor_id}/status	Get Monitor Status
get_run_accounts_account_id_monitoring_runs_run_id_get	GET /accounts/{account_id}/monitoring/runs/{run_id}	Get Run
health_health_get	GET /health	Health
list_monitor_statuses_accounts_account_id_monitoring_status_get	GET /accounts/{account_id}/monitoring/status	List Monitor Statuses
list_monitors_accounts_account_id_monitoring_monitors_get	GET /accounts/{account_id}/monitoring/monitors	List Monitors
list_runs_accounts_account_id_monitoring_runs_get	GET /accounts/{account_id}/monitoring/runs	List Runs
readiness_health_ready_get	GET /health/ready	Readiness
replace_monitors_accounts_account_id_monitoring_monitors_put	PUT /accounts/{account_id}/monitoring/monitors	Replace Monitors
update_monitor_accounts_account_id_monitoring_monitors_monitor_id_put	PUT /accounts/{account_id}/monitoring/monitors/{monitor_id}	Update Monitor

abort_run_accounts_account_id_monitoring_runs_run_id_delete

RunResponse abort_run_accounts_account_id_monitoring_runs_run_id_delete(run_id, account_id)

Abort Run

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.run_response import RunResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    run_id = 'run_id_example' # str | 
    account_id = 'account_id_example' # str | 

    try:
        # Abort Run
        api_response = await api_instance.abort_run_accounts_account_id_monitoring_runs_run_id_delete(run_id, account_id)
        print("The response of DefaultApi->abort_run_accounts_account_id_monitoring_runs_run_id_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->abort_run_accounts_account_id_monitoring_runs_run_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
run_id	str
account_id	str

Return type

RunResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

add_monitor_accounts_account_id_monitoring_monitors_post

MonitorResponse add_monitor_accounts_account_id_monitoring_monitors_post(account_id, add_resource_request)

Add Monitor

Adds a URL to the monitoring list for the given account.

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.add_resource_request import AddResourceRequest
from wordlift_client.models.monitor_response import MonitorResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    account_id = 'account_id_example' # str | 
    add_resource_request = wordlift_client.AddResourceRequest() # AddResourceRequest | 

    try:
        # Add Monitor
        api_response = await api_instance.add_monitor_accounts_account_id_monitoring_monitors_post(account_id, add_resource_request)
        print("The response of DefaultApi->add_monitor_accounts_account_id_monitoring_monitors_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_monitor_accounts_account_id_monitoring_monitors_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str
add_resource_request	AddResourceRequest

Return type

MonitorResponse

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful Response	-
422	Validation Error	-

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

delete_monitor_accounts_account_id_monitoring_monitors_monitor_id_delete

delete_monitor_accounts_account_id_monitoring_monitors_monitor_id_delete(monitor_id, account_id)

Delete Monitor

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    monitor_id = 'monitor_id_example' # str | 
    account_id = 'account_id_example' # str | 

    try:
        # Delete Monitor
        await api_instance.delete_monitor_accounts_account_id_monitoring_monitors_monitor_id_delete(monitor_id, account_id)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_monitor_accounts_account_id_monitoring_monitors_monitor_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
monitor_id	str
account_id	str

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Successful Response	-
422	Validation Error	-

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

get_check_timeseries_accounts_account_id_monitoring_monitors_monitor_id_checks_check_name_get

CheckTimeseriesResponse get_check_timeseries_accounts_account_id_monitoring_monitors_monitor_id_checks_check_name_get(monitor_id, check_name, account_id, since=since, to=to, limit=limit, sort=sort)

Get Check Timeseries

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.check_timeseries_response import CheckTimeseriesResponse
from wordlift_client.models.sort_direction import SortDirection
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    monitor_id = 'monitor_id_example' # str | 
    check_name = 'check_name_example' # str | 
    account_id = 'account_id_example' # str | 
    since = '2013-10-20T19:20:30+01:00' # datetime | Return results on or after this RFC 3339 timestamp (inclusive). (optional)
    to = '2013-10-20T19:20:30+01:00' # datetime | Return results on or before this RFC 3339 timestamp (inclusive). (optional)
    limit = 100 # int | Maximum number of data points to return. (optional) (default to 100)
    sort = wordlift_client.SortDirection() # SortDirection | Sort order: 'asc' for oldest-first (graphs), 'desc' for newest-first (history). (optional)

    try:
        # Get Check Timeseries
        api_response = await api_instance.get_check_timeseries_accounts_account_id_monitoring_monitors_monitor_id_checks_check_name_get(monitor_id, check_name, account_id, since=since, to=to, limit=limit, sort=sort)
        print("The response of DefaultApi->get_check_timeseries_accounts_account_id_monitoring_monitors_monitor_id_checks_check_name_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_check_timeseries_accounts_account_id_monitoring_monitors_monitor_id_checks_check_name_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
monitor_id	str
check_name	str
account_id	str
since	datetime	Return results on or after this RFC 3339 timestamp (inclusive).	[optional]
to	datetime	Return results on or before this RFC 3339 timestamp (inclusive).	[optional]
limit	int	Maximum number of data points to return.	[optional] [default to 100]
sort	SortDirection	Sort order: 'asc' for oldest-first (graphs), 'desc' for newest-first (history).	[optional]

Return type

CheckTimeseriesResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

get_monitor_accounts_account_id_monitoring_monitors_monitor_id_get

MonitorResponse get_monitor_accounts_account_id_monitoring_monitors_monitor_id_get(monitor_id, account_id)

Get Monitor

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.monitor_response import MonitorResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    monitor_id = 'monitor_id_example' # str | 
    account_id = 'account_id_example' # str | 

    try:
        # Get Monitor
        api_response = await api_instance.get_monitor_accounts_account_id_monitoring_monitors_monitor_id_get(monitor_id, account_id)
        print("The response of DefaultApi->get_monitor_accounts_account_id_monitoring_monitors_monitor_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_monitor_accounts_account_id_monitoring_monitors_monitor_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
monitor_id	str
account_id	str

Return type

MonitorResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

get_monitor_status_accounts_account_id_monitoring_monitors_monitor_id_status_get

MonitorStatusResponse get_monitor_status_accounts_account_id_monitoring_monitors_monitor_id_status_get(monitor_id, account_id)

Get Monitor Status

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.monitor_status_response import MonitorStatusResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    monitor_id = 'monitor_id_example' # str | 
    account_id = 'account_id_example' # str | 

    try:
        # Get Monitor Status
        api_response = await api_instance.get_monitor_status_accounts_account_id_monitoring_monitors_monitor_id_status_get(monitor_id, account_id)
        print("The response of DefaultApi->get_monitor_status_accounts_account_id_monitoring_monitors_monitor_id_status_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_monitor_status_accounts_account_id_monitoring_monitors_monitor_id_status_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
monitor_id	str
account_id	str

Return type

MonitorStatusResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

get_run_accounts_account_id_monitoring_runs_run_id_get

RunResponse get_run_accounts_account_id_monitoring_runs_run_id_get(run_id, account_id)

Get Run

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.run_response import RunResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    run_id = 'run_id_example' # str | 
    account_id = 'account_id_example' # str | 

    try:
        # Get Run
        api_response = await api_instance.get_run_accounts_account_id_monitoring_runs_run_id_get(run_id, account_id)
        print("The response of DefaultApi->get_run_accounts_account_id_monitoring_runs_run_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_run_accounts_account_id_monitoring_runs_run_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
run_id	str
account_id	str

Return type

RunResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

health_health_get

HealthResponse health_health_get()

Health

Example

import wordlift_client
from wordlift_client.models.health_response import HealthResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)


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

    try:
        # Health
        api_response = await api_instance.health_health_get()
        print("The response of DefaultApi->health_health_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->health_health_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

HealthResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

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

list_monitor_statuses_accounts_account_id_monitoring_status_get

ListMonitorStatusResponse list_monitor_statuses_accounts_account_id_monitoring_status_get(account_id, url=url, status=status, score_min=score_min, score_max=score_max, order_by=order_by, sort=sort, cursor=cursor, limit=limit)

List Monitor Statuses

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.list_monitor_status_response import ListMonitorStatusResponse
from wordlift_client.models.monitor_status_check_status import MonitorStatusCheckStatus
from wordlift_client.models.monitor_status_order_by import MonitorStatusOrderBy
from wordlift_client.models.sort_direction import SortDirection
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    account_id = 'account_id_example' # str | 
    url = 'url_example' # str | Glob pattern to filter by URL (e.g. `*example.com*`). (optional)
    status = [wordlift_client.MonitorStatusCheckStatus()] # List[MonitorStatusCheckStatus] | Filter by check status (repeatable, e.g. `?status=ERROR&status=WARNING`). (optional)
    score_min = 3.4 # float | Minimum score (inclusive). (optional)
    score_max = 3.4 # float | Maximum score (inclusive). (optional)
    order_by = wordlift_client.MonitorStatusOrderBy() # MonitorStatusOrderBy | Field to sort by. (optional)
    sort = wordlift_client.SortDirection() # SortDirection | Sort direction. (optional)
    cursor = 'cursor_example' # str | Opaque pagination cursor from a previous response. (optional)
    limit = 20 # int | Maximum number of items to return. (optional) (default to 20)

    try:
        # List Monitor Statuses
        api_response = await api_instance.list_monitor_statuses_accounts_account_id_monitoring_status_get(account_id, url=url, status=status, score_min=score_min, score_max=score_max, order_by=order_by, sort=sort, cursor=cursor, limit=limit)
        print("The response of DefaultApi->list_monitor_statuses_accounts_account_id_monitoring_status_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_monitor_statuses_accounts_account_id_monitoring_status_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str
url	str	Glob pattern to filter by URL (e.g. `example.com`).	[optional]
status	List[MonitorStatusCheckStatus]	Filter by check status (repeatable, e.g. `?status=ERROR&status=WARNING`).	[optional]
score_min	float	Minimum score (inclusive).	[optional]
score_max	float	Maximum score (inclusive).	[optional]
order_by	MonitorStatusOrderBy	Field to sort by.	[optional]
sort	SortDirection	Sort direction.	[optional]
cursor	str	Opaque pagination cursor from a previous response.	[optional]
limit	int	Maximum number of items to return.	[optional] [default to 20]

Return type

ListMonitorStatusResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

list_monitors_accounts_account_id_monitoring_monitors_get

ListMonitorsResponse list_monitors_accounts_account_id_monitoring_monitors_get(account_id, status=status, limit=limit, offset=offset)

List Monitors

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.list_monitors_response import ListMonitorsResponse
from wordlift_client.models.monitor_status import MonitorStatus
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    account_id = 'account_id_example' # str | 
    status = wordlift_client.MonitorStatus() # MonitorStatus | Filter by monitor status. (optional)
    limit = 100 # int | Maximum number of items to return. (optional) (default to 100)
    offset = 0 # int | Number of items to skip. (optional) (default to 0)

    try:
        # List Monitors
        api_response = await api_instance.list_monitors_accounts_account_id_monitoring_monitors_get(account_id, status=status, limit=limit, offset=offset)
        print("The response of DefaultApi->list_monitors_accounts_account_id_monitoring_monitors_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_monitors_accounts_account_id_monitoring_monitors_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str
status	MonitorStatus	Filter by monitor status.	[optional]
limit	int	Maximum number of items to return.	[optional] [default to 100]
offset	int	Number of items to skip.	[optional] [default to 0]

Return type

ListMonitorsResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

list_runs_accounts_account_id_monitoring_runs_get

ListRunsResponse list_runs_accounts_account_id_monitoring_runs_get(account_id, limit=limit, offset=offset)

List Runs

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.list_runs_response import ListRunsResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    account_id = 'account_id_example' # str | 
    limit = 5 # int | Maximum number of items to return. (optional) (default to 5)
    offset = 0 # int | Number of items to skip. (optional) (default to 0)

    try:
        # List Runs
        api_response = await api_instance.list_runs_accounts_account_id_monitoring_runs_get(account_id, limit=limit, offset=offset)
        print("The response of DefaultApi->list_runs_accounts_account_id_monitoring_runs_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->list_runs_accounts_account_id_monitoring_runs_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str
limit	int	Maximum number of items to return.	[optional] [default to 5]
offset	int	Number of items to skip.	[optional] [default to 0]

Return type

ListRunsResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

readiness_health_ready_get

ReadinessResponse readiness_health_ready_get()

Readiness

Example

import wordlift_client
from wordlift_client.models.readiness_response import ReadinessResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)


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

    try:
        # Readiness
        api_response = await api_instance.readiness_health_ready_get()
        print("The response of DefaultApi->readiness_health_ready_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->readiness_health_ready_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ReadinessResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
503	Service Unavailable	-

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

replace_monitors_accounts_account_id_monitoring_monitors_put

List[MonitorResponse] replace_monitors_accounts_account_id_monitoring_monitors_put(account_id, replace_monitors_request)

Replace Monitors

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.monitor_response import MonitorResponse
from wordlift_client.models.replace_monitors_request import ReplaceMonitorsRequest
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    account_id = 'account_id_example' # str | 
    replace_monitors_request = wordlift_client.ReplaceMonitorsRequest() # ReplaceMonitorsRequest | 

    try:
        # Replace Monitors
        api_response = await api_instance.replace_monitors_accounts_account_id_monitoring_monitors_put(account_id, replace_monitors_request)
        print("The response of DefaultApi->replace_monitors_accounts_account_id_monitoring_monitors_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->replace_monitors_accounts_account_id_monitoring_monitors_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str
replace_monitors_request	ReplaceMonitorsRequest

Return type

List[MonitorResponse]

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

update_monitor_accounts_account_id_monitoring_monitors_monitor_id_put

MonitorResponse update_monitor_accounts_account_id_monitoring_monitors_monitor_id_put(monitor_id, account_id, add_resource_request)

Update Monitor

Example

Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.add_resource_request import AddResourceRequest
from wordlift_client.models.monitor_response import MonitorResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.DefaultApi(api_client)
    monitor_id = 'monitor_id_example' # str | 
    account_id = 'account_id_example' # str | 
    add_resource_request = wordlift_client.AddResourceRequest() # AddResourceRequest | 

    try:
        # Update Monitor
        api_response = await api_instance.update_monitor_accounts_account_id_monitoring_monitors_monitor_id_put(monitor_id, account_id, add_resource_request)
        print("The response of DefaultApi->update_monitor_accounts_account_id_monitoring_monitors_monitor_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_monitor_accounts_account_id_monitoring_monitors_monitor_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
monitor_id	str
account_id	str
add_resource_request	AddResourceRequest

Return type

MonitorResponse

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

FilesExpand file tree

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

wordlift_client.DefaultApi

abort_run_accounts_account_id_monitoring_runs_run_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_monitor_accounts_account_id_monitoring_monitors_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_monitor_accounts_account_id_monitoring_monitors_monitor_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_check_timeseries_accounts_account_id_monitoring_monitors_monitor_id_checks_check_name_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_monitor_accounts_account_id_monitoring_monitors_monitor_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_monitor_status_accounts_account_id_monitoring_monitors_monitor_id_status_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_run_accounts_account_id_monitoring_runs_run_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

health_health_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_monitor_statuses_accounts_account_id_monitoring_status_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_monitors_accounts_account_id_monitoring_monitors_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_runs_accounts_account_id_monitoring_runs_get

Example

Parameters