Coalesce API (1.0.0)

Download OpenAPI specification:Download

REST API for performing operations with the Coalesce backend.

Environments

List Environments

Get a collection of environment information.

Authorizations:

BearerAuth

query Parameters

detail

boolean

Default: false

Include the full detail of the environments.

Responses

US primary

https://app.coalescesoftware.io/api/v1/environments

US primary Azure

https://app.centralus.azure.coalescesoftware.io/api/v1/environments

Europe primary

https://app.eu.coalescesoftware.io/api/v1/environments

Australia primary

https://app.australia-southeast1.gcp.coalescesoftware.io/api/v1/environments

US AWS US East

https://app.us-east-1.aws.coalescesoftware.io/api/v1/environments

US AWS US East with PrivateLink

https://app.us-east-1.aws.privatelink.coalescesoftware.io/api/v1/environments

US AWS US West

https://app.us-west-2.aws.coalescesoftware.io/api/v1/environments

US AWS US West with PrivateLink

https://app.us-west-2.aws.privatelink.coalescesoftware.io/api/v1/environments

Response samples

Content type

application/json

{"data": [{"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"firstName": "string",
"lastName": "string"
},
"currentGitBranch": "string",
"currentGitCommit": "string",
"currentGitURL": "string",
"currentMappings": {"property1": {"database": "string",
"schema": "string"
},
"property2": {"database": "string",
"schema": "string"
}
},
"currentlyRunningJobs": [0
],
"id": "string",
"deployedCommit": "string",
"status": "Deleting",
"connectionAccount": "string",
"defaultStorageMapping": "string",
"description": "string",
"name": "string",
"oauthEnabled": true,
"runTimeParameters": { },
"tagColors": {"backgroundColor": "string",
"textColor": "string"
},
"project": "string"
}
]
}

Get Environment

Get information about an environment.

Authorizations:

BearerAuth

path Parameters

environmentID

required

string

The environment ID.

Responses

US primary

https://app.coalescesoftware.io/api/v1/environments/{environmentID}

US primary Azure

https://app.centralus.azure.coalescesoftware.io/api/v1/environments/{environmentID}

Europe primary

https://app.eu.coalescesoftware.io/api/v1/environments/{environmentID}

Australia primary

https://app.australia-southeast1.gcp.coalescesoftware.io/api/v1/environments/{environmentID}

US AWS US East

https://app.us-east-1.aws.coalescesoftware.io/api/v1/environments/{environmentID}

US AWS US East with PrivateLink

https://app.us-east-1.aws.privatelink.coalescesoftware.io/api/v1/environments/{environmentID}

US AWS US West

https://app.us-west-2.aws.coalescesoftware.io/api/v1/environments/{environmentID}

US AWS US West with PrivateLink

https://app.us-west-2.aws.privatelink.coalescesoftware.io/api/v1/environments/{environmentID}

Response samples

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"createdBy": {"id": "string",
"firstName": "string",
"lastName": "string"
},
"currentGitBranch": "string",
"currentGitCommit": "string",
"currentGitURL": "string",
"currentMappings": {"property1": {"database": "string",
"schema": "string"
},
"property2": {"database": "string",
"schema": "string"
}
},
"currentlyRunningJobs": [0
],
"id": "string",
"deployedCommit": "string",
"status": "Deleting",
"connectionAccount": "string",
"defaultStorageMapping": "string",
"description": "string",
"name": "string",
"oauthEnabled": true,
"runTimeParameters": { },
"tagColors": {"backgroundColor": "string",
"textColor": "string"
},
"project": "string"
}

Nodes

List Nodes

Get a collection of nodes for an environment

Authorizations:

BearerAuth

path Parameters

environmentID

required

string

The environment ID.

query Parameters

detail

boolean

Default: false

Include the full detail of the nodes.

Responses

US primary

https://app.coalescesoftware.io/api/v1/environments/{environmentID}/nodes

US primary Azure

https://app.centralus.azure.coalescesoftware.io/api/v1/environments/{environmentID}/nodes

Europe primary

https://app.eu.coalescesoftware.io/api/v1/environments/{environmentID}/nodes

Australia primary

https://app.australia-southeast1.gcp.coalescesoftware.io/api/v1/environments/{environmentID}/nodes

US AWS US East

https://app.us-east-1.aws.coalescesoftware.io/api/v1/environments/{environmentID}/nodes

US AWS US East with PrivateLink

https://app.us-east-1.aws.privatelink.coalescesoftware.io/api/v1/environments/{environmentID}/nodes

US AWS US West

https://app.us-west-2.aws.coalescesoftware.io/api/v1/environments/{environmentID}/nodes

US AWS US West with PrivateLink

https://app.us-west-2.aws.privatelink.coalescesoftware.io/api/v1/environments/{environmentID}/nodes

Response samples

Content type

application/json

{"data": [{"database": "string",
"id": "string",
"locationName": "string",
"name": "string",
"nodeType": "Dimension",
"schema": "string"
}
]
}

Get Node

Get information about a node in an environment.

Authorizations:

BearerAuth

path Parameters

environmentID required	string The environment ID.
nodeID required	string The node ID.

Responses

US primary

https://app.coalescesoftware.io/api/v1/environments/{environmentID}/nodes/{nodeID}

US primary Azure

https://app.centralus.azure.coalescesoftware.io/api/v1/environments/{environmentID}/nodes/{nodeID}

Europe primary

https://app.eu.coalescesoftware.io/api/v1/environments/{environmentID}/nodes/{nodeID}

Australia primary

https://app.australia-southeast1.gcp.coalescesoftware.io/api/v1/environments/{environmentID}/nodes/{nodeID}

US AWS US East

https://app.us-east-1.aws.coalescesoftware.io/api/v1/environments/{environmentID}/nodes/{nodeID}

US AWS US East with PrivateLink

https://app.us-east-1.aws.privatelink.coalescesoftware.io/api/v1/environments/{environmentID}/nodes/{nodeID}

US AWS US West

https://app.us-west-2.aws.coalescesoftware.io/api/v1/environments/{environmentID}/nodes/{nodeID}

US AWS US West with PrivateLink

https://app.us-west-2.aws.privatelink.coalescesoftware.io/api/v1/environments/{environmentID}/nodes/{nodeID}

Response samples

Content type

application/json

Example

SourceNode

{"metadata": {"columns": [{"appliedColumnTests": {"property1": true,
"property2": true
},
"columnID": "string",
"columnReferences": [{"columnName": "string",
"tableName": "string"
}
],
"config": { },
"dataType": "string",
"defaultValue": "string",
"description": "string",
"hashDetails": {"hashAlgorithm": "MD5",
"hashType": "ChangeHash",
"hubHashes": [{"columnID": "string",
"nodeID": "string"
}
]
},
"hashedColumns": [{"columnID": "string",
"nodeID": "string"
}
],
"isBusinessKey": true,
"isChangeTracking": true,
"isSurrogateKey": true,
"keyColumnType": "None",
"name": "string",
"nullable": true,
"primaryKey": true,
"sources": [{"columnReferences": [{"columnID": "string",
"nodeID": "string"
}
],
"transform": "string"
}
],
"systemColumnType": "None",
"transform": "string",
"uniqueKey": true
}
],
"join": {"joinCondition": "string"
},
"sourceMapping": [{"aliases": {"property1": "string",
"property2": "string"
},
"customSQL": {"customSQL": "string"
},
"dependencies": [{"locationName": "string",
"nodeName": "string"
}
],
"join": {"joinCondition": "string"
},
"name": "string",
"noLinkRefs": [{"locationName": "string",
"nodeName": "string"
}
]
}
]
},
"table": "string",
"database": "string",
"description": "string",
"id": "string",
"locationName": "string",
"name": "string",
"nodeType": "Dimension",
"schema": "string"
}

Runs

List Runs

Get a collection of information about runs.

Authorizations:

BearerAuth

query Parameters

limit	integer [ 0 .. 1000 ] Default: 25 The maximum number of runs to return.
	integer or string The starting run ID, runStartTime, or runEndTime (exclusive) for paging the query results.
orderBy	string (RunsOrderBy) Default: "id" Enum: "id" "runStartTime" "runEndTime" The field used to order results.
orderByDirection	string Default: "desc" Enum: "asc" "desc" The sort order for query results.
runType	string (RunType) Enum: "deploy" "refresh" A run type to filter the query results.
runStatus	string (RunStatus) Enum: "canceled" "completed" "failed" "running" "waitingToRun" A status value to filter the query results.
environmentID	string An environment ID to filter the query results.
detail	boolean Default: false Include the full detail of the run.

Responses

US primary

https://app.coalescesoftware.io/api/v1/runs

US primary Azure

https://app.centralus.azure.coalescesoftware.io/api/v1/runs

Europe primary

https://app.eu.coalescesoftware.io/api/v1/runs

Australia primary

https://app.australia-southeast1.gcp.coalescesoftware.io/api/v1/runs

US AWS US East

https://app.us-east-1.aws.coalescesoftware.io/api/v1/runs

US AWS US East with PrivateLink

https://app.us-east-1.aws.privatelink.coalescesoftware.io/api/v1/runs

US AWS US West

https://app.us-west-2.aws.coalescesoftware.io/api/v1/runs

US AWS US West with PrivateLink

https://app.us-west-2.aws.privatelink.coalescesoftware.io/api/v1/runs

Response samples

Content type

application/json

{"limit": 0,
"orderByDirection": "asc",
"orderBy": "id",
"data": [{"id": 0,
"reRunID": "string",
"runStartTime": "2019-08-24T14:15:22Z",
"runEndTime": "2019-08-24T14:15:22Z",
"runType": "deploy",
"runStatus": "canceled",
"environmentID": "string",
"runFailureReason": "string"
}
]
}

Get Run

Gets a single run.

Authorizations:

BearerAuth

path Parameters

runID

required

integer

The run ID.

Responses

US primary

https://app.coalescesoftware.io/api/v1/runs/{runID}

US primary Azure

https://app.centralus.azure.coalescesoftware.io/api/v1/runs/{runID}

Europe primary

https://app.eu.coalescesoftware.io/api/v1/runs/{runID}

Australia primary

https://app.australia-southeast1.gcp.coalescesoftware.io/api/v1/runs/{runID}

US AWS US East

https://app.us-east-1.aws.coalescesoftware.io/api/v1/runs/{runID}

US AWS US East with PrivateLink

https://app.us-east-1.aws.privatelink.coalescesoftware.io/api/v1/runs/{runID}

US AWS US West

https://app.us-west-2.aws.coalescesoftware.io/api/v1/runs/{runID}

US AWS US West with PrivateLink

https://app.us-west-2.aws.privatelink.coalescesoftware.io/api/v1/runs/{runID}

Response samples

Content type

application/json

{"id": 0,
"reRunID": "string",
"runDetails": {"canceled": true,
"deployCommit": "string",
"deployCommitMessage": "string",
"environmentID": "string",
"parallelism": 0,
"nodesInRun": 0
},
"runEndTime": "2019-08-24T14:15:22Z",
"runHistory": [0
],
"runStartTime": "2019-08-24T14:15:22Z",
"runStatus": "canceled",
"runTimeParameters": { },
"runType": "deploy",
"userCredentials": {"snowflakeAccount": "string",
"snowflakeAuthType": "Basic",
"snowflakeRole": "string",
"snowflakeUsername": "string",
"snowflakeWarehouse": "string"
},
"userID": "string",
"version": 0
}

List Run Results

Get a collection of the results of a deploy or refresh run

Authorizations:

BearerAuth

path Parameters

runID

required

integer

The run ID.

Responses

US primary

https://app.coalescesoftware.io/api/v1/runs/{runID}/results

US primary Azure

https://app.centralus.azure.coalescesoftware.io/api/v1/runs/{runID}/results

Europe primary

https://app.eu.coalescesoftware.io/api/v1/runs/{runID}/results

Australia primary

https://app.australia-southeast1.gcp.coalescesoftware.io/api/v1/runs/{runID}/results

US AWS US East

https://app.us-east-1.aws.coalescesoftware.io/api/v1/runs/{runID}/results

US AWS US East with PrivateLink

https://app.us-east-1.aws.privatelink.coalescesoftware.io/api/v1/runs/{runID}/results

US AWS US West

https://app.us-west-2.aws.coalescesoftware.io/api/v1/runs/{runID}/results

US AWS US West with PrivateLink

https://app.us-west-2.aws.privatelink.coalescesoftware.io/api/v1/runs/{runID}/results

Response samples

Content type

application/json

{"data": [{"isRunning": true,
"name": "string",
"nodeID": "string",
"queryResults": [{"endTime": "2019-08-24T14:15:22Z",
"error": {"errorString": "string",
"errorDetail": "string"
},
"isRunning": true,
"name": "string",
"queryID": "string",
"rowsDeleted": 0,
"rowsInserted": 0,
"rowsUpdated": 0,
"sql": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"success": true,
"warehouse": "string"
}
],
"renderQueryResult": {"endTime": "2019-08-24T14:15:22Z",
"error": {"errorString": "string",
"errorDetail": "string"
},
"isRunning": true,
"name": "string",
"queryID": "string",
"rowsDeleted": 0,
"rowsInserted": 0,
"rowsUpdated": 0,
"sql": "string",
"startTime": "2019-08-24T14:15:22Z",
"status": "string",
"success": true,
"warehouse": "string"
}
}
]
}

Get database connectivity information.

Gets the information required to connect to the Coalesce database.

Responses

US primary

https://app.coalescesoftware.io/api/v1/database

US primary Azure

https://app.centralus.azure.coalescesoftware.io/api/v1/database

Europe primary

https://app.eu.coalescesoftware.io/api/v1/database

Australia primary

https://app.australia-southeast1.gcp.coalescesoftware.io/api/v1/database

US AWS US East

https://app.us-east-1.aws.coalescesoftware.io/api/v1/database

US AWS US East with PrivateLink

https://app.us-east-1.aws.privatelink.coalescesoftware.io/api/v1/database

US AWS US West

https://app.us-west-2.aws.coalescesoftware.io/api/v1/database

US AWS US West with PrivateLink

https://app.us-west-2.aws.privatelink.coalescesoftware.io/api/v1/database

Response samples

200

Content type

application/json

{"apiKey": "string",
"authDomain": "string",
"projectId": "string",
"storageBucket": "string",
"messagingSenderId": "string",
"appId": "string",
"measurementId": "string"
}