Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.31 KB

deployment_getDeployStatus.rst

File metadata and controls

55 lines (36 loc) · 1.31 KB

deployment_getDeployStatus

GET /users/{uid}/deployments/{did}/status

Summary

  • Method: GET
  • Response Code: 200 / 304
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.fp6

Returns the status of a deployment.

A deployment is the instantiation of a deployment-object.

Currently a deployment is a single instance of a software stack. To deploy a published machine image, refer to machineImagePublished-deploy.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user-object
  • did (required): the id of the deployment-object

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/deployments/{did}/status" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"
  • deployment-object
  • deployment-get
  • deployment-getAll
  • deployment-terminate
  • machineImagePublished-deploy
  • user-object