User Guide

To get the most out of using our SDK, it’s useful to understand the basic concepts and principals we used when we designed it. It is also important that you are familiar with the F5® BIG-IP® and, at a minimum, how to configure BIG-IP® using the configuration utility (the GUI). More useful still would be if you are already familiar with the iControl® REST API.

• Basic Concepts
  • REST URIs
  • REST Endpoints
  • Dynamic Attributes
  • iControl® REST kind Parameters
  • Methods
• REST API Endpoints
  • Overview
    • REST URI Segments
  • Endpoints
    • Organizing Collection
    • Collection
    • Resource
    • Subcollection
    • Subcollection Resource
• Python Object Paths
  • Organizing Collection
  • Collection
  • Resource
  • Subcollection
  • Subcollection Resource
• Coding Example
• OData Queries
• REST Proxies
  • Activation
  • Usage
• Further Reading