REST APIs

Service endpoint

The Service Endpoint Resource contains the root resource to access the REST API of Sitecore Content Hub. This should be the only URL known by the client, and serves as the starting point to reach every other resource.

Methods supported: GET, HEAD

GET /api

Returns a Service Endpoint Object describing where to find the entities and entity definitions, among other things.

Example request:

GET http://<hostname>/api
Host: hostname
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Length: content length
Content-Type: application/json; charset=utf-8
ETag: "hash string"

{
    "entitydefinitions":{
        "href":"http://<hostname>/api/entitydefinitions",
        "title":"The collection of entity definitions."
    },
    "entities":{
        "href":"http://<hostname>/api/entities",
        "title":"The collection of entities."
    },
    "entitydefinition_by_name":{
        "href":"http://<hostname>/api/entitydefinitions/{name}",
        "title":"Get the entity definition with the spe...",
        "is_template":true
    },
    "entity_by_id":{
        "href":"http://<hostname>/api/entities/{id}",
        "title":"Get the entity with the specified id.",
        "is_template":true
    },
    "authenticate":{
        "href":"http://<hostname>/api/authenticate",
        "title":"Provides authentication tokens"
    }
}

If you have suggestions for improving this article, let us know!