get /instance-configuration

Get instance configuration

Returns configuration parameters of the current API instance, e.g. limits.

Note: This endpoint can be disabled via the instanceConfiguration.enabled configuration option, in which case a 403 Forbidden response is returned instead. It should therefore be considered optional.

The version field can additionally be hidden by the administrator (instanceConfiguration.showVersion), in which case it is returned as null.

Request

curl \
  -H 'Authorization: Bearer secret-token:PIPeJGUt7c00ENn8a5uDlc' \
  https://api.example.com/instance-configuration
import requests


url = "https://api.example.com/instance-configuration"


headers = {"Authorization": "Bearer secret-token:PIPeJGUt7c00ENn8a5uDlc"}


response = requests.get(url, headers=headers)


print(response.json())
const url = 'https://api.example.com/instance-configuration';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer secret-token:PIPeJGUt7c00ENn8a5uDlc'}
};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
<?php


$client = new \GuzzleHttp\Client();


$response = $client->request('GET', 'https://api.example.com/instance-configuration', [
  'headers' => [
    'Authorization' => 'Bearer secret-token:PIPeJGUt7c00ENn8a5uDlc',
  ],
]);


echo $response->getBody();

Response

200 · OK

Returns the instance’s configuration parameters and limits.

MDN HTTP.dev 

401 · Unauthorized

The provided token is either invalid or expired.

MDN HTTP.dev 

403 · Forbidden

The endpoint has been disabled by the instance’s administrator (instanceConfiguration.enabled set to false).

MDN HTTP.dev 
{
  "version": "0.1.31",
  "pageSize": {
    "min": 5,
    "default": 25,
    "max": 100
  },
  "register": {
    "enabled": true,
    "uniqueIdentifier": "email",
    "uniqueIdentifierRegex": false
  },
  "expression": {
    "enabled": true,
    "maxLength": 10240
  },
  "file": {
    "maxFileSizeInBytes": 10737418240,
    "uploadExpiresInSecondsAfterFirstRequest": 10800,
    "uploadMinChunkSizeInBytes": 5242880,
    "uploadMaxChunkSizeInBytes": 105906176
  }
}
Access-Control-Allow-Headers: Authorization, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method
Access-Control-Allow-Methods: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: ETag, Location
Allow: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Cache-Control: no-cache, private
X-Powered-By: Ember Nexus API
{
  "type": "object",
  "description": "Configuration parameters and limits of the current API instance.",
  "properties": {
    "version": {
      "type": "string",
      "nullable": true,
      "description": "API version. `null` if the administrator has disabled exposing it via `instanceConfiguration.showVersion`.",
      "example": "0.1.31"
    },
    "pageSize": {
      "type": "object",
      "properties": {
        "min": {
          "type": "integer",
          "example": 5
        },
        "default": {
          "type": "integer",
          "example": 25
        },
        "max": {
          "type": "integer",
          "example": 100
        }
      }
    },
    "register": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true
        },
        "uniqueIdentifier": {
          "type": "string",
          "example": "email"
        },
        "uniqueIdentifierRegex": {
          "type": "boolean",
          "nullable": true,
          "example": false
        }
      }
    },
    "expression": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "example": true
        },
        "maxLength": {
          "type": "integer",
          "example": 10240
        }
      }
    },
    "file": {
      "type": "object",
      "properties": {
        "maxFileSizeInBytes": {
          "type": "integer",
          "example": 10737418240
        },
        "uploadExpiresInSecondsAfterFirstRequest": {
          "type": "integer",
          "example": 10800
        },
        "uploadMinChunkSizeInBytes": {
          "type": "integer",
          "example": 5242880
        },
        "uploadMaxChunkSizeInBytes": {
          "type": "integer",
          "example": 105906176
        }
      }
    }
  }
}
{
  "type": "https://api.example.com/error/401/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authorization for the request failed due to possible problems with the token (incorrect or expired), password (incorrect or changed), the user's unique identifier, or the user's status (e.g., missing, blocked, or deleted)."
}
Access-Control-Allow-Headers: Authorization, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method
Access-Control-Allow-Methods: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: ETag, Location
Allow: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Cache-Control: no-cache, private
X-Powered-By: Ember Nexus API
{
  "$schema": "https://spec.openapis.org/oas/3.0/schema/2021-09-28#/definitions/Schema",
  "type": "object",
  "description": "RFC 7807 Problem Details object.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "detail": {
      "type": "string"
    }
  }
}
{
  "type": "https://api.example.com/error/403/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "Requested endpoint, element or action is forbidden."
}
Access-Control-Allow-Headers: Authorization, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method
Access-Control-Allow-Methods: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: ETag, Location
Allow: GET, HEAD, POST, OPTIONS, PUT, PATCH, DELETE, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK
Cache-Control: no-cache, private
X-Powered-By: Ember Nexus API
{
  "$schema": "https://spec.openapis.org/oas/3.0/schema/2021-09-28#/definitions/Schema",
  "type": "object",
  "description": "RFC 7807 Problem Details object.",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "detail": {
      "type": "string"
    }
  }
}

Request Header

Authorization

optional

Bearer token for user authentication. If omitted, the request is processed as an anonymous user; if provided, the associated user account is used.

MDN HTTP.dev Authentication guide 

Response Header

Access-Control-Allow-Headers

always

Specifies which HTTP headers can be used during a cross-origin request, returned in preflight responses.

MDN HTTP.dev 

Access-Control-Allow-Methods

always

Indicates which HTTP methods are permitted for cross-origin requests, typically returned in preflight responses.

MDN HTTP.dev 

Access-Control-Allow-Origin

always

Specifies which origin(s) may access the resource.

MDN HTTP.dev 

Access-Control-Expose-Headers

always

Lists the response headers that browsers are allowed to access from JavaScript beyond the default restricted set.

MDN HTTP.dev 

Allow

always

Lists the HTTP methods supported by the endpoint; returned alongside a 405 Method Not Allowed response.

MDN HTTP.dev 

Cache-Control

always

Directives controlling caching behavior for the response.

MDN HTTP.dev 

X-Powered-By

always

Identifies the underlying API implementation.

MDN HTTP.dev