Skip to content
Pages in Reference

Previews

Reference Updated View as Markdown
Method Path What it does Permission Sudo Approval
GET /api/apps/{domain}/previews List Previews apps.read
POST /api/apps/{domain}/previews Create Preview apps.deploy yes
GET /api/apps/{domain}/previews/dns Get Preview Dns apps.read
GET /api/apps/{domain}/previews/pull-requests List Pull Requests apps.read
PUT /api/apps/{domain}/previews/settings Put Preview Settings apps.manage yes
DELETE /api/apps/{domain}/previews/settings Delete Preview Settings apps.manage yes
GET /api/apps/{domain}/previews/variables Get Preview Variables apps.read
PUT /api/apps/{domain}/previews/variables/{name} Put Preview Variable apps.manage yes
DELETE /api/apps/{domain}/previews/variables/{name} Delete Preview Variable apps.manage yes
GET /api/apps/{domain}/previews/{number} Get Preview apps.read
DELETE /api/apps/{domain}/previews/{number} Delete Preview apps.manage yes
POST /api/apps/{domain}/previews/{number}/approve Approve Preview apps.deploy yes
GET /api/apps/{domain}/previews/{number}/logs Get Preview Logs apps.read
POST /api/apps/{domain}/previews/{number}/redeploy Redeploy Preview apps.deploy yes
POST /api/apps/{domain}/previews/{number}/reject Reject Preview apps.deploy yes
POST /api/apps/{domain}/previews/{number}/start Start Preview apps.operate yes
POST /api/apps/{domain}/previews/{number}/stop Stop Preview apps.operate yes

Something on this page is wrong or unclear? Report it on GitHub.

Help, contributing and the project’s policies are under Project.

Search the documentation

Type to search every page.

↑ ↓ to move, Enter to open, Esc to close