openapi_client.LockfileApi

All URIs are relative to http://https://rest.vuls.biz

Method	HTTP request	Description
lockfile_add_lockfile	POST /v1/lockfile	addLockfile lockfile
lockfile_delete_lockfile	DELETE /v1/lockfile/{lockfileID}	deleteLockfile lockfile
lockfile_get_lockfile_detail	GET /v1/lockfile/{lockfileID}	getLockfileDetail lockfile
lockfile_get_lockfile_list	GET /v1/lockfiles	getLockfileList lockfile
lockfile_update_lockfile	PUT /v1/lockfile/{lockfileID}	updateLockfile lockfile

lockfile_add_lockfile

LockfileAddLockfileResponseBody lockfile_add_lockfile(add_lockfile_request_body)

addLockfile lockfile

add lockfile

Example

Api Key Authentication (api_key_header_Authorization):

import time
import openapi_client
from openapi_client.api import lockfile_api
from openapi_client.model.lockfile_add_lockfile_response_body import LockfileAddLockfileResponseBody
from openapi_client.model.lockfile_add_lockfile_request_body import LockfileAddLockfileRequestBody
from pprint import pprint
# Defining the host is optional and defaults to http://https://rest.vuls.biz
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://https://rest.vuls.biz"
)

# 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: api_key_header_Authorization
configuration.api_key['api_key_header_Authorization'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lockfile_api.LockfileApi(api_client)
    add_lockfile_request_body = LockfileAddLockfileRequestBody(
        file_content="",
        path="/FutureVuls/package.json",
        server_id=1,
    ) # LockfileAddLockfileRequestBody | 
    authorization = "Authorization_example" # str | api key auth (optional)

    # example passing only required values which don't have defaults set
    try:
        # addLockfile lockfile
        api_response = api_instance.lockfile_add_lockfile(add_lockfile_request_body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling LockfileApi->lockfile_add_lockfile: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # addLockfile lockfile
        api_response = api_instance.lockfile_add_lockfile(add_lockfile_request_body, authorization=authorization)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling LockfileApi->lockfile_add_lockfile: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_lockfile_request_body	LockfileAddLockfileRequestBody
authorization	str	api key auth	[optional]

Return type

LockfileAddLockfileResponseBody

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: application/json, application/xml, application/gob
Accept: application/json, application/xml, application/gob

HTTP response details

Status code	Description	Response headers
200	OK response.	-

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

lockfile_delete_lockfile

lockfile_delete_lockfile(lockfile_id)

deleteLockfile lockfile

lockfile delete

Example

Api Key Authentication (api_key_header_Authorization):

import time
import openapi_client
from openapi_client.api import lockfile_api
from pprint import pprint
# Defining the host is optional and defaults to http://https://rest.vuls.biz
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://https://rest.vuls.biz"
)

# 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: api_key_header_Authorization
configuration.api_key['api_key_header_Authorization'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lockfile_api.LockfileApi(api_client)
    lockfile_id = 1 # int | Lockfile ID
    authorization = "Authorization_example" # str | api key auth (optional)

    # example passing only required values which don't have defaults set
    try:
        # deleteLockfile lockfile
        api_instance.lockfile_delete_lockfile(lockfile_id)
    except openapi_client.ApiException as e:
        print("Exception when calling LockfileApi->lockfile_delete_lockfile: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # deleteLockfile lockfile
        api_instance.lockfile_delete_lockfile(lockfile_id, authorization=authorization)
    except openapi_client.ApiException as e:
        print("Exception when calling LockfileApi->lockfile_delete_lockfile: %s\n" % e)

Parameters

Name	Type	Description	Notes
lockfile_id	int	Lockfile ID
authorization	str	api key auth	[optional]

Return type

void (empty response body)

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK response.	-

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

lockfile_get_lockfile_detail

LockfileGetLockfileDetailResponseBody lockfile_get_lockfile_detail(lockfile_id)

getLockfileDetail lockfile

lockfile detail

Example

Api Key Authentication (api_key_header_Authorization):

import time
import openapi_client
from openapi_client.api import lockfile_api
from openapi_client.model.lockfile_get_lockfile_detail_response_body import LockfileGetLockfileDetailResponseBody
from pprint import pprint
# Defining the host is optional and defaults to http://https://rest.vuls.biz
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://https://rest.vuls.biz"
)

# 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: api_key_header_Authorization
configuration.api_key['api_key_header_Authorization'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lockfile_api.LockfileApi(api_client)
    lockfile_id = 1 # int | Lockfile ID
    authorization = "Authorization_example" # str | api key auth (optional)

    # example passing only required values which don't have defaults set
    try:
        # getLockfileDetail lockfile
        api_response = api_instance.lockfile_get_lockfile_detail(lockfile_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling LockfileApi->lockfile_get_lockfile_detail: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # getLockfileDetail lockfile
        api_response = api_instance.lockfile_get_lockfile_detail(lockfile_id, authorization=authorization)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling LockfileApi->lockfile_get_lockfile_detail: %s\n" % e)

Parameters

Name	Type	Description	Notes
lockfile_id	int	Lockfile ID
authorization	str	api key auth	[optional]

Return type

LockfileGetLockfileDetailResponseBody

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml, application/gob

HTTP response details

Status code	Description	Response headers
200	OK response.	-

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

lockfile_get_lockfile_list

LockfileGetLockfileListResponseBody lockfile_get_lockfile_list()

getLockfileList lockfile

lockfile list

Example

Api Key Authentication (api_key_header_Authorization):

import time
import openapi_client
from openapi_client.api import lockfile_api
from openapi_client.model.lockfile_get_lockfile_list_response_body import LockfileGetLockfileListResponseBody
from pprint import pprint
# Defining the host is optional and defaults to http://https://rest.vuls.biz
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://https://rest.vuls.biz"
)

# 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: api_key_header_Authorization
configuration.api_key['api_key_header_Authorization'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lockfile_api.LockfileApi(api_client)
    page = 1 # int | Page Number (optional) if omitted the server will use the default value of 1
    limit = 20 # int | Limit (optional) if omitted the server will use the default value of 20
    offset = 0 # int | Offset (optional) if omitted the server will use the default value of 0
    filter_server_id = 1 # int | ServerID filter (optional)
    filter_path = "filterPath_example" # str | Path filter (optional)
    authorization = "Authorization_example" # str | api key auth (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # getLockfileList lockfile
        api_response = api_instance.lockfile_get_lockfile_list(page=page, limit=limit, offset=offset, filter_server_id=filter_server_id, filter_path=filter_path, authorization=authorization)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling LockfileApi->lockfile_get_lockfile_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	Page Number	[optional] if omitted the server will use the default value of 1
limit	int	Limit	[optional] if omitted the server will use the default value of 20
offset	int	Offset	[optional] if omitted the server will use the default value of 0
filter_server_id	int	ServerID filter	[optional]
filter_path	str	Path filter	[optional]
authorization	str	api key auth	[optional]

Return type

LockfileGetLockfileListResponseBody

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml, application/gob

HTTP response details

Status code	Description	Response headers
200	OK response.	-

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

lockfile_update_lockfile

LockfileUpdateLockfileResponseBody lockfile_update_lockfile(lockfile_id, update_lockfile_request_body)

updateLockfile lockfile

update lockfile

Example

Api Key Authentication (api_key_header_Authorization):

import time
import openapi_client
from openapi_client.api import lockfile_api
from openapi_client.model.lockfile_update_lockfile_response_body import LockfileUpdateLockfileResponseBody
from openapi_client.model.lockfile_update_lockfile_request_body import LockfileUpdateLockfileRequestBody
from pprint import pprint
# Defining the host is optional and defaults to http://https://rest.vuls.biz
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://https://rest.vuls.biz"
)

# 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: api_key_header_Authorization
configuration.api_key['api_key_header_Authorization'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lockfile_api.LockfileApi(api_client)
    lockfile_id = 1 # int | Lockfile ID
    update_lockfile_request_body = LockfileUpdateLockfileRequestBody(
        file_content="",
        path="/FutureVuls/package.json",
    ) # LockfileUpdateLockfileRequestBody | 
    authorization = "Authorization_example" # str | api key auth (optional)

    # example passing only required values which don't have defaults set
    try:
        # updateLockfile lockfile
        api_response = api_instance.lockfile_update_lockfile(lockfile_id, update_lockfile_request_body)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling LockfileApi->lockfile_update_lockfile: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # updateLockfile lockfile
        api_response = api_instance.lockfile_update_lockfile(lockfile_id, update_lockfile_request_body, authorization=authorization)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling LockfileApi->lockfile_update_lockfile: %s\n" % e)

Parameters

Name	Type	Description	Notes
lockfile_id	int	Lockfile ID
update_lockfile_request_body	LockfileUpdateLockfileRequestBody
authorization	str	api key auth	[optional]

Return type

LockfileUpdateLockfileResponseBody

Authorization

api_key_header_Authorization

HTTP request headers

Content-Type: application/json, application/xml, application/gob
Accept: application/json, application/xml, application/gob

HTTP response details

Status code	Description	Response headers
200	OK response.	-

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

Files

LockfileApi.md

Latest commit

History

LockfileApi.md

File metadata and controls

openapi_client.LockfileApi

lockfile_add_lockfile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lockfile_delete_lockfile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lockfile_get_lockfile_detail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lockfile_get_lockfile_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lockfile_update_lockfile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details