Deployments

Close a deployment

Changed on
delete/v1/deployments/{dseq}

Request

  • Base URL
    https://console-api-sandbox.akash.network
  • URL
    https://console-api-sandbox.akash.network/v1/deployments/{dseq}
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Path parameters

dseqstring required

Deployment sequence number

Query parameters

async'true' | 'false'

With true, the close finishes in the background: the request answers 202 with an activityId to follow at GET /v1/activities/{id} once every check that could refuse it has passed. It answers 200 as without it when the deployment was already closed or background closes are unavailable.

batchIdstring uuid

Groups this close with the other closes of one bulk close. The activity it records carries the id in meta.batchId, so a client can report the batch together. Any UUID the caller picks, sent with every close of the batch.

Headers

x-organization-idstring

Id or slug of the organization the request runs in. Defaults to the organization used last, or the caller's personal one. Answers 403 organization_forbidden when the caller is not a member, and 400 organization_mismatch when it names another organization than the API key's.

x-project-idstring uuid

Id of a project of the active organization to limit the request to. Answers 403 project_forbidden when the caller cannot reach the project, or the API key is limited to another one.

Response

Deployment closed successfully

Changes

  • bb97e5bacb6fRevision changes
    • info

      added the new optional header request parameter x-organization-id

    • info

      added the new optional header request parameter x-project-id

    • info

      added the non-success response with the status

  • 28b96d566a4fRevision changes
    • info

      added the new optional query request parameter batchId