Function EnvironmentsApiAxiosParamCreator

Returns {
    adminCreateEnvironmentValue: ((groupId, appId, body?, options?) => Promise<RequestArgs>);
    adminDeleteEnvironmentValue: ((groupId, appId, environmentValueId, options?) => Promise<RequestArgs>);
    adminGetEnvironmentValue: ((groupId, appId, environmentValueId, options?) => Promise<RequestArgs>);
    adminListEnvironmentValues: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminModifyEnvironmentValue: ((groupId, appId, environmentValueId, body?, options?) => Promise<RequestArgs>);
    adminSetEnvironment: ((groupId, appId, adminSetEnvironmentRequest?, options?) => Promise<RequestArgs>);
}

• adminCreateEnvironmentValue: ((groupId, appId, body?, options?) => Promise<RequestArgs>)

  • • (groupId, appId, body?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

      Summary

      Create an Environment Value

      Throws

• adminDeleteEnvironmentValue: ((groupId, appId, environmentValueId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, environmentValueId, options?): Promise<RequestArgs>

    • 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<RequestArgs>

      Summary

      Delete an Environment Value

      Throws

• adminGetEnvironmentValue: ((groupId, appId, environmentValueId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, environmentValueId, options?): Promise<RequestArgs>

    • 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<RequestArgs>

      Summary

      Get an Environment Value

      Throws

• adminListEnvironmentValues: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • 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<RequestArgs>

      Summary

      List All Environment Values

      Throws

• adminModifyEnvironmentValue: ((groupId, appId, environmentValueId, body?, options?) => Promise<RequestArgs>)

  • • (groupId, appId, environmentValueId, body?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

      Summary

      Modify an Environment Value

      Throws

• adminSetEnvironment: ((groupId, appId, adminSetEnvironmentRequest?, options?) => Promise<RequestArgs>)

  • • (groupId, appId, adminSetEnvironmentRequest?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

      Summary

      Set the App Environment

      Throws