API Endpoints

Endpoints define the routes clients use to interact with an API. Each endpoint represents a resource or operation, with a path, method, and content type.

Manage Endpoints

While onboarding an API—or later from My APIs—you can add endpoints and configure custom headers, query parameters, response schema, and form data / body.

Supported methods:

• GET
• PUT
• POST
• PATCH
• DELETE

Supported content types when adding an endpoint:

• application/json
• application/x-www-form-encoded
• multipart/form-data
• application/xml

Note

The user role required to manage endpoints is platform-admin, api-product-manager, or api-developer.

Open Manage Endpoints

• Go to Manage APIs → select My APIs.

• Click for the API whose endpoints you need to manage.

Note

If the API is published, unpublish it before adding or changing endpoints. Visit Unpublish API. Published APIs remain viewable, but endpoint edits are locked.

• Scroll to Manage Endpoints and click Edit.

Add endpoints

Upload OpenAPI file

To register multiple endpoints at once:

• In the OpenAPI File section, click Upload.

• In the Upload OpenAPI file window:
  • Enter the Version number
  • Click Select File, then choose a Swagger 2.0 or OpenAPI 3.0.0 / 3.1.0 JSON specification
  • Click Upload

Note

Uploading an OpenAPI file deletes any existing endpoint data for this API and replaces it with the file contents.

Register endpoints manually

• On Manage Endpoints, click Add next to the endpoints list (from endpoint details, use Add Endpoint).

• In the add window, enter:
  • Endpoint Name
  • Endpoint Path
  • Method — GET | PUT | POST | DELETE | PATCH
  • Content Type — application/json | application/x-www-form-encoded | multipart/form-data | application/xml
  • Description (max 500 characters)
  • Base Path appears when already set for the API (read-only)

• Click Add Endpoints.

The endpoint is successfully added. Repeat to add more endpoints with different methods or content types as needed.

Edit an endpoint

• Open Manage Endpoints for the API (see Open Manage Endpoints).
• Select the endpoint.

• Update the endpoint fields as needed.

Info

Fields with asterisk (*) are mandatory.

Note

When editing an endpoint, Content Type options are application/json, application/x-www-form-encoded, and application/xml (multipart/form-data is available when adding, not when editing).

• Click Update.

• Click Back, then save the API edit if prompted.

Delete an endpoint

• Open Manage Endpoints for the API.
• Select the endpoint.

• Click Delete.

• Click Delete in the confirmation window.

The endpoint is successfully deleted.

Custom headers, query parameters, response schema, and form data

Endpoints support custom headers, query parameters, response schema, and form data / body so you can document request and response details for consumers.

Add Headers

• Open Manage Endpoints, select the endpoint, then open the Headers tab.
• Click Add Header.

• In the Add Header window:
  • Enter Name and Description
  • Select Type — String | Number | Boolean
  • For String or Number, enter Value
  • For Boolean, select True or False
  • Select Mandatory or Optional
  • Click Add

Info

Fields with asterisk (*) are mandatory.

The header is successfully added. Select another endpoint and repeat as needed.

Add Query Parameters

• Open Manage Endpoints, select the endpoint, then open the Query Parameter tab.

• Click Add Query Parameter.

• In the Add Query Parameters window:

  • Enter Name and Description
  • Select Type — String | Number | Boolean
  • For String or Number, enter Value
  • For Boolean, select True or False
  • Select Mandatory or Optional
  • Click Add

Info

Fields with asterisk (*) are mandatory.

The query parameter is successfully added.

Add Response Schema

• Open Manage Endpoints, select the endpoint, then open the Response Schema tab.

• Click Add Response Schema.

• In the Add Response Schema window:

  • Enter Name and Description
  • Select Type — String | Number | Boolean | Array | Modal
  • For String, Number, Array, or Modal: enter Status Code and Value
  • For Boolean: select True or False, then enter Status Code
  • Click Add

Info

Fields with asterisk (*) are mandatory.

The response schema is successfully added.

Add Form Data / Body

The Form Data / Body tab is available for PUT, POST, PATCH, and DELETE endpoints (not for GET).

• Open Manage Endpoints, select the endpoint, then open the Form Data / Body tab.

• Click Add Form Data / Body.

• In the Add Form Data / Payload / Body window:

  • Enter Name and Description
  • Select Type — String | Number | Boolean | Modal | Xml
  • For String or Number, enter Value
  • For Boolean, select True or False
  • For Modal or Xml, enter the corresponding Value
  • Select Mandatory or Optional
  • Click Add

Info

Fields with asterisk (*) are mandatory.

The form data / body field is successfully added.

Edit or delete headers, query parameters, response schema, or form data

• Open Manage Endpoints and select the endpoint.
• Open the relevant tab (Headers, Query Parameter, Response Schema, or Form Data / Body).
• Select the row, then click Edit or Delete.
• For edit: update fields in the popup, then click Update.

• For delete: confirm with Delete in the confirmation window.

The parameter is successfully updated or deleted.

Tryout

You can try an endpoint from Manage Endpoints or from endpoint details.

• On Manage Endpoints, click Tryout, or open an endpoint and click Tryout.
• Select the endpoint (and application keys as required), then run the tryout.

Note

Tryout on endpoint details is hidden when the API is published. For tryout with applications, see also How to use an application.

Policies

Endpoint details include a Policies section where you attach and configure gateway policies for that endpoint.

Available policy types grow over time; this page does not list them individually. To create and manage gateway policies, see Gateway Policies.