Starfish ETL API - Documentation

The APIs defined below are available to all Starfish ETL cloud customers. See Authentication for help on authenticating to the API. You must provide a valid token before invoking any of the methods below.

All API methods defined here should be invoked against https://api.starfishetl.com/v1/(api). If you have any questions, email us at support@starfishetl.com.

Download the example C# Test App which illustrates authentication & executing a job.

ExecuteJobAsync

Starts jobs in asynchronous mode.

API	Description
POST v1/ExecuteJobAsync	Executes a Job in asynchronous mode. The response will be returned immediately. You can configure a webhook to be notififed upon completion, or you can check the results via the Results API.

ExecuteJob

Starts job in synchronous mode.

API	Description
POST v1/ExecuteJob	Executes a Job in synchronous mode. The response will be returned once the job execution completes.

Results

Get the results of a completed job.

API	Description
GET v1/Results/{id}	Gets the results of job that was executed by the Run ID.

CancelJob

Cancel a currently running job.

API	Description
GET v1/CancelJob/{id}	Cancels a currently running job by the provided Run ID.

Webhook

API	Description
POST v1/Webhook?instance={instance}&projectid={projectid}&jobid={jobid}	No documentation available.