Skip to content

Files

Latest commit

 

History

History
435 lines (312 loc) · 13.2 KB

EndpointsApi.md

File metadata and controls

435 lines (312 loc) · 13.2 KB

openapi_client.EndpointsApi

All URIs are relative to http://localhost:8080/api/v2

Method HTTP request Description
endpoints_create POST /endpoints/
endpoints_delete DELETE /endpoints/{id}/
endpoints_generate_report POST /endpoints/{id}/generate_report/
endpoints_list GET /endpoints/
endpoints_partial_update PATCH /endpoints/{id}/
endpoints_read GET /endpoints/{id}/
endpoints_update PUT /endpoints/{id}/

endpoints_create

Endpoint endpoints_create(data)

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.EndpointsApi(openapi_client.ApiClient(configuration))
data = openapi_client.Endpoint() # Endpoint | 

try:
    api_response = api_instance.endpoints_create(data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_create: %s\n" % e)

Parameters

Name Type Description Notes
data Endpoint

Return type

Endpoint

Authorization

api_key

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 -

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

endpoints_delete

endpoints_delete(id)

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.EndpointsApi(openapi_client.ApiClient(configuration))
id = 56 # int | A unique integer value identifying this endpoint.

try:
    api_instance.endpoints_delete(id)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_delete: %s\n" % e)

Parameters

Name Type Description Notes
id int A unique integer value identifying this endpoint.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 -

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

endpoints_generate_report

Endpoint endpoints_generate_report(id, data)

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.EndpointsApi(openapi_client.ApiClient(configuration))
id = 56 # int | A unique integer value identifying this endpoint.
data = openapi_client.Endpoint() # Endpoint | 

try:
    api_response = api_instance.endpoints_generate_report(id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_generate_report: %s\n" % e)

Parameters

Name Type Description Notes
id int A unique integer value identifying this endpoint.
data Endpoint

Return type

Endpoint

Authorization

api_key

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 -

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

endpoints_list

InlineResponse2001 endpoints_list(limit=limit, offset=offset)

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.EndpointsApi(openapi_client.ApiClient(configuration))
limit = 56 # int | Number of results to return per page. (optional)
offset = 56 # int | The initial index from which to return the results. (optional)

try:
    api_response = api_instance.endpoints_list(limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_list: %s\n" % e)

Parameters

Name Type Description Notes
limit int Number of results to return per page. [optional]
offset int The initial index from which to return the results. [optional]

Return type

InlineResponse2001

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

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

endpoints_partial_update

Endpoint endpoints_partial_update(id, data)

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.EndpointsApi(openapi_client.ApiClient(configuration))
id = 56 # int | A unique integer value identifying this endpoint.
data = openapi_client.Endpoint() # Endpoint | 

try:
    api_response = api_instance.endpoints_partial_update(id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_partial_update: %s\n" % e)

Parameters

Name Type Description Notes
id int A unique integer value identifying this endpoint.
data Endpoint

Return type

Endpoint

Authorization

api_key

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

endpoints_read

Endpoint endpoints_read(id)

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.EndpointsApi(openapi_client.ApiClient(configuration))
id = 56 # int | A unique integer value identifying this endpoint.

try:
    api_response = api_instance.endpoints_read(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_read: %s\n" % e)

Parameters

Name Type Description Notes
id int A unique integer value identifying this endpoint.

Return type

Endpoint

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

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

endpoints_update

Endpoint endpoints_update(id, data)

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.EndpointsApi(openapi_client.ApiClient(configuration))
id = 56 # int | A unique integer value identifying this endpoint.
data = openapi_client.Endpoint() # Endpoint | 

try:
    api_response = api_instance.endpoints_update(id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_update: %s\n" % e)

Parameters

Name Type Description Notes
id int A unique integer value identifying this endpoint.
data Endpoint

Return type

Endpoint

Authorization

api_key

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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