GoDaddy
Support
API ReferencePlatform & IntegrationHostingList deployments GET

List deployments

View as Markdown

Returns deployments for the application, newest first.

Full description

Returns deployments for the application, newest first. Use this to inspect deployment history or find the most recent successful build.

GET
/apps/{appId}/deployments

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_-]+$

Query Parameters

pageToken?string

Opaque pagination cursor. Clients should navigate by following links[rel=next].href from the previous response rather than constructing URLs manually; this parameter is documented so that the endpoint's contract is discoverable.

pageSize?integer

Maximum number of items to return.

Range1 <= value <= 100
Default25
totalRequired?boolean

When true, populate totalItems in the response. This may impact response time on large collections.

Defaultfalse

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/apps/string/deployments"
{  "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": [    {      "deploymentId": "string",      "status": "PENDING",      "gitHash": "string",      "createdAt": "stringstringstringst",      "updatedAt": "stringstringstringst",      "error": {        "name": "string",        "correlationId": "string",        "message": "string",        "informationLink": "string",        "details": [          {            "field": "string",            "value": "string",            "location": "body",            "issue": "string",            "description": "string"          }        ],        "links": [          {            "href": "http://example.com",            "rel": "string",            "title": "string",            "targetMediaType": "string",            "targetSchema": null,            "method": "string",            "submissionMediaType": "application/json",            "submissionSchema": null          }        ]      },      "logs": [        "string"      ],      "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?