FRfrain-dev
Endpoints

Roll endpoint secret

Changed on

This endpoint expires and re-generates the endpoint secret.

put/v1/projects/{projectID}/endpoints/{endpointID}/expire_secret

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    API key in header Authorization

Path parameters

projectIDstring required

Project ID

endpointIDstring required

Endpoint ID

Request body

expirationinteger

Amount of time to wait before expiring the old endpoint secret. If AdvancedSignatures is turned on for the project, signatures for both secrets will be generated up until the old signature is expired.

secretstring

New Endpoint secret value.

Response

OK

messagestring
statusboolean

Changes