Obtener configuraciones

API operation: Open the endpoint in Scalar

Usa GET /configs para listar las configuraciones visibles para el solicitante. La operación es Config.findAll.

Respuesta de lista sin modo

Sin mode, la operación devuelve result como un arreglo. dictionary no se aplica de forma predeterminada.

{
  "error": false,
  "result": [
    {
      "id": 1,
      "key": "example_setting",
      "value": "example",
      "public": true,
      "hidden": false
    }
  ]
}

Modo de diccionario

Establece mode=dictionary para devolver un objeto indexado por el valor de key de cada configuración en lugar de un arreglo:

GET /configs?mode=dictionary

{
  "error": false,
  "result": {
    "example_setting": {
      "id": 1,
      "key": "example_setting",
      "value": "example",
      "public": true,
      "hidden": false
    }
  }
}

El modo de diccionario excluye las configuraciones exclusivas de v2 y omite description de los registros del modelo. mode=dashboard no es un alias del modo de diccionario.

Visibilidad y acceso

Los solicitantes que no sean administradores ni servidores pueden ver únicamente configuraciones con public=true y hidden=false, con excepciones para plugins y administradores de negocio. Las solicitudes pueden usar una clave de API o un token bearer; no des por hecho que el acceso anónimo esté habilitado.

Las configuraciones protegidas pueden devolver PROTECT en lugar de su valor almacenado. Nunca uses ejemplos de documentación para exponer o inferir valores protegidos.

Ejemplo de SDK heredado

const list = await ordering.configs().get()
const dictionary = await ordering.configs().asDictionary().get()

Los nombres y argumentos de los helpers del SDK pueden diferir según la versión.

Referencia de OpenAPI

Operación: GET /configs

Parámetros de consulta

Nombre	Tipo	Obligatorio	Descripción
params	string	No	Lista de campos separados por comas. La lista se cruza con $fillable del modelo; si está vacía o no es válida, se devuelven todos los campos.
orderBy	string	No	Campo de ordenamiento, con - como prefijo para indicar orden descendente. Se pueden encadenar varios campos separados por comas.
where	string	No	Filtro en JSON sobre los campos que el modelo declara como filtrables. Los campos válidos de cada recurso se exponen en la extensión de schema x-ordering-whereable.
mode	string	No	—

Respuestas

Código	Descripción
200	Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON.
400	Respuesta de error (error=true). Los errores de validación y de negocio comparten este código.
401	Respuesta de error: sesión ausente, inválida, o nivel de usuario fuera de los permitidos. Respuesta de error: el proyecto no existe o no tiene una suscripción activa.
404	Respuesta vacía: la versión de API solicitada no está admitida.
429	Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key.
500	Respuesta de error: falló la búsqueda o inicialización del proyecto.
503	Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1).

Abrir esta operación en la Referencia de la API