You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
682 lines
24 KiB
Markdown
682 lines
24 KiB
Markdown
# cvat_sdk.ServerApi
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**server_create_exception**](ServerApi.md#server_create_exception) | **POST** /api/server/exception | Method saves an exception from a client on the server
|
|
[**server_create_logs**](ServerApi.md#server_create_logs) | **POST** /api/server/logs | Method saves logs from a client on the server
|
|
[**server_list_share**](ServerApi.md#server_list_share) | **GET** /api/server/share | Returns all files and folders that are on the server along specified path
|
|
[**server_retrieve_about**](ServerApi.md#server_retrieve_about) | **GET** /api/server/about | Method provides basic CVAT information
|
|
[**server_retrieve_annotation_formats**](ServerApi.md#server_retrieve_annotation_formats) | **GET** /api/server/annotation/formats | Method provides the list of supported annotations formats
|
|
[**server_retrieve_plugins**](ServerApi.md#server_retrieve_plugins) | **GET** /api/server/plugins | Method provides allowed plugins
|
|
|
|
|
|
# **server_create_exception**
|
|
> Exception server_create_exception(exception_request)
|
|
|
|
Method saves an exception from a client on the server
|
|
|
|
Sends logs to the ELK if it is connected
|
|
|
|
### Example
|
|
|
|
* Api Key Authentication (SignatureAuthentication):
|
|
* Basic Authentication (basicAuth):
|
|
* Api Key Authentication (cookieAuth):
|
|
* Api Key Authentication (tokenAuth):
|
|
|
|
```python
|
|
import time
|
|
import cvat_sdk
|
|
from cvat_sdk.api import server_api
|
|
from cvat_sdk.model.exception_request import ExceptionRequest
|
|
from cvat_sdk.model.exception import Exception
|
|
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 = cvat_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 API key authorization: SignatureAuthentication
|
|
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'
|
|
|
|
# Configure HTTP basic authorization: basicAuth
|
|
configuration = cvat_sdk.Configuration(
|
|
username = 'YOUR_USERNAME',
|
|
password = 'YOUR_PASSWORD'
|
|
)
|
|
|
|
# Configure API key authorization: cookieAuth
|
|
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
|
|
# Configure API key authorization: tokenAuth
|
|
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
|
|
# Enter a context with an instance of the API client
|
|
with cvat_sdk.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = server_api.ServerApi(api_client)
|
|
exception_request = ExceptionRequest(
|
|
system="system_example",
|
|
client="client_example",
|
|
time=dateutil_parser('1970-01-01T00:00:00.00Z'),
|
|
job_id=1,
|
|
task_id=1,
|
|
proj_id=1,
|
|
client_id=1,
|
|
message="message_example",
|
|
filename="filename_example",
|
|
line=1,
|
|
column=1,
|
|
stack="stack_example",
|
|
) # ExceptionRequest |
|
|
x_organization = "X-Organization_example" # str | (optional)
|
|
org = "org_example" # str | Organization unique slug (optional)
|
|
org_id = 1 # int | Organization identifier (optional)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
try:
|
|
# Method saves an exception from a client on the server
|
|
api_response = api_instance.server_create_exception(exception_request)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling ServerApi->server_create_exception: %s\n" % e)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
# Method saves an exception from a client on the server
|
|
api_response = api_instance.server_create_exception(exception_request, x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling ServerApi->server_create_exception: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**exception_request** | [**ExceptionRequest**](ExceptionRequest.md)| |
|
|
**x_organization** | **str**| | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
[**Exception**](Exception.md)
|
|
|
|
### Authorization
|
|
|
|
[SignatureAuthentication](../README.md#SignatureAuthentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data, application/offset+octet-stream
|
|
- **Accept**: application/vnd.cvat+json
|
|
|
|
|
|
### HTTP response details
|
|
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
**201** | | - |
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **server_create_logs**
|
|
> [LogEvent] server_create_logs(log_event_request)
|
|
|
|
Method saves logs from a client on the server
|
|
|
|
Sends logs to the ELK if it is connected
|
|
|
|
### Example
|
|
|
|
* Api Key Authentication (SignatureAuthentication):
|
|
* Basic Authentication (basicAuth):
|
|
* Api Key Authentication (cookieAuth):
|
|
* Api Key Authentication (tokenAuth):
|
|
|
|
```python
|
|
import time
|
|
import cvat_sdk
|
|
from cvat_sdk.api import server_api
|
|
from cvat_sdk.model.log_event import LogEvent
|
|
from cvat_sdk.model.log_event_request import LogEventRequest
|
|
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 = cvat_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 API key authorization: SignatureAuthentication
|
|
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'
|
|
|
|
# Configure HTTP basic authorization: basicAuth
|
|
configuration = cvat_sdk.Configuration(
|
|
username = 'YOUR_USERNAME',
|
|
password = 'YOUR_PASSWORD'
|
|
)
|
|
|
|
# Configure API key authorization: cookieAuth
|
|
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
|
|
# Configure API key authorization: tokenAuth
|
|
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
|
|
# Enter a context with an instance of the API client
|
|
with cvat_sdk.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = server_api.ServerApi(api_client)
|
|
log_event_request = [
|
|
LogEventRequest(
|
|
job_id=1,
|
|
task_id=1,
|
|
proj_id=1,
|
|
client_id=1,
|
|
name="name_example",
|
|
time=dateutil_parser('1970-01-01T00:00:00.00Z'),
|
|
message="message_example",
|
|
payload={
|
|
"key": None,
|
|
},
|
|
is_active=True,
|
|
),
|
|
] # [LogEventRequest] |
|
|
x_organization = "X-Organization_example" # str | (optional)
|
|
org = "org_example" # str | Organization unique slug (optional)
|
|
org_id = 1 # int | Organization identifier (optional)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
try:
|
|
# Method saves logs from a client on the server
|
|
api_response = api_instance.server_create_logs(log_event_request)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling ServerApi->server_create_logs: %s\n" % e)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
# Method saves logs from a client on the server
|
|
api_response = api_instance.server_create_logs(log_event_request, x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling ServerApi->server_create_logs: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**log_event_request** | [**[LogEventRequest]**](LogEventRequest.md)| |
|
|
**x_organization** | **str**| | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
[**[LogEvent]**](LogEvent.md)
|
|
|
|
### Authorization
|
|
|
|
[SignatureAuthentication](../README.md#SignatureAuthentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data, application/offset+octet-stream
|
|
- **Accept**: application/vnd.cvat+json
|
|
|
|
|
|
### HTTP response details
|
|
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
**201** | | - |
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **server_list_share**
|
|
> [FileInfo] server_list_share()
|
|
|
|
Returns all files and folders that are on the server along specified path
|
|
|
|
### Example
|
|
|
|
* Api Key Authentication (SignatureAuthentication):
|
|
* Basic Authentication (basicAuth):
|
|
* Api Key Authentication (cookieAuth):
|
|
* Api Key Authentication (tokenAuth):
|
|
|
|
```python
|
|
import time
|
|
import cvat_sdk
|
|
from cvat_sdk.api import server_api
|
|
from cvat_sdk.model.file_info import FileInfo
|
|
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 = cvat_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 API key authorization: SignatureAuthentication
|
|
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'
|
|
|
|
# Configure HTTP basic authorization: basicAuth
|
|
configuration = cvat_sdk.Configuration(
|
|
username = 'YOUR_USERNAME',
|
|
password = 'YOUR_PASSWORD'
|
|
)
|
|
|
|
# Configure API key authorization: cookieAuth
|
|
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
|
|
# Configure API key authorization: tokenAuth
|
|
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
|
|
# Enter a context with an instance of the API client
|
|
with cvat_sdk.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = server_api.ServerApi(api_client)
|
|
x_organization = "X-Organization_example" # str | (optional)
|
|
directory = "directory_example" # str | Directory to browse (optional)
|
|
org = "org_example" # str | Organization unique slug (optional)
|
|
org_id = 1 # int | Organization identifier (optional)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
# Returns all files and folders that are on the server along specified path
|
|
api_response = api_instance.server_list_share(x_organization=x_organization, directory=directory, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling ServerApi->server_list_share: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**x_organization** | **str**| | [optional]
|
|
**directory** | **str**| Directory to browse | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
[**[FileInfo]**](FileInfo.md)
|
|
|
|
### Authorization
|
|
|
|
[SignatureAuthentication](../README.md#SignatureAuthentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/vnd.cvat+json
|
|
|
|
|
|
### HTTP response details
|
|
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
**200** | | - |
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **server_retrieve_about**
|
|
> About server_retrieve_about()
|
|
|
|
Method provides basic CVAT information
|
|
|
|
### Example
|
|
|
|
* Api Key Authentication (SignatureAuthentication):
|
|
* Basic Authentication (basicAuth):
|
|
* Api Key Authentication (cookieAuth):
|
|
* Api Key Authentication (tokenAuth):
|
|
|
|
```python
|
|
import time
|
|
import cvat_sdk
|
|
from cvat_sdk.api import server_api
|
|
from cvat_sdk.model.about import About
|
|
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 = cvat_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 API key authorization: SignatureAuthentication
|
|
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'
|
|
|
|
# Configure HTTP basic authorization: basicAuth
|
|
configuration = cvat_sdk.Configuration(
|
|
username = 'YOUR_USERNAME',
|
|
password = 'YOUR_PASSWORD'
|
|
)
|
|
|
|
# Configure API key authorization: cookieAuth
|
|
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
|
|
# Configure API key authorization: tokenAuth
|
|
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
|
|
# Enter a context with an instance of the API client
|
|
with cvat_sdk.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = server_api.ServerApi(api_client)
|
|
x_organization = "X-Organization_example" # str | (optional)
|
|
org = "org_example" # str | Organization unique slug (optional)
|
|
org_id = 1 # int | Organization identifier (optional)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
# Method provides basic CVAT information
|
|
api_response = api_instance.server_retrieve_about(x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling ServerApi->server_retrieve_about: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**x_organization** | **str**| | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
[**About**](About.md)
|
|
|
|
### Authorization
|
|
|
|
[SignatureAuthentication](../README.md#SignatureAuthentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/vnd.cvat+json
|
|
|
|
|
|
### HTTP response details
|
|
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
**200** | | - |
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **server_retrieve_annotation_formats**
|
|
> DatasetFormats server_retrieve_annotation_formats()
|
|
|
|
Method provides the list of supported annotations formats
|
|
|
|
### Example
|
|
|
|
* Api Key Authentication (SignatureAuthentication):
|
|
* Basic Authentication (basicAuth):
|
|
* Api Key Authentication (cookieAuth):
|
|
* Api Key Authentication (tokenAuth):
|
|
|
|
```python
|
|
import time
|
|
import cvat_sdk
|
|
from cvat_sdk.api import server_api
|
|
from cvat_sdk.model.dataset_formats import DatasetFormats
|
|
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 = cvat_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 API key authorization: SignatureAuthentication
|
|
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'
|
|
|
|
# Configure HTTP basic authorization: basicAuth
|
|
configuration = cvat_sdk.Configuration(
|
|
username = 'YOUR_USERNAME',
|
|
password = 'YOUR_PASSWORD'
|
|
)
|
|
|
|
# Configure API key authorization: cookieAuth
|
|
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
|
|
# Configure API key authorization: tokenAuth
|
|
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
|
|
# Enter a context with an instance of the API client
|
|
with cvat_sdk.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = server_api.ServerApi(api_client)
|
|
x_organization = "X-Organization_example" # str | (optional)
|
|
org = "org_example" # str | Organization unique slug (optional)
|
|
org_id = 1 # int | Organization identifier (optional)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
# Method provides the list of supported annotations formats
|
|
api_response = api_instance.server_retrieve_annotation_formats(x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling ServerApi->server_retrieve_annotation_formats: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**x_organization** | **str**| | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
[**DatasetFormats**](DatasetFormats.md)
|
|
|
|
### Authorization
|
|
|
|
[SignatureAuthentication](../README.md#SignatureAuthentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/vnd.cvat+json
|
|
|
|
|
|
### HTTP response details
|
|
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
**200** | | - |
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **server_retrieve_plugins**
|
|
> Plugins server_retrieve_plugins()
|
|
|
|
Method provides allowed plugins
|
|
|
|
### Example
|
|
|
|
* Api Key Authentication (SignatureAuthentication):
|
|
* Basic Authentication (basicAuth):
|
|
* Api Key Authentication (cookieAuth):
|
|
* Api Key Authentication (tokenAuth):
|
|
|
|
```python
|
|
import time
|
|
import cvat_sdk
|
|
from cvat_sdk.api import server_api
|
|
from cvat_sdk.model.plugins import Plugins
|
|
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 = cvat_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 API key authorization: SignatureAuthentication
|
|
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'
|
|
|
|
# Configure HTTP basic authorization: basicAuth
|
|
configuration = cvat_sdk.Configuration(
|
|
username = 'YOUR_USERNAME',
|
|
password = 'YOUR_PASSWORD'
|
|
)
|
|
|
|
# Configure API key authorization: cookieAuth
|
|
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
|
|
# Configure API key authorization: tokenAuth
|
|
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'
|
|
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'
|
|
|
|
# Enter a context with an instance of the API client
|
|
with cvat_sdk.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = server_api.ServerApi(api_client)
|
|
x_organization = "X-Organization_example" # str | (optional)
|
|
org = "org_example" # str | Organization unique slug (optional)
|
|
org_id = 1 # int | Organization identifier (optional)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
# Method provides allowed plugins
|
|
api_response = api_instance.server_retrieve_plugins(x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling ServerApi->server_retrieve_plugins: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**x_organization** | **str**| | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
[**Plugins**](Plugins.md)
|
|
|
|
### Authorization
|
|
|
|
[SignatureAuthentication](../README.md#SignatureAuthentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/vnd.cvat+json
|
|
|
|
|
|
### HTTP response details
|
|
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
**200** | | - |
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|