Landing Page

GET /

Canister API Landing Page

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- status string
  
  Value is 200 OK.
- date string(date-time)
- data object
  
  Hide data attributes Show data attributes object
  
  info object
  
  Hide info attributes Show info attributes object
  
  platform string
  
  Platform and compiler version
  
  runtime string
  
  Runtime environment and version
  
  name string
  
  Production name of the API
  
  version string
  
  Current deployed API version
  
  build string
  
  Build date and git commit hash
  
  reference object
  
  Hide reference attributes Show reference attributes object
  
  contact_email string
  
  Support email for questions or concerns
  
  privacy_policy string
  
  Link to the API privacy policy
  
  copyright string
  
  Copyright notice
  
  docs string
  
  Link to the API documentation
  
  privacy_updated string
  
  Date the privacy policy was last updated

GET /

curl \
 --request GET 'http://api.example.com/'

Response examples (200)

{
  "status": "200 OK",
  "date": "2025-05-04T09:42:00Z",
  "data": {
    "info": {
      "platform": "rust-1.66.0+aarch64-apple-darwin_llvm15.0",
      "runtime": "k8s_v1.26.0-linux/amd64-api-679f97c997-5fvlq",
      "name": "Canister (cnstr)",
      "version": "2.0.0",
      "build": "2023-01-04T19:23:23.765094Z+git-146c6fc-tree/main"
    },
    "reference": {
      "contact_email": "support@canister.me",
      "privacy_policy": "https://canister.me/privacy",
      "copyright": "Aarnav Tale (c) 2023",
      "docs": "https://docs.canister.me",
      "privacy_updated": "2022-03-25"
    }
  }
}