Using GloboNetworkAPI V3

• Improve GET requests through some extra parameters
  • Kind parameter
  • Fields parameter
  • Include parameter
  • Exclude parameter
  • Using Include and Exclude together
  • Using Kind and Include together
  • Using Kind and Exclude together
  • Using Kind, Include and Exclude together
  • Getting more information from fields that acts as a foreign key
• Datacenter module
  • Data Center /api/dc/
    • POST
      • Creating a Data Center object
    • PUT
      • Editing a Data Center object
    • GET
      • Obtaining list of Data Centers
      • Default behavior
    • DELETE
      • Deleting a Data Center object
  • Fabric /api/dcrooms/
    • POST
      • Creating a Fabric object
    • GET
      • Obtaining list of Fabrics
      • Get a Fabric by id
      • Get a Fabric by the datacenters id
      • Default behavior
    • PUT
      • Editing a Fabric object
    • DELETE
      • Deleting a Fabric object
  • Racks /api/rack/
    • GET
      • Obtaining list of Racks
        • Get a list of Racks by the fabric id
        • Get a Rack by id
        • Default behavior
    • POST
      • Creating a Rack object
    • PUT
      • Editing a Rack object
    • DELETE
      • Deleting a Rack object
• Environment module
  • /api/v3/environment/
    • GET
      • Obtaining list of Environments
        • Obtaining list of Environments through id’s
        • Obtaining list of Environments through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
  • /api/v3/environment/environment-vip/
    • GET
      • Obtaining environments associated to environment vip
• Environment Vip module
  • /api/v3/environment-vip/
    • GET
      • Obtaining list of Environment Vip
        • Obtaining list of Environment Vip through id’s
        • Obtaining list of Environment Vip through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
  • /api/v3/environment-vip/step
    • GET
      • Obtaining finality list
      • Obtaining client list through finality
      • Obtaining environment vip list through finality and client
      • Obtaining environment vip through finality, client and environmentp44
• Equipment module
  • /api/v3/equipment/
    • GET
      • Obtaining list of Equipments
        • Obtaining list of Equipments through some Optional GET Parameters
        • Obtaining list of Equipments through id’s
        • Obtaining list of Equipments through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
    • POST
      • Creating list of equipments
    • PUT
      • Updating list of equipments in database
    • DELETE
      • Deleting a list of equipments in database
        • Deleting list of equipments and all relationships
• Option Pool module
  • /api/v3/option-pool/environment
    • GET
      • Obtaining options pools associated to environment
• Option Vip module
  • /api/v3/option-vip/environment-vip
    • GET
      • Obtaining list of Options Vip
        • Obtaining options vip through environment vip
  • /api/v3/option-vip/environment-vip/type-option
    • GET
      • Obtaining options vip through environment vip and type option
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
• Server Pool module
  • /api/v3/pool/
    • GET
      • Obtaining list of Server Pool
        • Obtaining list of Server Pools through id’s
        • Obtaining list of Server Pools through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
    • POST
      • Creating list of pools in database:
    • PUT
      • Updating list of server pools in database
    • DELETE
      • Deleting a list of server pools in database
  • /api/v3/pool/deploy
    • GET
      • Obtaining list of pools with member states updated
        • Pool Member
    • POST
      • Creating list of pools in equipments
    • PUT
      • Enabling/Disabling pool member by list of server pool
      • Updating pools by list in equipments
    • DELETE
      • Deleting a list of server pools in equipments
  • /api/v3/pool/details
    • GET
      • Obtaining server pools with some more details through id’s
      • Obtaining server pools with some more details through extended search
  • /api/v3/pool/environment-vip
    • GET
      • Obtaining server pools associated to environment vips
  • /api/v3/pool/deploy/async/
    • POST
      • Deploying list of Server Pool asynchronously
    • PUT
      • Updating and Redeploying list of Server Pool asynchronously
    • DELETE
      • Undeploying list of Server Pool asynchronously
• Type Option module
  • /api/v3/type-option/environment-vip
    • GET
      • Obtaining options vip through environment vip and type option
• Vip Request module
  • /api/v3/vip-request/
    • GET
      • Obtaining list of Vip Request
        • Obtaining list of Vip Request through id’s
        • Obtaining list of Vip Request through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
    • POST
      • Creating list of vip request
    • PUT
      • Updating list of vip request in database
    • DELETE
      • Deleting a list of vip request in database
        • Deleting list of vip-request and associated IP’s
        • Deleting list of vip-request keeping associated IP’s
  • /api/v3/vip-request/deploy/
    • POST
      • Deploying list of vip request in equipments
    • PUT
      • Updating list of vip requests in equipments
    • DELETE
      • Deleting list of vip requests in equipments
  • /api/v3/vip-request/details/
    • GET
      • Obtaining list of vip request
        • Obtaining list of vip request with some more details through id’s
        • Obtaining list of vip request with some more details through extended search
  • /api/v3/vip-request/deploy/async/
    • POST
      • Deploying list of Vip Request asynchronously
    • PUT
      • Updating and Redeploying list of Vip Request asynchronously
    • DELETE
      • Undeploying list of Vip Request asynchronously
  • /api/v3/vip-request/pool
    • GET
      • Obtaining vip requests associated to server pool
• Vlan module
  • /api/v3/vlan
    • GET
      • Obtaining list of Vlans
        • Obtaining list of Vlans through id’s
        • Obtaining list of Vlans through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
    • POST
      • Creating list of vlans
    • PUT
      • Updating list of Vlans in database
    • DELETE
      • Deleting a list of vlan in database
        • Deleting list of vlan and associated Networks and Object Group Permissions
  • /api/v3/vlan/async/
    • POST
      • Creating list of vlans asynchronously
    • PUT
      • Updating list of vlans asynchronously
    • DELETE
      • Deleting list of vlans asynchronously
• NetworkIPv4 module
  • /api/v3/networkv4/
    • GET
      • Obtaining list of Network IPv4 objects
        • Obtaining list of Network IPv4 objects through id’s
        • Obtaining list of Network IPv4 objects through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
    • POST
      • Creating list of IPv4 objects
    • PUT
      • Updating list of Network IPv4 objects in database
    • DELETE
      • Deleting a list of Network IPv4 objects in database
        • Deleting list of Network IPv4 objects and associated IPv4 addresses
  • /api/v3/networkv4/deploy/
    • POST
      • Deploying list of Network IPv4 in equipments
    • DELETE
      • Undeploying list of Network IPv4 objects from equipments
  • /api/v3/networkv4/async/
    • POST
      • Creating list of Network IPv4 asynchronously
    • PUT
      • Updating list of Network IPv4 asynchronously
    • DELETE
      • Deleting list of Network IPv4 asynchronously
  • /api/v3/networkv4/deploy/async/
    • POST
      • Deploying list of Network IPv4 asynchronously
    • DELETE
      • Undeploying list of Network IPv4 asynchronously
• NetworkIPv6 module
  • /api/v3/networkv6/
    • GET
      • Obtaining list of Network IPv6 objects
        • Obtaining list of Network IPv6 objects through id’s
        • Obtaining list of Network IPv6 objects through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
    • POST
      • Creating list of IPv6 objects
    • PUT
      • Updating list of Network IPv6 objects in database
    • DELETE
      • Deleting a list of Network IPv6 objects in database
        • Deleting list of Network IPv6 objects and associated IPv6 addresses
  • /api/v3/networkv6/deploy/
    • POST
      • Deploying list of Network IPv6 in equipments
    • DELETE
      • Undeploying list of Network IPv6 objects from equipments
  • /api/v3/networkv6/async/
    • POST
      • Creating list of Network IPv6 asynchronously
    • PUT
      • Updating list of Network IPv6 asynchronously
    • DELETE
      • Deleting list of Network IPv6 asynchronously
  • /api/v3/networkv6/deploy/async/
    • POST
      • Deploying list of Network IPv6 asynchronously
    • DELETE
      • Undeploying list of Network IPv6 asynchronously
• IPv4 module
  • /api/v3/ipv4/
    • GET
      • Obtaining list of IPv4 objects
        • Obtaining list of IPv4 objects through id’s
        • Obtaining list of IPv4 objects through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
    • POST
      • Creating list of IPv4 objects
    • PUT
      • Updating list of IPv4 objects in database
    • DELETE
      • Deleting a list of IPv4 objects in database
        • Deleting list of IPv4 objects and associated Vip Requests and relationships with Equipments
  • /api/v3/ipv4/async/
    • POST
      • Creating list of IPv4 asynchronously
    • PUT
      • Updating list of IPv4 asynchronously
    • DELETE
      • Deleting list of IPv4 asynchronously
• IPv6 module
  • /api/v3/ipv6/
    • GET
      • Obtaining list of IPv6 objects
        • Obtaining list of IPv6 objects through id’s
        • Obtaining list of IPv6 objects through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
    • POST
      • Creating list of IPv6 objects
    • PUT
      • Updating list of IPv6 objects in database
    • DELETE
      • Deleting a list of IPv6 objects in database
        • Deleting list of IPv6 objects and associated Vip Requests and relationships with Equipments
  • /api/v3/ipv6/async/
    • POST
      • Creating list of IPv6 asynchronously
    • PUT
      • Updating list of IPv6 asynchronously
    • DELETE
      • Deleting list of IPv6 asynchronously
• Object Group Permissions module
  • /api/v3/object-group-perm/
    • GET
      • Obtaining list of Object Group Permissions
        • Obtaining list of Object Group Permissions through id’s
        • Obtaining list of Object Group Permissions through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
    • POST
      • Creating list of Object Group Permissions objects
    • PUT
      • Updating list of Object Group Permissions objects
    • DELETE
      • Deleting a list of Object Group Permissions objects in database
        • Deleting list of Object Group Permissions objects
• General Object Group Permissions module
  • /api/v3/object-group-perm-general/
    • GET
      • Obtaining list of General Object Group Permissions
        • Obtaining list of General Object Group Permissions through id’s
        • Obtaining list of General Object Group Permissions through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
    • POST
      • Creating list of General Object Group Permissions objects
    • PUT
      • Updating list of General Object Group Permissions objects
    • DELETE
      • Deleting a list of General Object Group Permissions objects in database
        • Deleting list of General Object Group Permissions objects
• Object Type module
  • /api/v3/object-type/
    • GET
      • Obtaining list of Object Types
        • Obtaining list of Object Types through id’s
        • Obtaining list of Object Types through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
• Vrf module
  • /api/v3/vrf/
    • GET
      • Obtaining list of Vrfs
        • Obtaining list of Vrfs through id’s
        • Obtaining list of Vrfs through extended search
      • Using fields GET parameter
      • Using kind GET parameter
      • Using fields and kind together
      • Default behavior without kind and fields
    • POST
      • Creating list of Vrf objects
    • PUT
      • Updating list of Vrf objects
    • DELETE
      • Deleting a list of Vrf objects in database
        • Deleting list of Vrf objects and relationships with Equipments
• Task module
  • /api/v3/task/
    • GET
      • How can I know the state of an asynchronous request?