Overview
Statistics
15
Operations
3
Skills
Gateway
Category
Manage API proxy deployments and deployment targets for CloudHub, CloudHub 2.0, and Runtime Fabric.
Servers
-
https://anypoint.mulesoft.com/proxies/xapi/v1 -
https://{region}.anypoint.mulesoft.com/proxies/xapi/v1 -
https://{region}.platform.mulesoft.com/proxies/xapi/v1
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 Organizations By Organizationid Environments By Environmentid Apis By Environmentapiid Proxy getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidProxy
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets a proxy.
Path Parameters
environmentApiId *:
integerThe environmentApi ID to identify the target resource.
min: 1, max: 2147483647
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Query Parameters
gatewayVersion:
stringThe gatewayVersion query parameter.
default:
3.8.0Response
Successful operation.
Create Organizations By Organizationid Environments By Environmentid Apis By Environmentapiid Active createOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidActive
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a active.
Path Parameters
environmentApiId *:
integerThe environmentApi ID to identify the target resource.
min: 1, max: 2147483647
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Request Body
jsonResponse
Resource created successfully.
Get Organizations By Organizationid Environments By Environmentid Apis By Environmentapiid Deployments getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeployments
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a deployments.
Path Parameters
environmentApiId *:
integerThe environmentApi ID to identify the target resource.
min: 1, max: 2147483647
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Response
Successful operation.
Create Organizations By Organizationid Environments By Environmentid Apis By Environmentapiid Deployments createOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeployments
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a deployments.
Path Parameters
environmentApiId *:
integerThe environmentApi ID to identify the target resource.
min: 1, max: 2147483647
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Request Body *
jsontype *:
stringenvironmentName:
stringminLength: 1, maxLength: 150
environmentId:
stringUUID (or 24 alphanumeric for legacy environments)
minLength: 1, maxLength: 40
gatewayVersion:
stringminLength: 1, maxLength: 150
targetId:
integer | stringtargetName:
stringminLength: 1, maxLength: 150
targetType:
stringminLength: 1, maxLength: 150
overwrite:
boolean | nullapplicationName:
stringminLength: 1, maxLength: 150
name:
stringminLength: 1, maxLength: 150
target:
objectResponse
Resource created successfully.
Get Organizations By Organizationid Environments By Environmentid Apis By Environmentapiid Deployments By Proxydeploymentid getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeploymentsByProxydeploymentid
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a deployment (And sync it with deployment targets)
Path Parameters
proxyDeploymentId *:
integerThe proxyDeployment ID to identify the target resource.
min: 1, max: 2147483647
environmentApiId *:
integerThe environmentApi ID to identify the target resource.
min: 1, max: 2147483647
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Query Parameters
checkAutomatedPolicies:
booleanThe checkAutomatedPolicies query parameter.
Response
Successful operation.
Update Organizations By Organizationid Environments By Environmentid Apis By Environmentapiid Deployments By Proxydeploymentid updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeploymentsByProxydeploymentid
PUT
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Replaces a deployments.
Path Parameters
proxyDeploymentId *:
integerThe proxyDeployment ID to identify the target resource.
min: 1, max: 2147483647
environmentApiId *:
integerThe environmentApi ID to identify the target resource.
min: 1, max: 2147483647
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Query Parameters
checkAutomatedPolicies:
booleanThe checkAutomatedPolicies query parameter.
Request Body *
jsontype *:
stringenvironmentName:
stringminLength: 1, maxLength: 150
environmentId:
stringUUID (or 24 alphanumeric for legacy environments)
minLength: 1, maxLength: 40
gatewayVersion:
stringminLength: 1, maxLength: 150
targetId:
integer | stringtargetName:
stringminLength: 1, maxLength: 150
targetType:
stringminLength: 1, maxLength: 150
overwrite:
boolean | nullapplicationName:
stringminLength: 1, maxLength: 150
name:
stringminLength: 1, maxLength: 150
target:
objectResponse
Resource created successfully.
Patch Organizations By Organizationid Environments By Environmentid Apis By Environmentapiid Deployments By Proxydeploymentid patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeploymentsByProxydeploymentid
PATCH
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a deployments.
Path Parameters
proxyDeploymentId *:
integerThe proxyDeployment ID to identify the target resource.
min: 1, max: 2147483647
environmentApiId *:
integerThe environmentApi ID to identify the target resource.
min: 1, max: 2147483647
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Query Parameters
checkAutomatedPolicies:
booleanThe checkAutomatedPolicies query parameter.
Request Body *
jsonResponse
Successful operation.
Get Organizations By Organizationid Environments By Environmentid Apis By Environmentapiid Deployments By Proxydeploymentid Status getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeploymentsByProxydeploymentidStatus
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves the deployment details of a version (And sync it with deployment targets).
Path Parameters
proxyDeploymentId *:
integerThe proxyDeployment ID to identify the target resource.
min: 1, max: 2147483647
environmentApiId *:
integerThe environmentApi ID to identify the target resource.
min: 1, max: 2147483647
environmentId *:
stringThe environment ID to identify the target resource.
Related Operations:
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Response
Successful operation.
Get Organizations By Organizationid Deployment Targets getOrganizationsByOrganizationidDeploymentTargets
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a deployment targets.
Path Parameters
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Query Parameters
environmentId *:
stringThe environment ID query parameter.
Related Operations:
Response
Successful operation.
Get Organizations By Organizationid Targets By Targetid Runtimes Mule Versions getOrganizationsByOrganizationidTargetsByTargetidRuntimesMuleVersions
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a versions.
Path Parameters
targetId *:
stringThe target ID to identify the target resource.
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Query Parameters
operation:
stringThe operation query parameter.
Response
Successful operation.
Get Organizations By Organizationid Providers By Providerid Runtime Fabric Deployment Targets getOrganizationsByOrganizationidProvidersByProvideridRuntimeFabricDeploymentTargets
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a runtime fabric deployment targets.
Path Parameters
providerId *:
stringThe provider ID to identify the target resource.
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Query Parameters
environmentId *:
stringThe environment ID query parameter.
Related Operations:
Response
Successful operation.
Get Organizations By Organizationid Providers By Providerid Cloudhub2Deployment Targets getOrganizationsByOrganizationidProvidersByProvideridCloudhub2DeploymentTargets
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a cloudhub2 deployment targets.
Path Parameters
providerId *:
stringThe provider ID to identify the target resource.
organizationId *:
stringThe organization ID to identify the target resource.
pattern:
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Query Parameters
environmentId *:
stringThe environment ID query parameter.
Related Operations:
returnAllTargets:
booleanThe returnAllTargets query parameter.
Response
Successful operation.
Get Ch Domains By Domainname getChDomainsByDomainname
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Retrieves a ch domains.
Path Parameters
domainName *:
stringThe domainName to identify the target resource.
Response
Successful operation.
Get Status Echo getStatusEcho
GET
Try it out
Custom Query Parameters
Custom Headers
Lists echo.
Response
Successful operation.
Get Status Version getStatusVersion
GET
Try it out
Custom Query Parameters
Custom Headers
Retrieves the date and commit of the deployed version.
Response
Successful operation.