Home
Version 3
Spaces API

Spaces API

List all Domains for the Space (deprecated)

GET /v2/spaces/:guid/domains

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the Space
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name, owning_organization_guid, space_guid
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTI4OSIsImVtYWlsIjoiZW1haWwtMjIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjh9.23t3MDzvqI21JpAo0s7mIJjbjga-VaNNmmKshwvppDQ
Host: example.org
Cookie: 

Route

GET /v2/spaces/a3efdab0-3988-4c49-b3cb-ee3c716890c2/domains

cURL

curl "https://api.[your-domain.com]/v2/spaces/a3efdab0-3988-4c49-b3cb-ee3c716890c2/domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4OSIsImVtYWlsIjoiZW1haWwtMjIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjh9.23t3MDzvqI21JpAo0s7mIJjbjga-VaNNmmKshwvppDQ" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: edd0c93b-87b9-4715-8294-a25b09f59178
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 729
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "7c208b5a-f728-4757-8fc8-479ae9554685",
        "url": "/v2/domains/7c208b5a-f728-4757-8fc8-479ae9554685",
        "created_at": "2014-11-24T19:32:46+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "d3f90c97-3bb4-4bdb-9387-9a9bcb9f70de",
        "url": "/v2/domains/d3f90c97-3bb4-4bdb-9387-9a9bcb9f70de",
        "created_at": "2014-11-24T19:32:47+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    }
  ]
}