# CloudHub API

Manage CloudHub applications, domains, deployments, alerts, and autoscale policies. Monitor dashboard statistics and diagnostics.

- **Version:** 1.0.0
- **Category:** Runtime
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/cloudhub/api.yaml)

## Servers
- `https://anypoint.mulesoft.com/cloudhub/api`
- `https://{region}.anypoint.mulesoft.com/cloudhub/api`
- `https://{region}.platform.mulesoft.com/cloudhub/api`

## Operations (108)
### GET /v2/alerts

**Operation ID:** `getV2Alerts`
Retrieve all alerts in the specified environment.
Requires 'Read Alerts' role.


**Parameters:**
| `offset` | query | Offset to return alerts from | required |
| `limit` | query | Maximum number of alerts to return | required |
| `resource` | query | Only return alerts which are connected to this resource (application name) | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /v2/alerts

**Operation ID:** `createV2Alerts`
Create an alert


**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /v2/alerts/{id}

**Operation ID:** `getV2AlertsById`
Retrieve a single alert


**Parameters:**
| `id` | query | The id to identify the target resource. | required |

### PUT /v2/alerts/{id}

**Operation ID:** `updateV2AlertsById`
Update an existing alert


**Parameters:**
| `id` | query | The id to identify the target resource. | required |

### DELETE /v2/alerts/{id}

**Operation ID:** `deleteV2AlertsById`
Delete a single alert


**Parameters:**
| `id` | query | The id to identify the target resource. | required |

### GET /v2/alerts/{id}/history

**Operation ID:** `getV2AlertsByIdHistory`
Retrieve the history describing when this alert was triggered


**Parameters:**
| `id` | query | The id to identify the target resource. | required |

### GET /v2/applications

**Operation ID:** `getV2Applications`
Retrieve all applications in the specified environment.
Requires 'Read Applications' role.


**Parameters:**
| `retrieveStatistics` | query | Include statistics for each application in the response | required |
| `period` | query | Number of milliseconds of statistics to gather | required |
| `retrieveLogLevels` | query | Include log levels for each application in the response | required |
| `retrieveTrackingSettings` | query | Include tracking settings for each application in the response | required |
| `retrieveIpAddresses` | query | Include ip address allocations for each application in the response | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /v2/applications

**Operation ID:** `createV2Applications`
Create a new application.
Requires 'Create Applications' role.


**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### PUT /v2/applications

**Operation ID:** `updateV2Applications`
Bulk Action (UPDATE, START, STOP, RESTART, DELETE) for Applications.

**UPDATE**: Update all applications in the provided list to the latest
update of the Mule Version that the application is currently using

**START**: Start all applications in the provided list if they are stopped

**STOP**: Stop all applications in the provided list if they are started

**RESTART**: Restart all applications in the provided list with zero downtime

**DELETE**: Delete all applications in the provided list

The threshold for number of domains in the bulk actions is 100.

These actions cannot be stopped. Requires 'Manage Settings' role.


**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /v2/applications/{domain}

**Operation ID:** `getV2ApplicationsByDomain`
Retrieve a single application by name.
Requires 'Read Applications' role.


**Parameters:**
| `domain` | query | Application domain name | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### PUT /v2/applications/{domain}

**Operation ID:** `updateV2ApplicationsByDomain`
Update a single application.
Requires 'Manage Settings' role.


**Parameters:**
| `domain` | query | Application domain name | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### DELETE /v2/applications/{domain}

**Operation ID:** `deleteV2ApplicationsByDomain`
Delete a single application


**Parameters:**
| `domain` | query | Application domain name | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /v2/applications/{domain}/dashboardStats

**Operation ID:** `getV2ApplicationsByDomainDashboardstats`
Retrieve statistics for an application or specific application workers.
Requires 'Read Applications' role.

(Note: The maximum number of statistic points returned for each metric from a single call is 1440.)


**Parameters:**
| `endDate` | query | ISO format date string representing the last date to retrieve statistics. If not specified, defaults to now.
 | required |
| `statistics` | query | Specify which statistics to retrieve. If not specified, retrieve all statistics
 | required |
| `interval` | query | Amount of time between samples in milliseconds. Worker statistics can be retrieved for period as short as 1 minute. | required |
| `workerIds` | query | Specify which worker to retrieve statistics for. Can be specified multiple times to retrieve statistics for multiple workers. If not specified, statistics for all workers are retrieved.
 | required |
| `startDate` | query | ISO format date string representing the first date to retrieve statistics. If not specified, defaults to endDate - 24 hours.
 | required |
| `domain` | query | Application domain name | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /v2/applications/{domain}/files

**Operation ID:** `createV2ApplicationsByDomainFiles`
Deploy or re-deploy an application with the specified application file.
Requires 'Manage Settings' role.


**Parameters:**
| `domain` | query | Application domain name | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /v2/applications/{domain}/queueStatistics

**Operation ID:** `getV2ApplicationsByDomainQueuestatistics`
Retrieve statistics for persistent queues.
Requires 'Read Applications' role.


**Parameters:**
| `endDate` | query | ISO format date string representing the last date to retrieve statistics. If not specified, defaults to now.
 | optional |
| `statistics` | query | Specifiy which statistics to retrieve
 | optional |
| `interval` | query | Amount of time between samples in milliseconds.
 | optional |
| `offset` | query | Index of the first queue to retrieve. Used for paging results.
 | required |
| `queueName` | query | Specify the name of the queue to retrieve data for
 | required |
| `limit` | query | Maximum number of queues to retrieve statistics for.
 | required |
| `startDate` | query | ISO format date string representing the first date to retrieve statistics. If not specified, defaults to endDate - 24 hours.
 | optional |
| `domain` | query | Application domain name | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /v2/applications/{domain}/staticips

**Operation ID:** `getV2ApplicationsByDomainStaticips`
Retrieve all the static IP addresses related with the application


**Parameters:**
| `domain` | query | Application domain name | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /v2/applications/{domain}/staticips

**Operation ID:** `createV2ApplicationsByDomainStaticips`
Request a static IP for the application.


**Parameters:**
| `domain` | query | Application domain name | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### DELETE /v2/applications/{domain}/staticips/{region}

**Operation ID:** `deleteV2ApplicationsByDomainStaticipsByRegion`
Release any unused static IP address(es) assigned to the application for that region back to the pool.

**Parameters:**
| `domain` | query | Application domain name | required |
| `region` | query | the region | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /v2/applications/{domain}/deployments

**Operation ID:** `getV2ApplicationsByDomainDeployments`
description: Retrieve deploymentIds and InstanceIds using this API. These Ids are useful for downloading mule application and worker logs.


**Parameters:**
| `limit` | query | Maximum number of deployments to retrieve.
 | optional |
| `offset` | query | Index of the first deployment to retrieve. Used for paging results.
 | optional |
| `orderByDate` | query | Order of deployments
 | optional |
| `loggingVersion` | query | if you are using new logging system then use VERSION_2
 | optional |
| `domain` | query | Application domain name | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /v2/applications/{domain}/deployments/{deploymentId}/logs

**Operation ID:** `getV2ApplicationsByDomainDeploymentsByDeploymentidLogs`
Retrieve deployment log for a specific depoymentId. May be subject of rate limit.

We do not recommend the use of this API for extraction of logs. Please use custom log appenders for this purpose. [More Info](https://docs.mulesoft.com/cloudhub/custom-log-appender)


**Parameters:**
| `limit` | query | number of log lines, less or equal 2000
 | optional |
| `domain` | query | Application domain name | required |
| `deploymentId` | query | deploymentId retrieved from /deployments API | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /v2/applications/{domain}/instances/{instanceId}/logs

**Operation ID:** `getV2ApplicationsByDomainInstancesByInstanceidLogs`
Retrieve instance log for a specific instanceId. Instance log is related to your application. May be subject to rate limit.

We do not recommend the use of this API for extraction of logs. Please use custom log appenders for this purpose. [More Info](https://docs.mulesoft.com/cloudhub/custom-log-appender)


**Parameters:**
| `limit` | query | number of log lines, less or equal 2000
 | optional |
| `offset` | query | offset from end for tail, or from start for head request
 | optional |
| `tail` | query | tail the log
 | optional |
| `domain` | query | Application domain name | required |
| `instanceId` | query | instanceId retrieved from /deployments API | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /v2/applications/{domain}/instances/{instanceId}/diagnostics

**Operation ID:** `getV2ApplicationsByDomainInstancesByInstanceidDiagnostics`
description: Retrieve thread dump of a worker.


**Parameters:**
| `domain` | query | Application domain name | required |
| `instanceId` | query | instanceId retrieved from /deployments API | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /v2/applications/{domain}/instances/{instanceId}/log-file

**Operation ID:** `getV2ApplicationsByDomainInstancesByInstanceidLogFile`
Download the log file associated with your application

We do not recommend the use of this API for extraction of logs. Please use custom log appenders for this purpose. [More Info](https://docs.mulesoft.com/cloudhub/custom-log-appender)


**Parameters:**
| `domain` | query | Application domain name | required |
| `instanceId` | query | instanceId retrieved from /deployments API | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### DELETE /v2/applications/{domain}/insight/transactions/replays

**Operation ID:** `deleteV2ApplicationsByDomainInsightTransactionsReplays`
Deletes Replay Data for all the transactions of the given application

**Parameters:**
| `domain` | query | Application domain name | required |

### GET /v2/applications/{domain}/insight/transactions/hasReplays

**Operation ID:** `getV2ApplicationsByDomainInsightTransactionsHasreplays`
Checks if Replay Data Exists on Amazon S3 for the given application

**Parameters:**
| `domain` | query | Application domain name | required |

### GET /v2/applications/{domain}/autoscalepolicies

**Operation ID:** `getV2ApplicationsByDomainAutoscalepolicies`
Retrieve auto-scaling policies

**Parameters:**
| `domain` | query | Application domain name | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /v2/applications/{domain}/autoscalepolicies

**Operation ID:** `createV2ApplicationsByDomainAutoscalepolicies`
Create new Auto-scaling Policy

**Parameters:**
| `domain` | query | Application domain name | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /v2/applications/{domain}/autoscalepolicies/{policyId}

**Operation ID:** `getV2ApplicationsByDomainAutoscalepoliciesByPolicyid`
Retrieve specified auto scaling policy

**Parameters:**
| `domain` | query | Application domain name | required |
| `policyId` | query | Applied policy instance id on this API instance. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### PUT /v2/applications/{domain}/autoscalepolicies/{policyId}

**Operation ID:** `updateV2ApplicationsByDomainAutoscalepoliciesByPolicyid`
Update specified auto scaling policy

**Parameters:**
| `domain` | query | Application domain name | required |
| `policyId` | query | Applied policy instance id on this API instance. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### DELETE /v2/applications/{domain}/autoscalepolicies/{policyId}

**Operation ID:** `deleteV2ApplicationsByDomainAutoscalepoliciesByPolicyid`
Delete auto-scaling policy

**Parameters:**
| `domain` | query | Application domain name | required |
| `policyId` | query | Applied policy instance id on this API instance. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /v2/applications/{domain}/logs

**Operation ID:** `createV2ApplicationsByDomainLogs`
Search logs for the application.

We do not recommend the use of this API for extraction of logs. There may be some delays. Please use custom log appenders for this purpose. [More Info](https://docs.mulesoft.com/cloudhub/custom-log-appender)


**Parameters:**
| `domain` | query | Application domain name | required |

### GET /account

**Operation ID:** `getAccount`
Retrieve information about the logged-in user.


**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications

**Operation ID:** `getApplications`
Retrieve all applications in the specified environment.
Requires 'Read Applications' role.


**Parameters:**
| `retrieveStatistics` | query | Include statistics for each application in the response | required |
| `period` | query | Number of milliseconds of statistics to gather | required |
| `intervalCount` | query | Amount of time between samples in milliseconds. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /applications

**Operation ID:** `createApplications`
Create a new application.
Requires 'Create Applications' role.


**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/domains/{domain}

**Operation ID:** `getApplicationsDomainsByDomain`
Check if the specified domain is available.
Requires 'Read Applications' role.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |

### GET /applications/{domain}

**Operation ID:** `getApplicationsByDomain`
Retrieve a single application by name.
Requires 'Read Applications' role.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### PUT /applications/{domain}

**Operation ID:** `updateApplicationsByDomain`
Update a single application.
Requires 'Manage Settings' role.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### DELETE /applications/{domain}

**Operation ID:** `deleteApplicationsByDomain`
Delete a single application.
Requires 'Delete applications' role.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/{domain}/download/{filename}

**Operation ID:** `getApplicationsByDomainDownloadByFilename`
Requires 'Download Applications' role.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `filename` | query | The filename to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/{domain}/logs/levels

**Operation ID:** `getApplicationsByDomainLogsLevels`
Get all log levels for current application

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### PUT /applications/{domain}/logs/levels

**Operation ID:** `updateApplicationsByDomainLogsLevels`
Add/Update log levels for current application

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/{domain}/logs/levels/{name}

**Operation ID:** `getApplicationsByDomainLogsLevelsByName`
Get single log level with name

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `name` | query | The name to identify the target resource. | required |

### DELETE /applications/{domain}/logs/levels/{name}

**Operation ID:** `deleteApplicationsByDomainLogsLevelsByName`
Delete single log level with name

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `name` | query | The name to identify the target resource. | required |

### GET /applications/{domain}/notifications

**Operation ID:** `getApplicationsByDomainNotifications`
To use a non-default environment, set this header

**Parameters:**
| `status` | query | If specified, filter the notifications by status. 'read' or 'unread'.
 | required |
| `limit` | query | Maximum number of notifications to retrieve.
 | required |
| `offset` | query | Index of the first notification to retrieve. Used for paging results.
 | required |
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/{domain}/schedules

**Operation ID:** `getApplicationsByDomainSchedules`
Retrieves a schedules.

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |

### PUT /applications/{domain}/schedules

**Operation ID:** `updateApplicationsByDomainSchedules`
Batch update of the schedules. Enable/Disable or run all or subset of schedules.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |

### GET /applications/{domain}/schedules/{jobId}

**Operation ID:** `getApplicationsByDomainSchedulesByJobid`
Retrieves a schedules.

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `jobId` | query | The job ID to identify the target resource. | required |

### PUT /applications/{domain}/schedules/{jobId}

**Operation ID:** `updateApplicationsByDomainSchedulesByJobid`
Replaces a schedules.

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `jobId` | query | The job ID to identify the target resource. | required |

### POST /applications/{domain}/schedules/{jobId}/run

**Operation ID:** `createApplicationsByDomainSchedulesByJobidRun`
Creates a run.

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `jobId` | query | The job ID to identify the target resource. | required |

### GET /applications/{domain}/settings/tracking

**Operation ID:** `getApplicationsByDomainSettingsTracking`
Retrieves a tracking.

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |

### PUT /applications/{domain}/settings/tracking

**Operation ID:** `updateApplicationsByDomainSettingsTracking`
Possible values are 'DISABLED' , 'METADATA' and 'METADATA_AND_REPLAY'.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |

### GET /applications/{domain}/statistics

**Operation ID:** `getApplicationsByDomainStatistics`
To use a non-default environment, set this header

**Parameters:**
| `period` | query | The time period in milliseconds. If period is passed, the end date will be now and start date will be now minus the period.
 | required |
| `start` | query | Milliseconds since epoch representing the first date to retrieve statistics. If not specified, defaults to end - 1 week.
 | required |
| `end` | query | Milliseconds since epoch representing the last date to retrieve statistics. If not specified, defaults to now.
 | required |
| `intervalCount` | query | The number of intervals to split the statistics into. | required |
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/{domain}/status

**Operation ID:** `getApplicationsByDomainStatus`
Retrieve status of the application.
Requires 'Read Applications' role.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /applications/{domain}/status

**Operation ID:** `createApplicationsByDomainStatus`
Update status of the application.
Requires 'Manage Settings' role


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/{domain}/tracking/custom-keys

**Operation ID:** `getApplicationsByDomainTrackingCustomKeys`
To use a non-default environment, set this header

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/{domain}/tracking/searches

**Operation ID:** `getApplicationsByDomainTrackingSearches`
To use a non-default environment, set this header

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /applications/{domain}/tracking/searches/{name}

**Operation ID:** `createApplicationsByDomainTrackingSearchesByName`
To use a non-default environment, set this header

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `name` | query | The name to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### PUT /applications/{domain}/tracking/searches/{name}

**Operation ID:** `updateApplicationsByDomainTrackingSearchesByName`
To use a non-default environment, set this header

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `name` | query | The name to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### DELETE /applications/{domain}/tracking/searches/{name}

**Operation ID:** `deleteApplicationsByDomainTrackingSearchesByName`
To use a non-default environment, set this header

**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `name` | query | The name to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/{domain}/tracking/statistics

**Operation ID:** `getApplicationsByDomainTrackingStatistics`
Retrieve a list of application statistics.
Requires 'Read Applications' role.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /applications/{domain}/tracking/statistics

**Operation ID:** `createApplicationsByDomainTrackingStatistics`
Retrieve a list of application statistics, filtered by parameters passed in the request body.
Requires 'Read Applications' role.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /applications/{domain}/tracking/transactions

**Operation ID:** `createApplicationsByDomainTrackingTransactions`
Retrieve a list of application transactions, filtered by parameters
passed in the request body.
Requires 'Read Applications' role.


**Parameters:**
| `offset` | query | Index of the first event to retrieve. Used for paging results.
 | required |
| `count` | query | Maximum number of events to return
 | required |
| `total` | query | If true, the response is an object with a list of events and a total field. Used for paging.
 | required |
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/{domain}/tracking/transactions/{transactionId}

**Operation ID:** `getApplicationsByDomainTrackingTransactionsByTransactionid`
Retrieve the events for a single application transaction.
Requires 'Read Applications' role.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `transactionId` | query | The transaction ID to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/{domain}/tracking/transactions/{transactionId}/{flowName}/replay

**Operation ID:** `getApplicationsByDomainTrackingTransactionsByTransactionidByFlownameReplay`
Replay the flow for this transaction. Returns the id of the new flow.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `transactionId` | query | The transaction ID to identify the target resource. | required |
| `flowName` | query | The flowName to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /applications/{domain}/workers

**Operation ID:** `getApplicationsByDomainWorkers`
Retrieve workers for the application.
Requires 'Read Applications' role.


**Parameters:**
| `domain` | query | The domain to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /mule-versions

**Operation ID:** `getMuleVersions`
Retrieve all supported Mule versions.  The first version returned is the most recent, recommended version, and the last version returned is the oldest supported version.


**Parameters:**
| `releaseChannel` | query | If specified, filtered the Mule versions by release channels (EDGE, LTS, or NONE)
 | optional |
| `javaVersion` | query | If specified, filtered the Mule Versions by Java Versions (8, 17, etc)
 | required |
| `recommended` | query | If specified, filtered the Mule versions by recommended status
 | optional |
| `X-ANYPNT-ORG-ID` | query | The ID of your current organization
 | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /mule-versions/{version}

**Operation ID:** `getMuleVersionsByVersion`
Retrieve specified Mule Version


**Parameters:**
| `version` | query | The version to identify the target resource. | required |

### GET /mule-versions/{version}/updates/{updateId}

**Operation ID:** `getMuleVersionsByVersionUpdatesByUpdateid`
Retrieve a single update for a muleVersion


**Parameters:**
| `version` | query | The version to identify the target resource. | required |
| `updateId` | query | The update ID to identify the target resource. | required |

### GET /notifications

**Operation ID:** `getNotifications`
Retrieve notifications.
Requires 'Read Applications' role.


**Parameters:**
| `domain` | query | Limit notifications to a single application domain
 | optional |
| `limit` | query | Maximum number of notifications to retrieve.
 | optional |
| `offset` | query | Index of the first notification to retrieve.
 | optional |
| `status` | query | If specified, filter the notifications by status. 'read' or 'unread'.
 | optional |
| `search` | query | If specified, only return notifications where the message contains this string. (Insensitive)
 | optional |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### POST /notifications

**Operation ID:** `createNotifications`
Create a new notification


**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### PUT /notifications

**Operation ID:** `updateNotifications`
Mark all notifications for this application as read or unread.
Requires 'Read Applications' role.


**Parameters:**
| `domain` | query | Mark all notifications for this application domain
 | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /notifications/{id}

**Operation ID:** `getNotificationsById`
Retrieve a single notification.
Requires 'Read Applications' role.


**Parameters:**
| `id` | query | The id to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### PUT /notifications/{id}

**Operation ID:** `updateNotificationsById`
Mark a single notification  as read or unread.
Requires 'Read Applications' role.


**Parameters:**
| `id` | query | The id to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /organization

**Operation ID:** `getOrganization`
Retrieve the organization attached to the current environment.
Requires 'Organization Admin' role.


**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /organization/plan

**Operation ID:** `getOrganizationPlan`
Retrieve the subscription plan details for the organization.
Requires 'Organization Admin' role.


**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /organization/usage

**Operation ID:** `getOrganizationUsage`
Retrieve the the vCore / worker usage for the organization.
Requires 'Organization Admin' role.


**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /organization/{orgid}

**Operation ID:** `getOrganizationByOrgid`
Retrieve a single organization.
Requires 'Organization Admin' role.


**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |

### GET /organizations/{orgid}/usage

**Operation ID:** `getOrganizationsByOrgidUsage`
Retrieve the the vCore / worker / staticIP usage for the organization.
Requires 'Organization Admin' role.


**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |

### POST /organizations/{orgid}/logs/download

**Operation ID:** `createOrganizationsByOrgidLogsDownload`
Initiate a log download request for the specified resource.
Requires 'Read Load Balancers' permission.


**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |

### GET /organizations/{orgid}/logs/download/status

**Operation ID:** `getOrganizationsByOrgidLogsDownloadStatus`
Check the status of a log download execution.
Returns download URL when processing is complete.
Requires 'Read Load Balancers' permission.


**Parameters:**
| `executionName` | query | The execution name returned from the download initiation request | required |
| `orgid` | query | The orgid to identify the target resource. | required |

### GET /organizations/{orgid}/loadbalancers

**Operation ID:** `getOrganizationsByOrgidLoadbalancers`
List existing Load balancers for the organization

**Parameters:**
| `limit` | query | Result limit | optional |
| `offset` | query | Result offset | optional |
| `shortFormat` | query | If enabled certain LB fields (like "ipWhitelist", "mappings"...) are skipped in response | optional |
| `orgid` | query | The orgid to identify the target resource. | required |

### POST /organizations/{orgid}/loadbalancers/testcerts

**Operation ID:** `createOrganizationsByOrgidLoadbalancersTestcerts`
Test if LB certificates, keys, crls and their combinations are valid

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |

### GET /organizations/{orgid}/tgws

**Operation ID:** `getOrganizationsByOrgidTgws`
Get a list of all Transit Gateways belonging to the master organization

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |

### POST /organizations/{orgid}/tgws

**Operation ID:** `createOrganizationsByOrgidTgws`
Create a new Transit Gateway

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |

### PUT /organizations/{orgid}/tgws/{id}

**Operation ID:** `updateOrganizationsByOrgidTgwsById`
Add a new TGW-VPC attachment, modify VPC routes or update the TGW name

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `id` | query | The id to identify the target resource. | required |

### DELETE /organizations/{orgid}/tgws/{id}

**Operation ID:** `deleteOrganizationsByOrgidTgwsById`
Delete a TGW-VPC attachment or a TGW Resource Share

**Parameters:**
| `vpcId` | query | VPC ID of the TGW-VPC attachment to delete | optional |
| `orgid` | query | The orgid to identify the target resource. | required |
| `id` | query | The id to identify the target resource. | required |

### GET /organizations/{orgid}/vpcs

**Operation ID:** `getOrganizationsByOrgidVpcs`
Get a list of existing VPCs

**Parameters:**
| `limit` | query | Result limit | optional |
| `offset` | query | Result offset | optional |
| `orgid` | query | The orgid to identify the target resource. | required |

### POST /organizations/{orgid}/vpcs

**Operation ID:** `createOrganizationsByOrgidVpcs`
Create new VPC

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |

### GET /organizations/{orgid}/vpcs/{vpcId}

**Operation ID:** `getOrganizationsByOrgidVpcsByVpcid`
Obtain VPC information by its id

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |

### PUT /organizations/{orgid}/vpcs/{vpcId}

**Operation ID:** `updateOrganizationsByOrgidVpcsByVpcid`
Changes the configuration of the VPC by overriding the values of the properties passed in the JSON. ownerId, region and cidrBlock cannot be overriden.
Organizations that do not own the VPC can only update isDefault and associatedEnvironments.


**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |

### DELETE /organizations/{orgid}/vpcs/{vpcId}

**Operation ID:** `deleteOrganizationsByOrgidVpcsByVpcid`
Remove VPC by its id

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |

### GET /organizations/{orgid}/vpcs/{vpcId}/loadbalancers

**Operation ID:** `getOrganizationsByOrgidVpcsByVpcidLoadbalancers`
Get list of existing Load balancers

**Parameters:**
| `limit` | query | Result limit | optional |
| `offset` | query | Result offset | optional |
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |

### POST /organizations/{orgid}/vpcs/{vpcId}/loadbalancers

**Operation ID:** `createOrganizationsByOrgidVpcsByVpcidLoadbalancers`
Create new Load balancer

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |

### GET /organizations/{orgid}/vpcs/{vpcId}/loadbalancers/{lbId}

**Operation ID:** `getOrganizationsByOrgidVpcsByVpcidLoadbalancersByLbid`
returns load balancer by its ID

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |
| `lbId` | query | The lb ID to identify the target resource. | required |

### PATCH /organizations/{orgid}/vpcs/{vpcId}/loadbalancers/{lbId}

**Operation ID:** `patchOrganizationsByOrgidVpcsByVpcidLoadbalancersByLbid`
updates a load balancer

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |
| `lbId` | query | The lb ID to identify the target resource. | required |

### DELETE /organizations/{orgid}/vpcs/{vpcId}/loadbalancers/{lbId}

**Operation ID:** `deleteOrganizationsByOrgidVpcsByVpcidLoadbalancersByLbid`
deletes load balancer by its ID

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |
| `lbId` | query | The lb ID to identify the target resource. | required |

### GET /organizations/{orgid}/vpcs/{vpcId}/loadbalancers/{lbId}/deployments

**Operation ID:** `getOrganizationsByOrgidVpcsByVpcidLoadbalancersByLbidDeployments`
returns all the deployments

**Parameters:**
| `limit` | query | Result limit | optional |
| `offset` | query | Result offset | optional |
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |
| `lbId` | query | The lb ID to identify the target resource. | required |

### GET /organizations/{orgid}/vpcs/{vpcId}/loadbalancers/{lbId}/testmapping

**Operation ID:** `getOrganizationsByOrgidVpcsByVpcidLoadbalancersByLbidTestmapping`
makes a test call to the load balancer rules and returns a response with the rule number which will be applied to the input.

**Parameters:**
| `url` | query | URL to test | required |
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |
| `lbId` | query | The lb ID to identify the target resource. | required |

### GET /organizations/{orgid}/vpcs/{vpcId}/ipsec

**Operation ID:** `getOrganizationsByOrgidVpcsByVpcidIpsec`
get the configuration and state of a <<resourcePathName|!pluralize>>

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |

### POST /organizations/{orgid}/vpcs/{vpcId}/ipsec

**Operation ID:** `createOrganizationsByOrgidVpcsByVpcidIpsec`
Create a VPN connection from a VPC, up to a limit of 10 total VPN Connections per VPC

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |

### GET /organizations/{orgid}/vpcs/{vpcId}/ipsec/ipsec/{vpnId}

**Operation ID:** `getOrganizationsByOrgidVpcsByVpcidIpsecIpsecByVpnid`
Get the configuration and state of a <<resourcePathName|!pluralize>> string

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |
| `vpnId` | query | The vpn ID to identify the target resource. | required |

### DELETE /organizations/{orgid}/vpcs/{vpcId}/ipsec/ipsec/{vpnId}

**Operation ID:** `deleteOrganizationsByOrgidVpcsByVpcidIpsecIpsecByVpnid`
Delete a VPN connection

**Parameters:**
| `orgid` | query | The orgid to identify the target resource. | required |
| `vpcId` | query | The vpc ID to identify the target resource. | required |
| `vpnId` | query | The vpn ID to identify the target resource. | required |

### GET /ping

**Operation ID:** `getPing`
Lists ping.

### PUT /queues/{queueId}/clear

**Operation ID:** `updateQueuesByQueueidClear`
Replaces a clear.

**Parameters:**
| `queueId` | query | The queue ID to identify the target resource. | required |

### GET /queues/{queueId}/statistics

**Operation ID:** `getQueuesByQueueidStatistics`
Retrieves a statistics.

**Parameters:**
| `queueId` | query | The queue ID to identify the target resource. | required |

### GET /queues/{queueId}/statistics/{statistic}

**Operation ID:** `getQueuesByQueueidStatisticsByStatistic`
Retrieves a statistics.

**Parameters:**
| `startDate` | query | The startDate query parameter. | required |
| `endDate` | query | The endDate query parameter. | required |
| `interval` | query | The interval query parameter. | required |
| `queueId` | query | The queue ID to identify the target resource. | required |
| `statistic` | query | The statistic to identify the target resource. | required |

### GET /regions

**Operation ID:** `getRegions`
Lists regions.

### GET /users/current/permissions

**Operation ID:** `getUsersCurrentPermissions`
Retrieve the permissions for the current user


**Parameters:**
| `X-ANYPNT-ENV-ID` | query | Identifier of the environment where the api user is currently working. | required |