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.eyJ1c2VyX2lkIjoidWFhLWlkLTMxMiIsImVtYWlsIjoiZW1haWwtMjM5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODN9.YD2YkVBz5vqONVY_VuThTxm0B3dUIDGV-xkcfdU16QE
Host: example.org
Cookie: 

Route

GET /v2/spaces/ed863ce3-16ba-42d7-8e1a-2557c56b41c8/domains

cURL

curl "https://api.[your-domain.com]/v2/spaces/ed863ce3-16ba-42d7-8e1a-2557c56b41c8/domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxMiIsImVtYWlsIjoiZW1haWwtMjM5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODN9.YD2YkVBz5vqONVY_VuThTxm0B3dUIDGV-xkcfdU16QE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 4a3a9e0c-5850-4e51-ad6f-9c39e4b9ce22
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 719
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "08c7d7e6-af00-4038-afa6-50bf14ef692d",
        "url": "/v2/domains/08c7d7e6-af00-4038-afa6-50bf14ef692d",
        "created_at": "2015-01-27T19:14:37Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "748e1c3d-5841-43e7-9004-4d8dd4b0cc15",
        "url": "/v2/domains/748e1c3d-5841-43e7-9004-4d8dd4b0cc15",
        "created_at": "2015-01-27T19:14:37Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    }
  ]
}