Create Docker Registry Webhook Using POST
Create a Docker Registry Webhook
The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about
{
"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"
}Docker webhook description.
Indicates whether Docker webhook is enabled or not.
Docker endpoint.
Docker webhook listener link.
If provided then the pipeline execution is triggered only when the given image name regex matches the image name in the received payload.
Pipeline Execution input properties.
A human-friendly name used as an identifier in APIs that support this option
Pipeline name which is meant to be triggered when a docker event occur.
The project this entity belongs to.
Codestream API token.
Docker Repo Name.
Secret token to validate received payloads.
Docker server type.
Docker webhook name.
If provided then the pipeline execution is triggered only when the given tag name regex matches the tag name(s) in the received payload.
'Success' with Creation of Docker Registry Webhook
{
"_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"
}This field is provided for backward compatibility. Contains the same value as the 'createdAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'createdBy' field
Partial URL that provides details of the resource.
This field is provided for backward compatibility. Contains the same value as the 'updatedAt' field as a UNIX timestamp in microseconds
This field is provided for backward compatibility. Contains the same value as the 'updatedBy' field
Date when the entity was created. The date is in ISO 8601 with time zone
The user that created this entity
A human-friendly description.
Indicates whether Docker webhook is enabled or not.
Name of the Docker Endpoint.
Docker webhook listener link.
The id of this resource.
If provided then the pipeline execution is triggered only when the given image name regex matches the image name in the received payload.
Pipeline execution input properties.
A human-friendly name used as an identifier in APIs that support this option
Pipeline name which is meant to be triggered when a docker event occur.
The project this entity belongs to.
This token is used to authenticate when calling VMware Cloud Services APIs. These tokens are scoped within the organization.
Docker Repo Name.
Secret token to validate received payloads.
Docker server type.
Docker webhook name.
If provided then the pipeline execution is triggered only when the given tag name regex matches the tag name(s) in the received payload.
Date when the entity was last updated. The date is in ISO 8601 with time zone.
The user that last updated this entity
Version of the resource.
Unauthorized Request
Forbidden
Not Found
Server Error