Skip to content

List an environment's deployments, newest first

GET
https://deploy.ezghcloud.com/v1/organizations/{orgId}/deploy/stacks/{stackId}/environments/{environmentId}/deployments

Authorization

  • apiKeyoptionalHTTP
  • oauthoptionalHTTP
  • sessionCookieoptionalAPI key in cookie

Path parameters

  • orgIdstringrequired

    UUID or prefixed ID (org_…)

  • stackIdstringrequired

    UUID or prefixed ID (dps_…)

  • environmentIdstringrequired

    UUID or prefixed ID (den_…)

Query parameters

  • limitoptionalinteger

    Items per page.

    maximum: 100, minimum: 1
    Default: 20
  • cursoroptionalstring

    The previous page's nextCursor.

  • statusoptionalapplyingorawaitingApprovalorawaitingDnsorbuildingorcancelledorcancelling+7 more

    Clients treat a state they don't know as unknown.

Returns

200

Success.

JSON
  • deploymentsarray ofobjectrequired
    19 properties
    • approvedBystring | nullrequired
    • cancelReasonuserorsupersededorexpiredorpausedornullrequired
    • createdAtstringrequired

      An instant, YYYY-MM-DDTHH:MM:SS.sssZ.

    • environmentobjectrequired

      A stack (dps_…) or environment (den_…) by ID and name.

      2 properties
      • idstringrequired
      • namestringrequired
    • errorStateErrorornullrequired
      2 variants

      One of the following:

    • finishedAtstring | nullrequired

      An instant, YYYY-MM-DDTHH:MM:SS.sssZ.

    • idstringrequired

      dpl_…

    • keptarray ofobjectrequired

      The network pieces a teardown kept, detached, because detached data still sits in them; each with its reason.

      4 properties
      • idstring | nullrequired

        The resource's prefixed ID; null when it never had one.

      • keystringrequired
      • kindstringrequired
      • reasonstringrequired
    • leftBehindarray ofobjectrequired

      The resources the deployment left as they were, and why: a teardown that couldn't reach them (its deploy Bot no longer exists), or resources Deploy doesn't delete (organization-wide domain authorizations, a domain's DNS records).

      4 properties
      • idstring | nullrequired

        The resource's prefixed ID; null when it never had one.

      • keystringrequired
      • kindstringrequired
      • reasonstringrequired
    • planPlanSummaryornullrequired
      2 variants

      One of the following:

    • rollbackOfstring | nullrequired
    • rolloutsarray ofobjectrequired
      8 properties
      • errorStateErrorornullrequired
        2 variants

        One of the following:

      • idstringrequired
      • imageDigeststring | nullrequired

        The image this rollout deploys: its sha256 digest; null before the images are recorded.

      • servicestringrequired
      • statuscanaryorcancelledorcleaningordoneorfailedorpending+3 morerequired

        Clients treat a state they don't know as unknown.

      • stepintegerrequired

        The canary or rolling step reached, from 0.

      • strategyrollingorcanaryrequired
      • untilstring | nullrequired

        An instant, YYYY-MM-DDTHH:MM:SS.sssZ.

    • sandboxImagesarray ofobjectrequired

      The desired state's sandbox images, sorted by name, each with its built reference; [] when it has none.

      2 properties
      • imagestring | nullrequired

        /<ci.registry>/@sha256:; null before it is built.

      • namestringrequired
    • shastring | nullrequired
    • stackobjectrequired

      A stack (dps_…) or environment (den_…) by ID and name.

      2 properties
      • idstringrequired
      • namestringrequired
    • startedBystringrequired
    • statusapplyingorawaitingApprovalorawaitingDnsorbuildingorcancelledorcancelling+7 morerequired

      Clients treat a state they don't know as unknown.

    • stepsarray ofobjectrequired
      9 properties
      • actionstringrequired
      • attemptintegerrequired
      • errorStateErrorornullrequired
        2 variants

        One of the following:

      • idstringrequired
      • keystringrequired
      • kindstringrequired
      • operationIdstring | nullrequired
      • startedAtstring | nullrequired

        An instant, YYYY-MM-DDTHH:MM:SS.sssZ.

      • statusdoneorfailedorpendingorrunningorwaitingOperationrequired

        Clients treat a state they don't know as unknown.

    • triggerpushorchangesetorapplyorrollbackordeleteorteardownrequired
  • nextCursorstring | nullrequired

400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

401

unauthenticated: no credential, or one that doesn't check out.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

404

not_found: unknown, malformed, or in an organization the caller isn't in.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

503

unavailable: a dependency the request needs is down. Retry after Retry-After.

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
      maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
    • messagestringrequired
      maxLength: 1024
    • issuesoptionalarray ofobject

      invalid_request: one entry per problem, at a dotted path.

      2 properties
      • messagestringrequired
      • pathstringrequired
    • quotaoptionalobject

      quota_exceeded: the quota that refused the request. Never with Retry-After.

      11 properties
      • idstringrequired
      • kindallocationorrateorusageorconcurrencyrequired
      • limitintegerrequired
        minimum: 0
      • scopeorganizationorprojectorresourcerequired
      • inFlightoptionalinteger
        minimum: 0
      • periodStartoptionalstring
        format: date-time
      • regionoptionalstring
      • resetsAtoptionalstring
        format: date-time
      • scopeResourceNameoptionalstring
      • usedoptionalinteger
        minimum: 0
      • windowoptionalstring

        rate only: an ISO 8601 duration, PT1S to PT1H.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close