Jump to

• Request
• Response
• Examples

Stop an Application

post

/paas/service/apaas/api/v1.1/apps/{identityDomainId}/{appName}/stop

Stops an application.

Request

Path Parameters

• appName: string
  Name of the application
• identityDomainId: string
  Name of the identity domain for the Oracle Application Container Cloud Service acount

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

The response body contains information about the application.

Root Schema : viewApp-activity-response

Type: object

The response body contains information about the application.

Show Source

• appId(optional): string
  ID of the application
• appURL(optional): string
  URL of the created application
• createdTime(optional): string
  Creation time of the application
• currentOngoingActivity(optional): string
  Activity status
• identityDomain(optional): string
  Identity Domain of the application
• instances(optional): array instances
  Shows all instances currently running.
• lastModifiedTime(optional): string
  Modification time of the application
• latestDeployment(optional): array latestDeployment
  Shows all deployments currently in progress.
• name(optional): string
  Name of the application
• runningDeployment(optional): array runningDeployment
  Shows all deployments currently running.
• status(optional): string
  Status of the application
• subscriptionType(optional): string
  Type of subscription, Hourly or Monthly
• webURL(optional): string
  Web URL of the application

{
    "description":"The response body contains information about the application.",
    "properties":{
        "identityDomain":{
            "type":"string",
            "description":"Identity Domain of the application"
        },
        "appId":{
            "type":"string",
            "description":"ID of the application"
        },
        "name":{
            "type":"string",
            "description":"Name of the application"
        },
        "status":{
            "type":"string",
            "description":"Status of the application"
        },
        "createdTime":{
            "type":"string",
            "description":"Creation time of the application"
        },
        "lastModifiedTime":{
            "type":"string",
            "description":"Modification time of the application"
        },
        "subscriptionType":{
            "type":"string",
            "description":"Type of subscription, Hourly or Monthly"
        },
        "instances":{
            "type":"array",
            "description":"Shows all instances currently running.",
            "items":{
                "$ref":"#/definitions/viewInstance"
            }
        },
        "runningDeployment":{
            "type":"array",
            "description":"Shows all deployments currently running.",
            "items":{
                "$ref":"#/definitions/viewDeploy"
            }
        },
        "latestDeployment":{
            "type":"array",
            "description":"Shows all deployments currently in progress.",
            "items":{
                "$ref":"#/definitions/viewDeploy"
            }
        },
        "currentOngoingActivity":{
            "type":"string",
            "description":"Activity status"
        },
        "appURL":{
            "type":"string",
            "description":"URL of the created application"
        },
        "webURL":{
            "type":"string",
            "description":"Web URL of the application"
        }
    }
}

Nested Schema : instances

Type: array

Shows all instances currently running.

Show Source

• Array of: object viewInstance

{
    "type":"array",
    "description":"Shows all instances currently running.",
    "items":{
        "$ref":"#/definitions/viewInstance"
    }
}

Nested Schema : latestDeployment

Type: array

Shows all deployments currently in progress.

Show Source

• Array of: object viewDeploy

{
    "type":"array",
    "description":"Shows all deployments currently in progress.",
    "items":{
        "$ref":"#/definitions/viewDeploy"
    }
}

Nested Schema : runningDeployment

Type: array

Shows all deployments currently running.

Show Source

• Array of: object viewDeploy

{
    "type":"array",
    "description":"Shows all deployments currently running.",
    "items":{
        "$ref":"#/definitions/viewDeploy"
    }
}

Nested Schema : viewInstance

Type: object

Show Source

• instanceURL(optional): string
  Instance URL. Use this url to get a description of the application instance.
• memory(optional): string
  Memory of the instance
• name(optional): string
  Instance Name. Use this name to manage a specific instance.
• status(optional): string
  Status of the instance

{
    "properties":{
        "name":{
            "type":"string",
            "description":"Instance Name. Use this name to manage a specific instance."
        },
        "status":{
            "type":"string",
            "description":"Status of the instance"
        },
        "memory":{
            "type":"string",
            "description":"Memory of the instance"
        },
        "instanceURL":{
            "type":"string",
            "description":"Instance URL. Use this url to get a description of the application instance."
        }
    }
}

Nested Schema : viewDeploy

Type: object

Show Source

• deploymentId(optional): string
  Deployment ID. Use this ID to manage a specific deployment.
• deploymentStatus(optional): string
  Status of the deployment
• deploymentURL(optional): string
  Deployment URL. Use this URL to get a description of the application deployment.

{
    "properties":{
        "deploymentId":{
            "type":"string",
            "description":"Deployment ID. Use this ID to manage a specific deployment."
        },
        "deploymentStatus":{
            "type":"string",
            "description":"Status of the deployment"
        },
        "deploymentURL":{
            "type":"string",
            "description":"Deployment URL. Use this URL to get a description of the application deployment."
        }
    }
}

Back to Top

Examples

The following example shows how to stop an Oracle Application Cloud Service application by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, including how to determine your region, see Send Requests.

curl -i -X POST -u [e-mail]:Welcome1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/ExampleIdentityDomain/ExampleAppName/stop

Example of Response Header

The following shows an example of the response header.

Date:Thu,16Apr201508:43:38GMT
Location:https://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/ExampleIdentityDomain/ExampleAppName/opStatus/157
Retry-After:5
Service-URI:https://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/ExampleIdentityDomain/ExampleAppName
Transfer-Encoding:chunked
X-Frame-Options:DENY
X-Powered-By:Servlet/2.5JSP/2.1

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
 "identityDomain": "ExampleIdentityDomain",
  "appId": "996b4bcd-89c3-4231-9c0d-2cd7322268e9",
  "name": "ExampleAppName",
  "status": "RUNNING",
  "createdBy": "weblogic",
  "creationTime": "2015-09-25T02:46:54.165-0700",
  "lastModifiedTime": "2015-09-25T02:46:53.943-0700",
  "subscriptionType": "MONTHLY",
  "instances": [],
  "runningDeployment": {
    "deploymentId": "ee9714dc-a2d0-4d6e-8b3c-8f0d185577b2",
    "deploymentStatus": "READY",
    "deploymentURL": "http://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/ExampleIdentityDomain/ExampleAppName/deployments/ee9714dc-a2d0-4d6e-8b3c-8f0d185577b2"
  },
  "lastestDeployment": {
    "deploymentId": "ee9714dc-a2d0-4d6e-8b3c-8f0d185577b2",
    "deploymentStatus": "READY",
    "deploymentURL": "http://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/ExampleIdentityDomain/ExampleAppName/deployments/ee9714dc-a2d0-4d6e-8b3c-8f0d185577b2"
  },
  "currentOngoingActivity": "Stopping Application",
  "appURL": "http://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/ExampleIdentityDomain/ExampleAppName",
  "webUrl": "http://ExampleAppName-ExampleIdentityDomain-dev.apaas.demo.oraclecloudapps.com:8080",
  "message": []
}

Back to Top