checkEnvironment checks the environment definition.
Organization name
The environment definition
The environment diagnostics
checkEnvironmentYaml checks the environment definition from a YAML string.
Organization name
YAML representation of the environment
The environment diagnostics
cloneEnvironment clones an environment
Organization name
Destination project name
Destionation environment name
OptionalcloneOptions: CloneEnvironmentOptionsClone options
A promise that resolves when the environment is created
createEnvironment creates a new environment.
Organization name
Project name
Environment name
A promise that resolves when the environment is created
createEnvironmentRevisionTag creates a new environment revision tag.
Organization name
Project name
Environment name
The tag name
The revision number
A promise that resolves when the tag is created
createEnvironmentTag creates a new environment tag.
Organization name
Project name
Environment name
The tag name
The tag value
A promise that resolves when the tag is created
decryptEnvironment decrypts the environment definition.
Organization name
Project name
Environment name
The decrypted environment definition and the YAML representation
deleteEnvironment deletes an environment.
Organization name
Project name
Environment name
A promise that resolves when the environment is deleted
deleteEnvironmentRevisionTag deletes the environment revision tag.
Organization name
Project name
Environment name
The tag name
A promise that resolves when the tag is deleted
deleteEnvironmentTag deletes the environment tag.
Organization name
Project name
Environment name
The tag name
A promise that resolves when the tag is deleted
getEnvironment gets the definition of an environment.
Organization name
Project name
Environment name
The environment definition and the YAML representation
getEnvironmentAtVersion gets the definition of an environment at a specific version.
Organization name
Project name
Environment name
Version of the environment
The environment definition and the YAML representation
getEnvironmentRevisionTag gets the environment revision tag.
Organization name
Project name
Environment name
The tag name
The environment revision tag
getEnvironmentTag gets the environment tag.
Organization name
Project name
Environment name
The tag name
The environment tag
listEnvironmentRevisions lists the environment revisions, from oldest to newest.
Organization name
Project name
Environment name
Optionalbefore: numberThe revision number to start listing from
Optionalcount: numberThe number of revisions to list
A list of environment revisions
listEnvironmentRevisionTags lists the environment revision tags.
Organization name
Project name
Environment name
Optionalafter: stringThe tag to start listing from
Optionalcount: numberThe number of tags to list
A list of environment revision tags
listEnvironments lists the environments in an organization.
Organization name
OptionalcontinuationToken: stringcontinuation Token from previous query to fetch next page of results
A list of environments
listEnvironmentTags lists the environment tags.
Organization name
Project name
Environment name
Optionalafter: stringThe tag to start listing from
Optionalcount: numberThe number of tags to list
A list of environment tags
openAndReadEnvironment opens an environment session and reads the environment properties, resolving configuration variables and secrets.
Organization name
Project name
Environment name
The environment and its values
openAndReadEnvironmentAtVersion opens an environment session at a specific version and reads the environment properties, resolving configuration variables and secrets.
Organization name
Project name
Environment name
Version of the environment
The environment and its values
openEnvironment opens an environment session
Organization name
Project name
Environment name
The open environment session information
openEnvironmentAtVersion opens an environment session at a specific version
Organization name
Project name
Environment name
Version of the environment
The open environment session information
readOpenEnvironment reads the environment properties in an open session, resolving configuration variables and secrets.
Organization name
Project name
Environment name
Open session ID
The environment and its values
readOpenEnvironmentProperty reads a specific environment property in an open session, resolving configuration variables and secrets.
Organization name
Project name
Environment name
Open session ID
Property name
The environment property and its value
updateEnvironment updates the environment definition.
Organization name
Project name
Environment name
The environment definition
The environment diagnostics
updateEnvironmentRevisionTag updates the environment revision tag.
Organization name
Project name
Environment name
The tag name
The revision number
A promise that resolves when the tag is updated
updateEnvironmentTag updates the environment tag.
Organization name
Project name
Environment name
The tag name
The tag value
The new tag name
The new tag value
A promise that resolves when the tag is updated
updateEnvironmentYaml updates the environment definition from a YAML string.
Organization name
Project name
Environment name
YAML representation of the environment
The environment diagnostics
EscApi is a client for the ESC API. It wraps the raw API client and provides a more convenient interface.
Export
EscApi