Class EscRawApi

EscApi - object-oriented interface

Export

EscApi

Hierarchy

  • BaseAPI
    • EscRawApi

Constructors

constructor

Properties

axios basePath configuration

Methods

checkEnvironmentYaml cloneEnvironment createEnvironment createEnvironmentRevisionTag createEnvironmentTag decryptEnvironment deleteEnvironment deleteEnvironmentRevisionTag deleteEnvironmentTag getEnvironment getEnvironmentAtVersion getEnvironmentETag getEnvironmentRevisionTag getEnvironmentTag listEnvironmentRevisionTags listEnvironmentRevisions listEnvironmentTags listEnvironments openEnvironment openEnvironmentAtVersion readOpenEnvironment readOpenEnvironmentProperty updateEnvironmentRevisionTag updateEnvironmentTag updateEnvironmentYaml

Constructors

constructor

  • new EscRawApi(configuration?, basePath?, axios?): EscRawApi

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns EscRawApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

checkEnvironmentYaml

  • checkEnvironmentYaml(orgName, body, options?): Promise<any>

  • Checks an environment definition for errors

    Parameters

    • orgName: string

      Organization name

    • body: string

      Environment Yaml content

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Checks an environment definition for errors

    Throws

    Memberof

    EscApi

cloneEnvironment

  • cloneEnvironment(orgName, projectName, envName, cloneEnvironment, options?): Promise<any>

  • Clones an environment

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • cloneEnvironment: CloneEnvironment

      Clone environment

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Clones an environment

    Throws

    Memberof

    EscApi

createEnvironment

  • createEnvironment(orgName, createEnvironment, options?): Promise<any>

  • Creates an environment in the given org with the given name.

    Parameters

    • orgName: string

      Organization name

    • createEnvironment: CreateEnvironment

      Create Environment

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Create a new environment

    Throws

    Memberof

    EscApi

createEnvironmentRevisionTag

  • createEnvironmentRevisionTag(orgName, projectName, envName, createEnvironmentRevisionTag, options?): Promise<any>

  • Create environment revision tag

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • createEnvironmentRevisionTag: CreateEnvironmentRevisionTag

      Create environment revision tag

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Create environment revision tag

    Throws

    Memberof

    EscApi

createEnvironmentTag

  • createEnvironmentTag(orgName, projectName, envName, createEnvironmentTag, options?): Promise<any>

  • Create environment tag

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • createEnvironmentTag: CreateEnvironmentTag

      Create environment tag

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Create environment tag

    Throws

    Memberof

    EscApi

decryptEnvironment

  • decryptEnvironment(orgName, projectName, envName, options?): Promise<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

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Reads the definition for the given environment with static secrets in plaintext

    Throws

    Memberof

    EscApi

deleteEnvironment

  • deleteEnvironment(orgName, projectName, envName, options?): Promise<any>

  • Delete an environment

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Delete an environment

    Throws

    Memberof

    EscApi

deleteEnvironmentRevisionTag

  • deleteEnvironmentRevisionTag(orgName, projectName, envName, tagName, options?): Promise<any>

  • Delete environment revision tag

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • tagName: string

      Tag name

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Delete environment revision tag

    Throws

    Memberof

    EscApi

deleteEnvironmentTag

  • deleteEnvironmentTag(orgName, projectName, envName, tagName, options?): Promise<any>

  • Delete environment tag

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • tagName: string

      Tag name

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Delete environment tag

    Throws

    Memberof

    EscApi

getEnvironment

  • getEnvironment(orgName, projectName, envName, options?): Promise<any>

  • Read an environment

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Read an environment

    Throws

    Memberof

    EscApi

getEnvironmentAtVersion

  • getEnvironmentAtVersion(orgName, projectName, envName, version, options?): Promise<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

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Read an environment at a specific version

    Throws

    Memberof

    EscApi

getEnvironmentETag

  • getEnvironmentETag(orgName, projectName, envName, options?): Promise<any>

  • Returns the ETag for the given environment if it exists.

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Return an Environment ETag

    Throws

    Memberof

    EscApi

getEnvironmentRevisionTag

  • getEnvironmentRevisionTag(orgName, projectName, envName, tagName, options?): Promise<any>

  • Read environment revision tag

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • tagName: string

      Tag name

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Read environment revision tag

    Throws

    Memberof

    EscApi

getEnvironmentTag

  • getEnvironmentTag(orgName, projectName, envName, tagName, options?): Promise<any>

  • Read an environment tag

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • tagName: string

      Tag name

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Read an environment tag

    Throws

    Memberof

    EscApi

listEnvironmentRevisionTags

  • listEnvironmentRevisionTags(orgName, projectName, envName, after?, count?, options?): Promise<any>

  • List environment revisions

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • Optional after: string

      after tag for pagination

    • Optional count: number

      limit of tags to return

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    List environment revisions

    Throws

    Memberof

    EscApi

listEnvironmentRevisions

  • listEnvironmentRevisions(orgName, projectName, envName, before?, count?, options?): Promise<any>

  • List environment revisions

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • Optional before: number

      before revision number for pagination

    • Optional count: number

      limit of revisions to return

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    List environment revisions

    Throws

    Memberof

    EscApi

listEnvironmentTags

  • listEnvironmentTags(orgName, projectName, envName, after?, count?, options?): Promise<any>

  • List environment tags

    Parameters

    • orgName: string

      Organization name

    • projectName: string

      Project name

    • envName: string

      Environment name

    • Optional after: string

      after tag for pagination

    • Optional count: number

      limit of tags to return

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    List environment tags

    Throws

    Memberof

    EscApi

listEnvironments

  • listEnvironments(orgName, continuationToken?, options?): Promise<any>

  • List environments in the organization available to the current user

    Parameters

    • orgName: string

      Organization name

    • Optional continuationToken: string

      continuation Token from previous query to fetch next page of results

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    List environments in the organization

    Throws

    Memberof

    EscApi

openEnvironment

  • openEnvironment(orgName, projectName, envName, duration?, options?): Promise<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

    • Optional duration: 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”.

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Open an environment session

    Throws

    Memberof

    EscApi

openEnvironmentAtVersion

  • openEnvironmentAtVersion(orgName, projectName, envName, version, duration?, options?): Promise<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

    • Optional duration: 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”.

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Open an environment session at a specific version

    Throws

    Memberof

    EscApi

readOpenEnvironment

  • readOpenEnvironment(orgName, projectName, envName, openSessionID, options?): Promise<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

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Read an open environment

    Throws

    Memberof

    EscApi

readOpenEnvironmentProperty

  • readOpenEnvironmentProperty(orgName, projectName, envName, openSessionID, property, options?): Promise<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

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Read an open environment

    Throws

    Memberof

    EscApi

updateEnvironmentRevisionTag

  • updateEnvironmentRevisionTag(orgName, projectName, envName, tagName, updateEnvironmentRevisionTag, options?): Promise<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

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Update environment revision tag

    Throws

    Memberof

    EscApi

updateEnvironmentTag

  • updateEnvironmentTag(orgName, projectName, envName, tagName, updateEnvironmentTag, options?): Promise<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

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Update an environment tag

    Throws

    Memberof

    EscApi

updateEnvironmentYaml

  • updateEnvironmentYaml(orgName, projectName, envName, body, options?): Promise<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

    • Optional options: any

      Override http request option.

    Returns Promise<any>

    Summary

    Update an existing environment with Yaml file

    Throws

    Memberof

    EscApi

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcheckEnvironmentYamlcloneEnvironmentcreateEnvironmentcreateEnvironmentRevisionTagcreateEnvironmentTagdecryptEnvironmentdeleteEnvironmentdeleteEnvironmentRevisionTagdeleteEnvironmentTaggetEnvironmentgetEnvironmentAtVersiongetEnvironmentETaggetEnvironmentRevisionTaggetEnvironmentTaglistEnvironmentRevisionTagslistEnvironmentRevisionslistEnvironmentTagslistEnvironmentsopenEnvironmentopenEnvironmentAtVersionreadOpenEnvironmentreadOpenEnvironmentPropertyupdateEnvironmentRevisionTagupdateEnvironmentTagupdateEnvironmentYaml

Generated using TypeDoc