AvailabilityApi.md

canopy.openapi.AvailabilityApi

All URIs are relative to http://localhost

Method	HTTP request	Description
availability_get	GET /availability
availability_head	HEAD /availability

availability_get

AvailabilityResult availability_get(full=full, ping=ping)

Example

from __future__ import print_function
import time
import canopy.openapi
from canopy.openapi.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = canopy.openapi.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with canopy.openapi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = canopy.openapi.AvailabilityApi(api_client)
    full = False # bool |  (optional) (default to False)
ping = False # bool |  (optional) (default to False)

    try:
        api_response = api_instance.availability_get(full=full, ping=ping)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AvailabilityApi->availability_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
full	bool		[optional] [default to False]
ping	bool		[optional] [default to False]

Return type

AvailabilityResult

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

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

availability_head

availability_head()

Example

from __future__ import print_function
import time
import canopy.openapi
from canopy.openapi.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = canopy.openapi.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with canopy.openapi.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = canopy.openapi.AvailabilityApi(api_client)
    
    try:
        api_instance.availability_head()
    except ApiException as e:
        print("Exception when calling AvailabilityApi->availability_head: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

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