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.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MyIsImVtYWlsIjoiZW1haWwtMTE2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDR9.Q2WiuCMtueX5VZCf9YHhWOtjvQa548cpGZAVEUTqFOw
Host: example.org
Cookie: 

Route

GET /v2/stacks

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e4cb098c-47eb-4391-ace8-d52a2db05304
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": "f5f24f03-c4bf-46e3-a883-248b1d16fb71",
        "url": "/v2/stacks/f5f24f03-c4bf-46e3-a883-248b1d16fb71",
        "created_at": "2014-11-13T23:38:21+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "lucid64",
        "description": "Ubuntu 10.04 on x86-64"
      }
    },
    {
      "metadata": {
        "guid": "8d050664-9576-4e4a-954c-c33e059f234b",
        "url": "/v2/stacks/8d050664-9576-4e4a-954c-c33e059f234b",
        "created_at": "2014-11-13T23:38:21+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "default-stack-name",
        "description": "default-stack-description"
      }
    },
    {
      "metadata": {
        "guid": "736b0583-c9e4-420e-bc32-9ff0a86acf95",
        "url": "/v2/stacks/736b0583-c9e4-420e-bc32-9ff0a86acf95",
        "created_at": "2014-11-13T23:38:21+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "cider",
        "description": "cider-description"
      }
    }
  ]
}