Update app

Update an existing app, identified by its id.

The app name, slug, default branch, and delete protection setting can be changed. Omitted fields are left unchanged. Changing the slug affects the deployment domains generated for this app.

Important: The slug cannot collide with an existing app in the same project. A duplicate slug returns a 409 conflict.

Required Permissions

Your root key must have one of the following permissions:

app.*.update_app (to update any app)
app.<app_id>.update_app (to update a specific app)

1 min read

post/v2/apps.updateApp

Request example

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v2"
	"github.com/unkeyed/sdks/api/go/v2/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Apps.UpdateApp(ctx, components.V2AppsUpdateAppRequestBody{
        Project: "payments",
        App: "payments-service",
        Slug: unkey.Pointer("payments-api"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2AppsUpdateAppResponseBody != nil {
        // handle response
    }
}

Response

{
  "data": {
    "createdAt": 1704067200000,
    "defaultBranch": "main",
    "deleteProtection": true,
    "id": "app_1234abcd",
    "isRolledBack": false,
    "name": "Payments API",
    "slug": "payments-api",
    "updatedAt": 1704153600000
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

post/v2/apps.updateApp

Authorization

Authorizationstringheaderrequired#

Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs.
To authenticate, include the token in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key.
Security best practices:

Keep root keys secure and never expose them in client-side code
Use different root keys for different environments
Rotate keys periodically, especially after team member departures
Create keys with minimal necessary permissions following least privilege principle
Monitor key usage with audit logs.

Body

application/json

projectstringrequired#

Identifies a resource by either its unique ID or its slug.
Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Length: 3–255Pattern: ^[a-zA-Z0-9_-]+$

appstringrequired#

Identifies a resource by either its unique ID or its slug.
Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Length: 3–255Pattern: ^[a-zA-Z0-9_-]+$

namestring#

New human-readable name for the app.
Omit this field to leave the current name unchanged.

Length: 1–256

slugstring#

Identifies a resource by either its unique ID or its slug.
Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Length: 3–255Pattern: ^[a-zA-Z0-9_-]+$

gitobject · null#

Connect, reconfigure, or disconnect this app's GitHub repository.
Omit to leave unchanged, set null to disconnect, or set an object with a
"repository" to connect or replace it and/or a "defaultBranch" to set which
branch it tracks. Fields are independent, so send only the one you change.

Show child attributes

Any of

repositorystring#

The GitHub repository to connect, as "owner/repo". Omit to change only the
tracked branch of the already-connected repository. The workspace must have
the Unkey GitHub App installed with access to it.

Length: 1–255

defaultBranchstring#

The branch this app's deployments track. Omit to adopt the repository's
GitHub default branch on a new connection, keep the current branch when
replacing an already-connected repository, or set it alone to retarget the
branch of the connected repository.

Length: 1–256

deleteProtectionboolean#

Enable or disable delete protection for the app.
Omit this field to leave the current setting unchanged.

Responses

application/json

Successfully updated the app.

metaobjectrequired#

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

requestIdstringrequired#

A unique id for this request. Always include this ID when contacting support about a specific API request. This identifier allows Unkey's support team to trace the exact request through logs and diagnostic systems to provide faster assistance.

dataobjectrequired#

Show child attributes

idstringrequired#

The unique identifier of the app, generated by Unkey.

namestringrequired#

Human-readable name for this app.

slugstringrequired#

URL-safe handle for this app, unique within its project.
Chosen at creation time.

gitobject#

The connected GitHub repository and the branch its deployments track.
Omitted when the app has no repository connected (for example a
Docker-based app).

Show child attributes

repositorystringrequired#

The connected GitHub repository, as "owner/repo".

Length: 1–255

defaultBranchstring#

The branch this app's deployments track.

Length: 1–256

currentDeploymentIdstring#

The identifier of the deployment currently serving this app.
Omitted if the app has no active deployment yet.

isRolledBackbooleanrequired#

Whether the app is currently serving a rolled-back deployment rather than its latest one.

deleteProtectionbooleanrequired#

Whether delete protection is enabled for this app.
When true, the app cannot be deleted until protection is disabled.

createdAtintegerrequired#

Unix timestamp in milliseconds when the app was created.

Range: 0–9223372036854776000

updatedAtinteger#

Unix timestamp in milliseconds when the app was last updated.
Omitted if the app has never been updated.

Range: 0–9223372036854776000

metaobjectrequired#

Show child attributes

requestIdstringrequired#

errorobjectrequired#

Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.

Show child attributes

detailstringrequired#

A human-readable explanation specific to this occurrence of the problem. This provides detailed information about what went wrong and potential remediation steps. The message is intended to be helpful for developers troubleshooting the issue.

statusintegerrequired#

HTTP status code that corresponds to this error. This will match the status code in the HTTP response. Common codes include 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 409 (Conflict), and 500 (Internal Server Error).

titlestringrequired#

A short, human-readable summary of the problem type. This remains constant from occurrence to occurrence of the same problem and should be used for programmatic handling.

typestringrequired#

A URI reference that identifies the problem type. This provides a stable identifier for the error that can be used for documentation lookups and programmatic error handling. When followed, this URI should provide human-readable documentation for the problem type.

errorsobject[]required#

List of individual validation errors that occurred in the request. Each error provides specific details about what failed validation, where the error occurred in the request, and suggestions for fixing it. This granular information helps developers quickly identify and resolve multiple issues in a single request without having to make repeated API calls.

Show child attributes

locationstringrequired#

JSON path indicating exactly where in the request the error occurred. This helps pinpoint the problematic field or parameter. Examples include:

'body.name' (field in request body)
'body.items[3].tags' (nested array element)
'path.apiId' (path parameter)
'query.limit' (query parameter)
Use this location to identify exactly which part of your request needs correction.

messagestringrequired#

Detailed error message explaining what validation rule was violated. This provides specific information about why the field or parameter was rejected, such as format errors, invalid values, or constraint violations.

fixstring#

A human-readable suggestion describing how to fix the error. This provides practical guidance on what changes would satisfy the validation requirements. Not all validation errors include fix suggestions, but when present, they offer specific remediation advice.

List apps Create deployment