---
title: "The API's information"
method: GET
path: "/info"
tags: ["API Metadata Information"]
---

# The API's information

`GET /info`

## Request

- Base URL: `https://api-dor.ncl.ac.uk`
- URL: `https://api-dor.ncl.ac.uk/info`
- Auth: none declared

Returns a basic set of information describing the state of the API and its current version.

## Response `200`

The metadata object describing the basic information about the API.

- object
  - `version` string, required: A representation of a version compatible with [Semantic Versioning 2.0.0](https://semver.org/).
  - `build` string, required: A representation of a version compatible with [Semantic Versioning 2.0.0](https://semver.org/).
  - `baseUrl` string, required
  - `_links` object, required: Standard set of links related to the homepage.
    - `home` HateoasLink, required
      - `href` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
      - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.
    - `specification` HateoasLink, required
      - `href` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'DELETE', required
      - `parameters` HateoasParameters: Any relevant parameters that should be appended to the URL (for GET method) or passed as a payload for other HTTP methods.

## Other responses

- `5XX`: Indicates that the server encountered an unexpected exception preventing it from fulfilling the request.

---

[API](https://skmtc.dev/ncl/apis/newcastle-university-digitised-objects-repository-search-and.md) - [All operations](https://skmtc.dev/ncl/apis/newcastle-university-digitised-objects-repository-search-and/llms.txt) - [OpenAPI document](https://skmtc.dev/ncl/apis/newcastle-university-digitised-objects-repository-search-and/revisions/fe6a8df13009?raw)