On this page

    Refresh a Catalog

    This API refreshes a catalog entity.

    This API refreshes dependent reflections of the specified physical dataset. This endpoint only functions with physical dataset IDs and has no response object.


    Method and URL
    POST /api/v3/catalog/{id}/refresh

    Response Codes

    403 - User does not have permission to access the catalog entity.
    404 - A catalog entity with the specified ID could not be found.

    Example: Refresh Catalog Entities by ID

    In this example, the virtual dataset, my_elastic_dataset is refreshed. From the POST /catalog example, the my_elastic_dataset PDS ID is e2676566-1946-4f11-8e21-9fbb366fa77a.


    Postman was used to generate samples.

    HTTP Request

    HTTP request example
    POST localhost:9047/api/v3/catalog/e2676566-1946-4f11-8e21-9fbb366fa77a/refresh


    curl example
    curl -X POST \
      http://localhost:9047/api/v3/catalog/e2676566-1946-4f11-8e21-9fbb366fa77a/refresh \
      -H 'Authorization: _dremioo8opojj6vn4ughkvcpalpr46d6' \
      -H 'Content-Type: application/json'


    Python example
    import requests
    url = "http://localhost:9047/api/v3/catalog/e2676566-1946-4f11-8e21-9fbb366fa77a/refresh"
    payload = ""
    headers = {
        'Authorization': "_dremioo8opojj6vn4ughkvcpalpr46d6",
        'Content-Type': "application/json"
    response = requests.request("POST", url, data=payload, headers=headers)


    Response code
    204 No Content