GoDaddy
Support
API ReferencePlatform & IntegrationHostingList hosting subscriptions GET

List hosting subscriptions

View as Markdown

Returns hosting subscriptions for the authenticated user, including slot usage.

Full description

Returns hosting subscriptions for the authenticated user, including slot usage. Use this to find a subscriptionId when attaching a subscription to an application. hostingProduct is required. Cross-product listing will be supported in a future version. The parameter has three outcomes. Omitting it, or sending a value outside HostingProduct, returns 400 with details[].issue VALIDATION_FAILED. Sending a product the enum admits but this deployment does not serve returns 501 with details[].issue NOT_APPLICABLE — never 400. Sending a product this deployment serves returns 200.

GET
/subscriptions

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

hostingProduct*HostingProduct

Hosting product to scope the operation to. This filter is required rather than optional: an optional filter introduced after general availability would have to default to WEB_HOSTING for ever, or the set of subscriptions returned would silently change for clients that omit it. It is made required now, while this spec is still Beta.

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}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/subscriptions?hostingProduct=WEB_HOSTING"
{  "totalItems": 0,  "totalPages": 0,  "links": [    {      "href": "http://example.com",      "rel": "string",      "title": "string",      "targetMediaType": "string",      "targetSchema": null,      "method": "string",      "submissionMediaType": "application/json",      "submissionSchema": null    }  ],  "items": [    {      "subscriptionId": "string",      "hostingProduct": "WEB_HOSTING",      "tier": "ECONOMY",      "label": "string",      "status": "ACTIVE",      "attachedCount": 0,      "slotLimit": 0,      "availableSlots": 0,      "paidThroughDate": "2027-08-06T00:00:00Z",      "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?