/mgmt/shared/iapp/blocks

API to create, delete, or modify iApp blocks. For a list of all iApp LX Block properties, please refer to the iApps LX Block Reference page in Appendix A.

Sections in this page:


Action: Get all iApp LX Blocks

Gets the complete set of iApp Blocks defined on the local system. An array of all iApps LX blocks are returned in the items attribute.

URI Path HTTP Method
/mgmt/shared/iapp/blocks GET

Success Response

HTTP/1.1 200 OK

{
  "items": [
    {
      "id": "8b139857-bf33-3cde-9b66-73980a0c2924",
      "name": "HTTP App",
      "inputProperties": [
        {
          "id": "virtualAddress",
          "type": "STRING",
          "value": "10.0.0.25",
          "metaData" : {
            "description": "Virtual Server IP address, either IPv4 or IPv6",
            "displayName": "Virtual Server IP",
            "isRequired": true
          }
        }
      ],
      "configurationProcessorReference": {
        "link": "https://localhost/mgmt/shared/iapp/proccesors/noop"
      },
      "statsProcessorReferences": [
        {
          "link": "https://localhost/mgmt/shared/iapp/proccesors/noop"
        }
      ],
      "audit":
      {
        "intervalSeconds": 0,
        "policy": "NOTIFY_ONLY"
      },
      "configProcessorTimeoutSeconds" : 0,
      "state": "TEMPLATE",
      "lastUpdateMicros": 1403121799147801,
      "kind": "tm:shared:iapp:blocks:blockstate",
      "selfLink": "https://localhost/mgmt/shared/iapp/blocks/8b139857-bf33-3cde-9b66-73980a0c2924",
      "generation": 3
    },
    {
      "id": "47c1c515-6f20-31c9-b5e5-736a4e4c1f34",
      "name": "My HTTP App 1",
      "inputProperties": [
        {
          "id": "virtualAddress",
          "type": "STRING",
          "value": "10.0.0.125"
        }
      ],
      "configurationProcessorReference": {
        "link": "https://localhost/mgmt/shared/iapp/proccesors/noop"
      },
      "statsProcessorReferences": [
        {
          "link": "https://localhost/mgmt/shared/iapp/proccesors/noop"
        }
      ],
      "audit":
      {
        "intervalSeconds": 0,
        "policy": "NOTIFY_ONLY"
      },
      "configProcessorTimeoutSeconds" : 0,
      "state": "UNBOUND",
      "lastUpdateMicros": 1403121799147801,
      "kind": "tm:shared:iapp:blocks:blockstate",
      "selfLink": "https://localhost/mgmt/shared/iapp/blocks/47c1c515-6f20-31c9-b5e5-736a4e4c1f34",
      "generation": 3
    }
  ],
  "generation": 13,
  "kind": "tm:shared:iapp:blocks:blockcollectionstate",
  "lastUpdateMicros": 1403121799154699,
  "selfLink": "https://localhost/mgmt/shared/iapp/blocks"
}

Error Response

HTTP/1.1 401 Unauthorized

Example Call

curl -sk -u 'admin:admin' https://<BIG-IP>/mgmt/shared/iapp/blocks

Action: Query an iApp block

Gets a single iApp block defined in the block API.

URI Path HTTP Method
/mgmt/shared/iapp/<block_UUID> GET

Success Response

HTTP/1.1 200 OK


{
  "id": "8b139857-bf33-3cde-9b66-73980a0c2924",
  "name": "HTTP App",
  "inputProperties": [
    {
      "id": "virtualAddress",
      "type": "STRING",
      "value": "10.0.0.25",
      "metaData" : {
        "description": "Virtual Server IP address, either IPv4 or IPv6",
        "displayName": "Virtual Server IP",
        "isRequired": true
      }
    }
  ],
  "configurationProcessorReference": {
    "link": "https://localhost/mgmt/shared/iapp/proccesors/noop"
  },
  "statsProcessorReferences": [
    {
      "link": "https://localhost/mgmt/shared/iapp/proccesors/noop"
    }
  ],
  "audit":
  {
    "intervalSeconds": 0,
    "policy": "NOTIFY_ONLY"
  },
  "configProcessorTimeoutSeconds" : 0,
  "state": "TEMPLATE",
  "lastUpdateMicros": 1403121799147801,
  "kind": "tm:shared:iapp:blocks:blockstate",
  "selfLink": "https://localhost/mgmt/shared/iapp/blocks/8b139857-bf33-3cde-9b66-73980a0c2924",
  "generation": 3
}

Error Response

Unauthorized

HTTP/1.1 401 Unauthorized

Block GUID does not exist

HTTP/1.1 404 Not Found

{
  "code": 404,
  "message": "shared/iapp/blocks/8b139857-bf33-3cde-9b66-73980a0c2924",
  "referer": "192.168.1.245",
  "restOperationId": 1244215,
  "kind": ":resterrorresponse"
}

Example Call

curl -k -u admin:admin https://<|platform|>/mgmt/shared/iapp/blocks/8b139857-bf33-3cde-9b66-73980a0c2924

Action: Create an iApp block

Creates a new iApp block with the prescribed name.

URI Path HTTP Method
/mgmt/shared/iapp/blocks POST

Data Parameters

{
  "name": "My HTTPS App 2",
  "inputProperties": [
    {
      "id": "virtualAddress",
      "type": "STRING",
      "value": "10.0.0.125"
    }
  ],
  "configurationProcessorReference": {
    "link": "https://localhost/mgmt/shared/iapp/proccesors/noop"
  },
  "baseReference": {
    "link": "https://localhost/mgmt/shared/iapp/blocks/8b139857-bf33-3cde-9b66-73980a0c2924"
  },
  "state": "UNBOUND"
}

Success Response

HTTP/1.1 200 OK


{
  "id": "5227c388-6298-4399-a291-810a5f681610",
  "name": "My HTTPS App 2",
  "inputProperties": [
    {
      "id": "virtualAddress",
      "type": "STRING",
      "value": "10.0.0.125"
    }
  ],
  "configurationProcessorReference": {
    "link": "https://localhost/mgmt/shared/iapp/proccesors/noop"
  },
  "configProcessorTimeoutSeconds": 30,
  "statsProcessorTimeoutSeconds": 15,
  "configProcessorAffinity": {
    "processorPolicy": "LOAD_BALANCED",
    "affinityProcessorReference": {
      "link": "https://localhost/mgmt/shared/iapp/processors/affinity/load-balanced"
    }
  },
  "state": "UNBOUND",
  "baseReference": {
    "link": "https://localhost/mgmt/shared/iapp/blocks/8b139857-bf33-3cde-9b66-73980a0c2924"
  },
  "generation": 1,
  "lastUpdateMicros": 1517265123653207,
  "kind": "shared:iapp:blocks:blockstate",
  "selfLink": "https://localhost/mgmt/shared/iapp/blocks/5227c388-6298-4399-a291-810a5f681610"
}

Error Response

Unauthorized

HTTP/1.1 401 Unauthorized

Duplicate item

HTTP/1.1 400 Bad Request

{
  "code": 400,
  "message": "Duplicate item. Key already exists: id : 5227c388-6298-4399-a291-810a5f681610",
  "originalRequestBody": "<truncated>",
  "referer": "192.168.1.1",
  "restOperationId": 13960929,
  "kind": ":resterrorresponse"
}

Example Call

curl -sk -H 'Content-Type: application/json' -u 'admin:admin' \
 https://<BIG-IP>/mgmt/shared/iapp/blocks -d @my_block.json

Action: Delete an iApp block

Deletes an iApp block.

URI Path HTTP Method
/mgmt/shared/iapp/blocks/<block_UUID> DELETE

Success Response

HTTP/1.1 200 OK

Sends back the JSON of the deleted block.

Error Response

Unauthorized

HTTP/1.1 401 Unauthorized

Item not found

HTTP/1.1 404 Not Found

{
  "code": 404,
  "message": "item not found at /shared/iapp/blocks/5227c388-6298-4399-a291-810a5f681610",
  "referer": "192.168.1.1",
  "restOperationId": 13963074,
  "kind": ":resterrorresponse"
}

Example Call

curl -sk -u 'admin:admin' \
 https://<BIG-IP>/mgmt/shared/iapp/blocks/5227c388-6298-4399-a291-810a5f681610 -X DELETE

Action: Modify an iApp block

Modify the attirbutes within an iApp block.

To change a only the data parameters sent
URI Path HTTP Method
/mgmt/shared/iapp/blocks/<block_UUID> PATCH

To change a the data parameters sent and restore all others to default
URI Path HTTP Method
/mgmt/shared/iapp/blocks/<block_UUID> PUT

Data Parameters

{ "state": "BINDING" }

Success Response

HTTP/1.1 200 OK


{
  "id": "b057cc71-db0c-4cdb-954d-9dbb27c58e5f",
  "name": "My HTTP App 1",
  "inputProperties": [
    {
      "id": "virtualAddress",
      "type": "STRING",
      "value": "10.0.0.100",
      "metaData": {
        "description": "Virtual Server IP address, either IPv4 or IPv6",
        "displayName": "Virtual Server IP",
        "isRequired": true
      }
    }
  ],
  "configurationProcessorReference": {
    "link": "https://localhost/mgmt/shared/iapp/proccesors/noop"
  },
  "configProcessorTimeoutSeconds": 30,
  "statsProcessorTimeoutSeconds": 15,
  "configProcessorAffinity": {
    "processorPolicy": "LOAD_BALANCED",
    "affinityProcessorReference": {
      "link": "https://localhost/mgmt/shared/iapp/processors/affinity/load-balanced"
    }
  },
  "state": "BINDING",
  "baseReference": {
    "link": "https://localhost/mgmt/shared/iapp/blocks/d1da9791-059c-3d4e-98c0-624e3c06b44b"
  },
  "generation": 2,
  "lastUpdateMicros": 1517280703403758,
  "kind": "shared:iapp:blocks:blockstate",
  "selfLink": "https://localhost/mgmt/shared/iapp/blocks/b057cc71-db0c-4cdb-954d-9dbb27c58e5f"
}

Error Response

Unauthorized

HTTP/1.1 401 Unauthorized

Item not found

HTTP/1.1 404 Not Found

{
  "code": 404,
  "message": "item not found at /shared/iapp/blocks/5227c388-6298-4399-a291-810a5f681610",
  "referer": "192.168.1.1",
  "restOperationId": 13963074,
  "kind": ":resterrorresponse"
}

Example Call

curl -sk -H 'Content-Type: application/json' -u 'admin:admin' -d '{ "state": "BINDING" }' -X PATCH \
 https://<BIG-IP>/mgmt/shared/iapp/blocks/b057cc71-db0c-4cdb-954d-9dbb27c58e5f