HEhexclave

/api/v1

Changed on

Returns a human-readable message with some useful information about the API.

get/

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/
  • Auth
    none declared

Headers

X-Hexclave-Project-Idstring

The unique identifier of the project

Example:e0b52f4d-dece-408c-af49-d23061bb0f8d
X-Hexclave-Branch-Idstring

The unique identifier of the project

Example:e0b52f4d-dece-408c-af49-d23061bb0f8d
X-Hexclave-Access-Type'client' | 'server' | 'admin'
X-Hexclave-Access-Tokenstring
X-Hexclave-Refresh-Tokenstring
X-Hexclave-Publishable-Client-Keystring
X-Hexclave-Secret-Server-Keystring
X-Hexclave-Super-Secret-Admin-Keystring
X-Stack-Project-Idstring

The unique identifier of the project

Example:e0b52f4d-dece-408c-af49-d23061bb0f8d
X-Stack-Branch-Idstring

The unique identifier of the project

Example:e0b52f4d-dece-408c-af49-d23061bb0f8d
X-Stack-Access-Type'client' | 'server' | 'admin'
X-Stack-Access-Tokenstring
X-Stack-Refresh-Tokenstring
X-Stack-Publishable-Client-Keystring
X-Stack-Secret-Server-Keystring
X-Stack-Super-Secret-Admin-Keystring

Response

Successful response

Changes

  • 5c30fe8f8706Revision changes
    • info

      added the new optional header request parameter X-Hexclave-Access-Token

    • info

      added the new optional header request parameter X-Hexclave-Access-Type

    • info

      added the new optional header request parameter X-Hexclave-Branch-Id

    • info

      added the new optional header request parameter X-Hexclave-Project-Id

    • info

      added the new optional header request parameter X-Hexclave-Publishable-Client-Key

    • info

      added the new optional header request parameter X-Hexclave-Refresh-Token

    • info

      added the new optional header request parameter X-Hexclave-Secret-Server-Key

    • info

      added the new optional header request parameter X-Hexclave-Super-Secret-Admin-Key

  • f135fd8ca8b4Revision changes
    • breaking

      the X-Stack-Access-Type request header's property undefined was restricted to a list of enum values

    • breaking

      the header request parameter X-Stack-Access-Type was restricted to a list of enum values

    • info

      added the new enum value admin to the header request parameter X-Stack-Access-Type

    • info

      added the new enum value client to the header request parameter X-Stack-Access-Type

    • info

      added the new enum value server to the header request parameter X-Stack-Access-Type