Stacks API

List all Stacks

GET /v2/stacks

Request

Route

GET /v2/stacks

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

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyOCIsImVtYWlsIjoiZW1haWwtMjE5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3MjF9.TlWZZzDZ0zENTj5WT11-FknPSNGFbp8UWhT4THlJpl0
Host: example.org
Cookie: 

cURL

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

Response

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "995d5f10-3896-436c-abac-aa191453f3ed",
        "url": "/v2/stacks/995d5f10-3896-436c-abac-aa191453f3ed",
        "created_at": "2016-05-12T00:45:10Z",
        "updated_at": null
      },
      "entity": {
        "name": "cflinuxfs2",
        "description": "cflinuxfs2"
      }
    },
    {
      "metadata": {
        "guid": "e2ef3d79-1b83-4cd5-b36e-a4e1d59c5562",
        "url": "/v2/stacks/e2ef3d79-1b83-4cd5-b36e-a4e1d59c5562",
        "created_at": "2016-05-12T00:45:10Z",
        "updated_at": null
      },
      "entity": {
        "name": "default-stack-name",
        "description": "default-stack-description"
      }
    },
    {
      "metadata": {
        "guid": "7f967011-5143-4eff-809c-5c61b55c3385",
        "url": "/v2/stacks/7f967011-5143-4eff-809c-5c61b55c3385",
        "created_at": "2016-05-12T00:45:10Z",
        "updated_at": null
      },
      "entity": {
        "name": "cider",
        "description": "cider-description"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 1582ca33-1110-4b73-aaad-a9a6231d54b7
Content-Length: 1117
X-Content-Type-Options: nosniff