Skip to main content
Ctrl+K
PyHPS - Home PyHPS - Home
  • Home
  • Getting started
  • User guide
  • API reference
  • Examples
    • Contribute
Ctrl+K
  • GitHub
  • Home
  • Getting started
  • User guide
  • API reference
  • Examples
  • Contribute
Ctrl+K
  • GitHub

Section Navigation

  • Client
  • Authentication service
  • Job Management Service (JMS)
  • Resource Management Service (RMS)
  • Exceptions
  • Route Creation Service (RCS)
    • RcsApi
      • health_check
      • register_instance
      • unregister_instance
      • health
      • url
    • RegisterInstance
    • RegisterInstanceResponse
    • UnRegisterInstance
    • UnRegisterInstanceResponse
  • PyAnsys
  • API reference
  • Route Creation Service (RCS)
  • RcsApi

RcsApi#

class ansys.hps.client.rcs.api.RcsApi(client)#

Wraps around the RCS root endpoints.

Parameters:
clientClient

HPS client object.

Initialize the RmsApi object.

Methods

RcsApi.health_check()

Check the health of the RCS API.

RcsApi.register_instance(data)

Register an instance to RCS.

RcsApi.unregister_instance(data)

Unregister an instance from RCS.

Attributes

RcsApi.health

Health status of the RCS API.

RcsApi.url

URL of the API.

On this page
  • RcsApi

© Copyright (c) 2026 ANSYS, Inc. All rights reserved.

Created using Sphinx 8.1.3.

Built with the Ansys Sphinx Theme 1.7.2.
Last updated on