Home
Version 3
Organizations API

Organizations API

List all Domains for the Organization (deprecated)

GET /v2/organizations/:guid/domains

Fields

Name Description Default Valid Values Example Values

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization
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.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MiIsImVtYWlsIjoiZW1haWwtMjcxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTR9.Ee9egYpU2VNv4f-nuEj5jZpp_A6Q98bDW3Trho8Hq4Q
Host: example.org
Cookie: 

Route

GET /v2/organizations/2e1ec6e5-51d3-42e0-bb38-4159ee93384e/domains

cURL

curl "https://api.[your-domain.com]/v2/organizations/2e1ec6e5-51d3-42e0-bb38-4159ee93384e/domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MiIsImVtYWlsIjoiZW1haWwtMjcxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTR9.Ee9egYpU2VNv4f-nuEj5jZpp_A6Q98bDW3Trho8Hq4Q" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 81578b6a-3d9a-4c10-a466-54e752756313
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": "626ae416-700c-4a54-81a8-961c8d86df24",
        "url": "/v2/domains/626ae416-700c-4a54-81a8-961c8d86df24",
        "created_at": "2015-01-20T01:52:15+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "86159d7d-4806-44c8-99ba-866fdb507f86",
        "url": "/v2/domains/86159d7d-4806-44c8-99ba-866fdb507f86",
        "created_at": "2015-01-20T01:52:15+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    }
  ]
}