/
VE
vendure
/
@vendure-io/api — public
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 5h ago · Updated 3d ago
View markdown
vendure
@vendure-io/api — public
post
Create an install token (plaintext returned ONCE)
latest
OpenAPI 3.0.0
2026-08-20
86
102
148.5 KB
5fc4757128af
Assets
1
Customers Me
3
Enterprise Plugins
3
License Binding
2
Licenses
5
Org Team
9
Partners Me
4
Partners Me Activities
4
Partners Me Plugins
6
Partners Me Showcases
7
Projects
16
get
List caller-customer projects (paginated)
post
Create a new project for the caller customer
get
Project detail (must belong to caller customer)
delete
Delete a project
patch
Update a caller-owned project (name and/or description)
get
Current phone-home JWT for a caller-owned project
post
Mint a per-env phone-home JWT (GTM-440)
get
List install tokens for a project
post
Create an install token (plaintext returned ONCE)
delete
Revoke an install token (soft transition, returns the revoked row)
patch
Rename an install token label
get
Every currently-held seat for a caller-owned project, across every env it has activated in (GTM-444).
post
Revoke the caller-owned project binding for one env so the next activate call succeeds (GTM-444).
post
Runtime phone-home verification called by EE deployments
post
Mint a short-lived (max 72h) hub-signed break-glass token so license-guard can boot in soft mode while phone-home is failing (ECO-114).
get
List recent break-glass token issuances and revocations for a project (ECO-114).
Protected Assets
1
Public Enthusiasts
3
Public Partners
5
Public Plugin Categories
1
Public Plugins
3
Public VXP Awards
2
Users Me
6
Users Me Activities
3
Users Me Sessions
1
Well-Known
1
Projects
Create an install token (plaintext returned ONCE)
post
/v1/projects/{id}/install-tokens
Path parameters
id
string
required
Request body
InstallTokenCreateDto
required
label
object
nullable
expiresAt
string
date-time
Response
InstallTokenCreatedDto
required
token
InstallTokenDto
required
plaintext
string
required
Plaintext token value — only returned at creation time