Class EscRawApi

EscApi - object-oriented interface

Export

EscApi

Hierarchy

BaseAPI
- EscRawApi

Constructors

constructor

new EscRawApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): EscRawApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns EscRawApi
Inherited from BaseAPI.constructor
- Defined in raw/base.ts:55

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

checkEnvironmentYaml

checkEnvironmentYaml(
    orgName: string,
    body: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CheckEnvironment, any, {}>>
Checks an environment definition for errors
Parameters
- orgName: string
  Organization name
- body: string
  Environment Yaml content
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CheckEnvironment, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:2991

cloneEnvironment

cloneEnvironment(
    orgName: string,
    projectName: string,
    envName: string,
    cloneEnvironment: CloneEnvironment,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Clones an environment
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- cloneEnvironment: CloneEnvironment
  Clone environment
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3006

createEnvironment

createEnvironment(
    orgName: string,
    createEnvironment: CreateEnvironment,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Creates an environment in the given org with the given name.
Parameters
- orgName: string
  Organization name
- createEnvironment: CreateEnvironment
  Create Environment
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3019

createEnvironmentRevisionTag

createEnvironmentRevisionTag(
    orgName: string,
    projectName: string,
    envName: string,
    createEnvironmentRevisionTag: CreateEnvironmentRevisionTag,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Create environment revision tag
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- createEnvironmentRevisionTag: CreateEnvironmentRevisionTag
  Create environment revision tag
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3034

createEnvironmentTag

createEnvironmentTag(
    orgName: string,
    projectName: string,
    envName: string,
    createEnvironmentTag: CreateEnvironmentTag,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EnvironmentTag, any, {}>>
Create environment tag
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- createEnvironmentTag: CreateEnvironmentTag
  Create environment tag
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EnvironmentTag, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3049

decryptEnvironment

decryptEnvironment(
    orgName: string,
    projectName: string,
    envName: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EnvironmentDefinition, any, {}>>
Reads the definition for the given environment with static secrets in plaintext
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EnvironmentDefinition, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3063

deleteEnvironment

deleteEnvironment(
    orgName: string,
    projectName: string,
    envName: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Delete an environment
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3077

deleteEnvironmentRevisionTag

deleteEnvironmentRevisionTag(
    orgName: string,
    projectName: string,
    envName: string,
    tagName: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Delete environment revision tag
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tagName: string
  Tag name
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3092

deleteEnvironmentTag

deleteEnvironmentTag(
    orgName: string,
    projectName: string,
    envName: string,
    tagName: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Delete environment tag
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tagName: string
  Tag name
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3107

getEnvironment

getEnvironment(
    orgName: string,
    projectName: string,
    envName: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EnvironmentDefinition, any, {}>>
Read an environment
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EnvironmentDefinition, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3121

getEnvironmentAtVersion

getEnvironmentAtVersion(
    orgName: string,
    projectName: string,
    envName: string,
    version: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EnvironmentDefinition, any, {}>>
Read an environmentat a specific revision or tag
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- version: string
  Revision or tag
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EnvironmentDefinition, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3136

getEnvironmentETag

getEnvironmentETag(
    orgName: string,
    projectName: string,
    envName: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Returns the ETag for the given environment if it exists.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3150

getEnvironmentRevisionTag

getEnvironmentRevisionTag(
    orgName: string,
    projectName: string,
    envName: string,
    tagName: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EnvironmentRevisionTag, any, {}>>
Read environment revision tag
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tagName: string
  Tag name
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EnvironmentRevisionTag, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3165

getEnvironmentTag

getEnvironmentTag(
    orgName: string,
    projectName: string,
    envName: string,
    tagName: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EnvironmentTag, any, {}>>
Read an environment tag
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tagName: string
  Tag name
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EnvironmentTag, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3180

listEnvironmentRevisions

listEnvironmentRevisions(
    orgName: string,
    projectName: string,
    envName: string,
    before?: number,
    count?: number,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EnvironmentRevision[], any, {}>>
List environment revisions
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- Optionalbefore: number
  before revision number for pagination
- Optionalcount: number
  limit of revisions to return
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EnvironmentRevision[], any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3212

listEnvironmentRevisionTags

listEnvironmentRevisionTags(
    orgName: string,
    projectName: string,
    envName: string,
    after?: string,
    count?: number,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EnvironmentRevisionTags, any, {}>>
List environment revisions
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- Optionalafter: string
  after tag for pagination
- Optionalcount: number
  limit of tags to return
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EnvironmentRevisionTags, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3196

listEnvironments

listEnvironments(
    orgName: string,
    continuationToken?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<OrgEnvironments, any, {}>>
List environments in the organization available to the current user
Parameters
- orgName: string
  Organization name
- OptionalcontinuationToken: string
  continuation Token from previous query to fetch next page of results
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<OrgEnvironments, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3241

listEnvironmentTags

listEnvironmentTags(
    orgName: string,
    projectName: string,
    envName: string,
    after?: string,
    count?: number,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ListEnvironmentTags, any, {}>>
List environment tags
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- Optionalafter: string
  after tag for pagination
- Optionalcount: number
  limit of tags to return
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ListEnvironmentTags, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3228

openEnvironment

openEnvironment(
    orgName: string,
    projectName: string,
    envName: string,
    duration?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<OpenEnvironment, any, {}>>
Opens a session the given environment for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- Optionalduration: string
  open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<OpenEnvironment, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3256

openEnvironmentAtVersion

openEnvironmentAtVersion(
    orgName: string,
    projectName: string,
    envName: string,
    version: string,
    duration?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<OpenEnvironment, any, {}>>
Opens a session the given environment at a specific version for the indicated duration. This returns a session id that can be used to then read values. The default duration is 1 hour.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- version: string
  Revision or tag
- Optionalduration: string
  open duration - A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “1.5h” or “2h45m”. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<OpenEnvironment, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3272

readOpenEnvironment

readOpenEnvironment(
    orgName: string,
    projectName: string,
    envName: string,
    openSessionID: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<Environment, any, {}>>
Reads and decrypts secrets including retrieving dynamic secrets from providers.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- openSessionID: string
  Open session ID returned from environment open
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Environment, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3287

readOpenEnvironmentProperty

readOpenEnvironmentProperty(
    orgName: string,
    projectName: string,
    envName: string,
    openSessionID: string,
    property: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<Value, any, {}>>
Reads and decrypts secrets including retrieving dynamic secrets from providers.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- openSessionID: string
  Open session ID returned from environment open
- property: string
  Path to a specific property using Pulumi path syntax https://www.pulumi.com/docs/concepts/config/#structured-configuration
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Value, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3303

updateEnvironmentRevisionTag

updateEnvironmentRevisionTag(
    orgName: string,
    projectName: string,
    envName: string,
    tagName: string,
    updateEnvironmentRevisionTag: UpdateEnvironmentRevisionTag,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Update environment revision tag
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tagName: string
  Tag name
- updateEnvironmentRevisionTag: UpdateEnvironmentRevisionTag
  Update environment revision tag
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3319

updateEnvironmentTag

updateEnvironmentTag(
    orgName: string,
    projectName: string,
    envName: string,
    tagName: string,
    updateEnvironmentTag: UpdateEnvironmentTag,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EnvironmentTag, any, {}>>
Update an environment tag
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- tagName: string
  Tag name
- updateEnvironmentTag: UpdateEnvironmentTag
  Update environment tag
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EnvironmentTag, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3335

updateEnvironmentYaml

updateEnvironmentYaml(
    orgName: string,
    projectName: string,
    envName: string,
    body: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EnvironmentDiagnostics, any, {}>>
Validates and updates the given environment's definition.
Parameters
- orgName: string
  Organization name
- projectName: string
  Project name
- envName: string
  Environment name
- body: string
  Environment Yaml content
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EnvironmentDiagnostics, any, {}>>
Throws
Memberof
EscApi
- Defined in raw/api.ts:3350

Class EscRawApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EscRawApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

checkEnvironmentYaml

Parameters

Returns Promise<AxiosResponse<CheckEnvironment, any, {}>>

Throws

Memberof

cloneEnvironment

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

createEnvironment

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

createEnvironmentRevisionTag

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

createEnvironmentTag

Parameters

Returns Promise<AxiosResponse<EnvironmentTag, any, {}>>

Throws

Memberof

decryptEnvironment

Parameters

Returns Promise<AxiosResponse<EnvironmentDefinition, any, {}>>

Throws

Memberof

deleteEnvironment

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

deleteEnvironmentRevisionTag

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

deleteEnvironmentTag

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

getEnvironment

Parameters

Returns Promise<AxiosResponse<EnvironmentDefinition, any, {}>>

Throws

Memberof

getEnvironmentAtVersion

Parameters

Returns Promise<AxiosResponse<EnvironmentDefinition, any, {}>>

Throws

Memberof

getEnvironmentETag

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

getEnvironmentRevisionTag

Parameters

Returns Promise<AxiosResponse<EnvironmentRevisionTag, any, {}>>

Throws

`Protected`axios

`Protected`basePath

`Protected`configuration