Home
Version 3
Shared Domains API

Shared Domains API

List all Shared Domains

GET /v2/shared_domains

Request

Route

GET /v2/shared_domains

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MyIsImVtYWlsIjoiZW1haWwtMTY1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2MzR9.1mguAIAj1CvtEjVCLe-x_f4F7yu4U68FdBQxHVwSzuQ
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MyIsImVtYWlsIjoiZW1haWwtMTY1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2MzR9.1mguAIAj1CvtEjVCLe-x_f4F7yu4U68FdBQxHVwSzuQ" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 6,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "95fdf12f-7474-46f1-a028-d2b33ab3c651",
        "url": "/v2/shared_domains/95fdf12f-7474-46f1-a028-d2b33ab3c651",
        "created_at": "2016-04-16T01:23:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "f72de718-5750-4ac2-b28d-f1cdcc40a7ea",
        "url": "/v2/shared_domains/f72de718-5750-4ac2-b28d-f1cdcc40a7ea",
        "created_at": "2016-04-16T01:23:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "fb93702b-6320-4eee-85c8-e99394c37c9d",
        "url": "/v2/shared_domains/fb93702b-6320-4eee-85c8-e99394c37c9d",
        "created_at": "2016-04-16T01:23:54Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-52.example.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "1b8e8448-a6bd-48c9-9539-e1859430617d",
        "url": "/v2/shared_domains/1b8e8448-a6bd-48c9-9539-e1859430617d",
        "created_at": "2016-04-16T01:23:54Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-53.example.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "54753886-45a9-4d38-beb7-8e9298e0638b",
        "url": "/v2/shared_domains/54753886-45a9-4d38-beb7-8e9298e0638b",
        "created_at": "2016-04-16T01:23:54Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-54.example.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "25cba3bf-4863-4ed9-9014-394e404b9ead",
        "url": "/v2/shared_domains/25cba3bf-4863-4ed9-9014-394e404b9ead",
        "created_at": "2016-04-16T01:23:54Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-55.example.com",
        "router_group_guid": "my-random-guid",
        "router_group_type": "tcp"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6b5b07d6-0eba-4c0a-944c-f614d1448ede
Content-Length: 2410
X-Content-Type-Options: nosniff