VTvtex
API keys

Update API Key

Changed on

Activates or deactivates an appKey by its ID.

Permissions

Any user or API 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}

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/vlm/appkeys/{id}
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Path parameters

idstring required

ID from the API Key which will be updated

Request body

isActiveboolean required

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

Example request

{
  "isActive": true
}

Response

Success

Changes

  • c1edc71854fcRevision changes
    • info

      api tag API keys added

    • info

      api tag App Keys removed

  • 86441c3dfd15Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status