Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1437207152.4 KB

Creates a new branch for an Amplify app.

post/apps/{appId}/branches

Path parameters

appIdstring required

The unique ID for an Amplify app.

Request body

branchNamestring required

The name for the branch.

descriptionstring

The description for the branch.

stage'PRODUCTION' | 'BETA' | 'DEVELOPMENT' | 'EXPERIMENTAL' | 'PULL_REQUEST'

Describes the current stage for the branch.

frameworkstring

The framework for the branch.

enableNotificationboolean

Enables notifications for the branch.

enableAutoBuildboolean

Enables auto building for the branch.

environmentVariablesobject

The environment variables for the branch.

basicAuthCredentialsstring password

The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.

enableBasicAuthboolean

Enables basic authorization for the branch.

enablePerformanceModeboolean
<p>Enables performance mode for the branch.</p> <p>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </p>
tagsobject

The tag for the branch.

buildSpecstring password

The build specification (build spec) file for an Amplify app build.

ttlstring

The content Time to Live (TTL) for the website in seconds.

displayNamestring

The display name for a branch. This is used as the default domain prefix.

enablePullRequestPreviewboolean

Enables pull request previews for this branch.

pullRequestEnvironmentNamestring

The Amplify environment name for the pull request.

backendEnvironmentArnstring

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

Response

Success