ADC NITRO APIs

transformprofile_transformaction_binding

Binding object showing the transformaction that can be bound to transformprofile.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name of the profile.

Minimum length = 1
actionname Read-write URL Transformation action name.
priority Read-only Priority of the Action within the Profile.
resurlfrom Read-only Pattern of original response URLs. It corresponds to the way external users view the server, and acts as a source for response transformations.
cookiedomainfrom Read-only Pattern of the original domain in Set-Cookie headers.
profilename Read-only URL Transformation profile name.
state Read-only Enabled flag.

Possible values = ENABLED, DISABLED
cookiedomaininto Read-only Pattern of the transformed domain in Set-Cookie headers.
actioncomment Read-only Comments.
resurlinto Read-only Pattern of transformed response URLs. It corresponds to internal addresses and indicates how they are created.
requrlinto Read-only Pattern of transformed request URLs. It corresponds to internal addresses and indicates how they are created.
requrlfrom Read-only Pattern of original request URLs. It corresponds to the way external users view the server, and acts as a source for request transformations.
__count Read-only count parameter

Operations

(click to see Properties )

  • GET
  • GET (ALL)
  • COUNT

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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/transformprofile_transformaction_binding/ name_value<String>

Query-parameters:

filter

http:// <netscaler-ip-address> /nitro/v1/config/transformprofile_transformaction_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

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

pagination

http:// <netscaler-ip-address> /nitro/v1/config/transformprofile_transformaction_binding/ name_value<String> ? pagesize=#no;pageno=#no

Use this query-parameter to get the transformprofile_transformaction_binding 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:


{  "transformprofile_transformaction_binding": [ {
      "name":<String_value>,
      "actionname":<String_value>,
      "priority":<Double_value>,
      "resurlfrom":<String_value>,
      "cookiedomainfrom":<String_value>,
      "profilename":<String_value>,
      "state":<String_value>,
      "cookiedomaininto":<String_value>,
      "actioncomment":<String_value>,
      "resurlinto":<String_value>,
      "requrlinto":<String_value>,
      "requrlfrom":<String_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/transformprofile_transformaction_binding

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

http:// <netscaler-ip-address> /nitro/v1/config/transformprofile_transformaction_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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:


{  "transformprofile_transformaction_binding": [ {
      "name":<String_value>,
      "actionname":<String_value>,
      "priority":<Double_value>,
      "resurlfrom":<String_value>,
      "cookiedomainfrom":<String_value>,
      "profilename":<String_value>,
      "state":<String_value>,
      "cookiedomaininto":<String_value>,
      "actioncomment":<String_value>,
      "resurlinto":<String_value>,
      "requrlinto":<String_value>,
      "requrlfrom":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/transformprofile_transformaction_binding/ name_value<String> ? 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:


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

<!--NeedCopy-->
transformprofile_transformaction_binding