Update NTLM Settings

Overview

Updates NTLM (NT LAN Manager) authentication settings for an API proxy. NTLM settings configure Windows authentication for backend connections.

Endpoint

PATCH /apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/ntlm/

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

{
  "enabled": true,
  "domain": "EXAMPLE",
  "username": "user",
  "password": "password",
  "workstation": "WORKSTATION01"
}

Request Body Fields

Field Type Required Default Description
enabled boolean No false Enable/disable NTLM authentication
domain string No* - Windows domain name (required if enabled=true)
username string No* - Windows username (required if enabled=true)
password string No* - Windows password (required if enabled=true)
workstation string No - Workstation name (optional)

Note: All fields are optional. Only provided fields are updated.

Password Security: Password is encrypted when stored.

Response

Success Response (200 OK)

{
  "success": true
}

Response Fields

Field Type Description
success boolean Indicates if the request was successful

Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "Domain, username, and password are required when NTLM is enabled"
}

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

Example 1: Enable NTLM Authentication

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/ntlm/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "domain": "EXAMPLE",
    "username": "user",
    "password": "password",
    "workstation": "WORKSTATION01"
  }'

Example 2: Enable NTLM without Workstation

curl -X PATCH \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/MyAPI/settings/ntlm/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "domain": "EXAMPLE",
    "username": "user",
    "password": "password"
  }'

Notes and Warnings

  • Domain: Windows domain name (required when enabled=true)
  • Username: Windows username (required when enabled=true)
  • Password: Windows password (required when enabled=true, encrypted when stored)
  • Workstation: Optional workstation name
  • NTLM Protocol: Uses NTLM v1/v2 authentication
  • Security: Password is encrypted using default encryption algorithm
  • Permissions: Requires ROLE_MANAGE_PROXIES permission