All REST Endpoints

Sort by

Task Path Method

Group by API

Access Rules

View and manage the security rules for your service instances.

Add an Access Rule

Method: post

Path: /paas/api/v1.1/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/accessrules

Update an Access Rule

Method: put

Path: /paas/api/v1.1/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/accessrules/{ruleName}

View All Access Rules

Method: get

Path: /paas/api/v1.1/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/accessrules

Activity Logs

View status information and activity messages of operations performed on your service instances.

View the Status of an Operation by Job ID

Method: get

Path: /paas/api/v1.1/activitylog/{identityDomainId}/job/{jobId}

Backup and Restore

Manage backup and restore operations on your service instances.

Start a Backup Operation

Method: post

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/backups

Start a Restore Operation

Method: post

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/restoredbackups

Health Monitoring

Monitor the health of your service instances.

Monitor a Service Instance

Method: get

Path: /paas/api/v1.1/instancemgmt/{domainName}/services/IntegrationCloud/instances/{serviceName}/healthcheck

Patches

Apply Patch to your service instances.

Apply a Patch

Method: put

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/patches/{patchId}

Perform a Patching Precheck

Method: put

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/patches/checks/{patchId}

SSH Access

View and manage SSH keys for your service instance.

Add a New SSH Public Key

Method: post

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/credentials/crednames/{credentialName}

Retrieve the SSH Key Description Using Query Parameters

Method: get

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/credentials/crednames

Retrieve the SSH Key Value Using Query Parameters

Method: get

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/credentials

View the SSH Key Description

Method: get

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/credentials/crednames/{credentialName}

View the SSH Key Value

Method: get

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/credentials/{credentialName}

Scaling

Scaling in or scale out an service instance.

Scale-in the Service Instance

Method: put

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/servers

Scale-out the Service Instance

Method: post

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/servers

Service Instances

Manage the life cycle of your service instances.

Create a Service Instance

Method: post

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances

Delete a Service Instance

Method: put

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}

Restart a Service Instance

Method: post

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/hosts/restart

Start a Service Instance

Method: post

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/hosts/start

Stop a Service Instance

Method: post

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/hosts/stop

View a Service Instance

Method: get

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}

View All Service Instances

Method: get

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances

View the Status of a Service Instance Lifecycle Operation

Method: get

Path: /paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/status/{requestName}/job/{jobId}