Stacks API

List all Stacks

GET /v2/stacks

Fields

Name	Description	Default	Valid Values	Example Values
name	The name for the stack.
description	The description for the stack

Parameters

Name	Description	Valid Values	Example Values
q	Parameters used to filter the result set. Format queries as <filter><op><value> Valid ops: : >= <= < > IN Valid filters: name		q=filter:value q=filter>value q=filter IN a,b,c
page	Page of results to fetch
results-per-page	Number of results per page
order-direction	Order of the results: asc (default) or desc
inline-relations-depth	0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations	0 - de-duplicate object entries in response
exclude-relations	comma-delimited list of relations to drop from response
include-relations	comma-delimited list of the only relations to include in response

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzOCIsImVtYWlsIjoiZW1haWwtMTA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzJ9.PzeUZC_a3Vd-zpwgHNjdk7ZejMp2_ckwMyHPKd9NpUo
Host: example.org
Cookie: 

Route

GET /v2/stacks

cURL

curl "https://api.[your-domain.com]/v2/stacks" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzOCIsImVtYWlsIjoiZW1haWwtMTA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzJ9.PzeUZC_a3Vd-zpwgHNjdk7ZejMp2_ckwMyHPKd9NpUo" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 617f72f4-8ab1-4374-8504-09917527b1af
Content-Length: 1126
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "8dda95e7-8e9e-42f1-b754-5646a1bc4fca",
        "url": "/v2/stacks/8dda95e7-8e9e-42f1-b754-5646a1bc4fca",
        "created_at": "2015-01-27T19:14:28Z",
        "updated_at": null
      },
      "entity": {
        "name": "lucid64",
        "description": "Ubuntu 10.04 on x86-64"
      }
    },
    {
      "metadata": {
        "guid": "273dbbf2-8cf1-4f91-a019-a313fe284d15",
        "url": "/v2/stacks/273dbbf2-8cf1-4f91-a019-a313fe284d15",
        "created_at": "2015-01-27T19:14:28Z",
        "updated_at": null
      },
      "entity": {
        "name": "default-stack-name",
        "description": "default-stack-description"
      }
    },
    {
      "metadata": {
        "guid": "6d9b8afd-ba4b-473d-b04a-db819aa7e851",
        "url": "/v2/stacks/6d9b8afd-ba4b-473d-b04a-db819aa7e851",
        "created_at": "2015-01-27T19:14:28Z",
        "updated_at": null
      },
      "entity": {
        "name": "cider",
        "description": "cider-description"
      }
    }
  ]
}