Home
Version 3
Private Domains API

Private Domains API

List all Private Domains

GET /v2/private_domains

Request

Route

GET /v2/private_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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI3NyIsImVtYWlsIjoiZW1haWwtMjA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2Mzl9.fTS4FJpbcsYGOqVwDnlagVNw52cor7NNK11OqzqK7T0
Host: example.org
Cookie: 

cURL

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

Response

Status

200 OK

Body

{
  "total_results": 4,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "1c1aad37-9f20-4269-8e74-5d258b4bbbac",
        "url": "/v2/private_domains/1c1aad37-9f20-4269-8e74-5d258b4bbbac",
        "created_at": "2015-05-07T23:37:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "vcap.me",
        "owning_organization_guid": "93ec0abc-2f58-4e1a-8d35-75ccffaac783",
        "owning_organization_url": "/v2/organizations/93ec0abc-2f58-4e1a-8d35-75ccffaac783",
        "shared_organizations_url": "/v2/private_domains/1c1aad37-9f20-4269-8e74-5d258b4bbbac/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "67b27de5-eff7-4eb2-883a-6599c5422a3b",
        "url": "/v2/private_domains/67b27de5-eff7-4eb2-883a-6599c5422a3b",
        "created_at": "2015-05-07T23:37:19Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-44.example.com",
        "owning_organization_guid": "cf425f76-d02d-4b4d-9f0b-2a812eddb4c0",
        "owning_organization_url": "/v2/organizations/cf425f76-d02d-4b4d-9f0b-2a812eddb4c0",
        "shared_organizations_url": "/v2/private_domains/67b27de5-eff7-4eb2-883a-6599c5422a3b/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "95237d81-443e-4a16-8a09-00afc2bb93d9",
        "url": "/v2/private_domains/95237d81-443e-4a16-8a09-00afc2bb93d9",
        "created_at": "2015-05-07T23:37:19Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-45.example.com",
        "owning_organization_guid": "3f42ad1a-fe35-4a18-881f-8e0c1ba7fa8d",
        "owning_organization_url": "/v2/organizations/3f42ad1a-fe35-4a18-881f-8e0c1ba7fa8d",
        "shared_organizations_url": "/v2/private_domains/95237d81-443e-4a16-8a09-00afc2bb93d9/shared_organizations"
      }
    },
    {
      "metadata": {
        "guid": "d20ec82a-b23e-4583-860b-a38d692df5e4",
        "url": "/v2/private_domains/d20ec82a-b23e-4583-860b-a38d692df5e4",
        "created_at": "2015-05-07T23:37:19Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-46.example.com",
        "owning_organization_guid": "fd38d244-8e85-4d48-acd6-9b05f8324477",
        "owning_organization_url": "/v2/organizations/fd38d244-8e85-4d48-acd6-9b05f8324477",
        "shared_organizations_url": "/v2/private_domains/d20ec82a-b23e-4583-860b-a38d692df5e4/shared_organizations"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9c9c6292-1f7c-4222-8b16-a0b3d3904ab9
Content-Length: 2483
X-Content-Type-Options: nosniff