apispec_specendpoint_binding

Last published : Oct 30, 2026
Binding object showing the specendpoint that can be bound to apispec.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
apiname <String> Read-write API method used for display purposes.
name <String> Read-write Name of the spec for which to show detailed information.
Minimum length = 1
httpmethod <String> Read-only GRPC API option method: REST way to reach GRPC Service. One per service/method combination.
apiservice <String> Read-only API endpoint (could be GRPC service, REST path) used for display purposes.
httpurlpath <String> Read-only GRPC API option endpoint: REST way to reach GRPC Service. One per service/method combination.
__count <Double> 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/apispec_specendpoint_binding/ name_value<String> Query-parameters: filter http:// <netscaler-ip-address> /nitro/v1/config/apispec_specendpoint_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2
Use this query-parameter to get the filtered set of apispec_specendpoint_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/apispec_specendpoint_binding/ name_value<String> ? pagesize=#no;pageno=#no
Use this query-parameter to get the apispec_specendpoint_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:
{  "apispec_specendpoint_binding": [ {
"apiname":<String_value>,
"name":<String_value>,
"httpmethod":<String_value>,
"apiservice":<String_value>,
"httpurlpath":<String_value>
}]}

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/apispec_specendpoint_binding HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Query-parameters: bulkbindings http:// <netscaler-ip-address> /nitro/v1/config/apispec_specendpoint_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:
{  "apispec_specendpoint_binding": [ {
"apiname":<String_value>,
"name":<String_value>,
"httpmethod":<String_value>,
"apiservice":<String_value>,
"httpurlpath":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/apispec_specendpoint_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:
{"apispec_specendpoint_binding": [ { "__count": "#no"} ] }