leafleafleafFlower illustration
Updated on May 28, 2024
Environment

environment.Export

Estimated reading: 3 minutes 646 views
Namespace: Environment
REST: https://[hoster-api-host]/1.0/environment/export/rest/{method-name}
Scripting: environment.export.{method-name}
This service provides API methods for exporting environments on the accounts as downloadable manifests for future imports. Learn more in the documentation.

Methods

Create (appid, session, settings ) :

Creates a manifest file based on the existing environment (a JSON file with the topology and other settings) and stores it within the corresponding environment.

URL

https://[hoster-api-host]/1.0/environment/export/rest/create

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

  • settings : “string”

    JSON object with export settings: {“config”: true, “data”: true}

Example

Method: POST

https://[hoster-api-host]/1.0/environment/export/rest/create?settings=[string]&session=[string]&appid=[string]

Response

  • Response
    {
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}

Delete (envName, session, id ) :

Deletes a manifest file of the exported environment from the corresponding environment.

URL

https://[hoster-api-host]/1.0/environment/export/rest/delete

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • id : “string”

    unique identifier of the exported environment manifest.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/export/rest/delete?envName=[string]&session=[string]&id=[string]

Response

  • Response
    {
   "error": "string",
   "response": "Object",
   "result": "int"
}

DeleteExportedData (envName, session, fileName ) :

Deletes the exported data.

URL

https://[hoster-api-host]/1.0/environment/export/rest/deleteexporteddata

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • fileName : “string”

    filename to be removed.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/export/rest/deleteexporteddata?fileName=[string]&envName=[string]&session=[string]

Response

  • Response
    {
   "error": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}

GetList (envName, session ) :

Returns a list of all the exported copies of the environment.

URL

https://[hoster-api-host]/1.0/environment/export/rest/getlist

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/export/rest/getlist?envName=[string]&session=[string]

Response

  • Response
    {
   "error": "string",
   "response": "Object",
   "result": "int"
}

GetManifest (envName, session, id ) :

Returns a manifest file of the exported environment.

URL

https://[hoster-api-host]/1.0/environment/export/rest/getmanifest

Parameters

  • envName : “string”

    target environment name.

  • session : “string”

    user session or personal access token.

  • id : “string”

    Unique identifier of the exported environment manifest.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/export/rest/getmanifest?envName=[string]&session=[string]&id=[string]

Response

  • Response
    {
   "error": "string",
   "response": "Object",
   "result": "int"
}
Environment - Previous environment.Deployment Next - Environment environment.File

Leave a Comment

Powered By AccuWeb.Cloud