App Keys

Update appKey

Activates or deactivates an appKey by its ID.

Permissions

Any user or application key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
License ManagerServices access controlSave user

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
User Administrator - RESTRICTEDSave user

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys.

To learn more about machine authentication at VTEX, see Authentication overview.

put/api/vlm/appkeys/{id}

Path parameters

idstring required

ID from the appKey which will be updated

Request body

isActiveboolean required

Defines if the application key is active (true) or not (false).

Response

Success

Changes