Admin API

Current version: 4.2

The admin API is a GraphQL API that lists the entity definitions in your Sitecore Content Hub instance. You only see the entities and relations that you have permission to view.

Warning

The admin API should not be used for production purposes.

Base URL

The base URL of the admin API is:

{ContentHubURL}/api/graphql/admin/v1

Where {ContentHubURL} is your Content Hub instance URL.

Integrated development environment (IDE)

The URL of the admin API IDE is:

{ContentHubURL}/api/graphql/admin/ide

Where {ContentHubURL} is your Content Hub instance URL.

Endpoints

The admin API exposes a single endpoint:

Endpoint	HTTP Verb
`~/api/graphql/admin/v1`	`POST`

Headers

The following header is required:

Name	Format	Purpose
`X-Auth-Token`	Authentication token	Token used to authenticate requests.

Note

When you are logged in to Content Hub, authentication is inherited from the browser and you do not need additional authentication.

Request body

The body of the request is a GraphQL query.

Response format

The response of the request is a GraphQL-formatted response.