Server API Guide#

RSPM offers a Swagger UI view, which follows the OpenAPI Specification to document the commonly requested endpoints.

Versioning of the API#

The RSPM API is new and experimental. It should not be relied upon for any production work between releases. These are endpoints that RSPM is making available to our customers to solicit feedback; they are subject to change without notice. Such changes include anything from altered request/response shapes, to complete abandonment of the endpoint.

Navigating to the Server API Guide#

To navigate to the Server API Guide, click the Server API Guide button on the sidebar of an RSPM installation, or go directly to the Server API Guide here.

Disabling the Server API Guide#

If you'd like to disable access to the Server API Guide, edit the configuration property [Swagger].Enabled like so:

[Swagger]
Enabled = false

For more information, see the Swagger configuration settings in the appendix.