--- title: "Methods" slug: "methods" updated: 2025-12-23T11:42:39Z published: 2025-12-23T11:42:39Z canonical: "help.mail-and-deploy.com/methods" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.mail-and-deploy.com/llms.txt > Use this file to discover all available pages before exploring further. # Methods ### General This page lists all available API methods and describes their parameters and return values. ### CopyWorkspace This method requires an HTTP *POST* and copies an existing [Workspace](/release34/docs/workspaces) and all its contents to a newly created workspace. It has the following properties: | Name | Description | | --- | --- | | Id | The ID of the [Workspace](/release34/docs/workspaces) to be copied. | | The name of the copied workspace. | The name of the copied workspace. | The call returns a *SuccessStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call copies the [Workspace](/release34/docs/workspaces) with ID *aa6ffd4e-dc24-4ddb-8bb8-db494c31ea6f* and gives the newly created workspace the name *MyWorkspaceCopy*: Copy Workspace API Call http(s)://:/Api/?Method=CopyWorkspace&Id=aa6ffd4e-dc24-4ddb-8bb8-db494c31ea6f&CopiedWorkspaceName=MyWorkspaceCopy ### Delete This method requires an HTTP *DELETE* and deletes the entity with the given ID. It has the following parameters: | Name | Description | | --- | --- | | Id | The ID of the entity to delete. | The call returns a *SuccessStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call deletes the entity with ID *3388b658-1baf-4058-abd1-44edecdad4c3*: Delete API Call http(s)://:/Api/?Method=Delete&Id=3388b658-1baf-4058-abd1-44edecdad4c3 ### ExecuteTask This method requires an HTTP *POST* and executes the [Task](/release34/docs/tasks) with a given ID. It has the following properties: | Name | Description | | --- | --- | | Id | The ID of the [Task](/release34/docs/tasks) to be executed. | | Delay | An optional delay in seconds. | | Parameters | An optional query parameter that can contain one or more task parameters. An example is *Country:Austria;Germany\|Year:#2022* where the parameter *Country* will be set to two text values *(Austria and Germany)* and the parameter *Year* will be set to the number *2022*. | The call waits until the execution has finished and returns the *ExecutionResultStructure*. #### Example The following call executes the [Task](/release34/docs/tasks) with ID *3388b658-1baf-4058-abd1-44edecdad4c3*. ExecuteTask API Call http(s)://:/Api/?Method=ExecuteTask&TaskId=3388b658-1baf-4058-abd1-44edecdad4c3 ### ExecuteTaskAsync This method requires an HTTP *POST* and executes the [Task](/release34/docs/tasks) with a given ID. It has the following properties: | Name | Description | | --- | --- | | Id | The ID of the [Task](/release34/docs/tasks) to be executed. | | Delay | An optional delay in seconds. | | Parameters | An optional query parameter that can contain one or more task parameters. An example is *Country:Austria;Germany\|Year:#2022* where the parameter *Country* will be set to two text values *(Austria and Germany)* and the parameter *Year* will be set to the number *2022*. | The call immediately returns a *GuidStructure* that contains the ID of the request which can be used in a *GetRequestExecutionStatus* method to poll the status of the execution. #### Example The following call executes the [Task](/release34/docs/tasks) with ID *3388b658-1baf-4058-abd1-44edecdad4c3*. ExecuteTask API Call http(s)://:/Api/?Method=ExecuteTaskAsync&TaskId=3388b658-1baf-4058-abd1-44edecdad4c3 ### GetAlert This method requires an HTTP *GET* and returns the *AlertStructure* that represents the [Alert](/release34/docs/alerts) with a given ID. It has the following properties: | Name | Description | | --- | --- | | Id | The ID of the [Alert](/release34/docs/alerts) to be returned. | The call returns the requested *AlertStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns an *AlertStructure* that represents the [Alert](/release34/docs/alerts) with ID *c81c3676-bc73-432b-b82e-a09b6b8d5777*: GetAlert API Call http(s)://:/Api/?Method=GetAlert&Id=c81c3676-bc73-432b-b82e-a09b6b8d5777 #### GetAlerts This method requires an HTTP *GET* and returns an *InteropStructureCollection* that contains *AlertStructures* representing the queried [Alerts](/release34/docs/alerts). It has the following parameters: | Name | Description | | --- | --- | | NamePattern | A regular expression used to filter [Alerts](/release34/docs/alerts) by their name. This parameter is optional. | | WorkspaceId | The ID of the [Workspace](/release34/docs/workspaces) in which to query [Alerts](/release34/docs/alerts). This parameter is optional. | | WorkspaceName | The ID of the [Workspace](/release34/docs/workspaces) in which to query [Alerts](/release34/docs/alerts). This parameter is optional. | | UserId | The ID of the [Workspace](/release34/docs/workspaces) in which to query [Alerts](/release34/docs/alerts). This parameter is optional. | | UserName | The name of the [User](/release34/docs/users) whose [Alerts](/release34/docs/alerts) to query. This parameter is optional. | | DatasourceID | The ID of the [Datasource](/release34/docs/introduction-to-datasources) whose associated [Alerts](/release34/docs/alerts) to query. This parameter is optional. | | DatasourceName | The name of the [Datasource](/release34/docs/introduction-to-datasources) whose associated [Alerts](/release34/docs/alerts) to query. This parameter is optional. | The call returns an *InteropStructureCollection* containing the requested *AlertStructures* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns an *InteropStructureCollection* containing *AlertStructures* of all [Alerts](/release34/docs/alerts) that belong to the [User](/release34/docs/users) with ID *24e68134-9e23-429e-9f46-30ca1921460c* in the [Workspace](/release34/docs/workspaces) named *MyWorkspace*: GetAlerts API Call http(s)://:/Api/?Method=GetAlerts&UserId=24e68134-9e23-429e-9f46-30ca1921460c&WorkspaceName=MyWorkspace ### GetAuthenticatedUser This method requires an HTTP *GET* and returns a *UserStructure* that represents the [User](/release34/docs/users) that performs the API call. There are no parameters. ### GetBackupConfiguration This method requires an HTTP *GET* and returns the *BackupConfigurationStructure* that represents the current [Backup Settings](/release34/docs/backup-settings). The call returns the requested *BackupConfigurationStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns the *BackupConfigurationStructure*: GetBackupConfiguration API Call http(s)://:/Api/?Method=GetBackupConfiguration ### GetDataExchangeConfiguration This method requires an HTTP *GET* and returns the *DataExchangeConfigurationStructure* that represents the current [Data Exchange Settings](/release34/docs/data-exchange-settings). The call returns the requested *DataExchangeConfigurationStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns the *DataExchangeConfigurationStructure*: GetDataExchangeConfiguration API Call http(s)://:/Api/?Method=GetDataExchangeConfiguration ### GetDatasource This method requires an HTTP *GET* and returns the *DatasourceStructure* that represents the [Datasource](/release34/docs/introduction-to-datasources) with a given ID. It has the following properties: | Name | Description | | --- | --- | | Id | The ID of the [Datasource](/release34/docs/introduction-to-datasources) to be returned. | The call returns the requested *DatasourceStructure* if everything worked as expected or an ExceptionStr**ucture if an error occured. #### Example The following call returns a *DatasourceStructure* that represents the [Datasource](/release34/docs/introduction-to-datasources) with ID *c81c3676-bc73-432b-b82e-a09b6b8d5777*: :::(Info)(GetDatasource API Call) http(s)://:/Api/?Method=GetDatasource&Id=c81c3676-bc73-432b-b82e-a09b6b8d5777 ::: ### GetDatasources This method requires an HTTP *GET* and returns an *InteropStructureCollection* that contains *DatasourceStructures* representing the queried [Datasources](/release34/docs/introduction-to-datasources). It has the following parameters: | Name | Description | | --- | --- | | NamePattern | A regular expression used to filter [Datasources](/release34/docs/introduction-to-datasources) by their name. This parameter is optional. | | WorkspaceId | The ID of the Workspace in which to query [Datasources](/release34/docs/introduction-to-datasources). This parameter is optional. | | WorkspaceId | The name of the [Workspace](/release34/docs/workspaces) in which to query [Datasources](/release34/docs/introduction-to-datasources). This parameter is optional. | The call returns an *InteropStructureCollection* containing the requested *DatasourceStructures* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns an *InteropStructureCollection* containing *DatasourceStructures* of all [Datasources](/release34/docs/introduction-to-datasources) that belong to the [Workspace](/release34/docs/workspaces) named *MyWorkspace*: GetDatasources API Call http(s)://:/Api/?Method=GetDatasources&WorkspaceName=MyWorkspace ### GetDeploymentConfiguration This method requires an HTTP *GET* and returns the *DeploymentConfigurationStructure* that represents the current [Deployment Settings](/release34/docs/deployment-settings). The call returns the requested *DeploymentConfigurationStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns the *DeploymentConfigurationStructure*: GetDeploymentConfiguration API Call http(s)://:/Api/?Method=GetDeploymentConfiguration ### GetEMailServers This method requires an HTTP GET and returns an *InteropStructureCollection* that contains *EMailServerStructures* representing the queried [E-Mail Servers](/release34/docs/introduction-to-email-servers). It has the following parameters: | Name | Description | | --- | --- | | NamePattern | A regular expression used to filter [E-Mail Servers](/release34/docs/introduction-to-email-servers) by their name. This parameter is optional. | The call returns an *InteropStructureCollection* containing the requested *EMailServerStructures* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns an *InteropStructureCollection* containing *EMailServerStructures* of all [E-Mail Servers](/release34/docs/introduction-to-email-servers) whose name start with *Def*: GetEMailServers API Call http(s)://:/Api/?Method=GetEMailServers&NamePattern=^Def.* ### GetReport This method requires an HTTP *GET* and returns the *ReportStructure* that represents the [Report](/release34/docs/release34/docs/introduction-to-reports) with a given ID. It has the following properties: | Name | Description | | --- | --- | | Id | The ID of the [Report](/release34/docs/release34/docs/introduction-to-reports) to be returned. | The call returns the requested *ReportStructure* if everything worked as expected or an ExceptionStructure if an error occured. #### Example The following call returns a *ReportStructure* that represents the [Report](/release34/docs/release34/docs/introduction-to-reports) with ID *c81c3676-bc73-432b-b82e-a09b6b8d5777*: GetReport API Call http(s)://:/Api/?Method=GetReport&Id=c81c3676-bc73-432b-b82e-a09b6b8d5777 ### GetReports This method requires an HTTP *GET* and returns an *InteropStructureCollection* that contains *ReportStructures* representing the queried [Reports](/release34/docs/release34/docs/introduction-to-reports). It has the following parameters: | Name | Description | | --- | --- | | NamePattern | A regular expression used to filter [Reports](/release34/docs/release34/docs/introduction-to-reports) by their name. This parameter is optional. | | WorkspaceId | The ID of the [Workspace](/release34/docs/workspaces) in which to query [Reports](/release34/docs/release34/docs/introduction-to-reports). This parameter is optional. | | WorkspaceName | The name of the [Workspace](/release34/docs/workspaces) in which to query [Reports](/release34/docs/release34/docs/introduction-to-reports). This parameter is optional. | The call returns an *InteropStructureCollection* containing the requested *ReportStructures* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns an *InteropStructureCollection* containing *ReportStructures* of all [Reports](/release34/docs/release34/docs/introduction-to-reports) that belong to the [Workspace](/release34/docs/workspaces) named *MyWorkspace*: GetReports API Call http(s)://:/Api/?Method=GetReports&WorkspaceName=MyWorkspace ### GetReportSupportedFileTypes This method requires an HTTP *GET* and returns an *InteropStructureCollection* that contains *FileTypeStructures* for all output file types supported by a [Report](/release34/docs/release34/docs/introduction-to-reports) with a given ID. It has the following parameters: | Name | Description | | --- | --- | | ReportId | The ID of the [Report](/release34/docs/release34/docs/introduction-to-reports) for which to return supported output file types. | #### Example The following call returns an *InteropStructureCollection* containing *FileTypeStructures* for supported output file types of the [Report](/release34/docs/release34/docs/introduction-to-reports) with ID *c81c3676-bc73-432b-b82e-a09b6b8d5777*: GetReportSupportedFileTypes API Call http(s)://:/Api/?Method=GetReportSupportedFileTypes&ReportId=c81c3676-bc73-432b-b82e-a09b6b8d5777 ### GetSelfServiceReports This method requires an HTTP *GET* and returns an *InteropStructureCollection* that contains *ReportStructures* representing [Reports](/release34/docs/release34/docs/introduction-to-reports) to which the [User](/release34/docs/users) with the given ID has required [Authorizations](/release34/docs/introduction-to-authorizations) to request the report. It only returns reports within the [Workspace](/release34/docs/workspaces) with the given ID- It has the following parameters: | Name | Description | | --- | --- | | UserId | The ID of the [User](/release34/docs/users) whose self-service [Reports](/release34/docs/release34/docs/introduction-to-reports) to return. | | WorkspaceId | The ID of the [Workspace](/release34/docs/workspaces) in which to query [Reports](/release34/docs/introduction-to-reports). | The call returns an *InteropStructureCollection* containing the requested *ReportStructures* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns an *InteropStructureCollection* containing *ReportStructures* of all [Reports](/release34/docs/introduction-to-reports) that belong to the [Workspace](/release34/docs/workspaces) with ID *f11f7c91-5c5d-4eb0-9a64-c34f04954615* for which the [User](/release34/docs/users) with ID *4e4ff28a-d22e-4484-be08-4593875f17ff* has required [Authorizations](/release34/docs/introduction-to-authorizations) to request the report: GetSelfServiceReports API Call http(s)://:/Api/?Method=GetSelfServiceReports&UserId=4e4ff28a-d22e-4484-be08-4593875f17ff&WorkspaceId=f11f7c91-5c5d-4eb0-9a64-c34f04954615 ### GetTask This method requires an HTTP *GET* and returns the *TaskStructure* that represents the [Task](/release34/docs/tasks) with a given ID. It has the following properties: | Name | Description | | --- | --- | | Id | The ID of the [Task](/release34/docs/tasks) to be returned. | The call returns the requested *TaskStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns a *TaskStructure* that represents the [Task](/release34/docs/tasks) with ID* c81c3676-bc73-432b-b82e-a09b6b8d5777*: GetTask API Call http(s)://:/Api/?Method=GetTask&Id=c81c3676-bc73-432b-b82e-a09b6b8d5777 ### GetTasks This method requires an HTTP *GET* and returns an *InteropStructureCollection* that contains *TaskStructures* representing the queried [Tasks](/release34/docs/tasks). It has the following parameters: | Name | Description | | --- | --- | | NamePattern | A regular expression used to filter [Tasks](/release34/docs/tasks) by their name. This parameter is optional. | | WorkspaceId | The ID of the [Workspace](/release34/docs/workspaces) in which to query [Tasks](/release34/docs/tasks). This parameter is optional. | | WorkspaceName | The name of the [Workspace](/release34/docs/workspaces) in which to query [Tasks](/release34/docs/tasks). This parameter is optional. | The call returns an *InteropStructureCollection* containing the requested *TaskStructures* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns an *InteropStructureCollection* containing *TaskStructures* of all [Tasks](/release34/docs/tasks) that belong to the [Workspace](/release34/docs/workspaces) named *MyWorkspace*: GetTasks API Call http(s)://:/Api/?Method=GetTasks&WorkspaceName=MyWorkspace ### GetRequest This method requires an HTTP *GET* and returns the *RequestStructure* with a given ID. It has the following properties: | Name | Description | | --- | --- | | Id | The ID of the request to be returned. | The call returns the requested *RequestStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns a *RequestStructure* that represents the request with ID *c81c3676-bc73-432b-b82e-a09b6b8d5777*: :::(Info)(GetRequest API Call) http(s)://:/Api/?Method=GetRequest&Id=c81c3676-bc73-432b-b82e-a09b6b8d5777 ::: ### GetRequestExecutionStatus This method requires an HTTP *GET* and returns the *ExecutionStatusStructure* for the request with a given ID. It has the following properties: | Name | Description | | --- | --- | | Id | The ID of the request whose *ExecutionStatusStructure* to return. | The call returns the requested *ExecutionStatusStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns a *ExecutionStatusStructure* of the request with ID *c81c3676-bc73-432b-b82e-a09b6b8d5777*: GetRequestExecutionStatus API Call http(s)://:/Api/?Method=GetRequestExecutionStructure&Id=c81c3676-bc73-432b-b82e-a09b6b8d5777 ### GetUser This method requires an HTTP *GET* and returns the *UserStructure* that represents the [User](/release34/docs/users) with a given ID. It has the following properties: | Name | Description | | --- | --- | | Id | The ID of the [User](/release34/docs/users) to be returned. | The call returns the requested *UserStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns an *UserStructure* that represents the [User](/release34/docs/users) with ID *c81c3676-bc73-432b-b82e-a09b6b8d5777*: GetUser API Call http(s)://:/Api/?Method=GetUser&Id=c81c3676-bc73-432b-b82e-a09b6b8d5777 ### GetUsers This method requires an HTTP *GET* and returns an *InteropStructureCollection* that contains *UserStructures* representing the queried [Users](/release34/docs/users). It has the following parameters: | Name | Description | | --- | --- | | Description | A regular expression used to filter [Users](/release34/docs/users) by their name. This parameter is optional. | | EMailAddress | The e-mail address of [Users](/release34/docs/users) to return. This parameter is optional. | | CustomUsername | The e-mail address of [Users](/release34/docs/users) to return. This parameter is optional. | | CustomUsername | The windows account name of [Users](/release34/docs/users) to return. This parameter is optional. | The call returns an *InteropStructureCollection* containing the requested *UserStructures* if everything worked as expected or an *ExceptionStructure* if an error occured. ### Example The following call returns an InteropStructureCollection containing UserStructures of all Users with an e-mail address of user@company.com: GetUsers API Call http(s)://:/Api/?Method=GetUsers&EMailAddress=user%40company.com ### GetWorkspace This method requires an HTTP *GET* and returns the *WorkspaceStructure* that represents the [Workspace](/release34/docs/workspaces) with a given ID. It has the following properties: | Name | Description | | --- | --- | | Id | The ID of the [Workspace](/release34/docs/workspaces) to be returned. | The call returns the requested *WorkspaceStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns an *WorkspaceStructure* that represents the [Workspace](/release34/docs/workspaces) with ID *c81c3676-bc73-432b-b82e-a09b6b8d5777*: GetWorkspace API Call http(s)://:/Api/?Method=GetWorkspace&Id=c81c3676-bc73-432b-b82e-a09b6b8d5777 ### GetWorkspaces This method requires an HTTP *GET* and returns an *InteropStructureCollection* that contains *WorkspaceStructures* representing the queried [Workspaces](/release34/docs/workspaces). It has the following parameters: | Name | Description | | --- | --- | | NamePattern | A regular expression used to filter [Workspaces](/release34/docs/workspaces) by their name. This parameter is optional. | The call returns an *InteropStructureCollection* containing the requested *WorkspaceStructures* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call returns an *InteropStructureCollection* containing *WorkspaceStructures* of all [Workspaces](/release34/docs/workspaces) with a name that starts with R: GetWorkspaces API Call http(s)://:/Api/?Method=GetWorkspaces&NamePattern=%5ER ### Persist This method requires an HTTP *POST* and persists the *InteropStructure* supplied as POST data to the request. The call returns a *SuccessStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. ### RebuildDatasourceCache This method requires an HTTP *POST* and rebuilds the cache of the [Datasource](/release34/docs/introduction-to-datasources) with the given ID. It has the following parameters: | Name | Description | | --- | --- | | Id | The ID of the [Datasource](/release34/docs/introduction-to-datasources) whose cache to rebuild. | The call returns a *SuccessStructure* if everything worked as expected or an *ExceptionStructure* if an error occured. #### Example The following call rebuilds the cache of the [Datasource](/release34/docs/introduction-to-datasources) with ID *3388b658-1baf-4058-abd1-44edecdad4c3*: RebuildDatasourceCache API Call http(s)://:/Api/?Method=RebuildDatasourceCache&Id=3388b658-1baf-4058-abd1-44edecdad4c3