Update Endpoint Status

Endpoint

PATCH /apiops/projects/{projectName}/apiProxies/{apiProxyName}/endpoints/status/

Authentication

Requires a Personal API Access Token.

Header

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

{
  "identifierName": "/api/users",
  "identifierHttpMethod": "GET",
  "active": false,
  "deploy": false,
  "deployTargetEnvironmentNameList": []
}

Request Body Fields

Field	Type	Required	Default	Description
identifierName	string	Yes	-	Endpoint path/name (used to identify the endpoint)
identifierHttpMethod	string	Yes	-	HTTP method for the endpoint (used to identify the endpoint). See EnumHttpRequestMethod
active	boolean	Yes	-	Whether endpoint is active/enabled (true = enabled, false = disabled)
deploy	boolean	No	false	If true, deploy the API proxy after saving changes
deployTargetEnvironmentNameList	array[string]	No	-	List of environment names to deploy to (required when deploy=true)

EnumHttpRequestMethod

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

Response

Success Response (200 OK)

{
  "success": true
}

When deploy=true is specified:

{
  "success": true,
  "deploymentResult": {
    "success": true,
    "deploymentResults": [
      {
        "environmentName": "production",
        "success": true,
        "message": "Deployment successful"
      }
    ]
  }
}

Response Fields

Field	Type	Description
success	boolean	Indicates if the request was successful
deploymentResult	object	Deployment result (only present when deploy=true)
deploymentResult.success	boolean	Whether the overall deployment was successful
deploymentResult.deploymentResults	array	Per-environment deployment results

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "Endpoint identifier (name and httpMethod) must be provided in request body!"
}

or

{
  "status": "FAILURE",
  "resultMessage": "Endpoint with name (/api/users) and HTTP method (GET) is not found!"
}

Common Causes

• Missing identifierName or identifierHttpMethod fields
• Missing active field
• Endpoint with specified name and httpMethod does not exist

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "Token is not valid!"
}

cURL Example

Example 1: Disable Endpoint

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/endpoints/status/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "identifierName": "/api/users",
    "identifierHttpMethod": "GET",
    "active": false
  }'

Example 2: Enable Endpoint

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/endpoints/status/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "identifierName": "/api/users",
    "identifierHttpMethod": "GET",
    "active": true
  }'

Example 3: Save and Deploy

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/endpoints/status/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "identifierName": "/api/users",
    "identifierHttpMethod": "GET",
    "active": false,
    "deploy": true,
    "deployTargetEnvironmentNameList": ["production"]
  }'

Permissions

User must have API_MANAGEMENT + MANAGE permission in the project.

Notes and Warnings

• Endpoint Identifier: Endpoint is identified by identifierName and identifierHttpMethod combination (not by ID)
• Disabled Endpoints: Disabled endpoints return 404 Not Found when accessed
• Policies: Policies remain associated with the endpoint even when disabled
• Deploy: When deploy=true, the API proxy is automatically deployed to the specified environments after saving

Related Documentation

• List Endpoints - List all endpoints
• Get Endpoint - Get endpoint details
• Update Endpoint - Update endpoint configuration
• Delete Endpoint - Delete an endpoint