Inspect

Delete pull request preview

Remove a named preview from every Inspect session linked to the pull request, for example after the preview environment is torn down.

Base URL
DELETE
/api/public/v1/repositories/{owner}/{repo}/pulls/{pull_number}/previews/{name}

Remove a named preview from every Inspect session linked to the pull request, for example after the preview environment is torn down.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key authentication. Use your API key as the bearer token.

Path Parameters

owner*string

GitHub repository owner.

Length1 <= length
repo*string

GitHub repository name.

Length1 <= length
pull_number*integer

Pull request number.

Formatint64
Range0 < value
name*string

Preview name chosen by the caller, e.g. default or storybook. Lowercase kebab-case where each segment starts with a letter, at most 64 characters. The default preview is the session's primary preview.

Match^[a-z][a-z0-9]*(?:-[a-z][a-z0-9]*)*$
Lengthlength <= 64

Response Body

The preview was removed (or did not exist)

Example Request
curl -X DELETE 'https://your-org.inspect.com/api/public/v1/repositories/string/string/pulls/1/previews/string'
Example Response
Empty