From 6ff4d87deab4f4145958bbfb1435c2d414ef2f46 Mon Sep 17 00:00:00 2001 From: Mika Busch Date: Wed, 6 May 2020 17:15:35 +0200 Subject: [PATCH] Replaced status=1 with status=active Fixed the example using the old status=1 instead of the new status=active --- docs/api/overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/overview.md b/docs/api/overview.md index 81e4caa25..c051ce7a3 100644 --- a/docs/api/overview.md +++ b/docs/api/overview.md @@ -243,10 +243,10 @@ The maximum number of objects that can be returned is limited by the [`MAX_PAGE_ ## Filtering -A list of objects retrieved via the API can be filtered by passing one or more query parameters. The same parameters used by the web UI work for the API as well. For example, to return only prefixes with a status of "Active" (`1`): +A list of objects retrieved via the API can be filtered by passing one or more query parameters. The same parameters used by the web UI work for the API as well. For example, to return only prefixes with a status of "Active": ``` -GET /api/ipam/prefixes/?status=1 +GET /api/ipam/prefixes/?status=active ``` The choices available for fixed choice fields such as `status` can be retrieved by sending an `OPTIONS` API request for the desired endpoint: