GoDaddy
Support
API ReferencePlatform & IntegrationHostingUpdate an application PATCH

Update an application

View as Markdown

Partial update via [JSON Patch (RFC 6902)](https://datatracker.

Full description

Partial update via JSON Patch (RFC 6902). The request body is an array of operations applied in order and atomically. At least one operation must be present. Only the replace operation is supported, and only against the /name and /rootPath paths. Any other op or path returns 400 Bad Request. - /name — human-readable display name. String, 1–200 characters. - /rootPath — subdirectory within the repository to treat as the application root. Write-only; not returned on the Application resource. Currently only supported for NODEJS applications. Additional product-specific paths will be documented when those paths are available.

PATCH
/apps/{appId}

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer <token>.

In: header

Path Parameters

appId*string

Application identifier in {PRODUCT}-{id} form. The prefix is the application type in upper case — an upper-case letter followed by any number of upper-case letters, digits, or underscores — then a hyphen, then the identifier. For NODEJS, the suffix is a 10-character nanoid. Example: NODEJS-aBcDeFgHiJ.

Match^[A-Z][A-Z0-9_]*-[A-Za-z0-9_-]+$

Header Parameters

traceparent?string

W3C Trace Context identifier for this request. Clients should send a traceparent on every request so the trace can be correlated across services. See https://www.w3.org/TR/trace-context/ for the format.

Match^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

Request Body

application/json-patch+json

An array of JSON patch objects to apply partial updates to resources.

[index: integer]?

The JSON patch object to apply partial updates to resources.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/apps/string" \  -H "Content-Type: application/json-patch+json" \  -d '<0>    <op>add</op>  </0>'
{  "id": "NODEJS-aBcDeFgHiJ",  "name": "string",  "appType": "NODEJS",  "status": "CREATING",  "source": "ZIP",  "sourceDetails": {    "repositoryFullName": "string",    "branch": "string"  },  "urls": {    "preview": "http://example.com",    "publish": "http://example.com"  },  "region": "na",  "createdAt": "stringstringstringst",  "updatedAt": "stringstringstringst",  "links": [    {      "href": "http://example.com",      "rel": "string",      "title": "string",      "targetMediaType": "string",      "targetSchema": null,      "method": "string",      "submissionMediaType": "application/json",      "submissionSchema": null    }  ]}

Agent & Automation Notes

Scopeshosting.application:read, hosting.application:create, hosting.application:update, hosting.application:delete, hosting.source:write, hosting.deployment:execute, hosting.secret:write, hosting.log:read
Rate limit10–120 req/min per client IP depending on operation
On failureCreate app returns 202 with a job. Poll GET /app-operations/{operationId} until app is ready. Upload source and deployments return 202 with an operation ID. Poll the matching status endpoint until complete. GET operations are safe to retry. Do not resubmit writes without checking current state.

Related

Last updated on

How is this guide?