Home
Version 3
Organizations API

Organizations API

List all Domains for the Organization (deprecated)

GET /v2/organizations/:guid/domains

Request

Route

GET /v2/organizations/43504b26-b02c-4abf-844e-c3dd0d0eda9a/domains

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
  • 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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU0IiwiZW1haWwiOiJlbWFpbC0zMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYxOTU4MzkxfQ.pKqDLhGkaURbFXbK6vKK3splU_kaE_CAAmJPjKK46Wc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/43504b26-b02c-4abf-844e-c3dd0d0eda9a/domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU0IiwiZW1haWwiOiJlbWFpbC0zMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYxOTU4MzkxfQ.pKqDLhGkaURbFXbK6vKK3splU_kaE_CAAmJPjKK46Wc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "61d28015-bcc4-4f93-8818-92022115d2b2",
        "url": "/v2/domains/61d28015-bcc4-4f93-8818-92022115d2b2",
        "created_at": "2016-04-22T19:33:09Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "5c79af4e-ac40-44c9-86d6-e3b1f63389ae",
        "url": "/v2/domains/5c79af4e-ac40-44c9-86d6-e3b1f63389ae",
        "created_at": "2016-04-22T19:33:09Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e6b3b311-dd07-40eb-aef0-407e4d53acd6
X-Cf-Warnings: Endpoint+deprecated
Content-Length: 859
X-Content-Type-Options: nosniff