webMethods Developer Portal REST APIs

You can use the headless architecture feature of Developer Portal to build an application with the Developer Portal functions.

You can use the REST APIs that come along with the Developer Portal installation to perform all functions that you can accomplish through the application's user interface.

Developer Portal REST APIs are at InstallDir\DeveloperPortal\developers\openapis.

Authentication to use Developer Portal REST APIs

The authentication method applicable for the Developer Portal REST APIs is HTTP basic authentication.

Access privileges-based authorization

The availability of API resources is based on the user privilege. Typically, users who have the API AdministratorAPI AdministratorAPI mnagement admin privilege have access to all APIs, whereas the users the other privileges have limited access of API resources.

REST APIs URI format

You can access the Developer Portal resources by using URI paths. The REST call URI must be specified with corresponding methods in the following format.

http://host:port/portal/rest/v1/resource-name

The URI includes

Developer Portal URL: For example, http://host:port
Base path: For example, portal/rest
Version: For example, V1
Resource path: For example, apis

Possible response messages

The following table lists the possible response messages and what they indicate.

Response message	Description
`200 - OK`	The request is sent and a response is received.
`201 - Created`	The request is fulfilled, resulting in the creation of a new resource.
`400 - Bad request`	A parameter is missing in the request due to which it cannot be processed.
`401 - Unauthorized`	Authorization problem.
`403 - Forbidden`	No permission is available to the requested resource.
`404 - Not found`	The requested resource does not exist.
`500 - Internal server error`	An unexpected condition is encountered and no more specific message is suitable.

List of APIs

The following REST APIs are available in Developer Portal.