---
title: "rename_application"
description: "Generated reference for the management action rename_application: its description, access metadata, payload contract, and registration status."
slug: /reference/actions/rename-application
order: 75
visibility: public
redirects_from: []
---

# rename\_application

Generated automatically from the [published contract sources](/cloud/reference/about/#contract-sources).

A script calls this action over HTTPS at `POST https://tzcloud.turnzero.ai/v1/rename_application`, with a bearer credential and the action's payload as the JSON body. An MCP connection lists this action as the tool `tzcloud_rename_application`.

OAuth access tokens and minted tokens, including the turnzero command's computer token, are bearer credentials. The action determines which kinds, scopes and grants it accepts ([Sign-in, sessions, and tokens](/cloud/concepts/sign-in-sessions-and-tokens/)).

**Build metadata:** Registered in this build. Registration describes the default dispatcher in this build. It does not guarantee that a caller has the required credential or grant, that a tool is listed for that connection, or that the required service is configured.

## Contract description

Rename an application: pass `application` and the new `name`\. The readable name and the hostname change together, because the address is the name joined to a platform\-minted key\. A fresh key is minted when the approved action runs, so you learn the new address from the outcome\. The previous address stops responding for good\. Links to it break\. End users signed in on it must sign in again on the new address\. Passkeys they registered on it stop working\. Tell the account's owner this before you call\. The call creates a pending action and returns the approval URL\. A person approves it in the browser\. Read the outcome with `read_approval_status`\. A name another live application of your account uses is refused `name_taken`, and the current name `invalid_request`\.

## More about this action

Use a lowercase slug such as `todo-api` for `name`\. It has 1 to 40 characters, starts with a lowercase letter, and uses only lowercase letters, digits, and hyphens\.

Pass `request_id` to make a repeat safe\. While the earlier pending action is still live \(requested, approved, or executing\), a call with the same `request_id` from the same account returns that action and creates no second one\. Once the action has completed, failed, been declined, or expired, the same `request_id` starts a new one\.

## Access and action metadata

```json
{
  "name": "rename_application",
  "resource": "application",
  "tier": "destructive",
  "surface": "tzcloud",
  "addresses": [
    "tzcloud"
  ],
  "product": "cloud",
  "summary": "Rename one application: the readable name changes and a new hostname label is minted for it, the previous label retired for good. It completes through the pending action a person approves, whose description gives the previous hostname, the new name, and the end-user consequences.",
  "annotations": {
    "readOnlyHint": false,
    "destructiveHint": true,
    "openWorldHint": true
  }
}
```

## MCP catalog entry

```json
{
  "name": "rename_application",
  "title": "Rename application",
  "tier": "destructive",
  "summary": "Rename an application: pass `application` and the new `name`. The readable name and the hostname change together, because the address is the name joined to a platform-minted key. A fresh key is minted when the approved action runs, so you learn the new address from the outcome. The previous address stops responding for good. Links to it break. End users signed in on it must sign in again on the new address. Passkeys they registered on it stop working. Tell the account's owner this before you call. The call creates a pending action and returns the approval URL. A person approves it in the browser. Read the outcome with `read_approval_status`. A name another live application of your account uses is refused `name_taken`, and the current name `invalid_request`.",
  "owners": [
    "SVC-L0-07",
    "MAPI-05"
  ],
  "scenario": "CHI-L0-10"
}
```

## request

| JSON pointer | Description and constraints |
|---|---|
| "" \(root\) | Type: object<br>Required fields: \["application","name"\] |
| /<wbr>properties/<wbr>application | Your account's application `id` from `list_applications`, not its name or label\.<br><br>Type: string |
| /<wbr>properties/<wbr>name | A lowercase slug such as `todo-api`\. It becomes the readable half of a new hostname with a fresh platform\-minted key, and the previous hostname stops responding for good\. A name another live application of the account carries refuses `name_taken`; the current name refuses `invalid_request`\.<br><br>Type: string<br>Pattern: ^\[a\-z\]\[a\-z0\-9\-\]\{0,39\}$ |
| /<wbr>properties/<wbr>request\_id | Any string you choose\. A repeat from the same account while that pending action is live returns it again, creating no second one\. Omitted, every call creates a new one\.<br><br>Type: string |

## response

| JSON pointer | Description and constraints |
|---|---|
| "" \(root\) | The 202 creation envelope: the pending action and its approval link\. Read the outcome on the pending record with read\_approval\_status\. It holds the new name, label, and hostname beside the previous label and hostname, with one receipt per kind\.<br><br>Type: object<br>Required fields: \["contract\_version","pending\_action","approval\_url"\] |
| /<wbr>properties/<wbr>contract\_version | Required value: 1 |
| /<wbr>properties/<wbr>reference | The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call’s record row\. Quote it when you report the call\.<br><br>Type: string<br>Pattern: ^\[0\-9a\-f\]\{10\}$ |
| /<wbr>properties/<wbr>pending\_action | $ref: \#/shapes/pending\_action |
| /<wbr>properties/<wbr>approval\_url | Type: string |
| /<wbr>properties/<wbr>detail | Type: string |

## Complete payload contract

```json
{
  "request": {
    "type": "object",
    "required": [
      "application",
      "name"
    ],
    "properties": {
      "application": {
        "type": "string",
        "description": "Your account's application `id` from `list_applications`, not its name or label."
      },
      "name": {
        "type": "string",
        "pattern": "^[a-z][a-z0-9-]{0,39}$",
        "description": "A lowercase slug such as `todo-api`. It becomes the readable half of a new hostname with a fresh platform-minted key, and the previous hostname stops responding for good. A name another live application of the account carries refuses `name_taken`; the current name refuses `invalid_request`."
      },
      "request_id": {
        "type": "string",
        "description": "Any string you choose. A repeat from the same account while that pending action is live returns it again, creating no second one. Omitted, every call creates a new one."
      }
    }
  },
  "response": {
    "type": "object",
    "description": "The 202 creation envelope: the pending action and its approval link. Read the outcome on the pending record with read_approval_status (API-L0-07). It holds the new name, label, and hostname beside the previous label and hostname, with one receipt per kind.",
    "required": [
      "contract_version",
      "pending_action",
      "approval_url"
    ],
    "properties": {
      "contract_version": {
        "const": 1
      },
      "reference": {
        "type": "string",
        "pattern": "^[0-9a-f]{10}$",
        "description": "The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call’s record row. Quote it when you report the call."
      },
      "pending_action": {
        "$ref": "#/shapes/pending_action"
      },
      "approval_url": {
        "type": "string"
      },
      "detail": {
        "type": "string"
      }
    }
  }
}
```

## Shared contracts

- [Refusals](/cloud/reference/refusals/): every refusal, by surface, with its cause and its remedy
- [schemas/wire\_error\.schema\.json](/cloud/reference/sources/schemas/wire-error-schema/)
- [schemas/wire\_errors\.json](/cloud/reference/sources/schemas/wire-errors/)
- [schemas/action\_payloads\.json](/cloud/reference/sources/schemas/action-payloads/) (includes shared shapes)
- [management\_api\_contract\.md](/cloud/reference/sources/management-api-contract/)
