Skip to content

Deployment

deployment_preview_environment_create

Create a preview environment from an open PR

Tool

deployment_preview_environment_create

Create a preview environment from an open PR

Create a preview environment from an open PR

Behavior

HTTP
POST /deployment/preview-environments

Arguments

NameTypeRequiredDescription
prBranchstringNo description in the catalog.
prNumberintegerNo description in the catalog.
baseEnvironmentIdstringNo description in the catalog.

Response

FieldTypeAlwaysDescription
idstring
namestring
slugstring
typestring
statusstring
prBranchstring
prNumberinteger
createdAtstring
expiresAtstring
updatedAtstring
isProductionboolean
lastErrorMessagestring
baseEnvironmentIdstring

Try it

Create a preview environment from an open PR.

When to use

Create a preview environment from an open PR

Example

Ask your agent something like this:

Create a preview environment from an open PR.

The agent will invoke deployment_preview_environment_create with these arguments:

{
  "prNumber": "<prNumber>",
  "baseEnvironmentId": "<baseEnvironmentId>"
}

Esc

Start typing to search the docs.

navigateselect