Get AFA Advanced Configuration Parameter Value

Get the value of a specific AFA Advanced Configuration Parameter. This endpoint retrieves a single parameter's value based on the provided key (the parameter name). To get a list of configuration parameters found in the AFA config file (/home/afa/.fa/config), use GET /config method from the Configuration Parameters.

Resource name: /api/v1/config/{key}

Request Method: GET

Request parameters:

Parameter Type Description
key Mandatory string The AFA Advanced Configuration parameter name whose value will be returned. This is a path parameter.

cURL Example: 

curl -X GET "https://localhost/api/v1/config/param1" -H "Authorization: Bearer your-token"

Status codes:

Code Description
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
423 Locked
429 Too Many Requests
500 Internal Server Error
503 Service Unavailable

Response parameters:

Parameter Type Description
key string The key of the parameter.
value string The value of the parameter.

Response example success 200:

Copy 
{
  "key": "Max_Parallel_Analyses",
  "value": "7"
}

Response example failure 400:

Copy 
{
  "error": "string",
  "description": "string",
  "fieldErrors": [
    {
      "field": "string",
      "error": "string"
    }
  ]
}