Function EnvironmentsApiFp

Returns {
    adminCreateEnvironmentValue(groupId, appId, body?, options?) => Promise<((axios?, basePath?) => AxiosPromise<EnvironmentValueDescription>)>;
    adminDeleteEnvironmentValue(groupId, appId, environmentValueId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminGetEnvironmentValue(groupId, appId, environmentValueId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminListEnvironmentValues(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminModifyEnvironmentValue(groupId, appId, environmentValueId, body?, options?) => Promise<((axios?, basePath?) => AxiosPromise<EnvironmentValueDescription>)>;
    adminSetEnvironment(groupId, appId, adminSetEnvironmentRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
}

• adminCreateEnvironmentValue:function

  • adminCreateEnvironmentValue(groupId, appId, body?, options?): Promise<((axios?, basePath?) => AxiosPromise<EnvironmentValueDescription>)>

  • Define a new environment value.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • Optional body: any

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<EnvironmentValueDescription>)>

    Summary

    Create an Environment Value

    Throws

• adminDeleteEnvironmentValue:function

  • adminDeleteEnvironmentValue(groupId, appId, environmentValueId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Delete an existing environment value

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • environmentValueId: any

      The `_id` value of an environment value.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete an Environment Value

    Throws

• adminGetEnvironmentValue:function

  • adminGetEnvironmentValue(groupId, appId, environmentValueId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Get details about a specific environment value

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • environmentValueId: any

      The `_id` value of an environment value.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    Get an Environment Value

    Throws

• adminListEnvironmentValues:function

  • adminListEnvironmentValues(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Get basic information about all environment values in the App. Results do not include the environment-specific values. For details on a specific environment, call Get an Environment Value.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    List All Environment Values

    Throws

• adminModifyEnvironmentValue:function

  • adminModifyEnvironmentValue(groupId, appId, environmentValueId, body?, options?): Promise<((axios?, basePath?) => AxiosPromise<EnvironmentValueDescription>)>

  • Modify an existing environment value

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • environmentValueId: any

      The `_id` value of an environment value.

    • Optional body: any

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<EnvironmentValueDescription>)>

    Summary

    Modify an Environment Value

    Throws

• adminSetEnvironment:function

  • adminSetEnvironment(groupId, appId, adminSetEnvironmentRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Set the App's active environment

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • Optional adminSetEnvironmentRequest: AdminSetEnvironmentRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    Set the App Environment

    Throws