GetCustomFieldsConfig
This method can be used for the following: Get custom fields configuration for a type;
The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.
GET /api/ss/config/custom-fields/:type HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close
Get configuration options for a particular type. Must be one of the following: project, project-request, vulnerability, vulnerability-library, asset, or portfolio
Example:
GET /api/ss/config/custom-fields/project HTTP/1.1
The following example is a cURL request to get custom fields configuration for projects.
Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
curl -X GET 'https://demo.attackforge.com/api/ss/config/custom-fields/project' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Response contains a list of custom field configuration objects.
{
"type": "...",
"config" : [
{
"custom_field_type" : "...",
"custom_field_key" : "...",
"custom_field_default_value" : "...",
"custom_field_label" : "...",
"custom_field_required" : "...",
"custom_field_display_in_tables" : "...",
"custom_field_hide_condition" : "...",
"custom_field_sort_order" : 999,
"custom_field_placeholder" : "...",
"custom_field_information" : "...",
"custom_field_roles" : [
"...",
],
"custom_field_groups" : [
"...",
],
"custom_field_users" : [
"...",
],
"custom_field_linked_project_key" : "...",
"custom_field_select_field_options" : [
{
"option": "...",
"value": "..."
}
],
"custom_field_table_field_columns" : [
{
"column_type" : "...",
"column_key" : "...",
"column_value" : "...",
"column_label" : "...",
"column_info" : "...",
"column_required" : "...",
"column_options" : [
{
"option": "...",
"value": "..."
}
]
}
]
}
]
}
Last modified 1d ago