dohq_teamcity.DebugApi¶

Note

All serve_* method have aliases with get: serve_something == get_something
Some API have get method - default method to get object by locator (e.g agent_api.get('id:123') return Agent model by id
See more examples on page /examples/api/DebugApi and model examples
This is autogenerated page, don’t change them directly, use template. Read more in Development

Method	HTTP request
delete_current_remember_me	DELETE `/app/rest/debug/currentRequest/rememberMe`
empty_task	POST `/app/rest/debug/emptyTask`
execute_db_query	GET `/app/rest/debug/database/query/{query}`
get_build_chain_optimization_log	GET `/app/rest/debug/buildChainOptimizationLog/{buildLocator}`
get_cached_build_promotions	GET `/app/rest/debug/caches/buildPromotions/content`
get_cached_build_promotions_stats	GET `/app/rest/debug/caches/buildPromotions/stats`
get_cached_builds_stat	GET `/app/rest/debug/caches/builds/stats`
get_current_session	GET `/app/rest/debug/currentRequest/session`
get_current_session_max_inactive_interval	GET `/app/rest/debug/currentRequest/session/maxInactiveSeconds`
get_current_user_permissions	GET `/app/rest/debug/currentUserPermissions`
get_date	GET `/app/rest/debug/date/{dateLocator}`
get_diagnostics_perf_stats	GET `/app/rest/debug/diagnostics/threadPerfStat/stats`
get_environment_variables	GET `/app/rest/debug/jvm/environmentVariables`
get_hashed	GET `/app/rest/debug/values/transform/{method}`
get_ip_address	GET `/app/rest/debug/dns/lookup/{host}`
get_raw_investigations	GET `/app/rest/debug/investigations`
get_request_details	GET `/app/rest/debug/currentRequest/details{extra}`
get_scrambled	GET `/app/rest/debug/values/password/scrambled`
get_sessions	GET `/app/rest/debug/sessions`
get_system_properties	GET `/app/rest/debug/jvm/systemProperties`
get_thread_dump	GET `/app/rest/debug/threadDump`
get_thread_interrupted	GET `/app/rest/debug/threads/{threadLocator}/interrupted`
get_unscrambled	GET `/app/rest/debug/values/password/unscrambled`
interrupt_thread	PUT `/app/rest/debug/threads/{threadLocator}/interrupted`
invalidate_current_session	DELETE `/app/rest/debug/currentRequest/session`
list_db_tables	GET `/app/rest/debug/database/tables`
new_remember_me	POST `/app/rest/debug/currentRequest/rememberMe`
post_request_details	POST `/app/rest/debug/currentRequest/details{extra}`
put_request_details	PUT `/app/rest/debug/currentRequest/details{extra}`
save_memory_dump	POST `/app/rest/debug/memory/dumps`
schedule_checking_for_changes	POST `/app/rest/debug/vcsCheckingForChangesQueue`
set_current_session_max_inactive_interval	PUT `/app/rest/debug/currentRequest/session/maxInactiveSeconds`

delete_current_remember_me¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))


try:
    tc.debug_api.delete_current_remember_me()
except ApiException as e:
    print("Exception when calling DebugApi->delete_current_remember_me: %s\n" % e)

This endpoint does not need any parameter.

Return type:: void (empty response body)

Back to top

empty_task¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

time = 'time_example' # str |  (optional)
load = 56 # int |  (optional)
memory = 56 # int |  (optional)
memory_chunks = 1 # int |  (optional) (default to 1)

try:
    api_response = tc.debug_api.empty_task(time=time, load=load, memory=memory, memory_chunks=memory_chunks)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->empty_task: %s\n" % e)

Name	Types	Notes
time	str	[optional]
load	int	[optional]
memory	int	[optional]
memory_chunks	int	[optional] [default to `1`]

Return type:: str

Back to top

execute_db_query¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

query = 'query_example' # str |
field_delimiter = ', ' # str |  (optional) (default to , )
data_retrieve_query = 'data_retrieve_query_example' # str |  (optional)
count = 1000 # int |  (optional) (default to 1000)

try:
    api_response = tc.debug_api.execute_db_query(query, field_delimiter=field_delimiter, data_retrieve_query=data_retrieve_query, count=count)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->execute_db_query: %s\n" % e)

Name	Types	Notes
query	str
field_delimiter	str	[optional] [default to ``, ``]
data_retrieve_query	str	[optional]
count	int	[optional] [default to `1000`]

Return type:: str

Back to top

get_build_chain_optimization_log¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

build_locator = 'build_locator_example' # str |

try:
    api_response = tc.debug_api.get_build_chain_optimization_log(build_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_build_chain_optimization_log: %s\n" % e)

Name	Types	Notes
build_locator	str

Return type:: str

Back to top

get_cached_build_promotions¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

build_type_locator = 'build_type_locator_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_cached_build_promotions(build_type_locator=build_type_locator, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_cached_build_promotions: %s\n" % e)

Name	Types	Notes
build_type_locator	str	[optional]
fields	str	[optional]

Return type:: Builds

Back to top

get_cached_build_promotions_stats¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_cached_build_promotions_stats(fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_cached_build_promotions_stats: %s\n" % e)

Name	Types	Notes
fields	str	[optional]

Return type:: Properties

Back to top

get_cached_builds_stat¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_cached_builds_stat(fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_cached_builds_stat: %s\n" % e)

Name	Types	Notes
fields	str	[optional]

Return type:: Properties

Back to top

get_current_session¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_current_session(fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_current_session: %s\n" % e)

Name	Types	Notes
fields	str	[optional]

Return type:: Session

Back to top

get_current_session_max_inactive_interval¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))


try:
    api_response = tc.debug_api.get_current_session_max_inactive_interval()
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_current_session_max_inactive_interval: %s\n" % e)

This endpoint does not need any parameter.

Return type:: str

Back to top

get_current_user_permissions¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))


try:
    api_response = tc.debug_api.get_current_user_permissions()
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_current_user_permissions: %s\n" % e)

This endpoint does not need any parameter.

Return type:: str

Back to top

get_date¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

date_locator = 'date_locator_example' # str |
format = 'format_example' # str |  (optional)
timezone = 'timezone_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_date(date_locator, format=format, timezone=timezone)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_date: %s\n" % e)

Name	Types	Notes
date_locator	str
format	str	[optional]
timezone	str	[optional]

Return type:: str

Back to top

get_diagnostics_perf_stats¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_diagnostics_perf_stats(fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_diagnostics_perf_stats: %s\n" % e)

Name	Types	Notes
fields	str	[optional]

Return type:: Properties

Back to top

get_environment_variables¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_environment_variables(fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_environment_variables: %s\n" % e)

Name	Types	Notes
fields	str	[optional]

Return type:: Properties

Back to top

get_hashed¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

method = 'method_example' # str |
value = 'value_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_hashed(method, value=value)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_hashed: %s\n" % e)

Name	Types	Notes
method	str
value	str	[optional]

Return type:: str

Back to top

get_ip_address¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

host = 'host_example' # str |

try:
    api_response = tc.debug_api.get_ip_address(host)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_ip_address: %s\n" % e)

Name	Types	Notes
host	str

Return type:: Items

Back to top

get_raw_investigations¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_raw_investigations(fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_raw_investigations: %s\n" % e)

Name	Types	Notes
fields	str	[optional]

Return type:: Investigations

Back to top

get_request_details¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

extra = 'extra_example' # str |

try:
    api_response = tc.debug_api.get_request_details(extra)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_request_details: %s\n" % e)

Name	Types	Notes
extra	str

Return type:: str

Back to top

get_scrambled¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

value = 'value_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_scrambled(value=value)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_scrambled: %s\n" % e)

Name	Types	Notes
value	str	[optional]

Return type:: str

Back to top

get_sessions¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

manager = 789 # int |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_sessions(manager=manager, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_sessions: %s\n" % e)

Name	Types	Notes
manager	int	[optional]
fields	str	[optional]

Return type:: Sessions

Back to top

get_system_properties¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_system_properties(fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_system_properties: %s\n" % e)

Name	Types	Notes
fields	str	[optional]

Return type:: Properties

Back to top

get_thread_dump¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

locked_monitors = 'locked_monitors_example' # str |  (optional)
locked_synchronizers = 'locked_synchronizers_example' # str |  (optional)
detect_locks = 'detect_locks_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_thread_dump(locked_monitors=locked_monitors, locked_synchronizers=locked_synchronizers, detect_locks=detect_locks)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_thread_dump: %s\n" % e)

Name	Types	Notes
locked_monitors	str	[optional]
locked_synchronizers	str	[optional]
detect_locks	str	[optional]

Return type:: str

Back to top

get_thread_interrupted¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

thread_locator = 'thread_locator_example' # str |

try:
    api_response = tc.debug_api.get_thread_interrupted(thread_locator)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_thread_interrupted: %s\n" % e)

Name	Types	Notes
thread_locator	str

Return type:: str

Back to top

get_unscrambled¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

value = 'value_example' # str |  (optional)

try:
    api_response = tc.debug_api.get_unscrambled(value=value)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->get_unscrambled: %s\n" % e)

Name	Types	Notes
value	str	[optional]

Return type:: str

Back to top

interrupt_thread¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

thread_locator = 'thread_locator_example' # str |
body = 'body_example' # str |  (optional)

try:
    api_response = tc.debug_api.interrupt_thread(thread_locator, body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->interrupt_thread: %s\n" % e)

Name	Types	Notes
thread_locator	str
body	str	[optional]

Return type:: str

Back to top

invalidate_current_session¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))


try:
    tc.debug_api.invalidate_current_session()
except ApiException as e:
    print("Exception when calling DebugApi->invalidate_current_session: %s\n" % e)

This endpoint does not need any parameter.

Return type:: void (empty response body)

Back to top

list_db_tables¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))


try:
    api_response = tc.debug_api.list_db_tables()
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->list_db_tables: %s\n" % e)

This endpoint does not need any parameter.

Return type:: str

Back to top

new_remember_me¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))


try:
    api_response = tc.debug_api.new_remember_me()
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->new_remember_me: %s\n" % e)

This endpoint does not need any parameter.

Return type:: str

Back to top

post_request_details¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

extra = 'extra_example' # str |

try:
    api_response = tc.debug_api.post_request_details(extra)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->post_request_details: %s\n" % e)

Name	Types	Notes
extra	str

Return type:: str

Back to top

put_request_details¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

extra = 'extra_example' # str |

try:
    api_response = tc.debug_api.put_request_details(extra)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->put_request_details: %s\n" % e)

Name	Types	Notes
extra	str

Return type:: str

Back to top

save_memory_dump¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

archived = true # bool |  (optional)

try:
    api_response = tc.debug_api.save_memory_dump(archived=archived)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->save_memory_dump: %s\n" % e)

Name	Types	Notes
archived	bool	[optional]

Return type:: str

Back to top

schedule_checking_for_changes¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

locator = 'locator_example' # str |  (optional)
requestor = 'requestor_example' # str |  (optional)
fields = 'fields_example' # str |  (optional)

try:
    api_response = tc.debug_api.schedule_checking_for_changes(locator=locator, requestor=requestor, fields=fields)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->schedule_checking_for_changes: %s\n" % e)

Name	Types	Notes
locator	str	[optional]
requestor	str	[optional]
fields	str	[optional]

Return type:: VcsRootInstances

Back to top

set_current_session_max_inactive_interval¶

from pprint import pprint
from dohq_teamcity import TeamCity, ApiException

# username/password authentication
tc = TeamCity("https://teamcity.example.com", auth=('username', 'password'))

body = 'body_example' # str |  (optional)

try:
    api_response = tc.debug_api.set_current_session_max_inactive_interval(body=body)
   pprint(api_response)
except ApiException as e:
    print("Exception when calling DebugApi->set_current_session_max_inactive_interval: %s\n" % e)

Name	Types	Notes
body	str	[optional]

Return type:: str

Back to top