Cycle Docs | API Reference

Fetch Build

Fetch a specific stack build by ID.

Requires the stacks-builds-manage permission.

query

meta

Accepted Values: containers_count

Returns

Returns a stack build resource, otherwise returns an Error.

GET /v1/stacks/5a232a77b6393d0001ac2df2/builds/5b9c2a77b6393d0001eb45fd

Example Request

$ curl  https://api.cycle.io/v1/stacks/5a98710df231a500017f9aa4/builds/5d02f7e9b89494000108422a \
  -H "Authorization: Bearer API_KEY"
 \
  -H "X-Hub-Id: HUB_ID"

Example Response

{
  "data": {
    "id": "5d02f7e9b89494000108422a",
    "stack_id": "5d02f7e44146380001ccc871",
    "hub_id": "5a14ddd8b6393d0001976f44",
    "about": {
      "version": "1.0",
      "description": "A redis applicaiton"
    },
    "instructions": {},
    "spec": {
      "version": "1.0",
      "containers": {
        "redis": {
          "name": "redis",
          "image": {
            "name": "redis",
            "origin": {
              "type": "docker-hub",
              "details": {
                "target": "redis:latest"
              }
            }
          },
          "stateful": false,
          "config": {
            "network": {
              "public": "disable",
              "hostname": "redis",
              "ports": [
                "6379:6379"
              ]
            },
            "deploy": {
              "instances": 1
            },
            "runtime": {
              "environment_vars": {
                "TEST_VAR": "test_vaar_one"
              },
              "privileged": false
            }
          },
          "volumes": []
        },
        "web": {
          "name": "web",
          "image": {
            "name": "node",
            "origin": {
              "type": "docker-file",
              "details": {
                "context_dir": "/",
                "build_file": "/Dockerfile"
              }
            }
          },
          "stateful": false,
          "config": {
            "network": {
              "public": "enable",
              "hostname": "web",
              "ports": [
                "80:8081"
              ]
            },
            "deploy": {
              "instances": 1
            },
            "runtime": {
              "environment_vars": {
                "TEST_VAR": "test_var"
              },
              "privileged": false
            }
          },
          "volumes": []
        }
      },
      "annotations": {}
    },
    "events": {
      "created": "2019-06-14T01:27:05.486Z",
      "updated": "0001-01-01T00:00:00Z",
      "deleted": "0001-01-01T00:00:00Z"
    },
    "state": {
      "changed": "2019-06-14T01:29:01.238Z",
      "current": "live"
    },
    "meta": {
      "containers_count": {
        "state": {
          "new": 0,
          "starting": 0,
          "running": 0,
          "stopping": 0,
          "stopped": 0,
          "reimaging": 0,
          "deleting": 0,
          "deleted": 0
        },
        "total": 0,
        "available": 0
      }
    }
  }
}