Proxies API - Anypoint Platform APIs

Overview

Statistics

15 Operations

3 Skills

Gateway Category

Manage API proxy deployments and deployment targets for CloudHub, CloudHub 2.0, and Runtime Fabric.

Servers

US https://anypoint.mulesoft.com/proxies/xapi/v1
EU https://eu1.anypoint.mulesoft.com/proxies/xapi/v1
CA https://ca1.platform.mulesoft.com/proxies/xapi/v1
JP https://jp1.platform.mulesoft.com/proxies/xapi/v1
IN https://in1.platform.mulesoft.com/proxies/xapi/v1
AU https://au1.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 proxy getProxy

GET

Try it out

Path Parameters

environmentApiId *

organizationId *

environmentId *

Query Parameters

gatewayVersion

Custom Query Parameters

Custom Headers

Gets a proxy.

Path Parameters

environmentApiId *: integer

The environmentApi ID to identify the target resource.

min: 1, max: 2147483647

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Query Parameters

gatewayVersion: string

The gatewayVersion query parameter.

default: 3.8.0

Response

Successful operation.

Activate proxy activateProxy

POST

Try it out

Path Parameters

environmentApiId *

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Request Body application/json

Creates a active.

Path Parameters

environmentApiId *: integer

The environmentApi ID to identify the target resource.

min: 1, max: 2147483647

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Request Body

json

Response

Resource created successfully.

List proxy deployments listProxyDeployments

GET

Try it out

Path Parameters

environmentApiId *

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Retrieves a deployments.

Path Parameters

environmentApiId *: integer

The environmentApi ID to identify the target resource.

min: 1, max: 2147483647

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Response

Successful operation.

Create proxy deployment createProxyDeployment

POST

Try it out

Path Parameters

environmentApiId *

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Request Body application/json

Creates a deployments.

Path Parameters

environmentApiId *: integer

The environmentApi ID to identify the target resource.

min: 1, max: 2147483647

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Request Body *

json

type *: string

environmentName: string

minLength: 1, maxLength: 150

environmentId: string

UUID (or 24 alphanumeric for legacy environments)

minLength: 1, maxLength: 40

gatewayVersion: string

minLength: 1, maxLength: 150

targetId: integer | string

targetName: string

minLength: 1, maxLength: 150

targetType: string

minLength: 1, maxLength: 150

overwrite: boolean | null

applicationName: string

minLength: 1, maxLength: 150

name: string

minLength: 1, maxLength: 150

target: object

Response

Resource created successfully.

Get proxy deployment by ID getProxyDeploymentById

GET

Try it out

Path Parameters

proxyDeploymentId *

environmentApiId *

organizationId *

environmentId *

Query Parameters

checkAutomatedPolicies

Custom Query Parameters

Custom Headers

Returns a deployment (And sync it with deployment targets)

Path Parameters

proxyDeploymentId *: integer

The proxyDeployment ID to identify the target resource.

min: 1, max: 2147483647

environmentApiId *: integer

The environmentApi ID to identify the target resource.

min: 1, max: 2147483647

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Query Parameters

checkAutomatedPolicies: boolean

The checkAutomatedPolicies query parameter.

Response

Successful operation.

Replace proxy deployment replaceProxyDeployment

PUT

Try it out

Path Parameters

proxyDeploymentId *

environmentApiId *

organizationId *

environmentId *

Query Parameters

checkAutomatedPolicies

Custom Query Parameters

Custom Headers

Request Body application/json

Replaces a deployments.

Path Parameters

proxyDeploymentId *: integer

The proxyDeployment ID to identify the target resource.

min: 1, max: 2147483647

environmentApiId *: integer

The environmentApi ID to identify the target resource.

min: 1, max: 2147483647

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Query Parameters

checkAutomatedPolicies: boolean

The checkAutomatedPolicies query parameter.

Request Body *

json

type *: string

environmentName: string

minLength: 1, maxLength: 150

environmentId: string

UUID (or 24 alphanumeric for legacy environments)

minLength: 1, maxLength: 40

gatewayVersion: string

minLength: 1, maxLength: 150

targetId: integer | string

targetName: string

minLength: 1, maxLength: 150

targetType: string

minLength: 1, maxLength: 150

overwrite: boolean | null

applicationName: string

minLength: 1, maxLength: 150

name: string

minLength: 1, maxLength: 150

target: object

Response

Resource created successfully.

Patch proxy deployment patchProxyDeployment

PATCH

Try it out

Path Parameters

proxyDeploymentId *

environmentApiId *

organizationId *

environmentId *

Query Parameters

checkAutomatedPolicies

Custom Query Parameters

Custom Headers

Request Body application/json

Updates a deployments.

Path Parameters

proxyDeploymentId *: integer

The proxyDeployment ID to identify the target resource.

min: 1, max: 2147483647

environmentApiId *: integer

The environmentApi ID to identify the target resource.

min: 1, max: 2147483647

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Query Parameters

checkAutomatedPolicies: boolean

The checkAutomatedPolicies query parameter.

Request Body *

json

Response

Successful operation.

Get proxy deployment status getProxyDeploymentStatus

GET

Try it out

Path Parameters

proxyDeploymentId *

environmentApiId *

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Retrieves the deployment details of a version (And sync it with deployment targets).

Path Parameters

proxyDeploymentId *: integer

The proxyDeployment ID to identify the target resource.

min: 1, max: 2147483647

environmentApiId *: integer

The environmentApi ID to identify the target resource.

min: 1, max: 2147483647

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Response

Successful operation.

List deployment targets listDeploymentTargets

GET

Try it out

Path Parameters

organizationId *

Query Parameters

environmentId *

Custom Query Parameters

Custom Headers

Retrieves a deployment targets.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

environmentId *: string

A string that will be checked for an exact match of the Environment ID

minLength: 1

Related Operations:

access-management#listEnvironments.$.data[*].id

Response

Successful operation.

List Mule runtime versions listMuleRuntimeVersions

GET

Try it out

Path Parameters

targetId *

organizationId *

Query Parameters

operation

Custom Query Parameters

Custom Headers

Retrieves a versions.

Path Parameters

targetId *: string

The target ID to identify the target resource.

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

operation: string

The operation query parameter.

Response

Successful operation.

List Runtime Fabric deployment targets listRuntimeFabricTargets

GET

Try it out

Path Parameters

providerId *

organizationId *

Query Parameters

environmentId *

Custom Query Parameters

Custom Headers

Retrieves a runtime fabric deployment targets.

Path Parameters

providerId *: string

The provider ID to identify the target resource.

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

environmentId *: string

A string that will be checked for an exact match of the Environment ID

minLength: 1

Related Operations:

access-management#listEnvironments.$.data[*].id

Response

Successful operation.

List CloudHub 2.0 deployment targets listCloudHub2DeploymentTargets

GET

Try it out

Path Parameters

providerId *

organizationId *

Query Parameters

environmentId *

returnAllTargets

Custom Query Parameters

Custom Headers

Retrieves a cloudhub2 deployment targets.

Path Parameters

providerId *: string

The provider ID to identify the target resource.

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

environmentId *: string

A string that will be checked for an exact match of the Environment ID

minLength: 1

Related Operations:

access-management#listEnvironments.$.data[*].id

returnAllTargets: boolean

The returnAllTargets query parameter.

Response

Successful operation.

Get CH domain by name getChDomain

GET

Try it out

Path Parameters

domainName *

Custom Query Parameters

Custom Headers

Retrieves a ch domains.

Path Parameters

domainName *: string

The domainName to identify the target resource.

Response

Successful operation.

Get echo response getStatusEcho

GET

Try it out

Custom Query Parameters

Custom Headers

Lists echo.

Response

Successful operation.

Get service version getStatusVersion

GET

Try it out

Custom Query Parameters

Custom Headers

Retrieves the date and commit of the deployed version.

Response

Successful operation.