FerryDocs
ConceptsDeploys

Deploy hooks

A deploy hook is a secret URL. A request to this URL deploys the service.

Edit on GitHub
Your CIor a registryDeploy hookPOST …?key=…New deployanswer: 202

Each service has one deploy hook. The request needs no API token, because the key is in the URL.

Use the hook

Terminal
$ 

The answer is 202, with a summary of the deploy in the queue. GET also works.

If the URL leaks

The URL is a password

Each person who has the URL can deploy the service. If the URL leaks, replace the key. The old URL stops immediately.

Terminal
ferry deploy-hook rotate api

On this page