Agent Licenses

Update a license.

Changed on

Updates a license's settings, such as permissions, expiration date, or active status. Use this to modify access without creating a new license.

put/api/v1/projects/{projectId}/licenses/{licenseId}

Request

Path parameters

projectIdinteger required

The unique identifier of the agent (formerly known as project).

licenseIdinteger required

The unique identifier of a license.

Request body

namestring

The new name of the license

Example request

{
  "name": "My new license name"
}

Response

Updated agent license

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "license": {
    "name": "My License",
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": 7,
    "created_at": "2021-01-01 00:00:00",
    "updated_at": "2021-01-01 00:00:00"
  }
}

Changes

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • info

      added the non-success response with the status

    • info

      endpoint added