Support
API ReferencePlatform & IntegrationNode.js Hosting

Manage environment secrets per variant. Values are never returned.

List app secrets (metadata only)

GET
/apps/{appId}/secrets

Authorization

oauth2 hosting.paas.secrets:write
AuthorizationBearer <token>

GoDaddy OAuth access token (Bearer)

In: header

Scope: hosting.paas.secrets:write

Path Parameters

appId*string

Query Parameters

variant?string
Value in"preview" | "publish"

Response Body

application/json

application/json

curl -X GET "https://api.godaddy.com/v1/hosting/nodejs/apps/string/secrets"
{
  "shared": {
    "secrets": [
      {
        "name": "string",
        "systemManaged": true,
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  },
  "variants": {
    "preview": {
      "secrets": [
        {
          "name": "string",
          "systemManaged": true,
          "createdAt": "string",
          "updatedAt": "string"
        }
      ]
    },
    "publish": {
      "secrets": [
        {
          "name": "string",
          "systemManaged": true,
          "createdAt": "string",
          "updatedAt": "string"
        }
      ]
    }
  }
}
Empty
Empty
{
  "error": "string",
  "code": "RATE_LIMITED",
  "detail": "string"
}

Add, update, or delete app secrets

POST
/apps/{appId}/secrets

Authorization

oauth2 hosting.paas.secrets:write
AuthorizationBearer <token>

GoDaddy OAuth access token (Bearer)

In: header

Scope: hosting.paas.secrets:write

Path Parameters

appId*string

Request Body

application/json

Response Body

application/json

application/json

curl -X POST "https://api.godaddy.com/v1/hosting/nodejs/apps/string/secrets" \  -H "Content-Type: application/json" \  -d '{    "variant": "preview",    "operations": {      "additions": [],      "updates": [],      "deletions": []    }  }'
{
  "shared": {
    "secrets": [
      {
        "name": "string",
        "systemManaged": true,
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  },
  "variants": {
    "preview": {
      "secrets": [
        {
          "name": "string",
          "systemManaged": true,
          "createdAt": "string",
          "updatedAt": "string"
        }
      ]
    },
    "publish": {
      "secrets": [
        {
          "name": "string",
          "systemManaged": true,
          "createdAt": "string",
          "updatedAt": "string"
        }
      ]
    }
  }
}
Empty
Empty
{
  "error": "string",
  "code": "RATE_LIMITED",
  "detail": "string"
}

Agent & Automation Notes

Scopeshosting.paas.apps:read, hosting.paas.apps:create, hosting.paas.apps:update, hosting.paas.apps:delete, hosting.paas.code:write, hosting.paas.deploy:execute, hosting.paas.secrets:write, hosting.paas.logs:read
Rate limit10–120 req/min per client IP depending on operation
On failureCreate app returns 202 with a job. Poll GET /apps/jobs/{jobId} until active or failed. Upload, publish, and rollback return 200 with a job or deployment record. Poll the matching status endpoint until complete. GET operations are safe to retry. Do not resubmit writes without checking current state.

Last updated on

How is this guide?