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

Body

Name Description Default Valid Values Example Values
guid The guid of the domain.
router_group_guid The guid of the router group.
name The name of the domain.
  • example.com
  • foo.example.com

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNyIsImVtYWlsIjoiZW1haWwtNzRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0OTUzMTUxNX0.dYxe_CmE7TVswb2R1gnsQmHO3_NoJwVfFFq6eB9LG6E
Host: example.org
Cookie: 

cURL

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

Response

Status

200 OK

Body

{
  "total_results": 5,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "f01b174d-c750-46b0-9ddf-3aeb2064d796",
        "url": "/v2/shared_domains/f01b174d-c750-46b0-9ddf-3aeb2064d796",
        "created_at": "2015-11-30T23:38:35Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "3595f6cb-81cf-424e-a546-533877ccccfd",
        "url": "/v2/shared_domains/3595f6cb-81cf-424e-a546-533877ccccfd",
        "created_at": "2015-11-30T23:38:35Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "d0d28c59-86ee-4415-9269-500976f18e72",
        "url": "/v2/shared_domains/d0d28c59-86ee-4415-9269-500976f18e72",
        "created_at": "2015-11-30T23:38:35Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-19.example.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "b7242cdb-f81a-4469-b897-d5a218470fdf",
        "url": "/v2/shared_domains/b7242cdb-f81a-4469-b897-d5a218470fdf",
        "created_at": "2015-11-30T23:38:35Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-20.example.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "130c193c-c1c6-41c9-98c2-4a0e16a948bf",
        "url": "/v2/shared_domains/130c193c-c1c6-41c9-98c2-4a0e16a948bf",
        "created_at": "2015-11-30T23:38:35Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-21.example.com",
        "router_group_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1841
X-Content-Type-Options: nosniff