`bird webhooks client-certificate upload`

Usage

Code example

bird webhooks client-certificate upload [flags]

Send the signed certificate first, then each intermediate certificate, as PEM. It replaces the certificate in use. Deliveries can present the previous certificate for up to a few minutes, so receivers must accept both until then.

Build the request from flags, a JSON WebhookClientCertificateUpload body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

This is destructive and cannot be undone; pass --yes to confirm.

Procedure

Step 3 of 6 of "Present a client certificate on webhook deliveries". Previous: bird webhooks client-certificate create-signing-request. Next: bird webhooks client-certificate update.

Examples

Code example

# print the body shape (no credentials needed)
bird webhooks client-certificate upload --example

# the body it prints:

Code example

{
  "certificate_chain": "-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----\n"
}

Code example

# upload the certificate your CA signed, with its intermediates
bird webhooks client-certificate upload --certificate-chain-file signed-chain.pem --yes

Options

Safety

Name	Description
`--yes`	Confirm the action (required; the CLI never prompts)

Request

Name	Description
`--body-file`	Read the JSON request body from this file; "-" reads stdin
`--example`	Print a complete example request body, then exit
`--dry-run`	Print the resolved request without sending it, then exit
`--idempotency-key`	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
`--certificate-chain`	PEM-encoded certificates, the signed certificate first, then any intermediate certificates. (required; or in --body-file)
`--certificate-chain-file`	Read the PEM certificate chain from this file instead of --certificate-chain.
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird webhooks client-certificate create-signing-request`	Create a webhook client certificate signing request
`bird webhooks client-certificate get`	Get the webhook client certificate
`bird webhooks client-certificate update`	Update the webhook client certificate settings

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources