REST API Examples

Attach different path parameters (URIs) to the Base URL to accomplish various actions in the Application.

Icon

Base URL: <hostname:portnumber>/apimanagement/manage/v1

Icon

All the requests and responses are in JSON format.

Register New Developer

This request adds new developer based on the JSON provided in the body.

URI	/developers
HTTP	POST

Sample

JSON Sample

Example Input and Response

Input

Output/Response

List Developer

This request lists details for the developer based on the Developer ID provided in the URI.

URI	/developers/{developerId}
HTTP	GET

Response

Response

Edit Developer

This request edits details for the developer based on the Developer ID provided in the URI.

Icon

Do not edit Developer ID.

URI	/developers/{developerId}
HTTP	PUT

Sample

Sample JSON

Example Input and Response

Sample Input

Output/Response

Registering New Application and Editing Existing Application

This request registers new application if not registered previously and also edits an application that is already present.

URI	/applications
HTTP	POST
Query Parameter	clientId

Sample

Sample JSON

Example Input and Response

Input

Output/Response for new registration

Output/Response if "id" is already present

List Application based on Query parameter

Lists names of application for client Id provided in the Query Parameter.

URI	/applications
HTTP	GET
Query Parameter	clientId

Response

Response

List Application based on Path parameter

Lists details of the application for theApplication Id provided in the URI.

URI	/applications/{applicationId}
HTTP	GET

Response

Response

Unregister Application

This request removes an existing application based on Application Id provided in URI.

URI	/applications/{applicationId}
HTTP	DELETE

Response

Response

Register Product

Register Product in Application with Application Id provided in the URI.

Icon

The product added will be based on the Product Id provided in POST body.

URI	/applications/{applicationId}/products
HTTP	POST

Example

Example

Response

Response

List Products

List Products based on access level provided in Query Parameter.

URI	/products
HTTP	GET
Query Parameter	accesslevel

Example

Response

Response

List APIs

List APIs based on API ID Provided in the URI.

URI	/apis/{apiId}
HTTP	GET

Response

Response

Return JSON for APIs

Return JSON for APIs based on the API ID provided in the URI.

URI	/apis/{apiId}.json
HTTP	GET

Response

Response

Deploy Project

Deploy Project based on the Project ID, Version and Server Group in the URI.

Icon

Server Group is the Gateway server name where products will be deployed.

URI	/apis/{projectId}/{version}/deploy/{ServerGroup}
HTTP	PUT

Response

Response

UnDeploy Project

UnDeploy project based on the Project ID, Version and Server Groups in the URI.

URI	/apis/{projectId}/{version}/undeploy/{ServerGroup}
HTTP	PUT

Response

Response

List Server Group URL

Lists the URL of the Server Group provided in the URI.

URI	/ServerGroups/{ServerGroup}/urls
HTTP	GET

Response

Response