REST API Examples

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

Base URL

Icon

<hostname:portnumber>/apimanagement/manage/v1

Icon

All the requests and responses are in JSON format.

Register New Developer

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

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 a new application if not registered previously as well as 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

This request lists names of applications listed for client Id provided in the Query Parameter.

URI	/applications
HTTP	GET
Query Parameter	clientId

Response

Response

List Application based on Path parameter

This request lists details of applications for theApplication ID provided in the URI.

URI	/applications/{applicationId}
HTTP	GET

Response

Response

Unregister Application

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

URI	/applications/{applicationId}
HTTP	DELETE

Response

Response

Register Product

This request registers a Product within the Application with Application ID provided in the URI.

Icon

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

URI	/applications/{applicationId}/products
HTTP	POST

Example

Example

Response

Response

List Products

request lists Products based on the access level provided in the Query Parameter.

URI	/products
HTTP	GET
Query Parameter	accesslevel

Example

Response

Response

List APIs

This request lists APIs based on the API ID Provided in the URI.

URI	/apis/{apiId}
HTTP	GET

Response

Response

Return JSON for APIs

This request returns JSON for APIs based on the API ID provided in the URI.

URI	/apis/{apiId}.json
HTTP	GET

Response

Response

Deploy Project

This request deploys a Project based on the Project ID, Version and Server Group provided in the URI.

Icon

Server Group is the Gateway server name where products are deployed.

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

Response

Response

UnDeploy Project

This request undeploys a project based on the Project ID, Version and Server Groups provided in the URI.

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

Response

Response

List Server Group URL

This request lists the URL of the Server Group provided in the URI.

URI	/enviornments/{Environment}/urls
HTTP	GET

Response

Response