Sign in
Endpoints

Roll endpoint secret

This endpoint expires and re-generates the endpoint secret.

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

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

Changed in 11 of the 69 revisions of this API.201319

  • v3c6c04abdfb6f1See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/teams_webhook_url to the response with the 200 status

      response-optional-property-added

  • v3bae289777c911854See the full diff
    • ▲

      the response property allOf[subschema #2]/data became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data became nullable for the status 404

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/authentication became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/cb_state became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/deleted_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/failure_count became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/failure_rate became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/mtls_client_cert became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/period_failure_rate became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/retry_count became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/secrets/items/deleted_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/secrets/items/expires_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/success_count became nullable for the status 200

      response-property-became-nullable

    • ▲

      the allOf[subschema #2]/data response's property type/format changed from object/ to / for status 400

      response-property-type-changed

    • ▲

      the allOf[subschema #2]/data response's property type/format changed from object/ to / for status 401

      response-property-type-changed

    • ▲

      the allOf[subschema #2]/data response's property type/format changed from object/ to / for status 404

      response-property-type-changed

    • ▲

      the allOf[subschema #2]/data/authentication response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property allOf[subschema #2]/data/authentication/api_key from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/authentication/basic_auth from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/authentication/oauth2 from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/authentication/type from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new enum value to the allOf[subschema #2]/data/status response property for the response status 200

      response-property-enum-value-added

    • ○

      added datastore.EndpointAuthentication to the allOf[subschema #2]/data/authentication response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added handlers.Stub to the allOf[subschema #2]/data response property allOf list for the response status 400

      response-property-all-of-added

    • ○

      added handlers.Stub to the allOf[subschema #2]/data response property allOf list for the response status 401

      response-property-all-of-added

    • ○

      added handlers.Stub to the allOf[subschema #2]/data response property allOf list for the response status 404

      response-property-all-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v32e8ab34176ea2See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/cb_state to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/retry_count to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v321fa7ff1d01a3See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/failure_count to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/period_failure_rate to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/success_count to the response with the 200 status

      response-optional-property-added

  • v3990a51cff1cc11See the full diff
    • ●

      added the new basic_auth enum value to the allOf[subschema #2]/data/authentication/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property allOf[subschema #2]/data/authentication/basic_auth to the response with the 200 status

      response-optional-property-added

  • v3af9526d13dc81See the full diff
    • ○

      removed the pending enum value from the allOf[subschema #2]/data/status response property for the response status 200

      response-property-enum-value-removed

  • v388eaa000293b11See the full diff
    • ●

      added the new oauth2 enum value to the allOf[subschema #2]/data/authentication/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property allOf[subschema #2]/data/authentication/oauth2 to the response with the 200 status

      response-optional-property-added

  • v3801a0bbf87fd2See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/content_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/mtls_client_cert to the response with the 200 status

      response-optional-property-added

  • v3de665d0e2fc31See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/failure_rate to the response with the 200 status

      response-optional-property-added

  • v328d285e4302c63See the full diff
    • ●

      removed the optional property allOf[util.ServerResponse]/data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[util.ServerResponse]/data from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[util.ServerResponse]/data from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[util.ServerResponse]/data from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/target_url from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[subschema #2]/data/title from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id ExpireSecret was added

      api-operation-id-added

    • ○

      added the optional property allOf[subschema #2]/data/name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/url to the response with the 200 status

      response-optional-property-added