AMC Application Manager API

Update scheduler configuration updateScheduler

PUT

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

flowName *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Request Body application/json

Schedulers

Updates the scheduler configuration for the specified flow name.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

flowName *: string

The flowName to identify the target resource.

Header Parameters

Authorization *: string

Bearer token for API authentication.

Request Body *

json

timeUnit: string

Only for FixedFrequencyScheduler or null otherwise. The time unit for the values of Frequency and Start Delay. The possible values are: MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

frequency: string

Only for FixedFrequencyScheduler or null otherwise. The frequency at which the Scheduler triggers the flow.

startDelay: string

Only for FixedFrequencyScheduler or null otherwise. The amount of time to wait before triggering the flow for the first time after the application is started.

expression: string

Only for CronScheduler or null otherwise. A date-time expression.

timeZone: string

Only for CronScheduler or null otherwise. Java timeZone values are supported.

enabled: boolean

True to enable the scheduler or false otherwise.

fixedFrequencyScehduler: boolean

Response

json

Success

total: integer(int64)

The items list size.

items: array

Examples

application/json

{ "total": 1, "items": [ { "id": "string", "type": "string" } ] }

Unauthorized

Deployment not found

Reset scheduler to default resetScheduler

DELETE

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

flowName *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Schedulers

Removes the custom scheduler configuration for the given flow name in the deployment and restores the default configuration.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

flowName *: string

The flowName to identify the target resource.

Header Parameters

Authorization *: string

Bearer token for API authentication.

Response

json

Success

total: integer(int64)

The items list size.

items: array

Examples

application/json

{ "total": 1, "items": [ { "id": "string", "type": "string" } ] }

Unauthorized

Deployment not found

List deployments listDeployments

GET

Try it out

Path Parameters

organizationId *

environmentId *

Query Parameters

deploymentQuery

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Deployments

Retrieves a list of deployments for the specified query. If the query returns no results, then an empty list is returned.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Query Parameters

deploymentQuery: any

The deploymentQuery query parameter.

Header Parameters

Authorization *: string

Bearer token for API authentication.

Response

json

Success

total: integer(int64)

The items list size.

items: array

Examples

application/json

{ "total": 1, "items": [ { "id": "string", "type": "string" } ] }

Deploy a new application createDeployment

POST

Try it out

Path Parameters

organizationId *

environmentId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Request Body application/json

Deployments

Deploys a new application with the provided data.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Header Parameters

Authorization *: string

Bearer token for API authentication.

Request Body *

json

name: string

The name of the application.

target: object

application: object

The details of the application to deploy.

desiredVersion: string

The desired spec version to deploy

upgradeData: object

Response

json

Accepted

id: string

The id of the deployment.

name: string

The name of the deployment.

creationDate: string(date-time)

The date when the deployment was created.

lastModifiedDate: string(date-time)

The date when the deployment was last modified.

target: object

The target of the deployment.

status: string

The status of the deployment.

application: object

The application of the deployment.

desiredVersion: string

The desired version of the deployment.

replicas: array

The list of replicas for the specified deployment.

lastSuccessfulVersion: string

The last version of the deployment that applied correctly.

Examples

application/json

{ "id": "e4899eda-22c9-4546-8ad2-ffde5a3d466d", "name": "app-name", "creationDate": "2024-01-15T10:30:00Z", "lastModifiedDate": "2024-01-15T10:30:00Z", "target": { "id": "string", "type": "string" }, "status": "FAILED", "application": { "id": "string", "type": "string" }, "desiredVersion": "0ef171b6-aad1-459b-8720-10c405b05ed1", "replicas": [ { "id": "string", "type": "string" } ], "lastSuccessfulVersion": "0ef171b6-aad1-459b-8720-10c405b05ed1" }

Run scheduler immediately runScheduler

POST

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

flowName *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Schedulers

Triggers a request to executes immediately the scheduler for the given flow name.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

flowName *: string

The flowName to identify the target resource.

Header Parameters

Authorization *: string

Bearer token for API authentication.

Response

Success

Unauthorized

Deployment not found

Deployment not ready

List CloudHub 2.0 alerts listAlerts

GET

Try it out

Path Parameters

organizationId *

environmentId *

Query Parameters

offset

limit

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Alerts

Retrieves Cloudhub 2.0 alerts

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Query Parameters

offset: integer(int32)

Pagination offset or page number for results.

limit: integer(int32)

Maximum number of results to return per page.

Header Parameters

Authorization *: string

Bearer token for API authentication.

Response

json

Success

data: array

Examples

application/json

{ "data": [ { "id": "string", "type": "string" } ] }

Create CloudHub 2.0 alert createAlert

POST

Try it out

Path Parameters

organizationId *

environmentId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Request Body application/json

Alerts

Creates a Cloudhub 2.0 alert

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

Header Parameters

Authorization *: string

Bearer token for API authentication.

Request Body *

json

name *: string

severity *: string

condition *: object

actions *: array

Response

json

Success

id: string

name: string

severity: string

enabled: boolean

organizationId: string

environmentId: string

lastModified: integer(int64)

createdAt: integer(int64)

isSystem: boolean

productName: string

condition: object

actions: array

conditionType: string

Examples

application/json

{ "id": "string", "name": "string", "severity": "INFO", "enabled": true, "organizationId": "string", "environmentId": "string", "lastModified": 0, "createdAt": 0, "isSystem": true, "productName": "string" }

Bad Request

Unauthorized

id: string

name: string

severity: string

enabled: boolean

organizationId: string

environmentId: string

lastModified: integer(int64)

createdAt: integer(int64)

isSystem: boolean

productName: string

condition: object

actions: array

conditionType: string

Examples

application/json

{ "id": "string", "name": "string", "severity": "INFO", "enabled": true, "organizationId": "string", "environmentId": "string", "lastModified": 0, "createdAt": 0, "isSystem": true, "productName": "string" }

Get deployment by ID getDeploymentById

GET

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Deployments

Retrieves a single deployment with the provided id.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

Header Parameters

Authorization *: string

Bearer token for API authentication.

Response

json

Success

id: string

The id of the deployment.

name: string

The name of the deployment.

creationDate: string(date-time)

The date when the deployment was created.

lastModifiedDate: string(date-time)

The date when the deployment was last modified.

target: object

The target of the deployment.

status: string

The status of the deployment.

application: object

The application of the deployment.

desiredVersion: string

The desired version of the deployment.

replicas: array

The list of replicas for the specified deployment.

lastSuccessfulVersion: string

The last version of the deployment that applied correctly.

Examples

application/json

{ "id": "e4899eda-22c9-4546-8ad2-ffde5a3d466d", "name": "app-name", "creationDate": "2024-01-15T10:30:00Z", "lastModifiedDate": "2024-01-15T10:30:00Z", "target": { "id": "string", "type": "string" }, "status": "FAILED", "application": { "id": "string", "type": "string" }, "desiredVersion": "0ef171b6-aad1-459b-8720-10c405b05ed1", "replicas": [ { "id": "string", "type": "string" } ], "lastSuccessfulVersion": "0ef171b6-aad1-459b-8720-10c405b05ed1" }

Unauthorized

Deployment not found

id: string

The id of the deployment.

name: string

The name of the deployment.

creationDate: string(date-time)

The date when the deployment was created.

lastModifiedDate: string(date-time)

The date when the deployment was last modified.

target: object

The target of the deployment.

status: string

The status of the deployment.

application: object

desiredVersion: string

The desired version of the deployment.

replicas: array

The list of replicas for the specified deployment.

lastSuccessfulVersion: string

The last version of the deployment that applied correctly.

Examples

application/json

{ "id": "e4899eda-22c9-4546-8ad2-ffde5a3d466d", "name": "app-name", "creationDate": "2024-01-15T10:30:00Z", "lastModifiedDate": "2024-01-15T10:30:00Z", "target": { "id": "string", "type": "string" }, "status": "FAILED", "application": { "id": "string", "type": "string" }, "desiredVersion": "0ef171b6-aad1-459b-8720-10c405b05ed1", "replicas": [ { "id": "string", "type": "string" } ], "lastSuccessfulVersion": "0ef171b6-aad1-459b-8720-10c405b05ed1" }

Update deployment patchDeployment

PATCH

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Request Body application/json

Deployments

Updates an existing deployment with the provided details.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

Header Parameters

Authorization *: string

Bearer token for API authentication.

Request Body *

json

target: object

application: object

The details of the application to deploy.

desiredVersion: string

The desired spec version to deploy

name: string

The name of the application.

Examples

Update vCores

{ "application": { "vCores": "0.07" } }

Update replicas

{ "target": { "replicas": 3 } }

Update runtime version

{ "target": { "deploymentSettings": { "runtimeVersion": "4.3.0:20220523-3" } } }

Update application ref

{ "application": { "ref": { "groupId": "66310c16-bce5-43c4-b978-5945ed2f99c5", "artifactId": "app-with-44-schedulers", "version": "1.0.44", "packaging": "jar" } } }

Update JVM arguments

{ "target": { "deploymentSettings": { "jvm": { "args": "-XX:MaxRAMPercentage=60.0" } } } }

Start application

{ "application": { "desiredState": "STARTED" } }

Stop application

{ "application": { "desiredState": "STOPPED" } }

Response

json

Success

id: string

The id of the deployment.

name: string

The name of the deployment.

creationDate: string(date-time)

The date when the deployment was created.

lastModifiedDate: string(date-time)

The date when the deployment was last modified.

target: object

The target of the deployment.

status: string

The status of the deployment.

application: object

The application of the deployment.

desiredVersion: string

The desired version of the deployment.

replicas: array

The list of replicas for the specified deployment.

lastSuccessfulVersion: string

The last version of the deployment that applied correctly.

Examples

application/json

{ "id": "e4899eda-22c9-4546-8ad2-ffde5a3d466d", "name": "app-name", "creationDate": "2024-01-15T10:30:00Z", "lastModifiedDate": "2024-01-15T10:30:00Z", "target": { "id": "string", "type": "string" }, "status": "FAILED", "application": { "id": "string", "type": "string" }, "desiredVersion": "0ef171b6-aad1-459b-8720-10c405b05ed1", "replicas": [ { "id": "string", "type": "string" } ], "lastSuccessfulVersion": "0ef171b6-aad1-459b-8720-10c405b05ed1" }

Unauthorized

Deployment not found

id: string

name: string

creationDate: string(date-time)

The date when the deployment was created.

lastModifiedDate: string(date-time)

The date when the deployment was last modified.

target: object

status: string

application: object

desiredVersion: string

replicas: array

lastSuccessfulVersion: string

Examples

application/json

{ "id": "string", "name": "string", "creationDate": "2024-01-15T10:30:00Z", "lastModifiedDate": "2024-01-15T10:30:00Z", "target": { "id": "string", "type": "string" }, "status": "PARTIALLY_STARTED", "application": { "id": "string", "type": "string" }, "desiredVersion": "string", "replicas": [ { "id": "string", "type": "string" } ], "lastSuccessfulVersion": "string" }

Delete deployment deleteDeployment

DELETE

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Deployments

Deletes the specified deploymentId.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

Header Parameters

Authorization *: string

Bearer token for API authentication.

Response

Success

Unauthorized

Deployment not found

List deployment schedulers listSchedulers

GET

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Schedulers

Retrieves a list of schedulers for the specified deployment. If this path contains no data, then an empty list is returned.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

Header Parameters

Authorization *: string

Bearer token for API authentication.

Response

json

Success

total: integer(int64)

The items list size.

items: array

Examples

application/json

{ "total": 1, "items": [ { "id": "string", "type": "string" } ] }

Unauthorized

Deployment not found

Enable or disable schedulers patchSchedulers

PATCH

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Request Body application/json

Schedulers

Disables or enables a list of schedulers in a deployment.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

Header Parameters

Authorization *: string

Bearer token for API authentication.

Request Body *

json

items: array

Array items

Response

json

Success

total: integer(int64)

The items list size.

items: array

Examples

application/json

{ "total": 1, "items": [ { "id": "string", "type": "string" } ] }

Unauthorized

Deployment not found

Get CloudHub 2.0 alert by ID getAlertById

GET

Try it out

Path Parameters

organizationId *

environmentId *

alertId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Alerts

Retrieves a single Cloudhub 2.0 alert

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

alertId *: string

The alert ID to identify the target resource.

Header Parameters

Authorization *: string

Bearer token for API authentication.

Response

json

Success

id: string

name: string

severity: string

enabled: boolean

organizationId: string

environmentId: string

lastModified: integer(int64)

createdAt: integer(int64)

isSystem: boolean

productName: string

condition: object

actions: array

conditionType: string

Examples

application/json

{ "id": "string", "name": "string", "severity": "INFO", "enabled": true, "organizationId": "string", "environmentId": "string", "lastModified": 0, "createdAt": 0, "isSystem": true, "productName": "string" }

Unauthorized

id: string

name: string

severity: string

enabled: boolean

organizationId: string

environmentId: string

lastModified: integer(int64)

createdAt: integer(int64)

isSystem: boolean

productName: string

condition: object

actions: array

conditionType: string

Examples

application/json

{ "id": "string", "name": "string", "severity": "INFO", "enabled": true, "organizationId": "string", "environmentId": "string", "lastModified": 0, "createdAt": 0, "isSystem": true, "productName": "string" }

Not Found

Bad Request

Update CloudHub 2.0 alert patchAlert

PATCH

Try it out

Path Parameters

organizationId *

environmentId *

alertId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Request Body application/json

Alerts

Updates a Cloudhub 2.0 alert

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

alertId *: string

The alert ID to identify the target resource.

Header Parameters

Authorization *: string

Bearer token for API authentication.

Request Body *

json

id: string

name *: string

enabled: boolean

productName: string

severity *: string

condition *: object

actions *: array

organizationId: string

environmentId: string

lastModified: integer(int64)

isSystem: boolean

createdAt: integer(int64)

system: boolean

Response

json

Success

id: string

name: string

severity: string

enabled: boolean

organizationId: string

environmentId: string

lastModified: integer(int64)

createdAt: integer(int64)

isSystem: boolean

productName: string

condition: object

actions: array

conditionType: string

Examples

application/json

{ "id": "string", "name": "string", "severity": "INFO", "enabled": true, "organizationId": "string", "environmentId": "string", "lastModified": 0, "createdAt": 0, "isSystem": true, "productName": "string" }

Bad Request

Unauthorized

id: string

name: string

severity: string

enabled: boolean

organizationId: string

environmentId: string

lastModified: integer(int64)

createdAt: integer(int64)

isSystem: boolean

productName: string

condition: object

actions: array

conditionType: string

Examples

application/json

{ "id": "string", "name": "string", "severity": "INFO", "enabled": true, "organizationId": "string", "environmentId": "string", "lastModified": 0, "createdAt": 0, "isSystem": true, "productName": "string" }

Internal Server Error

id: string

name: string

severity: string

enabled: boolean

organizationId: string

environmentId: string

lastModified: integer(int64)

createdAt: integer(int64)

isSystem: boolean

productName: string

condition: object

actions: array

conditionType: string

Examples

application/json

{ "id": "string", "name": "string", "severity": "INFO", "enabled": true, "organizationId": "string", "environmentId": "string", "lastModified": 0, "createdAt": 0, "isSystem": true, "productName": "string" }

Delete CloudHub 2.0 alert deleteAlert

DELETE

Try it out

Path Parameters

organizationId *

environmentId *

alertId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Alerts

Deletes a Cloudhub 2.0 alert

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

alertId *: string

The alert ID to identify the target resource.

Header Parameters

Authorization *: string

Bearer token for API authentication.

Response

Success

Unauthorized

Not Found

Bad Request

List deployment version specs listDeploymentSpecs

GET

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

Query Parameters

limit

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Deployments

Retrieves a list of deployment version specs for the specified deploymentId.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

Query Parameters

limit: integer(int32)

The number of specs the service can retrieve.

default: 10

Header Parameters

Authorization *: string

Bearer token for API authentication.

Response

json

Success

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Get CloudHub 2.0 alert history getAlertHistory

GET

Try it out

Path Parameters

organizationId *

environmentId *

alertId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Alerts

Retrieves a Cloudhub 2.0 alert history record

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

alertId *: string

The alert ID to identify the target resource.

Header Parameters

Authorization *: string

Bearer token for API authentication.

Response

json

Success

data: array

total: integer(int32)

Examples

application/json

{ "data": [ { "id": "string", "type": "string" } ], "total": 0 }

Unauthorized

data: array

total: integer(int32)

Examples

application/json

{ "data": [ { "id": "string", "type": "string" } ], "total": 0 }

Bad Request

Trigger replica thread dump diagnostic triggerReplicaDiagnostic

POST

Try it out

Path Parameters

organizationId *

environmentId *

replicaId *

deploymentId *

Custom Query Parameters

Custom Headers

Diagnostics

Trigger a thread dump diagnosis for a specific replica of a deployment

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

replicaId *: string

The replica ID to identify the target resource.

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

Response

No Content

Fetch deployment logs getDeploymentLogs

GET

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

specificationId *

Query Parameters

search *

Custom Query Parameters

Custom Headers

Logs

Fetch logs from the Log Aggregator V2 API.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

specificationId *: string

Specification Id

Query Parameters

search *: any

Search or filter expression to narrow results.

Response

OK

Download log entries as text downloadLogs

GET

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

specificationId *

Query Parameters

search *

Custom Query Parameters

Custom Headers

Logs

Download log entries matching the search as text attachment, without pagination.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

specificationId *: string

Specification Id

Query Parameters

search *: any

Search or filter expression to narrow results.

Response

OK

Examples

application/json

{}

List deployment diagnostics listDeploymentDiagnostics

GET

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

Custom Query Parameters

Custom Headers

Diagnostics

Retrieve a list of all executed actions related to the specified organization id, environment id and deployment id.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

Response

json

OK

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Get diagnostic thread dump report getDiagnosticReport

GET

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

actionId *

Custom Query Parameters

Custom Headers

Diagnostics

Fetch the thread dump report of a specific diagnosis action.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

actionId *: string

The action ID to identify the target resource.

Response

OK

Examples

application/json

{}

Bad Request

title: string

instance: string(uri)

type: string(uri)

parameters: object

status: object

detail: string

Examples

*/*

{ "title": "string", "instance": "https://example.com", "type": "https://example.com", "parameters": {}, "status": { "id": "string", "type": "string" }, "detail": "string" }

Not Found

Examples

application/json

{}

Update traffic switching percentage updateTrafficSwitching

PUT

Try it out

Path Parameters

organizationId *

environmentId *

deploymentId *

Header Parameters

Authorization *

Custom Query Parameters

Custom Headers

Request Body application/json

TrafficSwitching

upsert the percentage in which the traffic is switched to the CH2 deployment.

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[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

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

deploymentId *: string

The deployment ID to identify the target resource.

Related Operations:

amc-application-manager#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.items[*].id partner-manager-v2-partners#getOrganizationsByOrganizationidEnvironmentsByEnvironmentidDeployments.$.id tokenization-creation-and-mgmt#getEnvironmentsByEnvidDeployments.$.id

Header Parameters

Authorization *: string

Bearer token for API authentication.

Request Body *

json

switchedTraffic: integer(int32)

number mapped to an integer between 0 and 100

Response

json

Success

isSwitched: boolean

is the app traffic switched from CloudHub to CH2

switchedTrafficPercent: integer(int32)

number mapped to an integer between 0 and 100

ch1AppName: string

cloudhub app name

ch2AppName: string

CH2 app name

deploymentId: string

CH2 deployment id

Examples

application/json

{ "isSwitched": true, "switchedTrafficPercent": 50, "ch1AppName": "cloudhub app", "ch2AppName": "ch2 app", "deploymentId": "deployment id" }

Unauthorized

Deployment not found

Overview

Servers

Authentication & Security

Update scheduler configuration updateScheduler

Try it out

Response

Path Parameters

Header Parameters

Request Body *

Response

Reset scheduler to default resetScheduler

Try it out

Response

Path Parameters

Header Parameters

Response

List deployments listDeployments

Try it out

Response

Path Parameters

Query Parameters

Header Parameters

Response

Deploy a new application createDeployment

Try it out

Response

Path Parameters

Header Parameters

Request Body *

Response

Run scheduler immediately runScheduler

Try it out

Response

Path Parameters

Header Parameters

Response

List CloudHub 2.0 alerts listAlerts

Try it out

Response

Path Parameters

Query Parameters

Header Parameters

Response

Create CloudHub 2.0 alert createAlert

Try it out

Response

Path Parameters

Header Parameters

Request Body *

Response

Get deployment by ID getDeploymentById

Try it out

Response

Path Parameters

Header Parameters

Response

Update deployment patchDeployment

Try it out

Response

Path Parameters

Header Parameters

Request Body *

Response

Delete deployment deleteDeployment

Try it out

Response

Path Parameters

Header Parameters

Response

List deployment schedulers listSchedulers

Try it out

Response

Path Parameters

Header Parameters

Response

Enable or disable schedulers patchSchedulers

Try it out

Response

Path Parameters