Skip to main content

Get Environment

GET 
/api/v1/environments/:environmentID

Get information about an environment.

Request​

Path Parameters

    environmentID stringrequired

    The environment ID.

Responses​

Information about an environment.

Schema

    connectionAccount string

    The Snowflake account name.

    defaultStorageMapping stringnullable
    description string

    The Workspace description.

    name stringrequired

    The Workspace name.

    oauthEnabled booleanrequired

    If Snowflake OAuth is enabled.

    tagColors

    object

    The tag color from the Environment settings.

    backgroundColor string
    textColor string
    project stringrequired

    The Project ID.

    createdAt date-timerequired

    createdBy

    object

    Summary information about a user.

    id stringrequired

    The user ID.

    firstName string

    User first name.

    lastName string

    User last name.

    updatedAt date-timerequired
    currentGitBranch string

    The branch most recently run on this environment.

    currentGitCommit string
    currentGitURL string
    currentlyRunningJobs integer[]

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

    id stringrequired
    deployedCommit string

    The most recently deployed commit ID.

    status WorkspaceEnvHealth (string)required

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

    runTimeParameters

    object

    The default Environment parameters. Parameters changed during deploy will not show here.

    property name* any

    The default Environment parameters. Parameters changed during deploy will not show here.

    currentMappings

    object

    The Storage Mapping name.

    property name*

    object

    database string

    The Snowflake database name.

    schema string

    The database schema.

Loading...