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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0IiwiZW1haWwiOiJlbWFpbC0xNEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg1fQ.8eMUUnbE3GBCbBih3dJKNsKNbh55CbJkSpRMW4eAnzg
Host: example.org
Cookie: 

Route

GET /v2/organizations/296063cc-e3f6-4b4e-8c01-7e0e56e97dd4/domains

cURL

curl "https://api.[your-domain.com]/v2/organizations/296063cc-e3f6-4b4e-8c01-7e0e56e97dd4/domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0IiwiZW1haWwiOiJlbWFpbC0xNEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg1fQ.8eMUUnbE3GBCbBih3dJKNsKNbh55CbJkSpRMW4eAnzg" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 661f8525-fa7a-4577-bfee-85c19c9a73e9
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": "46d3ec1c-f5f0-4adb-a44a-61ac55d49951",
        "url": "/v2/domains/46d3ec1c-f5f0-4adb-a44a-61ac55d49951",
        "created_at": "2015-02-13T22:34:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "11a9666a-b2cb-4936-b637-1e78ccfa63f3",
        "url": "/v2/domains/11a9666a-b2cb-4936-b637-1e78ccfa63f3",
        "created_at": "2015-02-13T22:34:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    }
  ]
}