Skip to content

Record a deployment (the CI or a deploy script deploys; Pando records)

release: a published release's tag; left out, the newest published release at sha is named, if any. Pando never deploys.

POST
https://app.gitpando.com/v1/monorepos/{owner}/{monorepo}/repos/{repo}/deployments

Authorisation

  • credentialoptionalHTTP
  • sessionoptionalAPI key in cookie

Path parameters

  • ownerstringrequired

    The monorepo's owner, a namespace (a person's login or an organization). Matched without case.

    pattern: ^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$
  • monorepostringrequired

    The monorepo's name within its owner (or an old name). Matched without case.

    pattern: ^[a-z0-9](?:[a-z0-9._]|-(?!-)){0,38}$
  • repostringrequired

    The repo's name (projects-web).

Request bodyJSONrequired

  • environmentstringrequired

    a-z, 0-9, '.', '_', '-'; at most 64 (pando-dev, production).

  • shastringrequired
  • stateoptionalin_progressorsuccessorfailure
    Default: "success"
  • releaseoptionalstring
  • urloptionalstring
  • descriptionoptionalstring

Returns

201

Recorded

JSON
  • idstringrequired
  • repostringrequired
  • environmentstringrequired
  • shastringrequired
  • releasestring | nullrequired
  • statein_progressorsuccessorfailurerequired
  • urlstring | nullrequired
  • descriptionstring | nullrequired
  • created_bystringrequired
  • created_atstringrequired
    format: date-time
Navigation

Type to search…

↑↓ navigate↵ selectEsc close