ADC NITRO APIs

mcpprofile

July 9, 2026

Contributed by:

Configuration for mcpProfile resource.

Properties

(click to see Operations )

Name	Permissions	Description
name	Read-write	Name for the mcp profile. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my mcp profile”).
proxymode	Read-write	Proxy mode for the MCP profile. FORWARD mode replaces Host and URL in backend requests. REVERSE mode passes requests as-is. Default value: FORWARD Possible values = FORWARD, REVERSE
profiletype	Read-write	Type of MCP profile. Frontend profiles apply to the entity that receives requests from a client. Backend profiles apply to the entity that sends client requests to a server. Default value: BACKEND Possible values = BACKEND, FRONTEND
hostreplacement	Read-write	Whether the Host header should be replaced with the backend MCP server FQDN in FORWARD proxy mode. If mcpProxyMode is FORWARD, this parameter is ENABLED bydefault. If mcpProxyMode is REVERSE, this parameter is DISABLED and cannot be ENABLED. Possible values = ENABLED, DISABLED
urlreplacement	Read-write	Whether the URL should be replaced with the backend MCP server URL in FORWARD proxy mode. If mcpProxyMode is FORWARD, this parameter is ENABLED bydefault. If mcpProxyMode is REVERSE, this parameter is DISABLED and cannot be ENABLED. Possible values = ENABLED, DISABLED
protocolversion	Read-write	MCP protocol version to advertise during monitoring of a mcp server.
tokenorapi	Read-write	If you like to insert Bearer or API token, configure this parameter with full header.
comment	Read-write	Any information about the MCP profile.
insertheaderinclientrequest	Read-write	Whether mcp_token_or_api configuration will be used for MCP requests coming from client. Default value: DISABLED Possible values = ENABLED, DISABLED
newname	Read-write	New name for the mcpProfile. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Minimum length = 1
_nextgenapiresource	Read-only	.
__count	Read-only	count parameter

Operations

(click to see Properties )

ADD
UPDATE
UNSET
DELETE
GET (ALL)
GET
COUNT
RENAME

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: * Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"mcpprofile":{
<b>"name":<String_value>,
</b>"proxymode":<String_value>,
"profiletype":<String_value>,
"hostreplacement":<String_value>,
"urlreplacement":<String_value>,
"protocolversion":<String_value>,
"tokenorapi":<String_value>,
"comment":<String_value>,
"insertheaderinclientrequest":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"mcpprofile":{
<b>"name":<String_value>,
</b>"proxymode":<String_value>,
"hostreplacement":<String_value>,
"urlreplacement":<String_value>,
"protocolversion":<String_value>,
"tokenorapi":<String_value>,
"comment":<String_value>,
"insertheaderinclientrequest":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile? action=unset HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"mcpprofile":{
<b>"name":<String_value>,
</b>"proxymode":true,
"hostreplacement":true,
"urlreplacement":true,
"protocolversion":true,
"tokenorapi":true,
"comment":true,
"insertheaderinclientrequest":true
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile/ name_value<String> HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

rename

URL: http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile? action=rename HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"mcpprofile":{
<b>"name":<String_value>,
</b><b>"newname":<String_value>
</b>}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of mcpprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile? view=summary

Use this query-parameter to get the summary output of mcpprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile? pagesize=#no;pageno=#no

Use this query-parameter to get the mcpprofile resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "mcpprofile": [ {
"name":<String_value>,
"proxymode":<String_value>,
"profiletype":<String_value>,
"hostreplacement":<String_value>,
"urlreplacement":<String_value>,
"protocolversion":<String_value>,
"tokenorapi":<String_value>,
"comment":<String_value>,
"insertheaderinclientrequest":<String_value>,
"_nextgenapiresource":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile/ name_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of mcpprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "mcpprofile": [ {
"name":<String_value>,
"proxymode":<String_value>,
"profiletype":<String_value>,
"hostreplacement":<String_value>,
"urlreplacement":<String_value>,
"protocolversion":<String_value>,
"tokenorapi":<String_value>,
"comment":<String_value>,
"insertheaderinclientrequest":<String_value>,
"_nextgenapiresource":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/mcpprofile? count=yes HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "mcpprofile": [ { "__count": "#no"} ] }

<!--NeedCopy-->

The official version of this product documentation is in English. Any non-English version is solely provided for your convenience and may include machine-translated content. For more information, please refer to the Machine Translation Disclaimer on Cloud Software Group home.

Was this helpful

mcpprofile

July 9, 2026

Contributed by:

July 9, 2026

Contributed by:

mcpprofile

Properties

Operations

add

update

unset

delete

rename

get (all)

get

count

In this article