Ana içeriğe atla

​
Endpoint

GET /apiops/projects/{projectName}/apiProxies/{apiProxyName}/
Note: This endpoint may return the API proxy as part of the list endpoint response. Check the list endpoint for detailed information.

​
Authentication

Requires a Personal API Access Token. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer Yes

​
Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
apiProxyNamestringYesAPI Proxy name

​
Query Parameters

None

​
Response

​
Success Response (200 OK)

{
  "name": "MyAPI",
  "description": "My API Proxy description",
  "apiType": "REST",
  "categoryList": ["category1", "category2"],
  "sharingType": "PROJECT",
  "clientRoute": {
    "relativePathList": ["/api/v1"],
    "virtualHostList": ["api.example.com"]
  },
  "routing": {
    "routingEnabled": true,
    "routingAddressList": [
      {
        "address": "https://backend.example.com",
        "weight": 100,
        "healthCheckEnabled": true
      }
    ]
  },
  "deploymentList": [
    {
      "environmentName": "production",
      "deployed": true,
      "redeployRequired": false
    }
  ]
}

​
Response Fields

FieldTypeDescription
namestringAPI Proxy name
descriptionstringAPI Proxy description
apiTypestringAPI type (REST or SOAP)
categoryListarrayList of categories
sharingTypestringSharing type
clientRouteobjectClient route configuration
routingobjectRouting configuration
deploymentListarrayDeployment status per environment

​
EnumApiType

  • REST - REST API
  • SOAP - SOAP API
Enum: sharingType
  • PROJECT - Shared within project
  • ORGANIZATION - Shared within organization
  • PUBLIC - Publicly shared

​
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 GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Full JSON Body Example

This endpoint does not require a request body.

​
Notes and Warnings

  • Project Membership: User must be a member of the project
  • Case Sensitivity: API Proxy names are case-sensitive
  • Detailed Information: For complete API proxy details including endpoints and policies, use the list endpoints endpoint