GET /Api/Read/List
Authorization key

Read the list of endpoints available for the API read functions with a brief description of each and the last modified date. Secret Hmac Optional. Cache Time 1 Day.

Responses

  • 200 application/json

    List successfully created

    Hide response attributes Show response attributes object
    • summary string

      The summary of the API group

    • modified string

      Last udpate date of this API

    • operations array[object]
      Hide operations attributes Show operations attributes object
      • endpoint string

        The endpoint to call

      • description string

        The description of the endpoint

      • doc string

        public documentation URL
GET /Api/Read/List 
curl \
 --request GET 'https://api.wereadthemanual.com/v1.0/Api/Read/List' \
 --header "X-ApiKey: $API_KEY"
Response examples (200) 
{
  "summary": "Read information about the Read API system and your API Key",
  "modified": "Fri, 12 May 2023 18:16:02 GMT",
  "operations": [
    {
      "doc": "https://apidoc.wrtm.io/operation/operation-get-api-read-list",
      "endpoint": "/Api/Read/List",
      "description": "List all functions for api/Read/*"
    },
    {
      "doc": "https://apidoc.wrtm.io/operation/operation-get-api-read-acl",
      "endpoint": "/Api/Read/Acl",
      "description": "Show acl settings allowed to your key. Pass AclAllowed parameter with a path to get 1 or 0 response"
    },
    {
      "doc": "https://apidoc.wrtm.io/operation/operation-get-api-read-groups",
      "endpoint": "/Api/Read/Groups",
      "description": "Return all groups that your key can access"
    },
    {
      "doc": "https://apidoc.wrtm.io/operation/operation-get-api-read-history",
      "endpoint": "/Api/Read/History",
      "description": "Return the daily history for your key"
    },
    {
      "doc": "https://apidoc.wrtm.io/operation/operation-get-api-read-keys",
      "endpoint": "/Api/Read/Keys",
      "description": "return all keys that your key can access.  Pass KeyId for details on one key"
    },
    {
      "doc": "https://apidoc.wrtm.io/operation/operation-get-api-read-limits",
      "endpoint": "/Api/Read/Limits",
      "description": "Read details about use limits for your key (if any)"
    },
    {
      "doc": "https://apidoc.wrtm.io/operation/operation-get-api-read-log",
      "endpoint": "/Api/Read/Log",
      "description": "Return detailed log information for the LogRequestId parameter sent"
    },
    {
      "doc": "https://apidoc.wrtm.io/operation/operation-get-api-read-servers",
      "endpoint": "/Api/Read/Servers",
      "description": "List servers to call"
    }
  ]
}