---
updatedAt: 2026-05-27T19:59:49.000Z
agentTools:
  projectIndex: https://replicated-vendor-api.readme.io/v1.0/llms.txt
---

# Update app license for a given licenseId.

Note: that all fields are required to be passed or they will be overwritten to blank or default values.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Create, update, delete, revoke licenses and download license keys.",
    "title": "Vendor API V1",
    "contact": {
      "name": "Replicated, Inc.",
      "url": "http://www.replicated.com/",
      "email": "info@replicated.com"
    },
    "version": "1.0.0"
  },
  "paths": {
    "/license/{license_id}": {
      "put": {
        "security": [
          {
            "api_key": []
          }
        ],
        "description": "Note: that all fields are required to be passed or they will be overwritten to blank or default values.",
        "tags": [
          "license"
        ],
        "summary": "Update app license for a given licenseId.",
        "operationId": "updateLicense",
        "parameters": [
          {
            "x-go-name": "LicenseID",
            "description": "License identifier",
            "name": "license_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "license_type",
                  "assignee",
                  "channel_id",
                  "field_values",
                  "require_activation",
                  "activation_email",
                  "update_policy",
                  "assisted_setup_enabled",
                  "expiration_date",
                  "expiration_policy",
                  "airgap_download_enabled"
                ],
                "properties": {
                  "activation_email": {
                    "description": "If activation is required this is the email the code will be sent to.",
                    "type": "string",
                    "x-go-name": "ActivationEmail"
                  },
                  "airgap_download_enabled": {
                    "type": "boolean",
                    "x-go-name": "AirgapDownloadEnabled"
                  },
                  "assignee": {
                    "description": "License Label name, ie name of customer who is using license.",
                    "type": "string",
                    "x-go-name": "Assignee"
                  },
                  "assisted_setup_enabled": {
                    "type": "boolean",
                    "x-go-name": "AssistedSetupEnabled"
                  },
                  "channel_id": {
                    "description": "Channel id that the license will be associated with.",
                    "type": "string",
                    "x-go-name": "ChannelID"
                  },
                  "expiration_date": {
                    "description": "Date that the license will expire, can be null for no expiration or formated by year-month-day ex. 2016-02-02.",
                    "type": "string",
                    "x-go-name": "ExpirationDate"
                  },
                  "expiration_policy": {
                    "description": "Defines expiration policy for this license.\n\nValues:\nignore: replicated will take no action on a expired license\nnoupdate-norestart: application updates will not be downloaded, and once the application is stopped, it will not be started again\nnoupdate-stop: application updates will not be downloaded and the application will be stopped",
                    "type": "string",
                    "x-go-name": "ExpirationPolicy"
                  },
                  "external_support_bundle": {
                    "description": "Defines whether this license should use the external support bundle generator.",
                    "type": "boolean",
                    "x-go-name": "ExternalSupportBundle"
                  },
                  "field_values": {
                    "description": "An array of field values for custom fields of a given app",
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/LicenseFieldValue"
                    },
                    "x-go-name": "FieldValues"
                  },
                  "is_app_version_locked": {
                    "description": "A license can be optionally locked to a specific release",
                    "type": "boolean",
                    "x-go-name": "IsAppVersionLocked"
                  },
                  "license_type": {
                    "description": "LicenseType can be set to \"dev\", \"trial\", or \"prod\"",
                    "type": "string",
                    "x-go-name": "LicenseType"
                  },
                  "locked_app_patch_version": {
                    "description": "If app version is locked, this is the patch version to lock it to (patch_sequence)",
                    "type": "integer",
                    "format": "int64",
                    "x-go-name": "LockedAppPatchVersion"
                  },
                  "locked_app_version": {
                    "description": "If app version is locked, this is the version to lock it to (sequence)",
                    "type": "integer",
                    "format": "int64",
                    "x-go-name": "LockedAppVersion"
                  },
                  "require_activation": {
                    "description": "If this license requires activation set to true, make sure to set activation email as well.",
                    "type": "boolean",
                    "x-go-name": "RequireActivation"
                  },
                  "update_policy": {
                    "description": "If set to automatic will auto update remote license installation with every release. If set to manual will update only when on-premise admin clicks the install update button.",
                    "type": "string",
                    "x-go-name": "UpdatePolicy"
                  },
                  "use_console_support_spec": {
                    "description": "Defines whether this license should use support bundle specs from console.",
                    "type": "boolean",
                    "x-go-name": "UseConsoleSupportSpec"
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/updateLicenseResponse"
          },
          "400": {
            "$ref": "#/components/responses/responseErrBadRequest"
          },
          "401": {
            "$ref": "#/components/responses/responseErrUnauthorized"
          },
          "403": {
            "$ref": "#/components/responses/responseErrForbidden"
          },
          "404": {
            "$ref": "#/components/responses/responseErrNotFound"
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.replicated.com/vendor/v1"
    }
  ],
  "components": {
    "responses": {
      "responseErrBadRequest": {
        "description": "Returned on bad input",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error_code": {
                  "description": "Error code if available",
                  "type": "string",
                  "x-go-name": "ErrorCode"
                },
                "message": {
                  "description": "Error message text if available",
                  "type": "string",
                  "x-go-name": "Message"
                }
              }
            }
          }
        }
      },
      "responseErrForbidden": {
        "description": "Returned if the caller does not have the needed permission",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "x-go-name": "Message"
                    },
                    "messageCode": {
                      "type": "string",
                      "x-go-name": "MessageCode"
                    }
                  },
                  "x-go-name": "Error"
                }
              }
            }
          }
        }
      },
      "responseErrNotFound": {
        "description": "Returned on resource not found",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "x-go-name": "Message"
                }
              }
            }
          }
        }
      },
      "responseErrUnauthorized": {
        "description": "Return if the caller is not authorized",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "x-go-name": "Message"
                }
              }
            }
          }
        }
      },
      "updateLicenseResponse": {
        "description": "UpdateLicenseResponse contains the license",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "License"
              ],
              "properties": {
                "License": {
                  "$ref": "#/components/schemas/License"
                }
              }
            }
          }
        }
      }
    },
    "schemas": {
      "InstalledAppVersion": {
        "type": "object",
        "properties": {
          "Label": {
            "type": "string"
          },
          "LastCheck": {
            "type": "string",
            "format": "date-time"
          },
          "PatchSequence": {
            "type": "integer",
            "format": "int64"
          },
          "Sequence": {
            "type": "integer",
            "format": "int64"
          },
          "UpdateAvailable": {
            "type": "boolean"
          }
        },
        "x-go-package": "github.com/replicatedhq/vandoor/pkg/models"
      },
      "License": {
        "type": "object",
        "properties": {
          "ActivationEmail": {
            "type": "string"
          },
          "ActiveInstanceCount": {
            "type": "integer",
            "format": "int64"
          },
          "AirgapDownloadEnabled": {
            "type": "boolean"
          },
          "AirgapDownloadPassword": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "uint8"
            }
          },
          "Anonymous": {
            "type": "boolean"
          },
          "AppId": {
            "type": "string"
          },
          "AppStatus": {
            "type": "string"
          },
          "Archived": {
            "type": "boolean"
          },
          "Assignee": {
            "type": "string"
          },
          "AssistedSetupEnabled": {
            "type": "boolean"
          },
          "Billing": {
            "$ref": "#/components/schemas/LicenseBilling"
          },
          "BillingEvents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LicenseBillingEvent"
            }
          },
          "ChannelId": {
            "type": "string"
          },
          "ChannelName": {
            "type": "string"
          },
          "Clouds": {
            "type": "string"
          },
          "ExpirationPolicy": {
            "type": "string"
          },
          "ExpireDate": {
            "type": "string",
            "format": "date-time"
          },
          "ExternalSupportBundle": {
            "type": "boolean"
          },
          "FieldValues": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LicenseFieldValue"
            }
          },
          "GrantDate": {
            "type": "string",
            "format": "date-time"
          },
          "Id": {
            "type": "string"
          },
          "InactiveInstanceCount": {
            "type": "integer",
            "format": "int64"
          },
          "IsAppVersionLocked": {
            "type": "boolean"
          },
          "IsInstanceTracked": {
            "type": "boolean"
          },
          "LastSync": {
            "type": "string",
            "format": "date-time"
          },
          "LicenseType": {
            "type": "string"
          },
          "LicenseVersions": {
            "$ref": "#/components/schemas/LicenseVersions"
          },
          "LockedAppPatchVersion": {
            "type": "integer",
            "format": "int64"
          },
          "LockedAppVersion": {
            "type": "integer",
            "format": "int64"
          },
          "RequireActivation": {
            "type": "boolean"
          },
          "RevokationDate": {
            "type": "string",
            "format": "date-time"
          },
          "UntrackedInstanceCount": {
            "type": "integer",
            "format": "int64"
          },
          "UpdatePolicy": {
            "type": "string"
          },
          "UseConsoleSupportSpec": {
            "type": "boolean"
          }
        },
        "x-go-package": "github.com/replicatedhq/vandoor/pkg/models"
      },
      "LicenseBilling": {
        "type": "object",
        "properties": {
          "begin": {
            "type": "string",
            "format": "date-time",
            "x-go-name": "Begin"
          },
          "end": {
            "type": "string",
            "format": "date-time",
            "x-go-name": "End"
          },
          "frequency": {
            "type": "string",
            "x-go-name": "Frequency"
          },
          "revenue": {
            "type": "string",
            "x-go-name": "Revenue"
          }
        },
        "x-go-package": "github.com/replicatedhq/vandoor/pkg/models"
      },
      "LicenseBillingEvent": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "format": "int64",
            "x-go-name": "Amount"
          },
          "description": {
            "type": "string",
            "x-go-name": "Description"
          },
          "event_date": {
            "type": "string",
            "format": "date-time",
            "x-go-name": "EventDate"
          },
          "id": {
            "type": "string",
            "x-go-name": "ID"
          },
          "vendor_due_from_customer_date": {
            "type": "string",
            "format": "date-time",
            "x-go-name": "VendorDueCustomerDate"
          },
          "vendor_invoice_to_customer_date": {
            "type": "string",
            "format": "date-time",
            "x-go-name": "VendorInvoiceCustomerDate"
          },
          "vendor_paid_by_customer_date": {
            "type": "string",
            "format": "date-time",
            "x-go-name": "VendorPaidCustomerDate"
          }
        },
        "x-go-package": "github.com/replicatedhq/vandoor/pkg/models"
      },
      "LicenseFieldValue": {
        "type": "object",
        "properties": {
          "app_id": {
            "type": "string",
            "x-go-name": "AppID"
          },
          "field": {
            "type": "string",
            "x-go-name": "FieldName"
          },
          "title": {
            "type": "string",
            "x-go-name": "FieldTitle"
          },
          "type": {
            "type": "string",
            "x-go-name": "FieldType"
          },
          "value": {
            "type": "string",
            "x-go-name": "Value"
          }
        },
        "x-go-package": "github.com/replicatedhq/vandoor/handlers/vendor-api/replv1/license"
      },
      "LicenseVersions": {
        "type": "object",
        "properties": {
          "InstalledAppVersion": {
            "$ref": "#/components/schemas/InstalledAppVersion"
          },
          "ReplicatedVersions": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "x-go-package": "github.com/replicatedhq/vandoor/pkg/models"
      }
    }
  }
}
```