How to manage Apps

Overview

This page covers managing your deployed apps: listing all apps, reading a single app, updating its metadata, and deleting it. These operations use the hosting.application:read, hosting.application:update, and hosting.application:delete scopes.

Go to Deploy your Node.js app for the initial create-and-deploy flow. Go to Hosting core concepts for the scopes you need.

Prerequisites

The following prerequisites are required before you can manage your apps:

• a Personal Access Token with the hosting.application:read scope (all operations), plus hosting.application:update or hosting.application:delete as needed

List apps

GET /apps?appType=NODEJS returns all Node.js apps for your account.

The following procedure lists all apps.

• List all Node.js apps:

  curlNodePythonGo

  curl -s "$BASE_URL/v1/hosting/apps?appType=NODEJS" \
    -H "Authorization: Bearer $GODADDY_PAT" | jq .

The response is an array of app objects. Each includes the app id, name, creation status, and variant details.

Read an app

GET /apps/{appId} returns the full record for a single app.

The following procedure reads a specific app.

• Read the app:

  curlNodePythonGo

  curl -s "$BASE_URL/v1/hosting/apps/$APP_ID" \
    -H "Authorization: Bearer $GODADDY_PAT" | jq .

Update app metadata

PATCH /apps/{appId} updates the app's name or root path. The operation is synchronous and returns 200 with the updated app object.

The following procedure updates the app name.

• Update the app name:

  curlNodePythonGo

  curl -s -X PATCH "$BASE_URL/v1/hosting/apps/$APP_ID" \
    -H "Authorization: Bearer $GODADDY_PAT" \
    -H "Content-Type: application/json-patch+json" \
    -d '[{"op":"replace","path":"/name","value":"my-renamed-app"}]' | jq .

Delete an app

DELETE /apps/{appId} removes the app. The response is 204 No Content on success.

The following procedure deletes an app.

• Delete the app:

  curlNodePythonGo

  curl -s -X DELETE "$BASE_URL/v1/hosting/apps/$APP_ID" \
    -H "Authorization: Bearer $GODADDY_PAT"

Common errors

The following table lists common errors and recommended actions:

Last updated on