Jump to

• Request
• Response
• Examples

Delete a Deployment

delete

/api/v2/deployments/{deployment_id}

Deletes a stopped Deployment. You identify the deployment with the deployment_id parameter.

Request

Path Parameters

• deployment_id: string
  deployment_id

Security

• Authorization: apiKey
  Type: apiKey

Back to Top

Response

Supported Media Types

• application/json

200 Response

200 Response

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object items

{
    "items":{
        "properties":{
            "deleted":{
                "type":"string"
            }
        },
        "required":[
            "deleted"
        ],
        "type":"object"
    }
}

Nested Schema : items

Type: object

Show Source

• deleted: string

{
    "properties":{
        "deleted":{
            "type":"string"
        }
    },
    "required":[
        "deleted"
    ],
    "type":"object"
}

Default Response

Error Payload

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

The following example shows how to delete an Oracle Container Cloud Service deployment. You perform this task by submitting a DELETE request to the REST resource using cURL. For more information about cURL, see Use cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the manager node for the Oracle Cloud Container instance. See Send Requests for the appropriate URL structure to use for Oracle Public Cloud.

cURL Command

curl -sk 
     -X "DELETE" 
     -H "Authorization: Bearer b39f09c71c297f1d" 
     "https://rest_server_url/api/v2/deployments/Redis-20161026-165916"

Example of Response Body

{"deleted": "Redis-20161026-165916"}

Back to Top