Skip to main content
Previous section   Next section

Reference for the /api/mgmnt API

This reference lists the endpoints in the /api/mgmnt service, all of which apply to newer REST services. The following table summarizes the endpoints and indicates whether they also apply to manually-coded REST services.

Endpoint Summary Applies to NEWER REST Services? Applies to Manually-Coded REST Services?
DELETE /api/mgmnt/v2/:ns/:app Deletes the REST service YES no
GET /api/mgmnt Lists the REST-enabled web applications on this server YES YES
GET /api/mgmnt/v1/:ns/restapps Lists the REST-enabled web applications in the namespace YES YES
GET /api/mgmnt/v1/:ns/spec/:app Returns the OpenAPI 2.0 specification for the REST service no YES
GET /api/mgmnt/v2/ Lists the REST services on this server (including any that do not have an associated web application) YES no
GET /api/mgmnt/v2/:ns Lists the REST services in the namespace (including any that do not have an associated web application) YES no
GET /api/mgmnt/v2/:ns/:app Returns the OpenAPI 2.0 specification for the REST service YES YES

Here ns is a namespace, and app is the name of the package that contains the REST service classes.

  • DELETE /api/mgmnt/v2/:namespace/:application/ – Deletes the classes for the given REST application. Note that this call looks for a newer REST service. It ignores any manually-coded REST services.
  • GET /api/mgmnt/ – Returns an array that contains information about REST-enabled web applications in all namespaces.
  • GET /api/mgmnt/v1/:namespace/restapps – Returns an array that contains information about REST-enabled web applications in the given namespace.
  • GET /api/mgmnt/v1/:namespace/spec/:application/ – Returns the OpenAPI 2.0 specification for the given REST service, which must be a manually-coded REST service.
  • GET /api/mgmnt/v2/ – Returns an array that contains information about the newer REST services on the server (including any that do not have an associated web application). This call ignores any manually-coded REST services.
  • GET /api/mgmnt/v2/:namespace/ – Returns an array that contains information about the newer REST services in the given namespace (including any REST services that do not have an associated web application). This call ignores any manually-coded REST services.
  • GET /api/mgmnt/v2/:namespace/:application/ – Returns the OpenAPI 2.0 specification for the given REST service. The REST service can be either a newer REST service or a manually-coded REST service.
  • POST /api/mgmnt/v2/:namespace/:application – Given a Swagger (OpenAPI 2.0) specification, this call generates the scaffolding for the REST application.