Skip to content

docs(custom-fields): document the per-object filters on the custom field values API #16378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Maffooch merged 2 commits into from
Oct 16, 2026
Merged

docs(custom-fields): document the per-object filters on the custom field values API #16378

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e983acf
docs(custom-fields): document the per-object filters on the custom fi…
Maffooch Oct 16, 2026
9462559
docs(custom-fields): note pagination and the entity_type aliases on t…
Maffooch Oct 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions docs/content/asset_modelling/PRO__custom_fields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,29 @@ those owners, and the `finding_meta` / `product_meta` / `asset_meta` fields on t
Read and write custom field values through the **`/api/v2/custom_fields/values/`** endpoint instead, and
manage the field definitions through **`/api/v2/custom_fields/definitions/`**. Both use standard API-token
authentication (the same `Authorization: Token <key>` header as the rest of the API) and are listed in the
v2 Swagger UI under the **Custom Fields** tag. Values are owner-scoped and can be filtered to one object
(for example `?finding={id}`): you can read a value wherever you can view its object and write one wherever
you can edit it, while managing definitions requires the global Custom Field management permission. Endpoint
and Location metadata is unaffected and still lives on the metadata endpoints.
v2 Swagger UI under the **Custom Fields** tag. You can read a value wherever you can view its object and
write one wherever you can edit it, while managing definitions requires the global Custom Field management
permission. Endpoint and Location metadata is unaffected and still lives on the metadata endpoints.

To list the custom field values on one object, filter the values endpoint by that object's id:

| Object | Query parameter |
|--------|-----------------|
| Asset | `?asset={id}` (or `?product={id}`) |
| Organization | `?organization={id}` (or `?product_type={id}`) |
| Finding | `?finding={id}` |
| Engagement | `?engagement={id}` |
| Test | `?test={id}` |
| Risk Acceptance | `?risk_acceptance={id}` |

For example, `GET /api/v2/custom_fields/values/?asset=12` returns the custom field values on asset 12. The
response is paginated like the rest of the API, so follow `next` (or pass `limit` and `offset`) when an object
has more values than one page holds. Filters combine, so a request only returns values that match all of them,
and values on an object you cannot view are never returned. An id that is not a whole number returns a **400**.

To list the fields that apply to one object type, filter the definitions endpoint by `entity_type` (`finding`,
`asset`, `organization`, `engagement`, `test` or `risk_acceptance`; `product` and `product_type` also work),
for example `/api/v2/custom_fields/definitions/?entity_type=asset`. An unknown type returns a **400**.

Metadata on **Endpoints** and **Locations** is a separate feature and is unchanged: it stays as
free-form key/value metadata and is not part of the typed custom fields subsystem.
Loading