ping

gwdatafind.ping(host=None, api='v1', session=None, **request_kw)

Ping the GWDataFind host to test for life.

Parameters:

• host (str, optional) – the URL/name of the GWDataFind host to query; if not given get_default_host() will be used to discover the default host.

• api (str, optional) – The API version to use. Defaults to the value of the GWDATAFIND_API environment variable, or "v1" if not set.

• session (requests.Session, optional) – the connection session to use; if not given, a igwn_auth_utils.Session will be created on-the-fly

• token – passed directly to igwn_auth_utils.Session, see SciTokens for more details.

• token_audience – passed directly to igwn_auth_utils.Session, see SciTokens for more details.

• token_scope – passed directly to igwn_auth_utils.Session, see SciTokens for more details.

• cert – passed directly to igwn_auth_utils.Session, see X.509 for more details.

• request_kw – other keywords are passed to igwn_auth_utils.get()

Returns:

version_info (dict) – The information returned from the /api/version API endpoint. For LDR-era servers this returns an empty list.

Raises:

requests.RequestException – if the request fails for any reason