Endpoint
Authentication
Requires a Personal API Access Token.Header
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer | Yes |
| Content-Type | application/json | Yes |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| projectName | string | Yes | Project name |
| apiProxyName | string | Yes | API Proxy name |
Request Body
Full JSON Body Example
Request Body Fields
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Endpoint path/name |
| httpMethod | string | Yes | HTTP method for the endpoint. See EnumHttpRequestMethod |
Query Parameters
NoneResponse
Success Response (200 OK)
Response Fields
| Field | Type | Description |
|---|---|---|
| id | string | Endpoint unique identifier |
| endpoint | string | Endpoint path/name |
| description | string | Endpoint description |
| active | boolean | Whether endpoint is active/enabled |
| httpMethod | string | HTTP method for the endpoint |
| backendResourceUrl | string | Backend resource URL |
| backendHttpMethod | string | HTTP method for backend call |
| requestPolicyList | array | List of request pipeline policies |
| responsePolicyList | array | List of response pipeline policies |
| errorPolicyList | array | List of error pipeline policies |
Policy Object Fields (in policy lists)
| Field | Type | Description |
|---|---|---|
| type | string | Policy type |
| name | string | Policy name |
| description | string | Policy description |
| active | boolean | Whether policy is active |
EnumHttpRequestMethod
GET,POST,PUT,DELETE,PATCH,OPTIONS,HEAD,TRACE,ALL
Error Response (400 Bad Request)
Error Response (401 Unauthorized)
Error Response (404 Not Found)
cURL Example
Full JSON Body Example
Permissions
User must have any permission in the project (read access).Notes and Warnings
- Endpoint Identifier: Endpoint is identified by
nameandhttpMethodcombination (not by ID) - Policy Details: Policy objects contain basic information only. For full policy configuration, use the Policies API
- Empty Lists: If no policies exist in a pipeline, an empty array is returned
Related Documentation
- List Endpoints - List all endpoints
- Get Endpoint - Get endpoint details (without policies)
- Policies API - Policy management API

