On this page

    Node Collections

    Use the Node Collections API to deny access to Dremio cluster nodes and retrieve the currently denied nodes for the Dremio instance.

    The Node Collections API does not have a corresponding Node Collection object. The endpoints return a list of the currently denied nodes in the response.

    note:

    You must be a member of the Dremio ADMIN role to send requests to the Node Collections API.

    Denying Nodes

    Deny access to the specified Dremio cluster nodes.

    Method and URL
    POST /api/v3/nodeCollections/blacklist
    

    The request body is a comma-separated list of the names for the nodes that you want to deny, including any currently denied nodes that should remain denied. Format the request body as an array of string, with each node name in double quotes. Use a comma to separate each node name in the list.

    Any nodes omitted from the request body, including currently denied nodes, will be allowed.

    Example Request
    curl -X POST 'https://{hostname}/api/v3/nodeCollections/blacklist' \
    --header 'Authorization: _dremio{tokenstring}' \
    --header 'Content-Type: application/json' \
    --data-raw '["localhost-1.c.dremio-1093.external",  "localhost-2.c.dremio-1093.external"]'
    
    Example Response
    [
      "localhost-1.c.dremio-1093.external",
      "localhost-2.c.dremio-1093.external"
    ]
    

    Response Status Codes

    200

    OK

    401

    Unauthorized

    404

    Not Found


    Retrieving Denied Nodes

    Invalidate the LDAP authorization for a specific user or group by ID.

    Method and URL
    GET /nodeCollections/blacklist
    
    Example Request
    curl -X GET 'https://{hostname}/api/v3/nodeCollections/blacklist' \
    --header 'Authorization: _dremio{tokenstring}' \
    --header 'Content-Type: application/json'
    
    Example Response
    [
      "localhost-1.c.dremio-1093.external",
      "localhost-2.c.dremio-1093.external"
    ]
    

    Response Status Codes

    200

    OK

    401

    Unauthorized

    404

    Not Found


    Allowing All Nodes

    Allow access to all Dremio cluster nodes.

    Method and URL
    POST /api/v3/nodeCollections/blacklist
    

    To allow all nodes, send an empty array in the request body.

    Example Request
    curl -X POST 'https://{hostname}/api/v3/nodeCollections/blacklist' \
    --header 'Authorization: _dremio{tokenstring}' \
    --header 'Content-Type: application/json' \
    --data-raw '[]'
    
    Example Response
    []
    

    Response Status Codes

    200

    OK

    401

    Unauthorized

    404

    Not Found