Projects

Rotate a project's signing key

Changed on

Rotates the project's signing key and returns the project with the new signing_key.

The previous key may take about 1–2 minutes to stop working. As with create, the signing_key is only returned on this response and cannot be retrieved afterward.

Use it when the project's webhook-signing credential has been exposed or is due for rotation; this is separate from creating or revoking REST API tokens.

Permissions

With a project API token, the token must have the following scope(s) enabled to make a successful request: Management.

With a Personal access token there are no scopes. The token holder must be an owner or admin of the space, and the request reaches only the projects the holder is enabled for, plus their subprojects.

Learn more about API scopes.

post/api/projects/{id}/signing-key/rotate

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/projects/{id}/signing-key/rotate
  • Auth
    • HTTP basic
    • or HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

The unique identifier of the project or subproject.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

namestring required

The name of the project.

parent_project_idstring uuid required

Universal Unique Identifier.

subprojectboolean required

true when this project is a subproject.

region_preferencestring required

The effective region preference for the project. Returned in all responses; it is not currently settable through this API.

protect_recordingsboolean required

When enabled, recordings created within the project require authentication to access.

protect_message_mediaboolean required

When enabled, message media created within the project requires authentication to access.

protect_fax_mediaboolean required

When enabled, fax media created within the project requires authentication to access.

force_https_requestsboolean required

When enabled, requests made to the project's webhooks and callbacks must use HTTPS.

created_atstring date-time required

The date and time when the project was created.

updated_atstring date-time required

The date and time when the project was last updated.

signing_keystring required

The project's signing key. Only returned on create and signing-key rotation responses; it cannot be retrieved through the API afterward.

Example response

{
  "name": "Acme Staging",
  "subproject": true,
  "region_preference": "us-west",
  "force_https_requests": true,
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "signing_key": "PSK_4d8c2b1a9f3e7c6d5b4a3e2f1d0c9b8a"
}

Changes

  • 45bac4fd93abRevision changes
    • info

      the endpoint scheme security SignalWireBasicAuth was added to the API

    • info

      the endpoint scheme security SignalWirePersonalAccessTokenAuth was added to the API

  • e3d7a1ccbc4fRevision changes
    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

Some revisions have not been checked yet.