Get Private Settings
    • Dark
      Light
    • PDF

    Get Private Settings

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/settings

    List all private settings. Learn how this can be used in configuring your server in this guide.

    Header parameters
    X-User-Id
    stringRequired

    The user ID.

    ExampleCkCPNctrgCDfmWLqC
    X-Auth-Token
    stringRequired

    The authentication token.

    Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
    Responses
    200

    OK

    Success Example
    {
      "settings": [
        {
          "_id": "API_Allow_Infinite_Count",
          "value": true
        },
        {
          "_id": "API_CORS_Origin",
          "value": "*"
        }
      ],
      "count": 50,
      "offset": 0,
      "total": 299,
      "success": true
    }
    Expand All
    object
    settings
    Array of object
    object
    _id
    string
    value
    OneOf
    boolean
    boolean
    string
    string
    count
    integer
    offset
    integer
    total
    integer
    success
    boolean
    401

    Unauthorized

    Authorization Error
    {
      "status": "error",
      "message": "You must be logged in to do this."
    }
    object
    status
    string
    message
    string

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.