Action - Disable an Object

Disable one or more ADC objects for which the action applies to.

Supported on the following object types:

  • F5 – wideip, wideip pool, wideip pool member, vip, vip pool member, LTM node, GTM server, virtual address

  • A10 – Fqdn, ServiceIP, SLB_VSV, SLB Server, SLB VS

  • Cisco – GSLB Answer, SLB virtual server, SLB real server

  • Citrix – GSLB virtual server, GSLB services, SLB virtual servers, SLB service group, SLB service

  • Akamai – Datacenter

  • Radware – Virtual server, Server group, Real server: port, Real server

URL: /adc-device-object-action-disable

Type: PUT

Parameter
Param Type Name Description Field Type
Header sessionId ** Session Id received after login string
Query gwkey Tenant Key. Needed only in case of multitenant installations string
Query gwsource** Source from which the request is triggered (for example, web, external) String
Payload objectIds** Resource id of the objects. Note: Use the search API to search/get the resource id String[]

** - Mandatory value

Possible Response Message and Code

HTTP Code Description Response Message
202 Accepted The action triggered for the following <#> objects …
400 Bad request No objects found to perform the action
403 Forbidden No given object(s) have Read or Write permission

Sample Request/Response

Use Case

Trigger disable action on objects with resource id wideip_1 and wideip_2.

Request URL

http://appviewxapi.com/avxapi/adc-device-object-action-disable?gwkey=f000ca01&gwsource=external

Request Payload

{

"payload": {

"objectIds": [

"wideip_1",

" wideip_2"

]

}

}

Response 

{
  "response": "Action triggered successfully.",
  "message": "Action triggered for the following 2 objects : wideip_1,wideip_2"
}