ServerApi class reference

All URIs are relative to http://localhost

list_share

list_share( directory=None, search=None, **kwargs )

List files/directories in the mounted share

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    directory = "directory_example" # str | Directory to browse (optional)
    search = "search_example" # str | Search for specific files (optional)

    try:
        (data, response) = api_client.server_api.list_share(
            directory=directory,
            search=search,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling ServerApi.list_share(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[typing.List[FileInfo], urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details

retrieve_about

retrieve_about( **kwargs )

Get basic CVAT information

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:

    try:
        (data, response) = api_client.server_api.retrieve_about()
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling ServerApi.retrieve_about(): %s\n" % e)

Parameters

This endpoint does not need any parameter.

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[About, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details

retrieve_annotation_formats

retrieve_annotation_formats( **kwargs )

Get supported annotation formats

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:

    try:
        (data, response) = api_client.server_api.retrieve_annotation_formats()
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling ServerApi.retrieve_annotation_formats(): %s\n" % e)

Parameters

This endpoint does not need any parameter.

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[DatasetFormats, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details

retrieve_plugins

retrieve_plugins( **kwargs )

Get enabled plugins

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:

    try:
        (data, response) = api_client.server_api.retrieve_plugins()
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling ServerApi.retrieve_plugins(): %s\n" % e)

Parameters

This endpoint does not need any parameter.

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[Plugins, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details