POST

/apps/{appId}/branches/{branchName}

http://amplify.{region}.amazonaws.com/apps/{appId}/branches/{branchName}

Updates a branch for an Amplify app.

Access Token Required: API Key

Path Parameters

appIdstringrequired

The unique ID for an Amplify app.

branchNamestringrequired

The name for the branch.

Body Params

ttlstring

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

stagestring

Describes the current stage for the branch.

buildSpecstring

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

frameworkstring

The framework for the branch.

descriptionstring

The description for the branch.

displayNamestring

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

enableAutoBuildboolean

Enables auto building for the branch.

enableBasicAuthboolean

Enables basic authorization for the branch.

enableNotificationboolean

Enables notifications for the branch.

basicAuthCredentialsstring

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

environmentVariablesobject

The environment variables for the branch.

backendEnvironmentArnstring

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

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>

enablePullRequestPreviewboolean

Enables pull request previews for this branch.

pullRequestEnvironmentNamestring

The Amplify environment name for the pull request.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://amplify.{region}.amazonaws.com/apps/{appId}/branches/{branchName}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request POST \ 2 --url 'http://amplify.{region}.amazonaws.com/apps/{appId}/branches/{branchName}' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'