Skip to main content
Version: 1.0

CEEMS API

OpenAPI specification (OAS) for the CEEMS REST API.

See the Interactive Docs to try CEEMS API methods without writing code, and get the complete schema of resources exposed by the API.

If basic auth is enabled, all the endpoints require authentication.

All the endpoints, except health, swagger, debug and demo, must send a user-agent header.

A demo instance of CEEMS API server is provided for the users to test. This instance is running at https://ceems-demo.myaddr.tools:7443 and it is the default server that will serve the requests originating from current OAS client.

Some of the valid users for this demo instance are:

  • arnold
  • betty
  • edna
  • gazoo
  • wilma

Every request must contain a X-Grafana-User header with one of the usernames above as the value to the header. This is how CEEMS API server recognise the user.

Some of the valid projects for this demo instance are:

  • bedrock
  • cornerstone

Demo instance have CORS enabled to allow cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

To test admin resources, users can use admin as X-Grafana-User.

Timestamps must be specified in milliseconds, unless otherwise specified.

Authentication​

Security Scheme Type:

http

HTTP Authorization Scheme:

basic