CloudHub API

1.0.0

Overview

Statistics
108 Operations
0 Skills
Runtime Category
Manage CloudHub applications, domains, deployments, alerts, and autoscale policies. Monitor dashboard statistics and diagnostics.

Servers

  • https://anypoint.mulesoft.com/cloudhub/api
  • https://{region}.anypoint.mulesoft.com/cloudhub/api
  • https://{region}.platform.mulesoft.com/cloudhub/api

Authentication & Security

  • bearerAuth http

    Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login

  • clientAuth oauth2

    OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token

Get V2Alerts getV2Alerts

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve all alerts in the specified environment.
Requires 'Read Alerts' role.

Query Parameters

offset *: integer
limit *: integer
resource *: string
Only return alerts which are connected to this resource (application name)

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

json
Successful operation.
items: array
Array items
Examples
application/json
[ { "name": "failure", "severity": "INFO", "condition": { "type": "deployment-failed", "resources": [ "my-app-name" ], "resourceType": "application" }, "organizationId": "2105a52e-6bd7-4c86-92bd-119ba216f96d", "environmentId": "8606e617-21de-4d46-84fb-0e44036ac08b", "id": "1555fd61-3cfb-4662-afdc-298c1676beb0", "productName": "cloudhub", "actions": [ { "type": "email", "emails": [ "me@example.com" ], "subject": "subject line", "content": "deployment failed for ${resource}" } ], "enabled": true, "lastModified": 1458115909470, "isSystem": false, "createdAt": 1458115909470 }, { "name": "failure", "severity": "INFO", "condition": { "type": "deployment-success", "resources": [ "my-app-name" ], "resourceType": "application" }, "organizationId": "2105a52e-6bd7-4c86-92bd-119ba216f96d", "environmentId": "8606e617-21de-4d46-84fb-0e44036ac08b", "id": "1555fd61-3cfb-4662-afdc-298c1676beb2", "productName": "cloudhub", "actions": [ { "type": "email", "emails": [ "me@example.com" ], "subject": "subject line", "content": "deployment failed for ${resource}" } ], "enabled": true, "lastModified": 1458115909470, "isSystem": false, "createdAt": 1458115909470 } ]

Create V2Alerts createV2Alerts

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create an alert

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json
name *: string
severity *: any
actions *: array
condition *: object | object | object | object | object | object | object | object | object | object

Response

json
Successful operation.
name *: string
severity *: any
condition *: object | object | object | object | object | object | object | object | object | object
organizationId *: string
environmentId *: string
id *: string
productName *: string
actions *: array
enabled *: boolean
lastModified *: integer
isSystem *: boolean
createdAt *: integer
Examples
application/json
{ "name": "failure", "severity": "INFO", "condition": { "type": "deployment-failed", "resources": [ "my-app-name" ], "resourceType": "cloudhub-application" }, "organizationId": "2105a52e-6bd7-4c86-92bd-119ba216f96d", "environmentId": "8606e617-21de-4d46-84fb-0e44036ac08b", "id": "1555fd61-3cfb-4662-afdc-298c1676beb0", "productName": "cloudhub", "actions": [ { "type": "email", "emails": [ "me@example.com" ], "subject": "subject line", "content": "deployment failed for ${resource}" } ], "enabled": true, "lastModified": 1458115909470, "isSystem": false, "createdAt": 1458115909470 }

Get V2Alerts By Id getV2AlertsById

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieve a single alert

Path Parameters

id *: string
The id to identify the target resource.

Response

json
Successful operation.
name *: string
severity *: any
condition *: object | object | object | object | object | object | object | object | object | object
organizationId *: string
environmentId *: string
id *: string
productName *: string
actions *: array
enabled *: boolean
lastModified *: integer
isSystem *: boolean
createdAt *: integer
Examples
application/json
{ "name": "failure", "severity": "INFO", "condition": { "type": "deployment-failed", "resources": [ "my-app-name" ], "resourceType": "cloudhub-application" }, "organizationId": "2105a52e-6bd7-4c86-92bd-119ba216f96d", "environmentId": "8606e617-21de-4d46-84fb-0e44036ac08b", "id": "1555fd61-3cfb-4662-afdc-298c1676beb0", "productName": "cloudhub", "actions": [ { "type": "email", "emails": [ "me@example.com" ], "subject": "subject line", "content": "deployment failed for ${resource}" } ], "enabled": true, "lastModified": 1458115909470, "isSystem": false, "createdAt": 1458115909470 }

Update V2Alerts By Id updateV2AlertsById

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update an existing alert

Path Parameters

id *: string
The id to identify the target resource.

Request Body

json
name *: string
severity *: any
actions *: array
condition *: object | object | object | object | object | object | object | object | object | object

Response

json
Successful operation.
name *: string
severity *: any
condition *: object | object | object | object | object | object | object | object | object | object
organizationId *: string
environmentId *: string
id *: string
productName *: string
actions *: array
enabled *: boolean
lastModified *: integer
isSystem *: boolean
createdAt *: integer
Examples
application/json
{ "name": "failure", "severity": "INFO", "condition": { "type": "deployment-failed", "resources": [ "my-app-name" ], "resourceType": "cloudhub-application" }, "organizationId": "2105a52e-6bd7-4c86-92bd-119ba216f96d", "environmentId": "8606e617-21de-4d46-84fb-0e44036ac08b", "id": "1555fd61-3cfb-4662-afdc-298c1676beb0", "productName": "cloudhub", "actions": [ { "type": "email", "emails": [ "me@example.com" ], "subject": "subject line", "content": "deployment failed for ${resource}" } ], "enabled": true, "lastModified": 1458115909470, "isSystem": false, "createdAt": 1458115909470 }

Delete V2Alerts By Id deleteV2AlertsById

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete a single alert

Path Parameters

id *: string
The id to identify the target resource.

Response

Alert deleted

Get V2Alerts By Id History getV2AlertsByIdHistory

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieve the history describing when this alert was triggered

Path Parameters

id *: string
The id to identify the target resource.

Response

json
Successful operation.
data *: array
total *: integer
Examples
application/json
{ "data": [ { "triggeredAt": 1458117301985, "context": { "user": "jeffh", "resource": "testapi-jeffdasd2" }, "severity": "INFO", "condition": { "type": "deployment-success" }, "actions": [ { "state": "failed", "type": "email" } ] }, { "triggeredAt": 1458116181786, "context": { "user": "jeffh", "resource": "testapi-jeffdasd2" }, "severity": "INFO", "condition": { "type": "deployment-success" }, "actions": [ { "state": "failed", "type": "email" } ] } ], "total": 2 }

Get V2Applications getV2Applications

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve all applications in the specified environment.
Requires 'Read Applications' role.

Query Parameters

retrieveStatistics *: boolean
period *: number
retrieveLogLevels *: boolean
retrieveTrackingSettings *: boolean
retrieveIpAddresses *: boolean

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
[ { "domain": "example-app", "fullDomain": "example-app.cloudhub.io", "description": "", "properties": {}, "propertiesOptions": {}, "status": "STARTED", "workers": { "type": { "name": "Medium", "weight": 1, "cpu": "1 vCore", "memory": "1.5 GB memory" }, "amount": 1, "remainingOrgWorkers": 1, "totalOrgWorkers": 1, "recentStatistics": { "transactions": 0, "cpu": 0.95 } }, "lastUpdateTime": 1425571830350, "fileName": "example-app.jar", "muleVersion": { "version": "4.4.0", "updateId": "651c112af26039320eef384f", "latestUpdateId": "6527fb5109623963cc1d425e", "endOfSupportDate": 1703991600000, "endOfLifeDate": 1704078000000, "updateVersion": "10-03-2023", "releaseChannel": "NONE", "javaVersion": "8" }, "previousMuleVersion": { "version": "4.4.0", "updateId": "64f20477036da5595236faaf", "endOfSupportDate": 1703991600000, "endOfLifeDate": 1704078000000, "updateVersion": "09-01-2023", "releaseChannel": "NONE", "javaVersion": "8" }, "tenants": 0, "userId": "54f7ed7ae4b0d48f31a3099e", "userName": "fred-smith", "vpnConfig": { "network": "203.0.113.0", "mask": 27 }, "persistentQueues": false, "persistentQueuesEncryptionEnabled": false, "persistentQueuesEncrypted": false, "monitoringEnabled": true, "monitoringAutoRestart": true, "staticIPsEnabled": false, "multitenanted": false, "hasFile": true, "secureDataGatewayEnabled": false, "vpnEnabled": false, "trackingSettings": { "trackingLevel": "DISABLED" }, "logLevels": [], "ipAddresses": [] } ]

Create V2Applications createV2Applications

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Create a new application.
Requires 'Create Applications' role.

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json
applicationInfo: object
Application deployment information
applicationSource: object
Information about application source
autoStart: boolean
Should the application start deploying
applicationInfo: object
Application deployment information
applicationSource: object
Information about application source
autoStart: boolean
Should the application start deploying

Response

Successful operation.
Examples
application/json
{ "domain": "example-app", "fullDomain": "example-app.cloudhub.io", "description": "", "properties": {}, "propertiesOptions": {}, "status": "STARTED", "workers": { "type": { "name": "Medium", "weight": 1, "cpu": "1 vCore", "memory": "1.5 GB memory" }, "amount": 1, "remainingOrgWorkers": 1, "totalOrgWorkers": 1, "recentStatistics": { "transactions": 0, "cpu": 0.95 } }, "lastUpdateTime": 1425571830350, "fileName": "example-app.zip", "muleVersion": { "version": "4.4.0", "updateId": "651c112af26039320eef384f", "latestUpdateId": "6527fb5109623963cc1d425e", "endOfSupportDate": 1703991600000, "endOfLifeDate": 1704078000000, "updateVersion": "10-03-2023", "releaseChannel": "NONE", "javaVersion": "8" }, "previousMuleVersion": { "version": "4.4.0", "updateId": "64f20477036da5595236faaf", "endOfSupportDate": 1703991600000, "endOfLifeDate": 1704078000000, "updateVersion": "09-01-2023", "releaseChannel": "NONE", "javaVersion": "8" }, "tenants": 0, "userId": "54f7ed7ae4b0d48f31a3099e", "userName": "fred-smith", "vpnConfig": { "network": "203.0.113.0", "mask": 27 }, "deploymentGroup": { "id": "5aff4d75ea4580594b7405d6", "name": "US West and East 1" }, "persistentQueues": false, "persistentQueuesEncryptionEnabled": false, "persistentQueuesEncrypted": false, "monitoringEnabled": true, "monitoringAutoRestart": true, "staticIPsEnabled": false, "multitenanted": false, "hasFile": true, "secureDataGatewayEnabled": false, "vpnEnabled": false, "trackingSettings": { "trackingLevel": "DISABLED" }, "logLevels": [], "ipAddresses": [] }

Update V2Applications updateV2Applications

PUT

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
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.

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Successful operation.

Get V2Applications By Domain getV2ApplicationsByDomain

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve a single application by name.
Requires 'Read Applications' role.

Path Parameters

domain *: string
Application domain name

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "domain": "example-app", "fullDomain": "example-app.cloudhub.io", "description": "", "properties": {}, "propertiesOptions": {}, "status": "STARTED", "workers": { "type": { "name": "Medium", "weight": 1, "cpu": "1 vCore", "memory": "1.5 GB memory" }, "amount": 1, "remainingOrgWorkers": 1, "totalOrgWorkers": 1, "recentStatistics": { "transactions": 0, "cpu": 0.95 } }, "lastUpdateTime": 1425571830350, "fileName": "example-app.zip", "muleVersion": { "version": "4.4.0", "updateId": "651c112af26039320eef384f", "latestUpdateId": "6527fb5109623963cc1d425e", "endOfSupportDate": 1703991600000, "endOfLifeDate": 1704078000000, "updateVersion": "10-03-2023", "releaseChannel": "NONE", "javaVersion": "8" }, "previousMuleVersion": { "version": "4.4.0", "updateId": "64f20477036da5595236faaf", "endOfSupportDate": 1703991600000, "endOfLifeDate": 1704078000000, "updateVersion": "09-01-2023", "releaseChannel": "NONE", "javaVersion": "8" }, "tenants": 0, "userId": "54f7ed7ae4b0d48f31a3099e", "userName": "fred-smith", "vpnConfig": { "network": "203.0.113.0", "mask": 27 }, "deploymentGroup": { "id": "5aff4d75ea4580594b7405d6", "name": "US West and East 1" }, "persistentQueues": false, "persistentQueuesEncryptionEnabled": false, "persistentQueuesEncrypted": false, "monitoringEnabled": true, "monitoringAutoRestart": true, "staticIPsEnabled": false, "multitenanted": false, "hasFile": true, "secureDataGatewayEnabled": false, "vpnEnabled": false, "trackingSettings": { "trackingLevel": "DISABLED" }, "logLevels": [], "ipAddresses": [] }

Update V2Applications By Domain updateV2ApplicationsByDomain

PUT

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Update a single application.
Requires 'Manage Settings' role.

Path Parameters

domain *: string
Application domain name

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json
autoStart: boolean
Should the application start deploying
applicationInfo: object
Application deployment information
applicationSource: object
Information about application source
autoStart: boolean
Should the application start deploying
applicationInfo: object
Application deployment information
applicationSource: object
Information about application source

Response

Successful operation.
Examples
application/json
{ "domain": "example-app", "fullDomain": "example-app.cloudhub.io", "description": "", "properties": {}, "propertiesOptions": {}, "status": "STARTED", "workers": { "type": { "name": "Medium", "weight": 1, "cpu": "1 vCore", "memory": "1.5 GB memory" }, "amount": 1, "remainingOrgWorkers": 1, "totalOrgWorkers": 1, "recentStatistics": { "transactions": 0, "cpu": 0.95 } }, "lastUpdateTime": 1425571830350, "fileName": "example-app.zip", "muleVersion": { "version": "4.4.0", "updateId": "651c112af26039320eef384f", "latestUpdateId": "6527fb5109623963cc1d425e", "endOfSupportDate": 1703991600000, "endOfLifeDate": 1704078000000, "updateVersion": "10-03-2023", "releaseChannel": "NONE", "javaVersion": "8" }, "previousMuleVersion": { "version": "4.4.0", "updateId": "64f20477036da5595236faaf", "endOfSupportDate": 1703991600000, "endOfLifeDate": 1704078000000, "updateVersion": "09-01-2023", "releaseChannel": "NONE", "javaVersion": "8" }, "tenants": 0, "userId": "54f7ed7ae4b0d48f31a3099e", "userName": "fred-smith", "vpnConfig": { "network": "203.0.113.0", "mask": 27 }, "deploymentGroup": { "id": "5aff4d75ea4580594b7405d6", "name": "US West and East 1" }, "persistentQueues": false, "persistentQueuesEncryptionEnabled": false, "persistentQueuesEncrypted": false, "monitoringEnabled": true, "monitoringAutoRestart": true, "staticIPsEnabled": false, "multitenanted": false, "hasFile": true, "secureDataGatewayEnabled": false, "vpnEnabled": false, "trackingSettings": { "trackingLevel": "DISABLED" }, "logLevels": [], "ipAddresses": [] }

Delete V2Applications By Domain deleteV2ApplicationsByDomain

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Delete a single application

Path Parameters

domain *: string
Application domain name

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Operation completed successfully with no content returned.

Get V2Applications By Domain Dashboardstats getV2ApplicationsByDomainDashboardstats

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
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.)

Path Parameters

domain *: string
Application domain name

Query Parameters

endDate *: string
statistics *: string
interval *: integer
workerIds *: string
startDate *: string

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "events": { "1431145723547": 0, "1431229423547": 0, "1431230323547": 0, "1431231223547": 0 }, "workerStatistics": [ { "id": "i-0331cdfc", "ipAddress": "52.6.239.113", "statistics": { "memoryTotalUsed": { "1431231180000": 1000, "1431232080000": 1000 }, "diskWriteBytes": { "1431145680000": -1, "1431146580000": -1 }, "cpu": { "1431145680000": 3, "1431146580000": 5 }, "networkOut": { "1431146580000": 34234, "1431231180000": 73779.5 }, "diskReadBytes": { "1431145680000": 3434, "1431146580000": 4545 }, "networkIn": { "1431145680000": 4554, "1431146580000": 2222, "1431231180000": 334, "1431232080000": 6666 }, "memoryTotalMax": { "1431145680000": 344, "1431146580000": 344 } } } ] }

Create V2Applications By Domain Files createV2ApplicationsByDomainFiles

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body multipart/form-data
Deploy or re-deploy an application with the specified application file.
Requires 'Manage Settings' role.

Path Parameters

domain *: string
Application domain name

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

multipart/form-data
file *: string(binary)
staticIp: string

Response

Application deployment queued successfully.

Get V2Applications By Domain Queuestatistics getV2ApplicationsByDomainQueuestatistics

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve statistics for persistent queues.
Requires 'Read Applications' role.

Path Parameters

domain *: string
Application domain name

Query Parameters

endDate: string
statistics: array
interval: integer
offset *: integer
queueName *: string
limit *: integer
startDate: string

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "queues": [ { "id": "54f7ed78e4b0d48f31a30891_54f87d13e4b0d48f320c66cb_A9452D1A86C11FD2E70F2481D99B31", "name": "seda.queue(helloworldFlow.stage1)", "queued": 0, "inFlight": 0, "status": "NORMAL" } ], "queueStatistics": [ { "id": "54f7ed78e4b0d48f31a30891_54f87d13e4b0d48f320c66cb_A9452D1A86C11FD2E70F2481D99B31", "statistics": { "queued": {}, "inFlight": {}, "dequeued": {} } } ], "total": 1 }

Get V2Applications By Domain Staticips getV2ApplicationsByDomainStaticips

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve all the static IP addresses related with the application

Path Parameters

domain *: string
Application domain name

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "total": 2, "data": [ { "regionId": "us-east-1", "regionName": "US East (N. Virginia)", "type": "vpc", "address": "0.0.0.0", "state": "IN_USE" }, { "regionId": "us-west-2", "regionName": "US West (Oregon)", "type": "vpc", "address": "0.0.0.0", "state": "ASSIGNED" } ] }

Create V2Applications By Domain Staticips createV2ApplicationsByDomainStaticips

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Request a static IP for the application.

Path Parameters

domain *: string
Application domain name

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json
region: string

Response

Static IP is assigned to the application

Delete V2Applications By Domain Staticips By Region deleteV2ApplicationsByDomainStaticipsByRegion

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Release any unused static IP address(es) assigned to the application for that region back to the pool.

Path Parameters

domain *: string
Application domain name
region *: string
the region

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

IP address is successfully released back to the pool.

Get V2Applications By Domain Deployments getV2ApplicationsByDomainDeployments

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
description: Retrieve deploymentIds and InstanceIds using this API. These Ids are useful for downloading mule application and worker logs.

Path Parameters

domain *: string
Application domain name

Query Parameters

limit: integer
offset: integer
orderByDate: string
loggingVersion: string

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "deploymentId": "566f011be4b06b370949daff", "createTime": "2015-12-14T17:49:15.731000+00:00", "startTime": "2015-12-14T17:49:19.329000+00:00", "endTime": "2015-12-14T17:53:52.828000+00:00", "instances": [ { "instanceId": "566f011be4b06b370949daff-0", "publicIPAddress": "52.91.11.88", "status": "STARTED", "region": "us-east-1" } ] }, { "deploymentId": "566f00c2e4b06b3709496e0d", "createTime": "2015-12-14T17:47:46.833000+00:00", "startTime": "2015-12-14T17:47:49.282000+00:00", "endTime": "2015-12-14T17:49:18.366000+00:00", "instances": [] }, { "deploymentId": "566efefae4b06b3709475a6b", "createTime": "2015-12-14T17:40:10.659000+00:00", "startTime": "2015-12-14T17:40:14.002000+00:00", "endTime": "2015-12-14T17:43:25.923000+00:00", "instances": [] }, { "deploymentId": "566efdd5e4b06b37094601dc", "createTime": "2015-12-14T17:35:17.351000+00:00", "startTime": "2015-12-14T17:35:18.228000+00:00", "endTime": "2015-12-14T17:38:30.207000+00:00", "instances": [] }, { "deploymentId": "566efdd2e4b06b370945ff40", "createTime": "2015-12-14T17:35:14.444000+00:00", "startTime": "2015-12-14T17:35:18.231000+00:00", "endTime": "2015-12-14T17:35:18.356000+00:00", "instances": [] } ], "total": 5 }

Get V2Applications By Domain Deployments By Deploymentid Logs getV2ApplicationsByDomainDeploymentsByDeploymentidLogs

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
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

Path Parameters

domain *: string
Application domain name
deploymentId *: string

Query Parameters

limit: integer

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "loggerName": "org.mule.api.processor.LoggerMessageProcessor", "threadName": "[test-test].Copy_of_echoFlow.stage1.02", "timestamp": 1450128121850, "message": "\norg.mule.DefaultMuleMessage\n{\n id=b751b960-a2a8-11e5-9d9b-0e4b77f24b53\n payload=org.glassfish.grizzly.utils.BufferInputStream\n correlationId=<not set>\n correlationGroup=-1\n correlationSeq=-1\n encoding=UTF-8\n exceptionPayload=<not set>\n\nMessage properties:\n INVOCATION scoped properties:\n pollingFrequency=1000\n INBOUND scoped properties:\n MULE_ORIGINATING_ENDPOINT=endpoint.polling.1912630717\n cache-control=public, no-cache=\"Set-Cookie\", max-age=21\n cf-ray=254cf63924c50097-IAD\n connection=keep-alive\n content-type=text/html; charset=utf-8\n date=Mon, 14 Dec 2015 21:22:01 GMT\n expires=Mon, 14 Dec 2015 21:22:23 GMT\n http.reason=OK\n http.status=200\n last-modified=Mon, 14 Dec 2015 21:21:23 GMT\n server=cloudflare-nginx\n set-cookie=[__cfduid=d267b5965fec19705b85e5d82160b774d1450128121; expires=Tue, 13-Dec-16 21:22:01 GMT; path=/; domain=.stackoverflow.com; HttpOnly, prov=79f490c4-c64a-4de6-80a3-36b6f19f9cbc; domain=.stackoverflow.com; expires=Fri, 01-Jan-2055 00:00:00 GMT; path=/; HttpOnly]\n transfer-encoding=chunked\n vary=*\n x-frame-options=SAMEORIGIN\n x-request-guid=2f2996ba-bd71-43ac-bab2-d0e5682ebf51\n OUTBOUND scoped properties:\n SESSION scoped properties:\n}", "priority": "INFO", "instanceId": "566f011be4b06b370949daff-0" }, { "loggerName": "org.mule.api.processor.LoggerMessageProcessor", "threadName": "[test-test].echoFlow.stage1.02", "timestamp": 1450128121851, "message": "\norg.mule.DefaultMuleMessage\n{\n id=b7522e90-a2a8-11e5-9d9b-0e4b77f24b53\n payload=org.glassfish.grizzly.utils.BufferInputStream\n correlationId=<not set>\n correlationGroup=-1\n correlationSeq=-1\n encoding=UTF-8\n exceptionPayload=<not set>\n\nMessage properties:\n INVOCATION scoped properties:\n pollingFrequency=1000\n INBOUND scoped properties:\n MULE_ORIGINATING_ENDPOINT=endpoint.polling.1912630717\n cache-control=public, no-cache=\"Set-Cookie\", max-age=21\n cf-ray=254cf63933d2087a-IAD\n connection=keep-alive\n content-type=text/html; charset=utf-8\n date=Mon, 14 Dec 2015 21:22:01 GMT\n expires=Mon, 14 Dec 2015 21:22:23 GMT\n http.reason=OK\n http.status=200\n last-modified=Mon, 14 Dec 2015 21:21:23 GMT\n server=cloudflare-nginx\n set-cookie=[__cfduid=d8f18998797a26f0957f21db409e1741d1450128121; expires=Tue, 13-Dec-16 21:22:01 GMT; path=/; domain=.stackoverflow.com; HttpOnly, prov=7809cd0f-2cbe-4a8f-9df2-c5373732961d; domain=.stackoverflow.com; expires=Fri, 01-Jan-2055 00:00:00 GMT; path=/; HttpOnly]\n transfer-encoding=chunked\n vary=*\n x-frame-options=SAMEORIGIN\n x-request-guid=169bb6da-6b64-41ee-846a-fda65c51fbf1\n OUTBOUND scoped properties:\n SESSION scoped properties:\n}", "priority": "INFO", "instanceId": "566f011be4b06b370949daff-0" }, { "loggerName": "org.mule.api.processor.LoggerMessageProcessor", "threadName": "[test-test].Copy_of_echoFlow.stage1.02", "timestamp": 1450128143460, "message": "\norg.mule.DefaultMuleMessage\n{\n id=c4334d10-a2a8-11e5-9d9b-0e4b77f24b53\n payload=org.glassfish.grizzly.utils.BufferInputStream\n correlationId=<not set>\n correlationGroup=-1\n correlationSeq=-1\n encoding=UTF-8\n exceptionPayload=<not set>\n\nMessage properties:\n INVOCATION scoped properties:\n pollingFrequency=1000\n INBOUND scoped properties:\n MULE_ORIGINATING_ENDPOINT=endpoint.polling.1912630717\n cache-control=public, no-cache=\"Set-Cookie\", max-age=40\n cf-ray=254cf6c047f52456-IAD\n connection=keep-alive\n content-type=text/html; charset=utf-8\n date=Mon, 14 Dec 2015 21:22:23 GMT\n expires=Mon, 14 Dec 2015 21:23:03 GMT\n http.reason=OK\n http.status=200\n last-modified=Mon, 14 Dec 2015 21:22:03 GMT\n server=cloudflare-nginx\n set-cookie=[__cfduid=daba5383a0f8ede6ff1c538ca4eade3fa1450128143; expires=Tue, 13-Dec-16 21:22:23 GMT; path=/; domain=.stackoverflow.com; HttpOnly, prov=6844e5be-37f5-439f-b853-fb47c747d92d; domain=.stackoverflow.com; expires=Fri, 01-Jan-2055 00:00:00 GMT; path=/; HttpOnly]\n transfer-encoding=chunked\n vary=*\n x-frame-options=SAMEORIGIN\n x-request-guid=0255f6eb-9993-4a1e-91e8-3fbfbce0f277\n OUTBOUND scoped properties:\n SESSION scoped properties:\n}", "priority": "INFO", "instanceId": "566f011be4b06b370949daff-0" } ], "total": 3 }

Get V2Applications By Domain Instances By Instanceid Logs getV2ApplicationsByDomainInstancesByInstanceidLogs

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
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

Path Parameters

domain *: string
Application domain name
instanceId *: string
instanceId retrieved from /deployments API

Query Parameters

limit: integer
offset: integer
tail: boolean

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "loggerName": "org.mule.module.launcher.application.DefaultMuleApplication", "threadName": "qtp18605202-31", "timestamp": 1450115553412, "message": "\n++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n+ Initializing app 'test-test' +\n++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++", "priority": "INFO" }, { "loggerName": "com.mulesoft.ch.monitoring.MonitoringCoreExtension", "threadName": "qtp18605202-31", "timestamp": 1450115554065, "message": "Monitoring enabled: true", "priority": "INFO" }, { "loggerName": "com.mulesoft.ch.monitoring.MonitoringCoreExtension", "threadName": "qtp18605202-31", "timestamp": 1450115554066, "message": "Registering ping flow injector...", "priority": "INFO" }, { "loggerName": "com.mulesoft.ch.queue.boot.PersistentQueueCoreExtension", "threadName": "qtp18605202-31", "timestamp": 1450115554083, "message": "The PersistentQueueManager is NOT configured. The normal VM queue manager will be used.", "priority": "INFO" }, { "loggerName": "org.mule.lifecycle.AbstractLifecycleManager", "threadName": "qtp18605202-31", "timestamp": 1450115554119, "message": "Initialising RegistryBroker", "priority": "INFO" }, { "loggerName": "org.mule.module.extension.internal.manager.DefaultExtensionManager", "threadName": "qtp18605202-31", "timestamp": 1450115554265, "message": "Starting discovery of extensions", "priority": "INFO" }, { "loggerName": "org.mule.module.extension.internal.manager.DefaultExtensionManager", "threadName": "qtp18605202-31", "timestamp": 1450115555132, "message": "Discovered 1 extensions", "priority": "INFO" }, { "loggerName": "org.mule.module.extension.internal.manager.DefaultExtensionManager", "threadName": "qtp18605202-31", "timestamp": 1450115555132, "message": "Registering extension validation (version 3.7)", "priority": "INFO" }, { "loggerName": "org.mule.config.spring.MuleArtifactContext", "threadName": "qtp18605202-31", "timestamp": 1450115555560, "message": "Refreshing org.mule.config.spring.MuleArtifactContext@49cfd433: startup date [Mon Dec 14 17:52:35 UTC 2015]; root of context hierarchy", "priority": "INFO" }, { "loggerName": "org.mule.config.spring.processors.NoDevkitInjectorProcessor", "threadName": "qtp18605202-31", "timestamp": 1450115559139, "message": "JSR-330 'javax.inject.Inject' annotation found and supported for autowiring", "priority": "INFO" }, { "loggerName": "org.springframework.beans.factory.support.DefaultListableBeanFactory", "threadName": "qtp18605202-31", "timestamp": 1450115559778, "message": "Bean creation exception on FactoryBean type check: org.springframework.beans.factory.BeanCurrentlyInCreationException: Error creating bean with name '_defaultUserObjectStore': Requested bean is currently in creation: Is there an unresolvable circular reference?", "priority": "WARN" }, { "loggerName": "org.springframework.beans.factory.support.DefaultListableBeanFactory", "threadName": "qtp18605202-31", "timestamp": 1450115559916, "message": "Bean creation exception on FactoryBean type check: org.springframework.beans.factory.BeanCurrentlyInCreationException: Error creating bean with name '_defaultUserObjectStore': Requested bean is currently in creation: Is there an unresolvable circular reference?", "priority": "WARN" }, { "loggerName": "org.mule.lifecycle.AbstractLifecycleManager", "threadName": "qtp18605202-31", "timestamp": 1450115562916, "message": "Initialising connector: connector.polling.mule.default", "priority": "INFO" }, { "loggerName": "org.mule.lifecycle.AbstractLifecycleManager", "threadName": "qtp18605202-31", "timestamp": 1450115563399, "message": "Initialising model: _muleSystemModel", "priority": "INFO" }, { "loggerName": "org.mule.construct.FlowConstructLifecycleManager", "threadName": "qtp18605202-31", "timestamp": 1450115564260, "message": "Initialising flow: echoFlow", "priority": "INFO" }, { "loggerName": "org.mule.exception.DefaultMessagingExceptionStrategy", "threadName": "qtp18605202-31", "timestamp": 1450115564274, "message": "Initialising exception listener: org.mule.exception.DefaultMessagingExceptionStrategy@681f155", "priority": "INFO" }, { "loggerName": "org.mule.processor.SedaStageLifecycleManager", "threadName": "qtp18605202-31", "timestamp": 1450115564404, "message": "Initialising service: echoFlow.stage1", "priority": "INFO" }, { "loggerName": "org.mule.construct.FlowConstructLifecycleManager", "threadName": "qtp18605202-31", "timestamp": 1450115564469, "message": "Initialising flow: Copy_of_echoFlow", "priority": "INFO" }, { "loggerName": "org.mule.exception.DefaultMessagingExceptionStrategy", "threadName": "qtp18605202-31", "timestamp": 1450115564469, "message": "Initialising exception listener: org.mule.exception.DefaultMessagingExceptionStrategy@5face4a9", "priority": "INFO" }, { "loggerName": "org.mule.processor.SedaStageLifecycleManager", "threadName": "qtp18605202-31", "timestamp": 1450115564474, "message": "Initialising service: Copy_of_echoFlow.stage1", "priority": "INFO" }, { "loggerName": "org.mule.util.journal.TransactionJournal", "threadName": "qtp18605202-31", "timestamp": 1450115564522, "message": "Using files for tx logs /opt/mule/mule-3.7.2-R44/./.mule/test-test/queue-tx-log/tx1.log and /opt/mule/mule-3.7.2-R44/./.mule/test-test/queue-tx-log/tx2.log", "priority": "INFO" }, { "loggerName": "org.mule.util.journal.TransactionJournal", "threadName": "qtp18605202-31", "timestamp": 1450115564523, "message": "Using files for tx logs /opt/mule/mule-3.7.2-R44/./.mule/test-test/queue-xa-tx-log/tx1.log and /opt/mule/mule-3.7.2-R44/./.mule/test-test/queue-xa-tx-log/tx2.log", "priority": "INFO" }, { "loggerName": "org.mule.config.spring.SpringXmlConfigurationBuilder", "threadName": "qtp18605202-31", "timestamp": 1450115564717, "message": "Configured Mule using \"org.mule.config.spring.SpringXmlConfigurationBuilder\" with configuration resource(s): \"[ConfigResource{resourceName='/opt/mule/mule-3.7.2-R44/apps/test-test/queue-test2.xml'}]\"", "priority": "INFO" } ], "total": 14 }

Get V2Applications By Domain Instances By Instanceid Diagnostics getV2ApplicationsByDomainInstancesByInstanceidDiagnostics

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
description: Retrieve thread dump of a worker.

Path Parameters

domain *: string
Application domain name
instanceId *: string
instanceId retrieved from /deployments API

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.

Get V2Applications By Domain Instances By Instanceid Log File getV2ApplicationsByDomainInstancesByInstanceidLogFile

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
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

Path Parameters

domain *: string
Application domain name
instanceId *: string
instanceId retrieved from /deployments API

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.

Delete V2Applications By Domain Insight Transactions Replays deleteV2ApplicationsByDomainInsightTransactionsReplays

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Deletes Replay Data for all the transactions of the given application

Path Parameters

domain *: string
Application domain name

Response

Replay Data deleted successfully

Get V2Applications By Domain Insight Transactions Hasreplays getV2ApplicationsByDomainInsightTransactionsHasreplays

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Checks if Replay Data Exists on Amazon S3 for the given application

Path Parameters

domain *: string
Application domain name

Response

Successful operation.
Examples
application/json
{ "objectsExist": true }

Get V2Applications By Domain Autoscalepolicies getV2ApplicationsByDomainAutoscalepolicies

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve auto-scaling policies

Path Parameters

domain *: string
Application domain name

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
[ { "id": "5994bb6ee4b0fce59b281798", "enabled": true, "maxScale": 2, "minScale": 1, "scaleType": "WORKER_COUNT", "description": "policy_name", "metric": "CPU", "scaleUpNextScaleWaitMins": 30, "scaleDownNextScaleWaitMins": 30, "scaleUp": { "value": 80, "periodMins": 1, "periodCount": 10 }, "scaleDown": { "value": 20, "periodMins": 1, "periodCount": 10 } } ]

Create V2Applications By Domain Autoscalepolicies createV2ApplicationsByDomainAutoscalepolicies

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create new Auto-scaling Policy

Path Parameters

domain *: string
Application domain name

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json
description: string
scaleType: string
The scale type of the auto scaling policy
metric: string
The metric based on which auto scaling policy scales
maxScale: number
The maximum number of workers or size of workers for auto scaling
minScale: number
The minimum number of workers or size of workers for auto scaling
scaleUpNextScaleWaitMins: integer
Number of minutes to wait before applying new scale up policy
scaleDownNextScaleWaitMins: integer
Number of minutes to wait before applying new scale down policy
scaleUp: object
Scale up policy
scaleDown: object
Scale down policy

Response

New Auto-scaling Policy created
Examples
application/json
{ "id": "5994bb6ee4b0fce59b281798", "enabled": true, "maxScale": 2, "minScale": 1, "scaleType": "WORKER_COUNT", "description": "policy_name", "metric": "CPU", "scaleUpNextScaleWaitMins": 30, "scaleDownNextScaleWaitMins": 30, "scaleUp": { "value": 80, "periodMins": 1, "periodCount": 10 }, "scaleDown": { "value": 20, "periodMins": 1, "periodCount": 10 } }

Get V2Applications By Domain Autoscalepolicies By Policyid getV2ApplicationsByDomainAutoscalepoliciesByPolicyid

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve specified auto scaling policy

Path Parameters

domain *: string
Application domain name
policyId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "id": "5994bb6ee4b0fce59b281798", "enabled": true, "maxScale": 2, "minScale": 1, "scaleType": "WORKER_COUNT", "description": "policy_name", "metric": "CPU", "scaleUpNextScaleWaitMins": 30, "scaleDownNextScaleWaitMins": 30, "scaleUp": { "value": 80, "periodMins": 1, "periodCount": 10 }, "scaleDown": { "value": 20, "periodMins": 1, "periodCount": 10 } }

Update V2Applications By Domain Autoscalepolicies By Policyid updateV2ApplicationsByDomainAutoscalepoliciesByPolicyid

PUT

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update specified auto scaling policy

Path Parameters

domain *: string
Application domain name
policyId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json
id: string
The auto scaling policy ID
enabled: boolean
Whether the policy is enabled
description: string
scaleType: string
The scale type of the auto scaling policy
metric: string
The metric based on which auto scaling policy scales
maxScale: number
The maximum number of workers or size of workers for auto scaling
minScale: number
The minimum number of workers or size of workers for auto scaling
scaleUpNextScaleWaitMins: number
Number of minutes to wait before applying new scale up policy
scaleDownNextScaleWaitMins: number
Number of minutes to wait before applying new scale down policy
scaleUp: object
Scale up policy
scaleDown: object
Scale down policy

Response

Successful operation.
Examples
application/json
{ "id": "5994bb6ee4b0fce59b281798", "enabled": true, "maxScale": 2, "minScale": 1, "scaleType": "WORKER_COUNT", "description": "policy_name", "metric": "CPU", "scaleUpNextScaleWaitMins": 30, "scaleDownNextScaleWaitMins": 30, "scaleUp": { "value": 80, "periodMins": 1, "periodCount": 10 }, "scaleDown": { "value": 20, "periodMins": 1, "periodCount": 10 } }

Delete V2Applications By Domain Autoscalepolicies By Policyid deleteV2ApplicationsByDomainAutoscalepoliciesByPolicyid

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Delete auto-scaling policy

Path Parameters

domain *: string
Application domain name
policyId *: string

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Auto-scaling Policy deleted

Create V2Applications By Domain Logs createV2ApplicationsByDomainLogs

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
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

Path Parameters

domain *: string
Application domain name

Request Body

json

Response

Successful operation.
Examples
application/json
[ { "recordId": "16660AA8FF15bb55a67c9801713539d3028-05BB55A70000000D7", "deploymentId": "5bb55a67c9801713539d3028", "instanceId": "5bb55a67c9801713539d3028-0", "line": 215, "event": { "loggerName": "com.mulesoft.agent.buffer.BufferedHandler", "threadName": "pool-34-thread-1", "timestamp": 1539220082673, "message": "Trying to retry flushing on buffer. Remaining attempts: 2", "priority": "INFO" } }, { "recordId": "166613ED4455bb55a67c9801713539d3028-05BB55A70000000D8", "deploymentId": "5bb55a67c9801713539d3028", "instanceId": "5bb55a67c9801713539d3028-0", "line": 216, "event": { "loggerName": "com.mulesoft.agent.buffer.BufferedHandler", "threadName": "pool-34-thread-1", "timestamp": 1539229799493, "message": "Trying to retry flushing on buffer. Remaining attempts: 2", "priority": "INFO" } } ]

Get Account getAccount

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Retrieve information about the logged-in user.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "id": "54f7ed7ae4b0d48f31a3099e", "username": "fred-smith", "firstName": "Fred", "lastName": "Smith", "email": "fredsmith@example.com", "organizationName": "Example-Org", "defaultEnvironment": "54f7ed78e4b0d48f31a30892", "acceptedTermsOfService": false, "created": "2015-03-05T05:45:29.867000+00:00", "updated": "2015-03-05T05:45:29.867000+00:00", "enabled": true, "organization": { "id": "54f7ed78e4b0d48f31a30891", "csId": "e8ceea04-621e-4f69-a3c8-3f68ad7a99e2", "name": "Example-Org", "adminUserId": "54f7ed7ae4b0d48f31a3099e", "adminUsername": "fred-smith", "created": "2015-03-05T05:45:28.652000+00:00", "updated": "2015-03-05T05:45:28.652000+00:00", "enabled": true, "expiration": { "date": "2015-04-04T05:45:28.652000+00:00" }, "globalDeployment": { "enabled": false }, "multitenancy": { "enabled": false, "maxTenants": 0 }, "plan": { "subscriptionLevel": "Free", "maxProductionWorkers": 1, "maxSandboxWorkers": 1, "workerTypes": [ { "name": "Micro", "workerVal": 0.1, "weight": 0.1, "cpu": "0.1 vCores", "memory": "500 MB memory" }, { "name": "Small", "workerVal": 0.2, "weight": 0.2, "cpu": "0.2 vCores", "memory": "1 GB memory" }, { "name": "Medium", "workerVal": 1, "weight": 1, "cpu": "1 vCore", "memory": "1.5 GB memory" }, { "name": "Large", "workerVal": 2, "weight": 2, "cpu": "2 vCores", "memory": "3.5 GB meomory" }, { "name": "xLarge", "workerVal": 4, "weight": 4, "cpu": "4 vCores", "memory": "7.5 GB memory" } ], "maxStandardConnectors": 5, "maxPremiumConnectors": 1, "apiFabric": false, "secureDataGateway": true, "roleBasedAccess": true, "directVpn": false }, "downloadApplicationsEnabled": true, "persistentQueuesEncryptionEnabled": false, "usage": { "sandboxes": 0, "productions": 1, "standardConnectors": 0, "premiumConnectors": 0, "productionApplications": 1, "sandboxApplications": 0, "productionTenants": 0, "sandboxTenants": 0, "productionWorkers": 1, "sandboxWorkers": 0 } }, "csToken": "22405eb8-bf43-451a-a3f9-395dd6c1588b", "environments": [ { "id": "54f7ed78e4b0d48f31a30892", "csOrgId": "e8ceea04-621e-4f69-a3c8-3f68ad7a99e2", "name": "Production", "isProduction": true, "production": true } ], "activeEnvironment": "54f7ed78e4b0d48f31a30892" }

Get Applications getApplications

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve all applications in the specified environment.
Requires 'Read Applications' role.

Query Parameters

retrieveStatistics *: boolean
Include statistics for each application in the response
period *: number
intervalCount *: number

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
[ { "id": "54f7eda4e4b008704d5a1d98", "href": "http://anypoint.mulesoft.com:8080/api/applications/example-app", "domain": "example-app", "fullDomain": "example-app.cloudhub.io", "properties": {}, "propertiesOptions": {}, "status": "UNDEPLOYED", "workers": 1, "workerType": "Medium", "lastUpdateTime": 1425534372131, "remainingWorkerCount": 0, "muleVersion": "3.5.2", "supportedVersions": [ "3.3.2", "3.5.2" ], "instanceSize": "m3.medium", "tenants": 0, "region": "us-east-1", "userId": "54f7ed7ae4b0d48f31a3099e", "userName": "fred-smith", "vpnConfig": { "network": "203.0.113.0", "mask": 27 }, "hasFile": false, "staticIPsEnabled": false, "multitenanted": false, "persistentQueues": false, "monitoringAutoRestart": true, "encryptedPersistentQueues": false, "ipAddresses": [], "secureDataGateway": { "connected": false }, "secureDataGatewayEnabled": false, "vpnEnabled": false } ]

Create Applications createApplications

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a new application.
Requires 'Create Applications' role.

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Successful operation.
Examples
application/json
{ "id": "55526046e4b0e5a17c2a0bd3", "href": "http://anypoint.mulesoft.com:8080/api/applications/example-app2", "domain": "example-app2", "fullDomain": "example-app2.cloudhub.io", "properties": {}, "propertiesOptions": {}, "status": "UNDEPLOYED", "workers": 1, "workerType": "Medium", "lastUpdateTime": 1431461958989, "remainingWorkerCount": 0, "muleVersion": "3.6.1", "supportedVersions": [ "3.6.1" ], "instanceSize": "m3.medium", "tenants": 0, "region": "us-east-1", "userId": "54f7ed7ae4b0d48f31a3099e", "userName": "fred-smith", "vpnConfig": { "network": "203.0.113.0", "mask": 27 }, "hasFile": false, "staticIPsEnabled": false, "multitenanted": false, "persistentQueues": false, "monitoringAutoRestart": true, "encryptedPersistentQueues": false, "ipAddresses": [], "secureDataGateway": { "connected": false }, "secureDataGatewayEnabled": false, "vpnEnabled": false }

Get Applications Domains By Domain getApplicationsDomainsByDomain

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Check if the specified domain is available.
Requires 'Read Applications' role.

Path Parameters

domain *: string
The domain to identify the target resource.

Response

Domain name is valid. Availability specified in the response body.
Examples
application/json
{ "available": true }

Get Applications By Domain getApplicationsByDomain

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve a single application by name.
Requires 'Read Applications' role.

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "id": "55526046e4b0e5a17c2a0bd3", "href": "http://anypoint.mulesoft.com:8080/api/applications/example-app2", "domain": "example-app2", "fullDomain": "example-app2.cloudhub.io", "properties": {}, "propertiesOptions": {}, "status": "UNDEPLOYED", "workers": 1, "workerType": "Medium", "lastUpdateTime": 1431461958989, "remainingWorkerCount": 0, "muleVersion": "3.6.1", "supportedVersions": [ "3.6.1" ], "instanceSize": "m3.medium", "tenants": 0, "region": "us-east-1", "userId": "54f7ed7ae4b0d48f31a3099e", "userName": "fred-smith", "vpnConfig": { "network": "203.0.113.0", "mask": 27 }, "hasFile": false, "staticIPsEnabled": false, "multitenanted": false, "persistentQueues": false, "monitoringAutoRestart": true, "encryptedPersistentQueues": false, "ipAddresses": [], "secureDataGateway": { "connected": false }, "secureDataGatewayEnabled": false, "vpnEnabled": false }

Update Applications By Domain updateApplicationsByDomain

PUT

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update a single application.
Requires 'Manage Settings' role.

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Successful operation.
Examples
application/json
{ "id": "55526046e4b0e5a17c2a0bd3", "href": "http://anypoint.mulesoft.com:8080/api/applications/example-app2", "domain": "example-app2", "fullDomain": "example-app2.cloudhub.io", "properties": {}, "propertiesOptions": {}, "status": "UNDEPLOYED", "workers": 1, "workerType": "Medium", "lastUpdateTime": 1431461958989, "remainingWorkerCount": 0, "muleVersion": "3.6.1", "supportedVersions": [ "3.6.1" ], "instanceSize": "m3.medium", "tenants": 0, "region": "us-east-1", "userId": "54f7ed7ae4b0d48f31a3099e", "userName": "fred-smith", "vpnConfig": { "network": "203.0.113.0", "mask": 27 }, "hasFile": false, "staticIPsEnabled": false, "multitenanted": false, "persistentQueues": false, "monitoringAutoRestart": true, "encryptedPersistentQueues": false, "ipAddresses": [], "secureDataGateway": { "connected": false }, "secureDataGatewayEnabled": false, "vpnEnabled": false }

Delete Applications By Domain deleteApplicationsByDomain

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Delete a single application.
Requires 'Delete applications' role.

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Application deleted successfully.

Get Applications By Domain Download By Filename getApplicationsByDomainDownloadByFilename

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Requires 'Download Applications' role.

Path Parameters

domain *: string
The domain to identify the target resource.
filename *: string
The filename to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.

Get Applications By Domain Logs Levels getApplicationsByDomainLogsLevels

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Get all log levels for current application

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
[ { "packageName": "com.mulesoft", "level": "INFO" } ]

Update Applications By Domain Logs Levels updateApplicationsByDomainLogsLevels

PUT

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Add/Update log levels for current application

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Successful operation.

Get Applications By Domain Logs Levels By Name getApplicationsByDomainLogsLevelsByName

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get single log level with name

Path Parameters

domain *: string
The domain to identify the target resource.
name *: string
The name to identify the target resource.

Response

Successful operation.
Examples
application/json
{ "packageName": "com.mulesoft", "level": "INFO" }

Delete Applications By Domain Logs Levels By Name deleteApplicationsByDomainLogsLevelsByName

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete single log level with name

Path Parameters

domain *: string
The domain to identify the target resource.
name *: string
The name to identify the target resource.

Response

Log Level deleted succesfully

Get Applications By Domain Notifications getApplicationsByDomainNotifications

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
To use a non-default environment, set this header

Path Parameters

domain *: string
The domain to identify the target resource.

Query Parameters

status *: string
limit *: integer
offset *: integer

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "total": 1, "data": [ { "id": "5553812ee4b0a1b2e9faf2f9", "domain": "jeff-1amstudios-test", "message": "hello world", "createdAt": "2015-05-13T16:51:58.854000+00:00", "read": false, "href": "http://anypoint.mulesoft.com:8080/api/notifications/5553812ee4b0a1b2e9faf2f9" } ] }

Get Applications By Domain Schedules getApplicationsByDomainSchedules

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a schedules.

Path Parameters

domain *: string
The domain to identify the target resource.

Response

Successful operation.
Examples
application/json
[ { "id": "schedule-id1", "flow": "Copy_of_echoFlow", "name": "Copy_of_echoFlow Poll", "href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_Copy_of_echoFlow_polling_Copy_of_echoFlow_1", "lastRun": "2015-12-09T01:22:59.752000+00:00", "enabled": true, "status": "IDLE", "schedule": { "timeUnit": "seconds", "period": 10 }, "run-href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_Copy_of_echoFlow_polling_Copy_of_echoFlow_1/run" }, { "id": "schedule-id2", "flow": "echoFlow", "name": "echoFlow Poll", "href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_echoFlow_polling_echoFlow_1", "lastRun": "2015-12-09T01:22:54.343000+00:00", "enabled": true, "status": "IDLE", "schedule": { "timeUnit": "seconds", "period": 30 }, "run-href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_echoFlow_polling_echoFlow_1/run" }, { "id": "schedule-id3", "flow": "echoFlow1", "name": "echoFlow Poll1", "href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_echoFlow_polling_echoFlow_1", "lastRun": "2015-12-09T01:22:54.343000+00:00", "enabled": true, "status": "IDLE", "schedule": { "timeUnit": "seconds", "period": 30 }, "run-href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_echoFlow_polling_echoFlow_1/run" } ]

Update Applications By Domain Schedules updateApplicationsByDomainSchedules

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Batch update of the schedules. Enable/Disable or run all or subset of schedules.

Path Parameters

domain *: string
The domain to identify the target resource.

Request Body

json

Response

Successful operation.
Examples
application/json
[ { "id": "schedule-id1", "flow": "Copy_of_echoFlow", "name": "Copy_of_echoFlow Poll", "href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_Copy_of_echoFlow_polling_Copy_of_echoFlow_1", "lastRun": "2015-12-09T01:22:59.752000+00:00", "enabled": true, "status": "IDLE", "schedule": { "timeUnit": "seconds", "period": 10 }, "run-href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_Copy_of_echoFlow_polling_Copy_of_echoFlow_1/run" }, { "id": "schedule-id2", "flow": "echoFlow", "name": "echoFlow Poll", "href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_echoFlow_polling_echoFlow_1", "lastRun": "2015-12-09T01:22:54.343000+00:00", "enabled": true, "status": "IDLE", "schedule": { "timeUnit": "seconds", "period": 30 }, "run-href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_echoFlow_polling_echoFlow_1/run" }, { "id": "schedule-id3", "flow": "echoFlow1", "name": "echoFlow Poll1", "href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_echoFlow_polling_echoFlow_1", "lastRun": "2015-12-09T01:22:54.343000+00:00", "enabled": true, "status": "IDLE", "schedule": { "timeUnit": "seconds", "period": 30 }, "run-href": "http://qa.anypoint.mulesoft.com:8080/api/applications/poll-test/schedules/565f7691e4b0365bb4f4d774_echoFlow_polling_echoFlow_1/run" } ]

Get Applications By Domain Schedules By Jobid getApplicationsByDomainSchedulesByJobid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a schedules.

Path Parameters

domain *: string
The domain to identify the target resource.
jobId *: string
The job ID to identify the target resource.

Response

Successful operation.
Examples
application/json
{ "id": "566a0359e4b0dc517fef5bbb_echoFlow_polling_echoFlow_1", "flow": "echoFlow", "name": "echoFlow Poll", "href": "http://anypoint.mulesoft.com:8080/api/applications/polltest/schedules/566a0359e4b0dc517fef5bbb_echoFlow_polling_echoFlow_1", "lastRun": "2015-12-10T23:11:04.980000+00:00", "enabled": true, "status": "IDLE", "schedule": { "timeUnit": "minutes", "period": 10 }, "run-href": "http://anypoint.mulesoft.com:8080/api/applications/polltest/schedules/566a0359e4b0dc517fef5bbb_echoFlow_polling_echoFlow_1/run" }

Update Applications By Domain Schedules By Jobid updateApplicationsByDomainSchedulesByJobid

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replaces a schedules.

Path Parameters

domain *: string
The domain to identify the target resource.
jobId *: string
The job ID to identify the target resource.

Request Body

json

Response

Successful operation.
Examples
application/json
{ "message": "Operation completed successfully." }

Create Applications By Domain Schedules By Jobid Run createApplicationsByDomainSchedulesByJobidRun

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Creates a run.

Path Parameters

domain *: string
The domain to identify the target resource.
jobId *: string
The job ID to identify the target resource.

Response

Successful operation.
Examples
application/json
{ "message": "Operation completed successfully." }

Get Applications By Domain Settings Tracking getApplicationsByDomainSettingsTracking

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a tracking.

Path Parameters

domain *: string
The domain to identify the target resource.

Response

Successful operation.
Examples
application/json
{ "trackingLevel": "METADATA_AND_REPLAY" }

Update Applications By Domain Settings Tracking updateApplicationsByDomainSettingsTracking

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Possible values are 'DISABLED' , 'METADATA' and 'METADATA_AND_REPLAY'.

Path Parameters

domain *: string
The domain to identify the target resource.

Request Body

json

Response

Successful operation.

Get Applications By Domain Statistics getApplicationsByDomainStatistics

GET

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
To use a non-default environment, set this header

Path Parameters

domain *: string
The domain to identify the target resource.

Query Parameters

period *: integer
start *: string(date-time)
end *: string(date-time)
intervalCount *: integer

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "1430867011087": 0, "1430903299087": 2, "1430915395087": 0 }

Get Applications By Domain Status getApplicationsByDomainStatus

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve status of the application.
Requires 'Read Applications' role.

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

UNDEPLOYED - Application has no active servers
DEPLOYING - Some servers are in the process of deploying, but none are running
STARTED - App deployment is successfully completed on at least one server, which is
UNDEPLOYING - App is in the process of shutting down
DEPLOY_FAILED - No deploying or running servers; last deployment attempt was a startup
DELETED - The application is marked like deleted and as soon as all related the app resources

Create Applications By Domain Status createApplicationsByDomainStatus

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update status of the application.
Requires 'Manage Settings' role

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Successful operation.

Get Applications By Domain Tracking Custom Keys getApplicationsByDomainTrackingCustomKeys

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
To use a non-default environment, set this header

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
[ "customkey-1", "customkey-2", "customkey-3" ]

Get Applications By Domain Tracking Searches getApplicationsByDomainTrackingSearches

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
To use a non-default environment, set this header

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "name": "test-query", "searchParameters": [], "startDate": "2012-08-12T04:00:00+00:00", "endDate": "2012-08-13T04:00:00+00:00" }

Create Applications By Domain Tracking Searches By Name createApplicationsByDomainTrackingSearchesByName

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
To use a non-default environment, set this header

Path Parameters

domain *: string
The domain to identify the target resource.
name *: string
The name to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Successful operation.

Update Applications By Domain Tracking Searches By Name updateApplicationsByDomainTrackingSearchesByName

PUT

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
To use a non-default environment, set this header

Path Parameters

domain *: string
The domain to identify the target resource.
name *: string
The name to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Successful operation.

Delete Applications By Domain Tracking Searches By Name deleteApplicationsByDomainTrackingSearchesByName

DELETE

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
To use a non-default environment, set this header

Path Parameters

domain *: string
The domain to identify the target resource.
name *: string
The name to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Operation completed successfully with no content returned.

Get Applications By Domain Tracking Statistics getApplicationsByDomainTrackingStatistics

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve a list of application statistics.
Requires 'Read Applications' role.

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "sampleInterval": 118127558, "samples": [ { "2015-03-05 15:58:11.818000+00:00": 6 }, { "2015-03-07 00:46:59.376000+00:00": 3 } ], "total": 1 }

Create Applications By Domain Tracking Statistics createApplicationsByDomainTrackingStatistics

POST

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Retrieve a list of application statistics, filtered by parameters passed in the request body.
Requires 'Read Applications' role.

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Successful operation.
Examples
application/json
{ "sampleInterval": 118127558, "samples": [ { "2015-03-05 15:58:11.818000+00:00": 6 }, { "2015-03-07 00:46:59.376000+00:00": 3 } ], "total": 1 }

Create Applications By Domain Tracking Transactions createApplicationsByDomainTrackingTransactions

POST

Try it out

Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Retrieve a list of application transactions, filtered by parameters
passed in the request body.
Requires 'Read Applications' role.

Path Parameters

domain *: string
The domain to identify the target resource.

Query Parameters

offset *: integer
count *: integer
total *: boolean

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Successful operation.
Examples
application/json
{ "transactionsSummaries": [ { "id": "3a997e70-f908-11e4-9267-0e3a3095af15", "duration": 234, "started": "2015-05-13T00:37:26.617000+00:00", "status": "COMPLETED", "fields": {} } ], "totalTranscations": 1 }

Get Applications By Domain Tracking Transactions By Transactionid getApplicationsByDomainTrackingTransactionsByTransactionid

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve the events for a single application transaction.
Requires 'Read Applications' role.

Path Parameters

domain *: string
The domain to identify the target resource.
transactionId *: string
The transaction ID to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
[ { "messageId": "3a997e70-f908-11e4-9267-0e3a3095af15", "timestamp": "2015-05-13T00:37:26.617000+00:00", "type": "FLOW_BEGIN", "name": "Flow Began", "flow": "helloworldFlow" }, { "messageId": "3a997e70-f908-11e4-9267-0e3a3095af15", "timestamp": "2015-05-13T00:37:26.846000+00:00", "type": "FLOW_END", "name": "Flow Completed", "flow": "helloworldFlow" }, { "messageId": "3a997e70-f908-11e4-9267-0e3a3095af15", "timestamp": "2015-05-13T00:37:26.851000+00:00", "type": "FLOW_RETURN", "name": "Flow Returned", "flow": "helloworldFlow" } ]

Get Applications By Domain Tracking Transactions By Transactionid By Flowname Replay getApplicationsByDomainTrackingTransactionsByTransactionidByFlownameReplay

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Replay the flow for this transaction. Returns the id of the new flow.

Path Parameters

domain *: string
The domain to identify the target resource.
transactionId *: string
The transaction ID to identify the target resource.
flowName *: string
The flowName to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "id": "flow-id" }

Get Applications By Domain Workers getApplicationsByDomainWorkers

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve workers for the application.
Requires 'Read Applications' role.

Path Parameters

domain *: string
The domain to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
[ { "id": "i-ada16552", "host": "52.7.131.100", "port": 0, "status": "STARTED", "staticIPEnabled": false } ]

Get Mule Versions getMuleVersions

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
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.

Query Parameters

releaseChannel: string
javaVersion *: string
recommended: boolean

Header Parameters

X-ANYPNT-ORG-ID *: string
X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "version": "3.8.2", "displayName": "3.8.2", "recommended": true, "endOfSupportDate": 1507230009992, "endOfLifeDate": 1507230009992, "latestUpdate": { "id": "581bbe7383a74dc0901efd1c", "name": "Initial release", "releaseDate": 1476467030568, "flags": { "performLog4jReplacement": true, "skipMMCPairing": true, "log4j1Used": false, "usingMuleAgent": false, "vpnSupported": true, "monitoringSupported": true, "objectStoreV1": false, "loggingNgSupported": true, "diagnosticsSupported": true, "persistentQueuesSupported": true } }, "state": "ACTIVE", "releaseChannel": "NONE", "javaVersion": "8", "default": false } ], "total": 16 }

Get Mule Versions By Version getMuleVersionsByVersion

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieve specified Mule Version

Path Parameters

version *: string
The version to identify the target resource.

Response

Successful operation.
Examples
application/json
{ "version": "3.8.2", "displayName": "3.8.2", "recommended": true, "endOfSupportDate": 1507230009992, "endOfLifeDate": 1507230009992, "latestUpdate": { "id": "581bbe7383a74dc0901efd1c", "name": "Initial release", "releaseDate": 1476467030568, "flags": { "performLog4jReplacement": true, "skipMMCPairing": true, "log4j1Used": false, "usingMuleAgent": false, "vpnSupported": true, "monitoringSupported": true, "objectStoreV1": false, "loggingNgSupported": true, "diagnosticsSupported": true, "persistentQueuesSupported": true } }, "state": "ACTIVE", "releaseChannel": "NONE", "javaVersion": "8", "default": false }

Get Mule Versions By Version Updates By Updateid getMuleVersionsByVersionUpdatesByUpdateid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieve a single update for a muleVersion

Path Parameters

version *: string
The version to identify the target resource.
updateId *: string
The update ID to identify the target resource.

Response

Successful operation.
Examples
application/json
{ "id": "581bbe7383a74dc0901efd1c", "name": "Initial release", "releaseDate": 1476467030568, "flags": { "performLog4jReplacement": true, "skipMMCPairing": true, "log4j1Used": false, "usingMuleAgent": false, "vpnSupported": true, "monitoringSupported": true, "objectStoreV1": false, "loggingNgSupported": true, "diagnosticsSupported": true, "persistentQueuesSupported": true } }

Get Notifications getNotifications

GET

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve notifications.
Requires 'Read Applications' role.

Query Parameters

domain: string
limit: integer
offset: integer
status: string
search: string

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "total": 1, "data": [ { "id": "5553812ee4b0a1b2e9faf2f9", "domain": "jeff-1amstudios-test", "message": "hello world", "createdAt": "2015-05-13T16:51:58.854000+00:00", "read": false, "href": "http://anypoint.mulesoft.com:8080/api/notifications/5553812ee4b0a1b2e9faf2f9" } ] }

Create Notifications createNotifications

POST

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a new notification

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Resource created successfully.

Update Notifications updateNotifications

PUT

Try it out

Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Mark all notifications for this application as read or unread.
Requires 'Read Applications' role.

Query Parameters

domain *: string

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Operation completed successfully with no content returned.

Get Notifications By Id getNotificationsById

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve a single notification.
Requires 'Read Applications' role.

Path Parameters

id *: string
The id to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "id": "5553812ee4b0a1b2e9faf2f9", "domain": "example-app", "message": "hello world", "createdAt": "2015-05-13T16:51:58.854000+00:00", "read": false, "readOn": "2015-05-13T17:10:15.619000+00:00", "href": "http://anypoint.mulesoft.com:8080/api/notifications/5553812ee4b0a1b2e9faf2f9" }

Update Notifications By Id updateNotificationsById

PUT

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Mark a single notification as read or unread.
Requires 'Read Applications' role.

Path Parameters

id *: string
The id to identify the target resource.

Header Parameters

X-ANYPNT-ENV-ID *: string

Request Body

json

Response

Operation completed successfully with no content returned.

Get Organization getOrganization

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Retrieve the organization attached to the current environment.
Requires 'Organization Admin' role.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "id": "54f7ed78e4b0d48f31a30891", "csId": "e8ceea04-621e-4f69-a3c8-3f68ad7a99e2", "name": "Example Org", "adminUserId": "54f7ed7ae4b0d48f31a3099e", "adminUsername": "fred-smith", "created": "2015-03-05T05:45:28.652000+00:00", "updated": "2015-03-05T05:45:28.652000+00:00", "enabled": true, "expiration": { "date": "2015-04-04T05:45:28.652000+00:00" }, "globalDeployment": { "enabled": false }, "multitenancy": { "enabled": false, "maxTenants": 0 }, "plan": { "subscriptionLevel": "Free", "maxProductionWorkers": 1, "maxSandboxWorkers": 1, "workerTypes": [ { "name": "Micro", "workerVal": 0.1, "weight": 0.1, "cpu": "0.1 vCores", "memory": "500 MB memory" }, { "name": "Small", "workerVal": 0.2, "weight": 0.2, "cpu": "0.2 vCores", "memory": "1 GB memory" }, { "name": "Medium", "workerVal": 1, "weight": 1, "cpu": "1 vCore", "memory": "1.5 GB memory" }, { "name": "Large", "workerVal": 2, "weight": 2, "cpu": "2 vCores", "memory": "3.5 GB meomory" }, { "name": "xLarge", "workerVal": 4, "weight": 4, "cpu": "4 vCores", "memory": "7.5 GB memory" } ], "maxStandardConnectors": 5, "maxPremiumConnectors": 1, "apiFabric": false, "secureDataGateway": true, "roleBasedAccess": true, "directVpn": false }, "downloadApplicationsEnabled": true, "persistentQueuesEncryptionEnabled": false, "usage": { "sandboxes": 0, "productions": 1, "standardConnectors": 0, "premiumConnectors": 0, "productionApplications": 1, "sandboxApplications": 0, "productionTenants": 0, "sandboxTenants": 0, "productionWorkers": 1, "sandboxWorkers": 0 } }

Get Organization Plan getOrganizationPlan

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Retrieve the subscription plan details for the organization.
Requires 'Organization Admin' role.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "subscriptionLevel": "Free", "maxProductionWorkers": 1, "maxSandboxWorkers": 1, "workerTypes": [ { "name": "Micro", "workerVal": 0.1, "weight": 0.1, "cpu": "0.1 vCores", "memory": "500 MB memory" }, { "name": "Small", "workerVal": 0.2, "weight": 0.2, "cpu": "0.2 vCores", "memory": "1 GB memory" }, { "name": "Medium", "workerVal": 1, "weight": 1, "cpu": "1 vCore", "memory": "1.5 GB memory" }, { "name": "Large", "workerVal": 2, "weight": 2, "cpu": "2 vCores", "memory": "3.5 GB meomory" }, { "name": "xLarge", "workerVal": 4, "weight": 4, "cpu": "4 vCores", "memory": "7.5 GB memory" } ], "maxStandardConnectors": 5, "maxPremiumConnectors": 1, "apiFabric": false, "secureDataGateway": true, "roleBasedAccess": true, "globalCloud": false, "directVpn": false }

Get Organization Usage getOrganizationUsage

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Retrieve the the vCore / worker usage for the organization.
Requires 'Organization Admin' role.

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "sandboxes": 0, "productions": 1, "standardConnectors": 0, "premiumConnectors": 0, "productionApplications": 1, "sandboxApplications": 0, "productionTenants": 0, "sandboxTenants": 0, "productionWorkers": 1, "sandboxWorkers": 0 }

Get Organization By Orgid getOrganizationByOrgid

GET

Try it out

Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Retrieve a single organization.
Requires 'Organization Admin' role.

Path Parameters

orgid *: string

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "id": "54f7ed78e4b0d48f31a30891", "csId": "e8ceea04-621e-4f69-a3c8-3f68ad7a99e2", "name": "Example Org", "adminUserId": "54f7ed7ae4b0d48f31a3099e", "adminUsername": "fred-smith", "created": "2015-03-05T05:45:28.652000+00:00", "updated": "2015-03-05T05:45:28.652000+00:00", "enabled": true, "expiration": { "date": "2015-04-04T05:45:28.652000+00:00" }, "globalDeployment": { "enabled": false }, "multitenancy": { "enabled": false, "maxTenants": 0 }, "plan": { "subscriptionLevel": "Free", "maxProductionWorkers": 1, "maxSandboxWorkers": 1, "workerTypes": [ { "name": "Micro", "workerVal": 0.1, "weight": 0.1, "cpu": "0.1 vCores", "memory": "500 MB memory" }, { "name": "Small", "workerVal": 0.2, "weight": 0.2, "cpu": "0.2 vCores", "memory": "1 GB memory" }, { "name": "Medium", "workerVal": 1, "weight": 1, "cpu": "1 vCore", "memory": "1.5 GB memory" }, { "name": "Large", "workerVal": 2, "weight": 2, "cpu": "2 vCores", "memory": "3.5 GB meomory" }, { "name": "xLarge", "workerVal": 4, "weight": 4, "cpu": "4 vCores", "memory": "7.5 GB memory" } ], "maxStandardConnectors": 5, "maxPremiumConnectors": 1, "apiFabric": false, "secureDataGateway": true, "roleBasedAccess": true, "directVpn": false }, "downloadApplicationsEnabled": true, "persistentQueuesEncryptionEnabled": false, "usage": { "sandboxes": 0, "productions": 1, "standardConnectors": 0, "premiumConnectors": 0, "productionApplications": 1, "sandboxApplications": 0, "productionTenants": 0, "sandboxTenants": 0, "productionWorkers": 1, "sandboxWorkers": 0 } }

Get Organizations By Orgid Usage getOrganizationsByOrgidUsage

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieve the the vCore / worker / staticIP usage for the organization.
Requires 'Organization Admin' role.

Path Parameters

orgid *: string

Response

json
Successful operation.
productionVCoresConsumed *: number
sandboxVCoresConsumed *: number
staticIpsConsumed *: integer
Examples
application/json
{ "productionVCoresConsumed": 4, "sandboxVCoresConsumed": 1, "staticIpsConsumed": 10 }

Create Organizations By Orgid Logs Download createOrganizationsByOrgidLogsDownload

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Initiate a log download request for the specified resource.
Requires 'Read Load Balancers' permission.

Path Parameters

orgid *: string

Request Body

json
resourceType *: string
Type of resource to download logs from
resourceName *: string
Name of the resource (e.g., DLB name)
queryType *: string
Type of time query
timeRange: string
Relative time range. Required if queryType is RELATIVE
startTime: string
endTime: string
validityMinutes: integer
maxRows: integer

Response

json
Log download request accepted and processing started
executionName: string
Unique identifier for the download execution
startDate: string
Start date/time of the execution
status: string
Current status of the execution
message: string
Status message
Examples
application/json
{ "executionName": "dlb-logs-my-load-balancer-relative-1765412201", "startDate": "Wed Jan 15 10:30:00 UTC 2025", "status": "RUNNING", "message": "Log download request submitted successfully" }

Get Organizations By Orgid Logs Download Status getOrganizationsByOrgidLogsDownloadStatus

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Check the status of a log download execution.
Returns download URL when processing is complete.
Requires 'Read Load Balancers' permission.

Path Parameters

orgid *: string

Query Parameters

executionName *: string
The execution name returned from the download initiation request

Response

Status retrieved successfully
Examples
application/json
{ "status": "SUCCESS", "message": "DLB logs processed successfully", "downloadUrl": "https://cloudhub-logs-download.s3.amazonaws.com/results/org-id/my-load-balancer/20250115_103000_dlb_logs.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...", "expiresIn": "60 minutes", "token": "CHLOG-v1.a5k-31666605-1e10-4833-b585-3954edc0173d-T2e", "executionStatus": "SUCCEEDED", "executionName": "dlb-logs-my-load-balancer-relative-1765412201" }

Get Organizations By Orgid Loadbalancers getOrganizationsByOrgidLoadbalancers

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
List existing Load balancers for the organization

Path Parameters

orgid *: string

Query Parameters

limit: integer
offset: integer
shortFormat: boolean

Response

Successful operation.
Examples
application/json
{ "data": [ { "id": "571ffe36e4b00d565d743fe5", "vpcId": "vpc-5f89452", "name": "myloadbalancer", "domain": "lb.anypointdns.net", "state": "STOPPED", "IpAddresses": [ "52.202.80.104", "52.202.80.105" ], "ipAddressesInfo": [ { "ip": "52.202.80.104", "status": "USED", "staticIp": true }, { "ip": "52.202.80.105", "status": "USED", "staticIp": true } ], "ipWhitelist": [ "192.0.2.0/24", "198.51.100.23/32" ], "ipAllowlist": [ "192.0.2.0/24", "198.51.100.23/32" ], "enableStreaming": true, "forwardClientCertificate": true, "httpMode": "redirect", "defaultSslEndpoint": 0, "tlsv1": false, "tlsv13": false, "proxyReadTimeout": 300, "sslEndpoints": [ { "privateKeyDigest": "75caede4e70d7ffc4bc2ed8f1924467a9d030917", "publicKeyDigest": "fd562a311962ee8e278b04982f6b5fc1f5c85535", "publicKeyCN": "www.mydomain.com", "publicKeySANs": [ "uat.mydomain.com", "qa.mydomain.com" ], "clientCertDigest": "fd562a311962ee8e278b04982f6b5fc1f5c85535", "clientCertCN": "GeoTrust Primary Certification Authority \u2013 G3", "revocationListDigest": "6c390fbdadacb9c4c99341167771943b798a12ef", "revocationListLastUpdate": "Mar 4 14:49:08 2016 GMT", "revocationListNextUpdate": "Apr 3 14:49:08 2016 GMT", "revocationListSerial": "016569BF", "verifyClientMode": false, "mappings": [ { "inputUri": "{app}/", "appName": "{app}", "appUri": "/" } ] } ] } ], "total": 1 }

Create Organizations By Orgid Loadbalancers Testcerts createOrganizationsByOrgidLoadbalancersTestcerts

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Test if LB certificates, keys, crls and their combinations are valid

Path Parameters

orgid *: string

Request Body

json

Response

Successful operation.
Examples
application/json
[ { "publicKeyDigest": "2686e6dc262265c39038cbf0c4846110e75fe4bc", "publicKeyCN": "example.com", "publicKeySANs": [ "example.com" ], "privateKeyDigest": "2686e6dc262265c39038cbf0c4846110e75fe4bc", "clientCertDigest": "2686e6dc262265c39038cbf0c4846110e75fe4bc", "clientCertCN": "client.com", "revocationListDigest": "2686e6dc262265c39038cbf0c4846110e75fe4bc" } ]

Get Organizations By Orgid Tgws getOrganizationsByOrgidTgws

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get a list of all Transit Gateways belonging to the master organization

Path Parameters

orgid *: string

Response

Successful operation.
Examples
application/json
{ "data": [ { "id": "608c81b4e2146b529e24782c", "tgwId": "tgw-06b170c91fe8a5091", "tgwName": "my-tgw", "tgwStatus": "AVAILABLE", "resourceShareId": "90re84c9-c0da-432c-b663-f93ad477c4a2", "ownerId": "asc40cfe-68a2-48f4-89e1-3afa651c0ccb", "region": "us-east-1", "customerAwsId": 59970264529, "tgwAttachments": [ { "vpcId": "vpc-0173668523e1ad490", "routes": [ "218.1.0.0/16", "21.1.0.0/16" ], "status": "VPC_ATTACHED_ROUTED", "creationTime": 1619821858314, "lastModifiedTime": 1623369054731 } ], "creationTime": 1619820980286, "lastModifiedTime": 1623368877614 } ], "total": 1 }

Create Organizations By Orgid Tgws createOrganizationsByOrgidTgws

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a new Transit Gateway

Path Parameters

orgid *: string

Request Body

json
resourceShareId: string
customerAwsId: string
region: string
tgwName: string

Response

Transit Gateway created successfully
Examples
application/json
{ "id": "60f6305d72a20717fb5df6c2", "tgwName": "my-tgw", "resourceShareId": "66cf35e5-db31-4863-a3c4-acec30d935a0", "ownerId": "df240cfe-68a2-48f4-89e1-3afa651c0ccb", "region": "us-east-1", "customerAwsId": 55970264539, "tgwAttachments": [], "creationTime": 1626746973927, "lastModifiedTime": 1626746973927 }

Update Organizations By Orgid Tgws By Id updateOrganizationsByOrgidTgwsById

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Add a new TGW-VPC attachment, modify VPC routes or update the TGW name

Path Parameters

orgid *: string
id *: string
The id to identify the target resource.

Request Body

json
tgwVpcConnections: array
List of TGW-VPC connections to be created
tgwName: string

Response

Transit Gateway updated successfully
Examples
application/json
{}

Delete Organizations By Orgid Tgws By Id deleteOrganizationsByOrgidTgwsById

DELETE

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Delete a TGW-VPC attachment or a TGW Resource Share

Path Parameters

orgid *: string
id *: string
The id to identify the target resource.

Query Parameters

vpcId: string
VPC ID of the TGW-VPC attachment to delete

Response

TGW Resource Share or the TGW-VPC attachment successfully deleted

Get Organizations By Orgid Vpcs getOrganizationsByOrgidVpcs

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get a list of existing VPCs

Path Parameters

orgid *: string

Query Parameters

limit: integer
offset: integer

Response

Successful operation.
Examples
application/json
{ "data": [ { "id": "12345", "name": "myProductionVpc", "region": "us-east-1", "cidrBlock": "192.168.1.0/24", "internalDns": { "dnsServers": [ "8.8.8.8", "8.8.8.4" ], "specialDomains": [ "mydomain.local", "mydomain.localdomain" ] }, "isDefault": false, "associatedEnvironments": [ "eeeeb145-6f79-402d-85fc-8c90905d2490" ], "ownerId": "5555555-6666-7777-8888-99999999999", "sharedWith": [ "0000000-1111-2222-3333-44444444444" ], "firewallRules": [ { "cidrBlock": "0.0.0.0/0", "protocol": "tcp", "fromPort": 8081, "toPort": 8082 }, { "cidrBlock": "192.168.1.0/24", "protocol": "tcp", "fromPort": 8091, "toPort": 8092 } ] } ], "total": 1 }

Create Organizations By Orgid Vpcs createOrganizationsByOrgidVpcs

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create new VPC

Path Parameters

orgid *: string

Request Body

json
name: string
region: string
cidrBlock: string
internalDns: any
ownerId: string
isDefault: boolean
associatedEnvironments: array
sharedWith: array
firewallRules: array
Inbound firewall rules for all CloudHub workers in this VPC. The list is allow only with an implicit deny all if no rules match

Response

VPC created successfully
Examples
application/json
{ "id": "12345", "name": "myProductionVpc", "region": "us-east-1", "cidrBlock": "192.168.1.0/24", "internalDns": { "dnsServers": [ "8.8.8.8", "8.8.8.4" ], "specialDomains": [ "mydomain.local", "mydomain.localdomain" ] }, "isDefault": false, "associatedEnvironments": [ "eeeeb145-6f79-402d-85fc-8c90905d2490" ], "ownerId": "5555555-6666-7777-8888-99999999999", "sharedWith": [ "0000000-1111-2222-3333-44444444444" ], "firewallRules": [ { "cidrBlock": "0.0.0.0/0", "protocol": "tcp", "fromPort": 8081, "toPort": 8082 }, { "cidrBlock": "192.168.1.0/24", "protocol": "tcp", "fromPort": 8091, "toPort": 8092 } ] }

Get Organizations By Orgid Vpcs By Vpcid getOrganizationsByOrgidVpcsByVpcid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Obtain VPC information by its id

Path Parameters

orgid *: string
vpcId *: string

Response

Successful operation.
Examples
application/json
{ "id": "12345", "name": "myProductionVpc", "region": "us-east-1", "cidrBlock": "192.168.1.0/24", "internalDns": { "dnsServers": [ "8.8.8.8", "8.8.8.4" ], "specialDomains": [ "mydomain.local", "mydomain.localdomain" ] }, "isDefault": false, "associatedEnvironments": [ "eeeeb145-6f79-402d-85fc-8c90905d2490" ], "ownerId": "5555555-6666-7777-8888-99999999999", "sharedWith": [ "0000000-1111-2222-3333-44444444444" ], "firewallRules": [ { "cidrBlock": "0.0.0.0/0", "protocol": "tcp", "fromPort": 8081, "toPort": 8082 }, { "cidrBlock": "192.168.1.0/24", "protocol": "tcp", "fromPort": 8091, "toPort": 8092 } ] }

Update Organizations By Orgid Vpcs By Vpcid updateOrganizationsByOrgidVpcsByVpcid

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
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.

Path Parameters

orgid *: string
vpcId *: string

Request Body

json
name: string
region: string
cidrBlock: string
internalDns: any
ownerId: string
isDefault: boolean
associatedEnvironments: array
sharedWith: array
firewallRules: array
Inbound firewall rules for all CloudHub workers in this VPC. The list is allow only with an implicit deny all if no rules match

Response

The VPC has been updated. The entire configuration is returned
Examples
application/json
{ "name": "myProductionVpc", "internalDns": { "dnsServers": [ "8.8.8.8", "8.8.8.4" ], "specialDomains": [ "mydomain.local", "mydomain.localdomain" ] }, "isDefault": false, "associatedEnvironments": [ "eeeeb145-6f79-402d-85fc-8c90905d2490" ], "sharedWith": [ "0000000-1111-2222-3333-44444444444" ], "firewallRules": [ { "cidrBlock": "0.0.0.0/0", "protocol": "tcp", "fromPort": 8081, "toPort": 8082 }, { "cidrBlock": "192.168.1.0/24", "protocol": "tcp", "fromPort": 8091, "toPort": 8092 } ] }

Delete Organizations By Orgid Vpcs By Vpcid deleteOrganizationsByOrgidVpcsByVpcid

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Remove VPC by its id

Path Parameters

orgid *: string
vpcId *: string

Response

Deleted successfully

Get Organizations By Orgid Vpcs By Vpcid Loadbalancers getOrganizationsByOrgidVpcsByVpcidLoadbalancers

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get list of existing Load balancers

Path Parameters

orgid *: string
vpcId *: string

Query Parameters

limit: integer
offset: integer

Response

Successful operation.
Examples
application/json
{ "data": [ { "id": "571ffe36e4b00d565d743fe5", "vpcId": "vpc-5f89452", "name": "myloadbalancer", "domain": "lb.anypointdns.net", "state": "STOPPED", "IpAddresses": [ "52.202.80.104", "52.202.80.105" ], "ipAddressesInfo": [ { "ip": "52.202.80.104", "status": "USED", "staticIp": true }, { "ip": "52.202.80.105", "status": "USED", "staticIp": true } ], "ipWhitelist": [ "192.0.2.0/24", "198.51.100.23/32" ], "ipAllowlist": [ "192.0.2.0/24", "198.51.100.23/32" ], "enableStreaming": true, "forwardClientCertificate": true, "httpMode": "redirect", "defaultSslEndpoint": 0, "tlsv1": false, "tlsv13": false, "proxyReadTimeout": 300, "sslEndpoints": [ { "privateKeyDigest": "75caede4e70d7ffc4bc2ed8f1924467a9d030917", "publicKeyDigest": "fd562a311962ee8e278b04982f6b5fc1f5c85535", "publicKeyCN": "www.mydomain.com", "publicKeySANs": [ "uat.mydomain.com", "qa.mydomain.com" ], "clientCertDigest": "fd562a311962ee8e278b04982f6b5fc1f5c85535", "clientCertCN": "GeoTrust Primary Certification Authority \u2013 G3", "revocationListDigest": "6c390fbdadacb9c4c99341167771943b798a12ef", "revocationListLastUpdate": "Mar 4 14:49:08 2016 GMT", "revocationListNextUpdate": "Apr 3 14:49:08 2016 GMT", "revocationListSerial": "016569BF", "verifyClientMode": false, "mappings": [ { "inputUri": "{app}/", "appName": "{app}", "appUri": "/" } ] } ] } ], "total": 1 }

Create Organizations By Orgid Vpcs By Vpcid Loadbalancers createOrganizationsByOrgidVpcsByVpcidLoadbalancers

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create new Load balancer

Path Parameters

orgid *: string
vpcId *: string

Request Body

json
id: string
name: string
domain: string
state: string
The current state of the Load Balancer
doubleStaticIps: boolean
True if DLB will use double static IPs when restarting
ipAddresses: array
List of static IP addresses for the Load Balancer
ipAddressesInfo: array
List of IP addresses information for the Load Balancer
ipWhitelist: array
ipAllowlist: array
httpMode: string
enableStreaming: boolean
Setting this to true will disable request buffering at the DLB, thereby enabling streaming
tlsv1: boolean
tlsv13: boolean
forwardClientCertificate: boolean
Setting this to true will forward any incoming client certificates to upstream application
defaultSslEndpoint: integer
sslEndpoints: array
A list of server certificate files

Response

Load balancer created successfully
Examples
application/json
{ "id": "571ffe36e4b00d565d743fe5", "name": "myloadbalancer", "domain": "lb.anypointdns.net", "state": "STOPPED", "IpAddresses": [ "52.202.80.104", "52.202.80.105" ], "ipAddressesInfo": [ { "ip": "52.202.80.104", "status": "AVAILABLE", "staticIp": true }, { "ip": "52.202.80.105", "status": "AVAILABLE", "staticIp": true } ], "ipWhitelist": [ "192.0.2.0/24", "198.51.100.23/32" ], "ipAllowlist": [ "192.0.2.0/24", "198.51.100.23/32" ], "enableStreaming": true, "forwardClientCertificate": true, "httpMode": "redirect", "defaultSslEndpoint": 0, "tlsv1": false, "tlsv13": false, "sslEndpoints": [ { "privateKeyDigest": "75caede4e70d7ffc4bc2ed8f1924467a9d030917", "publicKeyDigest": "fd562a311962ee8e278b04982f6b5fc1f5c85535", "publicKeyCN": "www.mydomain.com", "publicKeySANs": [ "uat.mydomain.com", "qa.mydomain.com" ], "clientCertDigest": "fd562a311962ee8e278b04982f6b5fc1f5c85535", "clientCertCN": "GeoTrust Primary Certification Authority \u2013 G3", "revocationListDigest": "6c390fbdadacb9c4c99341167771943b798a12ef", "verifyClientMode": false, "mappings": [ { "inputUri": "{app}/", "appName": "{app}", "appUri": "/" } ] } ] }

Get Organizations By Orgid Vpcs By Vpcid Loadbalancers By Lbid getOrganizationsByOrgidVpcsByVpcidLoadbalancersByLbid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
returns load balancer by its ID

Path Parameters

orgid *: string
vpcId *: string
lbId *: string
The lb ID to identify the target resource.

Response

json
Successful operation.
id: string
name: string
domain: string
state: string
The current state of the Load Balancer
doubleStaticIps: boolean
True if DLB will use double static IPs when restarting
ipAddresses: array
List of static IP addresses for the Load Balancer
ipAddressesInfo: array
List of IP addresses information for the Load Balancer
ipWhitelist: array
ipAllowlist: array
httpMode: string
enableStreaming: boolean
Setting this to true will disable request buffering at the DLB, thereby enabling streaming
tlsv1: boolean
tlsv13: boolean
forwardClientCertificate: boolean
Setting this to true will forward any incoming client certificates to upstream application
defaultSslEndpoint: integer
sslEndpoints: array
A list of server certificate files
Examples
application/json
{ "id": "string", "name": "string", "domain": "string", "state": "STOPPED", "doubleStaticIps": true, "ipAddresses": [ "string" ], "ipAddressesInfo": [ { "ip": "string", "status": "string", "staticIp": true } ], "ipWhitelist": [ "string" ], "ipAllowlist": [ "string" ], "httpMode": true }

Patch Organizations By Orgid Vpcs By Vpcid Loadbalancers By Lbid patchOrganizationsByOrgidVpcsByVpcidLoadbalancersByLbid

PATCH

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json-patch+json
updates a load balancer

Path Parameters

orgid *: string
vpcId *: string
lbId *: string
The lb ID to identify the target resource.

Request Body

json-patch+json

Response

returns updated Load balancer JSON object.
Examples
application/json
{ "id": "571ffe36e4b00d565d743fe5", "name": "myloadbalancer", "domain": "lb.anypointdns.net", "state": "STOPPED", "IpAddresses": [ "52.202.80.104", "52.202.80.105" ], "ipAddressesInfo": [ { "ip": "52.202.80.104", "status": "AVAILABLE", "staticIp": true }, { "ip": "52.202.80.105", "status": "AVAILABLE", "staticIp": true } ], "ipWhitelist": [ "192.0.2.0/24", "198.51.100.23/32" ], "ipAllowlist": [ "192.0.2.0/24", "198.51.100.23/32" ], "enableStreaming": true, "forwardClientCertificate": true, "httpMode": "redirect", "defaultSslEndpoint": 0, "tlsv1": false, "tlsv13": false, "sslEndpoints": [ { "privateKeyDigest": "75caede4e70d7ffc4bc2ed8f1924467a9d030917", "publicKeyDigest": "fd562a311962ee8e278b04982f6b5fc1f5c85535", "publicKeyCN": "www.mydomain.com", "publicKeySANs": [ "uat.mydomain.com", "qa.mydomain.com" ], "clientCertDigest": "fd562a311962ee8e278b04982f6b5fc1f5c85535", "clientCertCN": "GeoTrust Primary Certification Authority \u2013 G3", "revocationListDigest": "6c390fbdadacb9c4c99341167771943b798a12ef", "verifyClientMode": false, "mappings": [ { "inputUri": "{app}/", "appName": "{app}", "appUri": "/" } ] } ] }

Delete Organizations By Orgid Vpcs By Vpcid Loadbalancers By Lbid deleteOrganizationsByOrgidVpcsByVpcidLoadbalancersByLbid

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
deletes load balancer by its ID

Path Parameters

orgid *: string
vpcId *: string
lbId *: string
The lb ID to identify the target resource.

Response

the load balancer was deleted successfully

Get Organizations By Orgid Vpcs By Vpcid Loadbalancers By Lbid Deployments getOrganizationsByOrgidVpcsByVpcidLoadbalancersByLbidDeployments

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
returns all the deployments

Path Parameters

orgid *: string
vpcId *: string
lbId *: string
The lb ID to identify the target resource.

Query Parameters

limit: integer
offset: integer

Response

Successful operation.
Examples
application/json
{ "data": [ { "id": "568b9909e4b03fbcf0c72ea6", "state": "PROCESSING", "deploymentConfig": { "name": "myloadbalancer", "ipWhitelist": [ "192.0.2.0/24", "198.51.100.23/32" ], "httpMode": "redirect", "defaultSslEndpoint": 0, "sslEndpoints": [ { "privateKeyDigest": "75caede4e70d7ffc4bc2ed8f1924467a9d030917", "publicKeyDigest": "fd562a311962ee8e278b04982f6b5fc1f5c85535", "publicKeyCN": "www.mydomain.com", "publicKeySANs": [ "uat.mydomain.com", "qa.mydomain.com" ], "clientCertDigest": "fd562a311962ee8e278b04982f6b5fc1f5c85535", "clientCertCN": "GeoTrustPrimaryCertificationAuthority\u2013G3", "revocationListDigest": "6c390fbdadacb9c4c99341167771943b798a12ef", "revocationListLastUpdate": "Mar414:49:082016GMT", "revocationListNextUpdate": "Apr314:49:082016GMT", "revocationListSerial": "016569BF", "verifyClientMode": false, "tlsv1": false, "mappings": [ { "inputUri": "{app}/", "appName": "{app}", "appUri": "/" } ] } ] }, "createTime": 1452585196698, "startTime": 1452585196821 } ], "total": 1 }

Get Organizations By Orgid Vpcs By Vpcid Loadbalancers By Lbid Testmapping getOrganizationsByOrgidVpcsByVpcidLoadbalancersByLbidTestmapping

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
makes a test call to the load balancer rules and returns a response with the rule number which will be applied to the input.

Path Parameters

orgid *: string
vpcId *: string
lbId *: string
The lb ID to identify the target resource.

Query Parameters

url *: string
URL to test

Response

returns updated Load balancer JSON object.
Examples
application/json
{ "domainIdx": 2, "ruleIdx": 2, "appName": "app123", "outputURI": "http://mule-worker-internal-app123.cloudhub.io:8081?greeting=hello" }

Get Organizations By Orgid Vpcs By Vpcid Ipsec getOrganizationsByOrgidVpcsByVpcidIpsec

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
get the configuration and state of a <<resourcePathName|!pluralize>>

Path Parameters

orgid *: string
vpcId *: string

Response

json
Successful operation.
data *: array
A collection of VpnConnection objects that include a unique id, Spec object and VpnConnectionState object
total *: integer
The number of returned VpnConnection objects in the response
Examples
application/json
{ "data": [ { "id": "4a6e3da830767b280a80ce33", "spec": { "name": "myDatacenterVpn", "remoteIpAddress": "100.100.100.100", "routingType": "STATIC", "remoteNetworks": [ "10.5.0.0/16" ], "tunnelConfigs": [ { "psk": "LKvQAyV7DyR1Q7kZoIAymsqFOh3SWb2S", "ptpCidr": "169.254.12.0/30" }, { "psk": "q.NFQABcVnKLp2.zjR7Pw7YtH9gICJlt", "ptpCidr": "169.254.12.4/30" } ] }, "state": { "vpnConnectionStatus": "AVAILABLE", "createdAt": "2017-01-01T00:00:01-0800", "bgpRoutes": [], "staticRoutes": [ { "remoteNetwork": "10.5.0.0/16", "state": "AVAILABLE" } ], "vpnTunnels": [ { "acceptedRouteCount": 1, "lastStatusChange": "2018-01-13T16:30:07-0800", "localExternalIpAddress": "50.112.49.102", "localPtpIpAddress": "169.254.13.241", "remotePtpIpAddress": "169.254.13.242", "psk": "LKvQAyV7DyR1Q7kZoIAymsqFOh3SWb2S", "status": "UP", "statusMessage": "" }, { "acceptedRouteCount": 1, "lastStatusChange": "2018-01-13T16:30:07-0800", "localExternalIpAddress": "34.216.124.13", "localPtpIpAddress": "169.254.15.17", "remotePtpIpAddress": "169.254.15.18", "psk": "q.NFQABcVnKLp2.zjR7Pw7YtH9gICJlt", "status": "DOWN", "statusMessage": "" } ] } } ], "total": 1 }

Create Organizations By Orgid Vpcs By Vpcid Ipsec createOrganizationsByOrgidVpcsByVpcidIpsec

POST

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Create a VPN connection from a VPC, up to a limit of 10 total VPN Connections per VPC

Path Parameters

orgid *: string
vpcId *: string

Request Body

json
name *: string
User-friendly name for VPN connection
localAsn: integer
remoteAsn: integer
remoteIpAddress *: string
remoteNetworks: array
tunnelConfigs: array

Response

VPN Infrastucture creation pending

Get Organizations By Orgid Vpcs By Vpcid Ipsec Ipsec By Vpnid getOrganizationsByOrgidVpcsByVpcidIpsecIpsecByVpnid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Get the configuration and state of a <<resourcePathName|!pluralize>> string

Path Parameters

orgid *: string
vpcId *: string
vpnId *: string
The vpn ID to identify the target resource.

Response

json
Successful operation.
id *: string
spec *: object
state *: object
The state of a provisioned VPN connection and tunnels
Examples
application/json
{ "id": "4a6e3da830767b280a80ce33", "spec": { "name": "myDatacenterVpn", "remoteAsn": 65000, "localAsn": 7224, "remoteIpAddress": "100.100.100.100", "routingType": "BGP" }, "state": { "vpnConnectionStatus": "AVAILABLE", "createdAt": "2017-01-01T00:00:01-0800", "bgpRoutes": [ { "remoteNetwork": "10.5.0.0/16", "state": "ACTIVE" } ], "staticRoutes": [], "vpnTunnels": [ { "acceptedRouteCount": 2, "lastStatusChange": "2018-01-13T16:30:07-0800", "localExternalIpAddress": "50.112.49.102", "localPtpIpAddress": "169.254.13.241", "remotePtpIpAddress": "169.254.13.242", "psk": "LKvQAyV7DyR1Q7kZoIAymsqFOh3SWb2S", "status": "UP", "statusMessage": "" }, { "acceptedRouteCount": 2, "lastStatusChange": "2018-01-13T16:30:07-0800", "localExternalIpAddress": "34.216.124.13", "localPtpIpAddress": "169.254.15.17", "remotePtpIpAddress": "169.254.15.18", "psk": "q.NFQABcVnKLp2.zjR7Pw7YtH9gICJlt", "status": "DOWN", "statusMessage": "" } ] } }

Delete Organizations By Orgid Vpcs By Vpcid Ipsec Ipsec By Vpnid deleteOrganizationsByOrgidVpcsByVpcidIpsecIpsecByVpnid

DELETE

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Delete a VPN connection

Path Parameters

orgid *: string
vpcId *: string
vpnId *: string
The vpn ID to identify the target resource.

Response

Deleted successfully

Get Ping getPing

GET

Try it out

Custom Query Parameters
Custom Headers
Lists ping.

Response

Successful operation.

Update Queues By Queueid Clear updateQueuesByQueueidClear

PUT

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Replaces a clear.

Path Parameters

queueId *: string
The queue ID to identify the target resource.

Response

Successful operation.
Examples
application/json
{ "message": "Operation completed successfully." }

Get Queues By Queueid Statistics getQueuesByQueueidStatistics

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a statistics.

Path Parameters

queueId *: string
The queue ID to identify the target resource.

Response

Successful operation.
Examples
application/json
[ { "name": "queued", "functions": [ "AVG" ] }, { "name": "inFlight", "functions": [ "AVG" ] }, { "name": "added", "functions": [ "COUNT" ] }, { "name": "dequeued", "functions": [ "COUNT" ] } ]

Get Queues By Queueid Statistics By Statistic getQueuesByQueueidStatisticsByStatistic

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a statistics.

Path Parameters

queueId *: string
The queue ID to identify the target resource.
statistic *: string
The statistic to identify the target resource.

Query Parameters

startDate *: string
The startDate query parameter.
endDate *: string
The endDate query parameter.
interval *: string
The interval query parameter.

Response

Successful operation.
Examples
application/json
{ "id": "54f7ed78e4b0d48f31a30891_54f87d13e4b0d48f320c66cb_A9452D1A86C11FD2E70F2481D99B31", "statistics": { "queued": {}, "inFlight": {}, "dequeued": {} } }

Get Regions getRegions

GET

Try it out

Custom Query Parameters
Custom Headers
Lists regions.

Response

Successful operation.
Examples
application/json
[ { "id": "us-east-1", "name": "US East (N. Virginia)", "default": true }, { "id": "us-west-2", "name": "US West (Oregon)", "default": false }, { "id": "eu-west-1", "name": "EU (Ireland)", "default": false }, { "id": "ap-southeast-2", "name": "Asia Pacific (Sydney)", "default": false }, { "id": "ap-southeast-1", "name": "Asia Pacific (Singapore)", "default": false }, { "id": "us-west-1", "name": "US West (N. California)", "default": false } ]

Get Users Current Permissions getUsersCurrentPermissions

GET

Try it out

Header Parameters
Custom Query Parameters
Custom Headers
Retrieve the permissions for the current user

Header Parameters

X-ANYPNT-ENV-ID *: string

Response

Successful operation.
Examples
application/json
{ "organization": { "settings": { "update": true, "read": true }, "permissions": { "assign": true, "read": true }, "environments": { "update": true, "delete": false, "read": true, "create": true } }, "environment": { "applications": { "delete": true, "create": true } }, "cloudhub": { "adminAPI": { "all": false } }, "applications": { "files": { "download": true }, "schedules": { "update": true, "read": true, "run": true }, "notifications": { "update": true, "read": true, "create": true }, "logs": { "read": true, "download": true }, "tenants": { "update": true, "delete": true, "read": true, "create": true }, "alerts": { "update": true, "delete": true, "read": true, "create": true }, "settings": { "update": true, "read": true }, "insights": { "read": true }, "data": { "delete": true, "read": true, "create": true }, "queues": { "clear": true, "read": true }, "dashboard": { "read": true } } }