Skip to content
DashboardGet API key

Get deployment

View .md
GET

Fetch a deployment to poll its status during a deploy.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • deploymentIdstringrequired

    Function deployment ID.

Responses

200Deployment details.
  • deploymentobjectrequired
    10 properties
    • idstringrequired
    • functionIdstringrequired
    • versionintegerrequired

      Monotonically increasing deployment version, starting at 1.

    • statusstringrequired

      Stage of a function deployment.

      One ofpendingbundlinguploadingpublishingactivefailedsuperseded
    • sourceCodeBytesintegernullable

      Total size of the deployed source tree in bytes.

    • bundleBytesintegernullable

      Size of the built bundle in bytes. Null until the build finishes.

    • errorMessagestringnullable

      Failure reason when status is 'failed'.

    • buildLogsstringnullable

      What the build printed: dependency installation, the bundler's output, and the compiler's message when it failed. Returned when fetching a single deployment, omitted from the list. Read this first when a deploy fails — errorMessage is often the outer wrapper's summary, and the line that names the broken import or the syntax error is here.

    • deployedAtstring<date-time>nullable
    • createdAtstring<date-time>required
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Deployment not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject