On this page

    Endpoints

    Deprecated:

    Use the Catalog API instead. The Source API will be removed in a future release.

    See Models for details on object representations.

    List all sources

    GET /api/v3/source
    

    Output

    {
      "data": [
         source,
         ...
      ]
    }
    

    Retrieve a specific source

    GET /api/v3/source/{id}
    

    Output

    source
    

    Response Codes

    401 - user does not have permission to view the source.

    404 - a source with the specified id could not be found.

    Create a new source

    POST /api/v3/source
    

    Input

    source
    

    The source object supplied must not contain any Dremio generated fields such id or tag.

    Dremio supports multiplesource types where each type has its own unique configuration configuration settings.

    Output

    source
    

    Response Codes

    401 - user does not have permission to create a source.

    409 - a source with the specified name already exists.

    Update an existing source

    PUT /api/v3/source/{id}
    

    Input

    source
    

    Output

    source
    

    Response Codes

    401 - user does not have permission to modify the source.

    404 - a source with the specified id could not be found.

    Delete an existing source

    DELETE /api/v3/source/{id}
    

    Response Codes

    401 - user does not have permission to delete the source.

    404 - a source with the specified id could not be found.