Update Using PUT

Update Using PUT

Update a Docker Registry Webhook

Request
URI
PUT
http://cava-s-182-041.eng.vmware.com//codestream/api/registry-webhooks/{id}
COPY
Path Parameters
string
id
Required

id

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about


Request Body
DockerRegistryWebHookSpec of type(s) application/json
Optional
{
    "description": "It is a docker saas webhook",
    "enabled": true,
    "endpoint": "Dcocker-SaaS",
    "externalListenerLink": "/codestream/api/registry-webhook-listeners/412aa461-6d46-47d6-af93-152bb0d88682",
    "imageNameRegExPattern": "admin/wordpress",
    "input": {
        "test": {
            "description": "test-value",
            "mandatory": false
        }
    },
    "name": "My-Name",
    "pipeline": "CD-Pipeline",
    "project": "My-Project",
    "refreshToken": "I5FLA8iQhlZwoos6OL3goKciAF5e",
    "repoName": "codestream",
    "secretToken": "DSkUyJJ8KA8rOSk=Ci",
    "serverType": "DockerHub/Docker_Trusted_Registry",
    "slug": "docker-webhook",
    "tagNamePattern": "tag1"
}
string
description
Optional

Docker webhook description.

boolean
enabled
Optional

Indicates whether Docker webhook is enabled or not.

string
endpoint
Optional

Docker endpoint.

string
externalListenerLink
Optional

Docker webhook listener link.

string
imageNameRegExPattern
Optional

If provided then the pipeline execution is triggered only when the given image name regex matches the image name in the received payload.

object
input
Optional

Pipeline Execution input properties.

string
name
Required

A human-friendly name used as an identifier in APIs that support this option

string
pipeline
Optional

Pipeline name which is meant to be triggered when a docker event occur.

string
project
Optional

The project this entity belongs to.

string
refreshToken
Optional

Codestream API token.

string
repoName
Optional

Docker Repo Name.

string
secretToken
Optional

Secret token to validate received payloads.

string
serverType
Optional

Docker server type.

string
slug
Optional

Docker webhook name.

string
tagNamePattern
Optional

If provided then the pipeline execution is triggered only when the given tag name regex matches the tag name(s) in the received payload.

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with Docker Registry Webhook Update

Returns DockerRegistryWebHook of type(s) application/json
{
    "_createTimeInMicros": 1568625938000000,
    "_createdBy": "exampleuser",
    "_link": "/codestream/api/<prefix>/8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "_updateTimeInMicros": 1568625938000000,
    "_updatedBy": "exampleuser",
    "createdAt": "2019-09-16 09:25:38.065065+00",
    "createdBy": "exampleuser",
    "description": "string",
    "enabled": true,
    "endpoint": "Docker Endpoint",
    "externalListenerLink": "codestream/api/registry-webhooks/sdscfvefw34rfrdsvdsat43erwfdf",
    "id": "8365ef3b-8bf3-48aa-bd5d-7113fcff827c",
    "imageNameRegExPattern": "admin/wordpress",
    "input": [
        {
            "ip": "10.5.23.84",
            "script": "testScript.sh"
        }
    ],
    "name": "My-Name",
    "pipeline": "DemoPipeline",
    "project": "My-Project",
    "refreshToken": "cKNNVCSHijnaxlrfnVsxUYr6wM2g5Bg11tfnotmWb9XdA5kpUCvI2ubJojTIGp9g",
    "repoName": "MyRepository",
    "secretToken": "dvcdefrffsdvdfvfdgfdvbfdbvrefg3ff=",
    "serverType": "DockerHub/Docker_Trusted_Registry",
    "slug": "docker-webhook",
    "tagNamePattern": "tag1",
    "updatedAt": "2019-09-16 09:25:38.065065+00",
    "updatedBy": "exampleuser",
    "version": "v1"
}
integer As int64 As int64
_createTimeInMicros
Optional

This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds

string
_createdBy
Optional

This field is provided for backward compatibility. Contains the same value as the 'createdBy' field

string
_link
Optional

Partial URL that provides details of the resource.

integer As int64 As int64
_updateTimeInMicros
Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds

string
_updatedBy
Optional

This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 with time zone

string
createdBy
Optional

The user that created this entity

string
description
Required

A human-friendly description.

boolean
enabled
Optional

Indicates whether Docker webhook is enabled or not.

string
endpoint
Optional

Name of the Docker Endpoint.

string
externalListenerLink
Optional

Docker webhook listener link.

string
id
Optional

The id of this resource.

string
imageNameRegExPattern
Optional

If provided then the pipeline execution is triggered only when the given image name regex matches the image name in the received payload.

object
input
Optional

Pipeline execution input properties.

string
name
Required

A human-friendly name used as an identifier in APIs that support this option

string
pipeline
Optional

Pipeline name which is meant to be triggered when a docker event occur.

string
project
Optional

The project this entity belongs to.

string
refreshToken
Optional

This token is used to authenticate when calling VMware Cloud Services APIs. These tokens are scoped within the organization.

string
repoName
Optional

Docker Repo Name.

string
secretToken
Optional

Secret token to validate received payloads.

string
serverType
Optional

Docker server type.

string
slug
Optional

Docker webhook name.

string
tagNamePattern
Optional

If provided then the pipeline execution is triggered only when the given tag name regex matches the tag name(s) in the received payload.

string
updatedAt
Optional

Date when the entity was last updated. The date is in ISO 8601 with time zone.

string
updatedBy
Optional

The user that last updated this entity

string
version
Optional

Version of the resource.


401

Unauthorized Request

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Server Error

Operation doesn't return any data structure

Triggers Operations
POST
Clone Listener Using POST
POST
Clone Trigger Using POST
POST
Create Docker Registry Webhook Using POST
POST
Create Gerrit Listener Using POST
POST
Create Git Webhook Using POST
POST
Create Using POST 2
DELETE
Delete By Id Using DELETE
DELETE
Delete By Id Using DELETE 1
DELETE
Delete By Name Using DELETE
DELETE
Delete By Name Using DELETE 1
DELETE
Delete By Name Using DELETE 2
DELETE
Delete By Name Using DELETE 3
DELETE
Delete Using DELETE
DELETE
Delete Using DELETE 4
DELETE
Delete Using DELETE 5
DELETE
Delete Using DELETE 6
DELETE
Delete Using DELETE 7
GET
Get All Docker Events Using GET
GET
Get All Docker Registry Webhooks Using GET
GET
Get All Events Using GET
GET
Get All Gerrit Listeners Using GET
GET
Get All Git Events Using GET
GET
Get All Git Webhooks Using GET
GET
Get All Using GET 2
GET
Get Docker Event By ID Using GET
GET
Get Docker Registry Webhook By ID Using GET
GET
Get Docker Registry Webhook By Name Using GET
GET
Get Event By ID Using GET
GET
Get Gerrit Listener By ID Using GET
GET
Get Gerrit Listener By Name Using GET
GET
Get Gerrit Projects Using GET
GET
Get Gerrit Projects Using GET 1
GET
Get Git Event By ID Using GET
GET
Get Git Webhook By ID Using GET
GET
Get Git Webhook By Name Using GET
GET
Get Trigger By Name Using GET
GET
Get Trigger Using GET
POST
Manual Trigger Using POST
PATCH
Patch By Id Using PATCH
PATCH
Patch By Id Using PATCH 1
PATCH
Patch By Id Using PATCH 2
PATCH
Patch By Name Using PATCH
PATCH
Patch By Name Using PATCH 1
PATCH
Patch By Name Using PATCH 2
POST
Resume Or Rerun Event Using POST
POST
Resume Or Rerun Event Using POST 1
POST
Resume Or Rerun Event Using POST 2
PUT
Update By Id Using PUT 2
PUT
Update By Id Using PUT 3
PUT
Update By Name Using PUT
PUT
Update By Name Using PUT 2
PUT
Update By Name Using PUT 3
PUT
Update By Name Using PUT 4
PUT
Update Using PUT
PUT
Update Using PUT 1
POST
Validate Gerrit Listener Using POST