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 (must be REST type) |
Request Body
Full JSON Body Example
Request Body Fields
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Endpoint path/name (used to identify the endpoint) |
| httpMethod | string | Yes | HTTP method for the endpoint (used to identify the endpoint). See EnumHttpRequestMethod |
Query Parameters
NoneResponse
Success Response (200 OK)
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
Error Response (400 Bad Request)
Common Causes
- API Proxy is not REST type (SOAP endpoints cannot be deleted manually)
- Missing
nameorhttpMethodfields - Endpoint with specified name and httpMethod does not exist
Error Response (401 Unauthorized)
Error Response (404 Not Found)
cURL Example
Full JSON Body Example
Permissions
User must haveAPI_MANAGEMENT + MANAGE permission in the project.
Notes and Warnings
- REST Only: Endpoints can only be deleted from REST API proxies. SOAP endpoints are managed through WSDL reparsing
- Permanent Deletion: Endpoint deletion is permanent and cannot be undone
- Policies: All policies associated with the endpoint are also deleted
- Endpoint Identifier: Endpoint is identified by
nameandhttpMethodcombination (not by ID)
Related Documentation
- List Endpoints - List all endpoints
- Get Endpoint - Get endpoint details
- Create Endpoint - Create a new endpoint
- Update Endpoint - Update an endpoint

