Quickstart | Akash Network - Your Guide to Decentralized Cloud

Deploy an nginx container to Akash in five API calls.

Prerequisites:

An API key from Console (Settings → API Keys), exported as AKASH_API_KEY. The key deploys in the account it was created in: your personal account, or the team that was active when you created it.
A deployment.json file shaped like { "data": { "sdl": "<YOUR_SDL_YAML_AS_STRING>" } }. It has no deposit field, because Console funds the deployment from your account credits. See How Funding Works.
jq for JSON parsing.

In a team, you can choose the project the deployment goes into by adding "projectId" next to "sdl" in deployment.json. Leave it out to use the only project you can deploy into, or else the team’s default project. See Deploy into a project.

# 1. Create a deployment
CREATE=$(curl -s -X POST https://console-api.akash.network/v1/deployments \
  -H "x-api-key: $AKASH_API_KEY" \
  -H "Content-Type: application/json" \
  -d @deployment.json)
DSEQ=$(echo "$CREATE" | jq -r '.data.dseq')

# 2. Wait 30 seconds for bids, then read the first bid's composite id
sleep 30
BID=$(curl -s "https://console-api.akash.network/v1/bids?dseq=$DSEQ" \
  -H "x-api-key: $AKASH_API_KEY" | jq -c '.data[0].bid.id')
GSEQ=$(echo "$BID" | jq -r '.gseq')
OSEQ=$(echo "$BID" | jq -r '.oseq')
PROVIDER=$(echo "$BID" | jq -r '.provider')

# 3. Create the lease. Console sends the provider the manifest itself
curl -s -X POST https://console-api.akash.network/v1/leases \
  -H "x-api-key: $AKASH_API_KEY" \
  -H "Content-Type: application/json" \
  -d "$(jq -n \
        --arg dseq "$DSEQ" \
        --argjson gseq "$GSEQ" \
        --argjson oseq "$OSEQ" \
        --arg provider "$PROVIDER" \
        '{leases: [{dseq: $dseq, gseq: $gseq, oseq: $oseq, provider: $provider}]}')"

# 4. Check status
curl -s "https://console-api.akash.network/v1/deployments/$DSEQ" \
  -H "x-api-key: $AKASH_API_KEY" | jq

# 5. Close when done
curl -s -X DELETE "https://console-api.akash.network/v1/deployments/$DSEQ" \
  -H "x-api-key: $AKASH_API_KEY"