Get Endpoint

Overview

Retrieves detailed information about a specific endpoint (API method). Policy details are not included by default.

Endpoint

POST /apiops/projects/{projectName}/apiProxies/{apiProxyName}/endpoints/details/

Authentication

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header Value Required
Authorization Bearer {token} 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

{
  "name": "/api/users",
  "httpMethod": "GET"
}

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

None

Response

Success Response (200 OK)

{
  "id": "endpoint-id",
  "endpoint": "/api/users",
  "description": "Get all users",
  "active": true,
  "httpMethod": "GET",
  "backendResourceUrl": "/users",
  "backendHttpMethod": "GET"
}

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

EnumHttpRequestMethod

  • GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD, TRACE, ALL

Note: Policy lists are not included. Use List Endpoint Policies to retrieve policy details.

Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "Endpoint identifier (name and httpMethod) must be provided in request body!"
}

or

{
  "error": "bad_request",
  "error_description": "Endpoint with name (/api/users) and HTTP method (GET) is not found!"
}

Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Invalid token"
}

Error Response (404 Not Found)

{
  "error": "not_found",
  "error_description": "ApiProxy (name: MyAPI) was not found!"
}

cURL Example

curl -X POST \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/endpoints/details/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "/api/users",
    "httpMethod": "GET"
  }'

Full JSON Body Example

{
  "name": "/api/users",
  "httpMethod": "GET"
}

Notes and Warnings

  • Endpoint Identifier: Endpoint is identified by name and httpMethod combination (not by ID)
  • Policy Details: Policy lists are not included. Use List Endpoint Policies to retrieve policies
  • Permissions: Requires ROLE_MANAGE_PROXIES permission