LIlit-protocol
Policy

Edits a policy

Changed on
put/policy/{packageName}

Request

  • Base URL
    https://api.heyvincent.ai
  • URL
    https://api.heyvincent.ai/policy/{packageName}
  • Auth
    API key in header Authorization

Path parameters

packageNamestring required

The NPM package name

Request body

activeVersionstring

Active version of the policy; must be an exact semver

titlestring

Policy title for displaying to users in the dashboard/Vincent Explorer UI

descriptionstring

Policy description - displayed to users in the dashboard/Vincent Explorer UI

deploymentStatus'dev' | 'test' | 'prod'

Identifies if a policy is in development, test, or production.

logostring

Base64 encoded logo image

Example request

{
  "activeVersion": "1.0.0",
  "title": "Vincent Spending Limit Policy",
  "description": "This policy is a foo bar policy",
  "deploymentStatus": "dev",
  "logo": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAIAAAACDbGyAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOvwAADr8BOAVTJAAAAA5JREFUGFdj/M+ACAAAAAD//wE7AnsAAAAAAElFTkSuQmCC"
}

Response

Successful operation

_idstring required

Document ID

updatedAtstring date-time required

Timestamp when this was last modified

createdAtstring date-time required

Timestamp when this was created

packageNamestring required

Policy NPM package name

authorWalletAddressstring required

Author wallet address. Derived from the authorization signature provided by the creator.

descriptionstring required

Policy description - displayed to users in the dashboard/Vincent Explorer UI

logostring

Base64 encoded logo image

activeVersionstring required

Active version of the policy; must be an exact semver

titlestring required

Policy title for displaying to users in the dashboard/Vincent Explorer UI

deploymentStatus'dev' | 'test' | 'prod'

Identifies if a policy is in development, test, or production.

isDeletedboolean

Whether or not this Policy is deleted

Example response

{
  "packageName": "@lit-protocol/vincent-policy-spending-limit",
  "authorWalletAddress": "0x123456789012345678901234567890123456abcd",
  "description": "This policy is a foo bar policy",
  "logo": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAIAAAACDbGyAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOvwAADr8BOAVTJAAAAA5JREFUGFdj/M+ACAAAAAD//wE7AnsAAAAAAElFTkSuQmCC",
  "activeVersion": "1.0.0",
  "title": "Vincent Spending Limit Policy",
  "deploymentStatus": "dev"
}

Changes

  • 3a57afc3e1f4Revision changes
    • info

      the endpoint scheme security siweAuth was added to the API

    • info

      the endpoint scheme security bearerAuth was removed from the API

  • 246a15ffe975Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security siweAuth was removed from the API