Deployments

Create new deployment

Changed on
post/v1/deployments

Request

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

Query parameters

async'true' | 'false'

With true, the deployment is created in the background: once every check that could refuse it has passed, the request answers 202 with the new deployment's dseq and an activityId to follow at GET /v1/activities/{id}. It answers 201 as without it when background creates are unavailable.

autoLease'true' | 'false'

Console web only. With true beside async=true, Console also picks the first provider that bids and answers for every placement, and leases the deployment, in the background. The 202 then carries autoLease: true, and a lease_create activity reports the match and the lease. Ignored when unavailable.

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.

Request body

Response

Create deployment successfully

Changes

  • b959efa6d493Revision changes
    • info

      added the new optional query request parameter autoLease

    • info

      added the optional property / to the response with the status

  • eb9ee4bcc3eeRevision changes
    • info

      added the new optional query request parameter async

    • info

      added the success response with the status