HTTP Endpoints

Below are the currently active CDS HTTP endpoint paths, followed by details on their usage.

---

NOTE: CDS endpoints require authorization; see the Getting Started page for more information.

---

“Service Unavailable” Errors

When do these occur?

In the course of normal usage, a client may receive a 503 Service Unavailable response from CDS, from any of the below listed HTTP endpoints.

This just means that the CDS is temporarily unable to respond to a request – say because of high traffic volume, or because it is down for maintenance. (More info on 503 responses can be found here.)

What should a client do?

In these instances, clients should retry their request at a later time.

Sample Response

{
    "error": {
        "message": "The Content Distribution Service (CDS) is temporarily unavailable. Please wait a moment, and retry your request.",
        ...
    }
}

---

Document Endpoints

• GET Document
  Get Single CDS document by ID

• GET Query Documents
  Query CDS for documents matching provided query parameters

• PUT Update Document
  CDS document creation + update route

• DELETE Document
  Delete Single CDS Document by ID

Profile/Schema Endpoints

• GET Profile
  Get an individual CDS Profile

• GET All Profiles
  Get a list of all current CDS profiles

• GET Schema
  Get JSON Schema object for an individual Schema

Notification Endpoints

• POST Subscription Confirmation
  Confirm a notification subscription

---

Table of contents

• Document Endpoints
• Profile Endpoints
• Subscription Endpoints