Jump to

• Request
• Response
• Examples

Update the Configuration of a Deployment Webhook

put

/api/v2/deployments/{deployment_id}/webhook/restart

Use this endpoint to update the configuration of a webhook assigned to the specified deployment. You can enable or disable the webhook or change the value of the full_url_path property.

Request

Supported Media Types

• application/json

Path Parameters

• deployment_id: string
  deployment_id

Body ()

Body parameters

Root Schema : schema

Type: object

Show Source

• deployment_id: string
• enabled: boolean
• token: string

{
    "properties":{
        "deployment_id":{
            "type":"string"
        },
        "enabled":{
            "type":"boolean"
        },
        "token":{
            "type":"string"
        }
    },
    "required":[
        "deployment_id",
        "enabled",
        "token"
    ],
    "type":"object"
}

Security

• Authorization: apiKey
  Type: apiKey

Back to Top

Response

Supported Media Types

• text/plain; charset=utf-8

200 Response

200 Response

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: string

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

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 update the webhook for a specific Oracle Container Cloud Service deployment. You perform this task by submitting a PUT 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 "PUT" 
     -H "Authorization: Bearer b39f09c71c297f1d" 
     "https://rest_server_url/api/v2/deployments/Redis-20161026-165916/webhook/restart" 
     -d '{"enabled":true}'

Example of Response Body

{
  "deployment_id": "Redis-20161026-165916",
  "token": "lsmrxevh",
  "enabled": true,
  "full_url_path": "/api/v2/deployments/Redis-20161026-165916/webhook/restart?token=lsmrxevh"
}

Back to Top