iControl® REST API User Guide - cdn.f5.comcdn.f5.com/websites/devcentral.f5.com/downloads/icontrol-rest-api-user... ·

  • View
    212

  • Download
    0

Embed Size (px)

Text of iControl® REST API User Guide -...

  • iControl REST API User Guide

    Version 12.0

  • Table of Contents

    Legal Notices..............................................................................................................................7

    Legal notices......................................................................................................................7

    REST............................................................................................................................................9

    About Representational State Transfer..............................................................................9

    Breaking changes in iControl REST API............................................................................9

    About URI format.............................................................................................................13

    About reserved ASCII characters..........................................................................14

    About REST resource identifiers...........................................................................14

    About HTTP method semantics.......................................................................................15

    About JSON format..........................................................................................................16

    About additional iControl REST properties...........................................................18

    About null values and properties...........................................................................19

    About reserved property names............................................................................20

    About property name format differences...............................................................21

    About JSON formats and encodings.....................................................................21

    About API versions...........................................................................................................21

    About iControl and authentication for user accounts ......................................................22

    Requesting a token for iControl REST authentication...........................................22

    Overview: Fundamentals of Cross-Origin Resource Sharing..........................................22

    Cross-Origin Resource Sharing request headers.................................................23

    Cross-Origin Resource Sharing response headers..............................................23

    About external authentication providers with iControl REST...........................................24

    GET Requests...........................................................................................................................27

    Discovering modules and components ...........................................................................27

    About paging properties........................................................................................31

    About query parameters........................................................................................31

    Paging through large collections...........................................................................33

    About sub-collection expansion.............................................................................34

    Returning resources from an administrative partition............................................38

    Obtaining statistical output....................................................................................39

    POST and PUT requests...........................................................................................................43

    About JSON format for POST and PUT...........................................................................43

    Creating a new resource with iControl.............................................................................43

    Modifying a resource with PATCH.........................................................................44

    About read only properties ...................................................................................45

    Adding or modifying in a specific partition.............................................................46

    3

    Table of Contents

  • Deleting Access Policy Manager resources..........................................................48

    Partitions...................................................................................................................................49

    About administrative partitions.........................................................................................49

    Adding an administrative partition.........................................................................49

    Deleting an administrative partition.......................................................................50

    Transactions..............................................................................................................................51

    About the iControl REST transaction model....................................................................51

    About iControl REST transaction phases..............................................................51

    About transaction validation..................................................................................52

    Creating an iControl REST transaction.................................................................52

    Modifying a transaction.........................................................................................53

    Committing an iControl REST transaction.............................................................54

    About iControl REST asynchronous tasks.......................................................................54

    Asynchronous task endpoints...............................................................................55

    Using an asynchronous task.................................................................................56

    Commands................................................................................................................................59

    About other tmsh global commands.................................................................................59

    Using the cp command..........................................................................................59

    Using the generate command...............................................................................60

    Using the install command....................................................................................60

    Using the load command.......................................................................................61

    Using the mv command.........................................................................................62

    Using the publish command..................................................................................62

    Using the reboot command...................................................................................63

    Using the restart command...................................................................................63

    Using the reset-stats command.............................................................................63

    Using the run command........................................................................................64

    Using the save command......................................................................................64

    Using the send-mail command..............................................................................65

    Using the start command......................................................................................66

    Using the stop command.......................................................................................66

    Application Security Manager.................................................................................................67

    Application Security Manager and iControl REST comparison........................................67

    Retrieving Application Security Manager resources..............................................69

    Creating Application Security Manager resources................................................72

    Updating Application Security Manager resources...............................................73

    Deleting resources in Application Security Manager.............................................74

    Application Security Manager policy.....................................................................74

    Application Security Manager signatures..............................................................78

    4

    Table of Contents

  • Application Security Manager schema upload......................................................83

    Application Security Manager policy restore.........................................................83

    Application Security Manager vulnerability import................................................85

    Application Security Manager vulnerability resolution...........................................91

    Web Scraping Configuration settings....................................................................94

    Learning Suggestion Object................................................................................101

    Access Policy Manager..........................................................................................................105

    About Access Policy Manager ......................................................................................105

    Retrieving