Jump to

• Request
• Response
• Examples

View Application Deployment History

get

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

Retrieves detailed information about the deployment history of 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

200 Response

OK

Body ()

The response body contains information about application deployments.

Root Schema : viewall-deployments-response

Type: object

The response body contains information about application deployments.

Show Source

• autoMinorVersionUpdate(optional): boolean
  Automatic minor version update for patching
• deploymentInfo(optional): array deploymentInfo
  Deployment details
• environment(optional): string
  Environment, such as Java, Node, PHP, Python, or Ruby
• environmentDisplayVersion(optional): string
  Display version of environment
• environmentMajorVersion(optional): string
  Major version of the environment
• environmentVariables(optional): array environmentVariables
  Show all environment variables for the deployment
• environmentVersion(optional): string
  Version of environment
• processes(optional): array processes
  Show all processes details of the application
• serviceBindings(optional): array serviceBindings
  Show all service bindings for the deployment

{
    "description":"The response body contains information about application deployments.",
    "properties":{
        "environment":{
            "type":"string",
            "description":"Environment, such as Java, Node, PHP, Python, or Ruby"
        },
        "environmentMajorVersion":{
            "type":"string",
            "description":"Major version of the environment"
        },
        "environmentVersion":{
            "type":"string",
            "description":"Version of environment"
        },
        "environmentDisplayVersion":{
            "type":"string",
            "description":"Display version of environment"
        },
        "autoMinorVersionUpdate":{
            "type":"boolean",
            "description":"Automatic minor version update for patching"
        },
        "deploymentInfo":{
            "type":"array",
            "description":"Deployment details",
            "items":{
                "$ref":"#/definitions/viewDeployInfo"
            }
        },
        "processes":{
            "type":"array",
            "description":"Show all processes details of the application",
            "items":{
                "$ref":"#/definitions/viewProcessesDef"
            }
        },
        "serviceBindings":{
            "type":"array",
            "description":"Show all service bindings for the deployment",
            "items":{
                "$ref":"#/definitions/viewServiceBindings"
            }
        },
        "environmentVariables":{
            "type":"array",
            "description":"Show all environment variables for the deployment",
            "items":{
                "$ref":"#/definitions/viewEnvironment"
            }
        }
    }
}

Nested Schema : deploymentInfo

Type: array

Deployment details

Show Source

• Array of: object viewDeployInfo
  The response body contains information about application deployments.

{
    "type":"array",
    "description":"Deployment details",
    "items":{
        "$ref":"#/definitions/viewDeployInfo"
    }
}

Nested Schema : environmentVariables

Type: array

Show all environment variables for the deployment

Show Source

• Array of: object viewEnvironment
  The response body contains information about all application environment variables.

{
    "type":"array",
    "description":"Show all environment variables for the deployment",
    "items":{
        "$ref":"#/definitions/viewEnvironment"
    }
}

Nested Schema : processes

Type: array

Show all processes details of the application

Show Source

• Array of: object viewProcessesDef
  The response body contains information about processes definitions.

{
    "type":"array",
    "description":"Show all processes details of the application",
    "items":{
        "$ref":"#/definitions/viewProcessesDef"
    }
}

Nested Schema : serviceBindings

Type: array

Show all service bindings for the deployment

Show Source

• Array of: object viewServiceBindings
  The response body contains information about all application service bindings.

{
    "type":"array",
    "description":"Show all service bindings for the deployment",
    "items":{
        "$ref":"#/definitions/viewServiceBindings"
    }
}

Nested Schema : viewDeployInfo

Type: object

The response body contains information about application deployments.

Show Source

• archiveName(optional): string
  File name of the application package
• buildNumber(optional): string
  Build number of the deployment
• commitId(optional): string
  Commit ID of the deployment
• creationTime(optional): string
  Creation time of the deployment
• deploymentId(optional): string
  Unique deployment ID
• deploymentNumber(optional): number
  Auto generated deployment number
• deploymentStatus(optional): string
  Status of the deployment
• deploymentVersion(optional): string
  User-specified deployment version
• releaseNotes(optional): string
  Release notes of the deployment
• size(optional): number
  Size of the application package
• source(optional): string
  Source of the application package
• uploadedBy(optional): string
  User who uploaded the application package

{
    "description":"The response body contains information about application deployments.",
    "properties":{
        "deploymentId":{
            "type":"string",
            "description":"Unique deployment ID"
        },
        "deploymentNumber":{
            "type":"number",
            "description":"Auto generated deployment number"
        },
        "deploymentStatus":{
            "type":"string",
            "description":"Status of the deployment"
        },
        "creationTime":{
            "type":"string",
            "description":"Creation time of the deployment"
        },
        "buildNumber":{
            "type":"string",
            "description":"Build number of the deployment"
        },
        "commitId":{
            "type":"string",
            "description":"Commit ID of the deployment"
        },
        "source":{
            "type":"string",
            "description":"Source of the application package"
        },
        "size":{
            "type":"number",
            "description":"Size of the application package"
        },
        "archiveName":{
            "type":"string",
            "description":"File name of the application package"
        },
        "uploadedBy":{
            "type":"string",
            "description":"User who uploaded the application package"
        },
        "deploymentVersion":{
            "type":"string",
            "description":"User-specified deployment version"
        },
        "releaseNotes":{
            "type":"string",
            "description":"Release notes of the deployment"
        }
    }
}

Nested Schema : viewEnvironment

Type: object

The response body contains information about all application environment variables.

Show Source

• varName(optional): string
  Name of the environment variable
• varValue(optional): string
  Value of the environment variable

{
    "description":"The response body contains information about all application environment variables.",
    "properties":{
        "varName":{
            "type":"string",
            "description":"Name of the environment variable"
        },
        "varValue":{
            "type":"string",
            "description":"Value of the environment variable"
        }
    }
}

Nested Schema : viewProcessesDef

Type: object

The response body contains information about processes definitions.

Show Source

• memory(optional): string
  Memory for the process
• processCommand(optional): string
  Command for running the process
• processName(optional): string
  Name of the process
• quantity(optional): string
  Number of process instances

{
    "description":"The response body contains information about processes definitions.",
    "properties":{
        "processName":{
            "type":"string",
            "description":"Name of the process"
        },
        "processCommand":{
            "type":"string",
            "description":"Command for running the process"
        },
        "memory":{
            "type":"string",
            "description":"Memory for the process"
        },
        "quantity":{
            "type":"string",
            "description":"Number of process instances"
        }
    }
}

Nested Schema : viewServiceBindings

Type: object

The response body contains information about all application service bindings.

Show Source

• password(optional): string
  Password for access to the service
• processName(optional): string
  Name of the process
• serviceName(optional): string
  Name of the service, a database name or an Oracle Java Cloud Service instance name
• serviceType(optional): string
  Type of the service, either Oracle Database Cloud Service or Oracle Java Cloud Service
• userName(optional): string
  Username for access to the service

{
    "description":"The response body contains information about all application service bindings.",
    "properties":{
        "processName":{
            "type":"string",
            "description":"Name of the process"
        },
        "serviceType":{
            "type":"string",
            "description":"Type of the service, either Oracle Database Cloud Service or Oracle Java Cloud Service"
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the service, a database name or an Oracle Java Cloud Service instance name"
        },
        "userName":{
            "type":"string",
            "description":"Username for access to the service"
        },
        "password":{
            "type":"string",
            "description":"Password for access to the service"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all deployments of an Oracle Application Cloud Service application by submitting a GET 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 GET -u [e-mail]:Welcome1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/ExampleIdentityDomain/ExampleAppName/deployments

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 
200 OK  
Date: Wed, 04 Feb 2015 21:24:33 GMT  
Transfer-Encoding: chunked  
Content-Type: application/json

Example of Response Body

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

{
  "releases": [
    {
      "environment": "Java",
      "environmentMajorVersion": "8",
      "environmentVersion": "1.8.0_71-b15",
      "environmentDisplayVersion": "Java SE 8u71",
      "autoMinorVersionUpdate": false,
      "deploymentInfo": {
        "deploymentId": "e27d094b-4c73-42a9-a94d-9a76ec1eec26",
        "deploymentNumber": "1",
        "deploymentStatus": "READY",
        "creationTime": "2016-02-26T19:21:04.110+0530",
        "buildNumber": "150520.1154",
        "commitId": "d8c2596364d9584050461",
        "source": "ORACLE",
        "size": 6710151,
        "archiveName": "java-sample-15.4.6.1.1.zip",
        "uploadedBy": "weblogic",
        "deploymentVersion": "15.1.0",
        "releaseNotes": "notes for release"
      },
      "processes": [
        {
          "processName": "web",
          "processCommand": "sh target/bin/start",
          "memory": "2G",
          "quantity": 1
        }
      ],
      "environmentVariables": [],
      "serviceBindings": []
    }
  ]
}

Back to Top