Home
Version 3
Stacks API

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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNiIsImVtYWlsIjoiZW1haWwtNzZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxNTc1NDEzNX0.Ny7IOY3tz44n8eaQ45JMnxjqV80iMTMNoMI7v7Zz61o
Host: example.org
Cookie: 

Route

GET /v2/stacks

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 029a3754-e343-42e5-b448-97b316e80830
Content-Length: 1141
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "27a9481e-b2ed-41c5-b852-d74af3e9a16c",
        "url": "/v2/stacks/27a9481e-b2ed-41c5-b852-d74af3e9a16c",
        "created_at": "2014-11-05T01:02:06+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "lucid64",
        "description": "Ubuntu 10.04 on x86-64"
      }
    },
    {
      "metadata": {
        "guid": "083fd1d1-525f-4f9f-80aa-d3b595652cb0",
        "url": "/v2/stacks/083fd1d1-525f-4f9f-80aa-d3b595652cb0",
        "created_at": "2014-11-05T01:02:07+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "default-stack-name",
        "description": "default-stack-description"
      }
    },
    {
      "metadata": {
        "guid": "b6143890-1eaa-49c6-83f1-047e14fb85b3",
        "url": "/v2/stacks/b6143890-1eaa-49c6-83f1-047e14fb85b3",
        "created_at": "2014-11-05T01:02:07+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "cider",
        "description": "cider-description"
      }
    }
  ]
}