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.
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.eyJ1c2VyX2lkIjoidWFhLWlkLTExNCIsImVtYWlsIjoiZW1haWwtODVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNDMxMDEyNX0.0oXHLVuE6CJ7Xdxsg9ye24odLdl12uWRjTfbc7wM1f8
Host: example.org
Cookie: 

Route

GET /v2/stacks

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 503e1aa8-df5d-4b9e-b2e8-6f156d9e1ad1
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": "78532e59-4633-45ff-9033-d11ea4ac36a0",
        "url": "/v2/stacks/78532e59-4633-45ff-9033-d11ea4ac36a0",
        "created_at": "2015-02-12T01:41:54Z",
        "updated_at": null
      },
      "entity": {
        "name": "lucid64",
        "description": "Ubuntu 10.04 on x86-64"
      }
    },
    {
      "metadata": {
        "guid": "0c695cfc-97a0-48f1-8c43-58cecc46584d",
        "url": "/v2/stacks/0c695cfc-97a0-48f1-8c43-58cecc46584d",
        "created_at": "2015-02-12T01:41:57Z",
        "updated_at": null
      },
      "entity": {
        "name": "default-stack-name",
        "description": "default-stack-description"
      }
    },
    {
      "metadata": {
        "guid": "496238c7-fc75-4d11-89e0-5efaa540c623",
        "url": "/v2/stacks/496238c7-fc75-4d11-89e0-5efaa540c623",
        "created_at": "2015-02-12T01:41:57Z",
        "updated_at": null
      },
      "entity": {
        "name": "cider",
        "description": "cider-description"
      }
    }
  ]
}