Home
Version 3
Stacks API

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.eyJ1c2VyX2lkIjoidWFhLWlkLTM5IiwiZW1haWwiOiJlbWFpbC0zOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM5NDI2MTkyfQ.DJkWOLlzE38g-ZzZUTCMVmsZAIMDUUUbMq0qyc-Tmsg
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/stacks" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5IiwiZW1haWwiOiJlbWFpbC0zOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM5NDI2MTkyfQ.DJkWOLlzE38g-ZzZUTCMVmsZAIMDUUUbMq0qyc-Tmsg" \
	-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": "5ff5c713-bf4a-4b81-b122-9fa1edaf1566",
        "url": "/v2/stacks/5ff5c713-bf4a-4b81-b122-9fa1edaf1566",
        "created_at": "2015-08-06T00:36:30Z",
        "updated_at": null
      },
      "entity": {
        "name": "cflinuxfs2",
        "description": "cflinuxfs2"
      }
    },
    {
      "metadata": {
        "guid": "97ea9cc1-4a9e-456d-b098-c4e7d95f7c4d",
        "url": "/v2/stacks/97ea9cc1-4a9e-456d-b098-c4e7d95f7c4d",
        "created_at": "2015-08-06T00:36:30Z",
        "updated_at": null
      },
      "entity": {
        "name": "default-stack-name",
        "description": "default-stack-description"
      }
    },
    {
      "metadata": {
        "guid": "0cbd7987-abb6-4c83-9fa5-22e556b3dda8",
        "url": "/v2/stacks/0cbd7987-abb6-4c83-9fa5-22e556b3dda8",
        "created_at": "2015-08-06T00:36:30Z",
        "updated_at": null
      },
      "entity": {
        "name": "cider",
        "description": "cider-description"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 0b8a4915-8c98-4ab7-9d90-77d60c55e152
Content-Length: 1117
X-Content-Type-Options: nosniff