{
    "openapi": "3.0.0",
    "info": {
        "title": "BigIQ License Management",
        "contact": {},
        "version": "8.1.0"
    },
    "servers": [
        {
            "url": "localhost",
            "variables": {}
        }
    ],
    "paths": {
        "/mgmt/cm/device/licensing/pool/initial-activation": {
            "post": {
                "tags": [
                    "License Management"
                ],
                "summary": "Activate a license",
                "operationId": "initialLicenseActivation",
                "parameters": [],
                "requestBody": {
                    "description": "Body.",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/pool/initial-activation/{registrationKey}": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Poll license activation status.",
                "operationId": "pollInitialLicenseActivation",
                "parameters": [
                    {
                        "name": "registrationKey",
                        "in": "path",
                        "description": "",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "patch": {
                "tags": [
                    "License Management"
                ],
                "summary": "Complete or retry an activation.",
                "operationId": "completeInitialActivation",
                "parameters": [
                    {
                        "name": "registrationKey",
                        "in": "path",
                        "description": "",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "description": "Body containing eulaText or licenseText and status",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "delete": {
                "tags": [
                    "License Management"
                ],
                "summary": "Remove failed activation.",
                "operationId": "removeFailedInitialActivation",
                "parameters": [
                    {
                        "name": "registrationKey",
                        "in": "path",
                        "description": "License registration key",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/pool/purchased-pool/licenses/{uuid}": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Get license reference.",
                "operationId": "getLicenseReference",
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "patch": {
                "tags": [
                    "License Management"
                ],
                "summary": "Reactivate or complete activation of purchased pool license.",
                "operationId": "reactivateLicense",
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "description": "Body for reactivation or completing activation",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "delete": {
                "tags": [
                    "License Management"
                ],
                "summary": "Delete a purchased pool license.",
                "operationId": "deletePurchasedPoolLicense",
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "License uuid",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/tasks/licensing/pool/member-management": {
            "post": {
                "tags": [
                    "License Management"
                ],
                "summary": "Assign or revoke a pool license to a managed device",
                "operationId": "assignOrRevokeLicense",
                "parameters": [],
                "requestBody": {
                    "description": "Body to assign or revoke license",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/tasks/licensing/pool/member-management/{uuid}": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Pool assign or revoke license task for completion.",
                "operationId": "pollTaskForCompletion",
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/assignments": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "View outstanding assignments.",
                "operationId": "viewOutstandingAssignments",
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/pool/purchased-pool/licenses": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Query existing purchased pool licenses.",
                "operationId": "queryExistingPurchasedLicenses",
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "post": {
                "tags": [
                    "License Management"
                ],
                "summary": "Activate a purchased pool license",
                "operationId": "activateNewPurchasedPoolLicense",
                "parameters": [],
                "requestBody": {
                    "description": "Body with registration key, name and method",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/pool/purchased-pool/licenses/{uuid}/members": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Query assignments for a purchased pool license.",
                "operationId": "queryPurchasedPoolLicenseAssignments",
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "post": {
                "tags": [
                    "License Management"
                ],
                "summary": "Assign license to managed device",
                "operationId": "assignPurchasedPoolLicenseMembers",
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "description": "Body containing device reference or details",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/pool/purchased-pool/licenses/{uuid}/members/{member_uuid}": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Query license assignment status.",
                "operationId": "queryPurchasedPoolLicenseAssignmentStatus",
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "License uuid",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "member_uuid",
                        "in": "path",
                        "description": "Member uuid",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "patch": {
                "tags": [
                    "License Management"
                ],
                "summary": "Refresh the license on a BIG-IP device",
                "operationId": "refreshPurchasedPoolLicenseOnBigIPDevice",
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "member_uuid",
                        "in": "path",
                        "description": "Member uuid",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "description": "Body including state and optional creds",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "delete": {
                "tags": [
                    "License Management"
                ],
                "summary": "Revoke a license from a device.",
                "operationId": "revokeAPurchasedPoolLicense",
                "parameters": [
                    {
                        "name": "uuid",
                        "in": "path",
                        "description": "",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "member_uuid",
                        "in": "path",
                        "description": "Member uuid",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/pool/regkey/licenses": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Query existing RegKey Pools.",
                "operationId": "queryExistingRegKeyPools",
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "post": {
                "tags": [
                    "License Management"
                ],
                "summary": "Create a RegKey Pool",
                "operationId": "createRegKeyPool",
                "parameters": [],
                "requestBody": {
                    "description": "Body",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/pool/regkey/licenses/{id}": {
            "patch": {
                "tags": [
                    "License Management"
                ],
                "summary": "Update a RegKey Pool to change name and/or description",
                "operationId": "updateRegKeyPool",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "RegKey Pool ID",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "description": "Body",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "delete": {
                "tags": [
                    "License Management"
                ],
                "summary": "Remove a RegKey Pool",
                "operationId": "removeRegKeyPool",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "RegKey Pool ID",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/pool/regkey/licenses/{id}/offerings": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Query existing license keys for a RegKey Pool.",
                "operationId": "queryExistingLicenseKeysForRegKeyPool",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "RegKey Pool ID",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "post": {
                "tags": [
                    "License Management"
                ],
                "summary": "Add a license key",
                "operationId": "addLicenseKey",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "RegKey Pool ID",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "description": "Body",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/pool/regkey/licenses/{id}/offerings/{regKey}": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Poll to get status",
                "operationId": "pollForRegKeyActivationStatus",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "RegKey Pool ID",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "regKey",
                        "in": "path",
                        "description": "RegKey",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "patch": {
                "tags": [
                    "License Management"
                ],
                "summary": "Complete or retry reg key activiation. May also reactivate a license with add-on keys.",
                "operationId": "completeRegKeyActivation",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "RegKey Pool ID",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "regKey",
                        "in": "path",
                        "description": "RegKey",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "description": "Body for manual or automatic activation",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "delete": {
                "tags": [
                    "License Management"
                ],
                "summary": "Delete a Registration key",
                "operationId": "deleteRegistrationKey",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "RegKey Pool ID",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "regKey",
                        "in": "path",
                        "description": "RegKey",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/pool/regkey/licenses/{id}/offerings/{regKey}/members": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Get the assignment for a registration key in a RegKey Pool",
                "operationId": "getRegistrationKeyAssignment",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "RegKey Pool ID",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "regKey",
                        "in": "path",
                        "description": "RegKey",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "post": {
                "tags": [
                    "License Management"
                ],
                "summary": "Assign a license to a managed or unmanaged device",
                "operationId": "assignRegistrationKeyToDevice",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "RegKey Pool ID",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "regKey",
                        "in": "path",
                        "description": "RegKey",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "description": "Body",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/pool/regkey/licenses/{id}/offerings/{regKey}/members/{member_uuid}": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Get the status of a new registration key assignment",
                "operationId": "getRegistrationKeyAssignmentStatus",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "RegKey Pool ID",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "regKey",
                        "in": "path",
                        "description": "RegKey",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "member_uuid",
                        "in": "path",
                        "description": "Member uuid",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "delete": {
                "tags": [
                    "License Management"
                ],
                "summary": "Revoke a license from a managed or unmanaged device",
                "operationId": "revokedRegistrationKeyFromDevice",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "RegKey Pool ID",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "regKey",
                        "in": "path",
                        "description": "RegKey",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "member_uuid",
                        "in": "path",
                        "description": "Member uuid",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "description": "Body required for unmanaged devices",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": false
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/setup/license": {
            "post": {
                "tags": [
                    "License Management"
                ],
                "summary": "Set the license text",
                "operationId": "setLicenseText",
                "parameters": [],
                "requestBody": {
                    "description": "Body with LicenseText",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            },
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Get the license text",
                "operationId": "getLicenseText",
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/tasks/licensing/utility-billing-reports": {
            "post": {
                "tags": [
                    "License Management"
                ],
                "summary": "Create utility billing license report",
                "operationId": "createUtilityBillingLicenseReport",
                "parameters": [],
                "requestBody": {
                    "description": "Body",
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/tasks/licensing/utility-billing-reports/{id}": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "View the status of a utility billing report",
                "operationId": "getUtilityBillingReportStatus",
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "description": "id",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        },
        "/mgmt/cm/device/licensing/license-reports-download/{report}": {
            "get": {
                "tags": [
                    "License Management"
                ],
                "summary": "Download a utility billing report",
                "operationId": "downloadUtilityBillingReport",
                "parameters": [
                    {
                        "name": "report",
                        "in": "path",
                        "description": "report",
                        "required": true,
                        "style": "simple",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Result",
                        "headers": {}
                    }
                },
                "deprecated": false
            }
        }
    },
    "components": {},
    "tags": [
        {
            "name": "License Management"
        }
    ]
}