Skip to content

Latest commit

 

History

History
263 lines (184 loc) · 8.35 KB

ApiKeysApi.md

File metadata and controls

263 lines (184 loc) · 8.35 KB

fastreport_cloud_sdk.ApiKeysApi

All URIs are relative to http://localhost

Method HTTP request Description
api_keys_create_api_key POST /api/manage/v1/ApiKeys Create a new apikey, 5 apikeys for user. Hardcoded for ddos.
api_keys_delete_api_key DELETE /api/manage/v1/ApiKeys Delete an apikey
api_keys_get_api_keys GET /api/manage/v1/ApiKeys Returns list with all apikeys of current user

api_keys_create_api_key

ApiKeyVM api_keys_create_api_key(create_api_key_vm)

Create a new apikey, 5 apikeys for user. Hardcoded for ddos.

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.api_key_vm import ApiKeyVM
from fastreport_cloud_sdk.models.create_api_key_vm import CreateApiKeyVM
from fastreport_cloud_sdk.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 = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.ApiKeysApi(api_client)
    create_api_key_vm = fastreport_cloud_sdk.CreateApiKeyVM() # CreateApiKeyVM | 

    try:
        # Create a new apikey, 5 apikeys for user. Hardcoded for ddos.
        api_response = api_instance.api_keys_create_api_key(create_api_key_vm)
        print("The response of ApiKeysApi->api_keys_create_api_key:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiKeysApi->api_keys_create_api_key: %s\n" % e)

Parameters

Name Type Description Notes
create_api_key_vm CreateApiKeyVM

Return type

ApiKeyVM

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Succesfully created -
400 wrong model provided or exception thrown (user's attempts to create sixth key for example throwns an exception) -
401 User is not authorized -

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

api_keys_delete_api_key

api_keys_delete_api_key(delete_api_key_vm)

Delete an apikey

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.delete_api_key_vm import DeleteApiKeyVM
from fastreport_cloud_sdk.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 = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with fastreport_cloud_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fastreport_cloud_sdk.ApiKeysApi(api_client)
    delete_api_key_vm = fastreport_cloud_sdk.DeleteApiKeyVM() # DeleteApiKeyVM | 

    try:
        # Delete an apikey
        api_instance.api_keys_delete_api_key(delete_api_key_vm)
    except Exception as e:
        print("Exception when calling ApiKeysApi->api_keys_delete_api_key: %s\n" % e)

Parameters

Name Type Description Notes
delete_api_key_vm DeleteApiKeyVM

Return type

void (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Succesfully deleted -
400 The request is wrong -
401 User is not authorized -
404 No such apikey found -

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

api_keys_get_api_keys

ApiKeysVM api_keys_get_api_keys()

Returns list with all apikeys of current user

Always work, it should make only 200 response (except if user is not authorized).

Example

  • Basic Authentication (ApiKey):
  • Bearer (JWT) Authentication (JWT):
import fastreport_cloud_sdk
from fastreport_cloud_sdk.models.api_keys_vm import ApiKeysVM
from fastreport_cloud_sdk.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 = fastreport_cloud_sdk.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: ApiKey
configuration = fastreport_cloud_sdk.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): JWT
configuration = fastreport_cloud_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

    try:
        # Returns list with all apikeys of current user
        api_response = api_instance.api_keys_get_api_keys()
        print("The response of ApiKeysApi->api_keys_get_api_keys:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiKeysApi->api_keys_get_api_keys: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ApiKeysVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Succesfully retured -
401 User is not authorized -

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