Get Environment

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

Get information about an environment.

Request

Path Parameters

environmentID stringrequired

The environment ID.

Responses

200

Information about an environment.

application/json

Schema

Schema

connectionAccountstring

The Snowflake account name.

defaultStorageMappingstringnullable

descriptionstring

The Workspace description.

namestringrequired

The Workspace name.

oauthEnabledbooleanrequired

If Snowflake OAuth is enabled.

tagColors object

The tag color from the Environment settings.

backgroundColorstring

textColorstring

projectstringrequired

The Project ID.

createdAtdate-timerequired

createdBy object

Summary information about a user.

idstringrequired

The user ID.

firstNamestring

User first name.

lastNamestring

User last name.

updatedAtdate-timerequired

currentGitBranchstring

The branch most recently run on this environment.

currentGitCommitstring

currentGitURLstring

currentlyRunningJobsinteger[]

An array of any running Jobs. If there are not Jobs running, this will return empty.

idstringrequired

deployedCommitstring

The most recently deployed commit ID.

statusWorkspaceEnvHealth (string)required

Possible values: [Deleting, Deploying, Failed Deploy, Failed Refresh, Initializing, Refreshing, Waiting]

runTimeParametersobject

Parameters changed during deploy will not show here.

currentMappings object

The Storage Mapping name.

property name* object

databasestring

The Snowflake database name.

schemastring

The database schema.

Example (auto)

{
  "connectionAccount": "string",
  "defaultStorageMapping": "string",
  "description": "string",
  "name": "string",
  "oauthEnabled": true,
  "tagColors": {
    "backgroundColor": "string",
    "textColor": "string"
  },
  "project": "string",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "createdBy": {
    "id": "string",
    "firstName": "string",
    "lastName": "string"
  },
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "currentGitBranch": "string",
  "currentGitCommit": "string",
  "currentGitURL": "string",
  "currentlyRunningJobs": [
    0
  ],
  "id": "string",
  "deployedCommit": "string",
  "status": "Deleting",
  "runTimeParameters": {},
  "currentMappings": {}
}

Environment Response

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

400

The request was invalid.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Invalid Request Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

401

User lacks authorization to perform this action.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Unauthorized

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

403

The client is not permitted to perform the requested operation.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Forbidden Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

404

The requested resource could not be found.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Not Found Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

500

The server encountered an unexpected condition that prevented it from fulfilling the request.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Internal Server Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

502

The server received an error from an upstream system.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Bad Gateway Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

503

The service is currently unavailable.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Service Unavailable Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

504

The server did not receive a response in time from an upstream system.

application/json

Schema

Schema

error objectrequired

errorStringstringrequired

The error message.

errorDetailstring

Additional detail about the error.

Example (auto)

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Gateway Timeout Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Authorization: http

name: BearerAuthtype: httpscheme: bearer

• curl
• python
• powershell
• php
• nodejs
• r
• javascript

• CURL

curl -L 'https://app.coalescesoftware.io/api/v1/environments/:environmentID' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://app.coalescesoftware.io

Auth

Bearer Token

Parameters

environmentID — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!