-
Language:
English
-
Language:
English
A.19. Filters
Repository filters are ways of filtering available source content from repositories.
A.19.1. List
Returns a list of filters in Pulp Server.
- method: GET
- path: /pulp/apifilters/
- permission: READ
- success response: 200 - OK
- failure response: None
- return:<List> Filter objects
- sample response:
[ { "description": "test-filter", "_ns": "filters", "package_list": [ "foo" ], "_id": "test-filter", "type": "blacklist", "id": "test-filter" }, { "description": "test-filter1", "_ns": "filters", "package_list": [ "foo1" ], "_id": "test-filter1", "type": "blacklist", "id": "test-filter1" } ]
A.19.2. Create
Creates a blacklist/whitelist filter.
- method: POST
- path: /pulp/apifilters/
- permission: CREATE
- success response: 201 - Created
- failure response:
- 409 - Conflict when filter with the same id already exists
- return: <dict> Newly created filter object
- parameters:dictionary describing the created CDS instance
- id <str> Filter ID required
- type <str> blacklist OR whitelist required
- description <str> Filter description optional - defaulted to filter id
- package_list <str> List of names or full NEVRA or python re syntax compatible regexes for packages (optional)
- sample response:
{ "description": "test-filter", "_ns": "filters", "package_list": [ "foo" ], "_id": "test-filter", "type": "blacklist", "id": "test-filter" }
A.19.3. Info
Returns information about a filter.
- method: GET
- path: /pulp/api/filters/<filter-id>
- permission: READ
- success response: 200 - OK
- failure response:
- 404 - Not Found if a filter with given id does not exist
- return: <dict> filter object
- sample response:
{ "description": "test-filter", "_ns": "filters", "package_list": [ "foo" ], "_id": "test-filter", "type": "blacklist", "id": "test-filter" }
A.19.4. Delete
Deletes a filter and it's associations with repositories, if any.
- method: DELETE
- path: /pulp/api/filters/<filter-id>
- permission: DELETE
- success response: 200 - OK
- failure response:
- 404 - Not Found if a filter with given id does not exist
- return:true if filter is successfully deleted